cgl.narada.wsinfra.deployment
Class SOAPServletContainer

java.lang.Object
  cgl.narada.wsinfra.deployment.SOAPServletContainer

Direct Known Subclasses:

SOAPServletContainerImpl

public abstract class SOAPServletContainer
extends Object

This container will be used to register SOAP Based roles. It is expected that in some cases there may be a servlet associated per role. Typically, this need not be the case. Upon the receipt of a SOAP message, a special class will parse the SOAP message to determine all the targeted roles. Depending on the roles, appropriate filter pipelines will be deployed to ensure complete processing of a SOAP message. In some cases, a set of default roles may be associated with a given SOAP message. This may include processing related to logging every SOAP message etc.

Constructor Summary

SOAPServletContainer()

Method Summary

abstract void	deregisterServlet(String servletName) This method deregisters a servlet.
abstract void	deregisterServletForRole(String servletName, String role) This method de-registers a servlet associated witha a specific role.
static SOAPServletContainer	getInstance()
abstract ServletConfig	getServletConfigForRole(String role) Retrieve the ServletContext associated with a specific role.
abstract void	initializeServices(int portNum) Starts up the HTTP Servlet container at this port number.
abstract boolean	isServletRegisteredForRole(String servletName, String role) Checks to see if a servlet has been registered for the specified role.
abstract void	processSOAPMessage(SOAPMessage soapMessage, String servletName) Method used by servlets to notify about SOAP messages received over the network.
abstract void	registerServlet(String servletName, String servletPath, String servletClass) This method registers a servlet.
abstract void	registerServletForRole(String role, String servletName, String pathSpec, String servletClass) This method registers a servlet associated with a specific role.
abstract void	startServices() Start Services
abstract void	stopServices() Stop Services

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SOAPServletContainer

public SOAPServletContainer()

Method Detail

getInstance

public static SOAPServletContainer getInstance()

initializeServices

public abstract void initializeServices(int portNum)
                                 throws DeploymentException

Starts up the HTTP Servlet container at this port number. This method throws an exception

Throws:

DeploymentException

startServices

public abstract void startServices()
                            throws DeploymentException

Start Services

Throws:

DeploymentException

stopServices

public abstract void stopServices()
                           throws DeploymentException

Stop Services

Throws:

DeploymentException

registerServlet

public abstract void registerServlet(String servletName,
                                     String servletPath,
                                     String servletClass)
                              throws DeploymentException

This method registers a servlet. The servlet is not associated with a specific role.

Throws:

DeploymentException

deregisterServlet

public abstract void deregisterServlet(String servletName)
                                throws DeploymentException

This method deregisters a servlet. The servlet is not associated with a specific role.

Throws:

DeploymentException

registerServletForRole

public abstract void registerServletForRole(String role,
                                            String servletName,
                                            String pathSpec,
                                            String servletClass)
                                     throws DeploymentException

This method registers a servlet associated with a specific role. This method throws an exception if another servlet has been previously registered for this role or if there are problems deploying this servlet.

Throws:

DeploymentException

deregisterServletForRole

public abstract void deregisterServletForRole(String servletName,
                                              String role)
                                       throws DeploymentException

This method de-registers a servlet associated witha a specific role. This method throws an exception if there are no servlets registered for this role.

Throws:

DeploymentException

isServletRegisteredForRole

public abstract boolean isServletRegisteredForRole(String servletName,
                                                   String role)
                                            throws DeploymentException

Checks to see if a servlet has been registered for the specified role.

Throws:

DeploymentException

getServletConfigForRole

public abstract ServletConfig getServletConfigForRole(String role)
                                               throws DeploymentException

Retrieve the ServletContext associated with a specific role.

Throws:

DeploymentException

processSOAPMessage

public abstract void processSOAPMessage(SOAPMessage soapMessage,
                                        String servletName)
                                 throws DeploymentException

Method used by servlets to notify about SOAP messages received over the network.

Throws:

DeploymentException