org.jboss.net.axis.server
Class AxisService

java.lang.Object
  extended byorg.jboss.mx.util.JBossNotificationBroadcasterSupport (src) 
      extended byorg.jboss.system.ServiceMBeanSupport (src) 
          extended byorg.jboss.deployment.SubDeployerSupport (src) 
              extended byorg.jboss.net.axis.server.AxisService
All Implemented Interfaces:
MBeanRegistration (src) , NotificationBroadcaster (src) , NotificationEmitter (src) , Service (src) , ServiceMBean (src) , SubDeployer (src)

public class AxisService
extends SubDeployerSupport (src)
implements MBeanRegistration (src)

A deployer service that installs Axis and manages Web-Services within the Jboss JMX environment. It is the base for all plain axis deployments, web service archive support and also (via an additional layer) WS4EE functionality.

Since:
27. September 2001

Nested Class Summary
 
Nested classes inherited from class org.jboss.deployment.SubDeployerSupport (src)
SubDeployerSupport.ClassConfiguration (src)
 
Field Summary
protected  AxisServer (src) axisServer
          the engine belonging to this service
protected  XMLResourceProvider (src) clientConfiguration
          the client configuration belonging to this service
protected  javax.xml.parsers.DocumentBuilder documentBuilder
          document builder
protected  javax.naming.InitialContext initialContext
          the initial context into which we bind external web-service proxies
protected  XMLResourceProvider (src) serverConfiguration
          the server configuration belonging to this service
protected  boolean validateDTDs
          whether we are validating
 
Fields inherited from class org.jboss.deployment.SubDeployerSupport (src)
CONFIGURATION, mainDeployer, nativePrefix, nativeSuffix, relativeOrder, suffixes, tempDeployDir
 
Fields inherited from class org.jboss.system.ServiceMBeanSupport (src)
log, server, SERVICE_CONTROLLER_SIG, serviceName
 
Fields inherited from interface org.jboss.deployment.SubDeployer (src)
CREATE_NOTIFICATION, DESTROY_NOTIFICATION, INIT_NOTIFICATION, RELATIVE_ORDER_100, RELATIVE_ORDER_200, RELATIVE_ORDER_300, RELATIVE_ORDER_400, RELATIVE_ORDER_500, RELATIVE_ORDER_600, RELATIVE_ORDER_700, RELATIVE_ORDER_800, RELATIVE_ORDER_900, START_NOTIFICATION, STOP_NOTIFICATION
 
Fields inherited from interface org.jboss.system.ServiceMBean (src)
CREATE_EVENT, CREATED, DESTROY_EVENT, DESTROYED, FAILED, REGISTERED, START_EVENT, STARTED, STARTING, states, STOP_EVENT, STOPPED, STOPPING, UNREGISTERED
 
Constructor Summary
AxisService()
          default
 
Method Summary
 boolean accepts(DeploymentInfo (src)  sdi)
          The accepts method is called by MainDeployer to determine which deployer is suitable for a DeploymentInfo.
protected  void copyChildren(org.w3c.dom.Document sourceDoc, org.w3c.dom.Element source, java.lang.String match, org.w3c.dom.Element target)
          this tiny helper copies all children of the given element that are elements and match the given name to the other element
 void create(DeploymentInfo (src)  sdi)
          Sub-classes should override this method to provide custom 'create' logic.
protected  void deployExternalWebService(org.w3c.dom.Element deployElement)
          deploy an external web service reference
 void destroy(DeploymentInfo (src)  sdi)
          Sub-classes should override this method to provide custom 'destroy' logic.
 AxisServer (src) getAxisServer()
          return the associated server
 EngineConfiguration (src) getClientEngineConfiguration()
          return the associated client configuration
 EngineConfiguration (src) getServerEngineConfiguration()
          return the associated server configuration
 void init(DeploymentInfo (src)  sdi)
          Sub-classes should override this method to provide custom 'init' logic.
 void start(DeploymentInfo (src)  sdi)
          Sub-classes should override this method to provide custom 'start' logic.
 void start(java.lang.String deploymentName, org.w3c.dom.Document doc, java.lang.ClassLoader serviceLoader)
          start method for usage with immediately known documents
protected  void startAxisDeployment(java.lang.String deploymentName, org.w3c.dom.Element root, java.lang.ClassLoader deploymentLoader)
          starts a single axis deployment
protected  void startService()
          start service means - initialise axis engine - register Axis servlet in WebContainer - contact the maindeployer
 void stop(DeploymentInfo (src)  sdi)
          Sub-classes should override this method to provide custom 'stop' logic.
 void stop(org.w3c.dom.Document doc)
          stop a given deployment by document
protected  void stopAxisDeployment(org.w3c.dom.Element root)
          stops a single axis deployment
protected  void stopService()
          what to do to stop axis temporarily --> undeploy the servlet
protected  void undeployExternalWebService(org.w3c.dom.Element deployElement)
          undeploys an external web service reference
 
Methods inherited from class org.jboss.deployment.SubDeployerSupport (src)
addDeployableFiles, addDeployableJar, createService, deployUrl, destroyService, emitNotification, getRelativeOrder, getSuffixes, isDeployable, processNestedDeployments, setRelativeOrder, setSuffixes
 
Methods inherited from class org.jboss.system.ServiceMBeanSupport (src)
create, destroy, getLog, getName, getNextNotificationSequenceNumber, getObjectName, getServer, getServiceName, getState, getStateString, jbossInternalCreate, jbossInternalDescription, jbossInternalDestroy, jbossInternalLifecycle, jbossInternalStart, jbossInternalStop, postDeregister, postRegister, preDeregister, preRegister, start, stop
 
Methods inherited from class org.jboss.mx.util.JBossNotificationBroadcasterSupport (src)
addNotificationListener, getNotificationInfo, handleNotification, removeNotificationListener, removeNotificationListener, sendNotification
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.management.MBeanRegistration (src)
postDeregister, postRegister, preDeregister, preRegister
 
Methods inherited from interface org.jboss.deployment.SubDeployer (src)
getServiceName
 

Field Detail

axisServer

protected AxisServer (src)  axisServer
the engine belonging to this service


clientConfiguration

protected XMLResourceProvider (src)  clientConfiguration
the client configuration belonging to this service


serverConfiguration

protected XMLResourceProvider (src)  serverConfiguration
the server configuration belonging to this service


initialContext

protected javax.naming.InitialContext initialContext
the initial context into which we bind external web-service proxies


documentBuilder

protected javax.xml.parsers.DocumentBuilder documentBuilder
document builder


validateDTDs

protected boolean validateDTDs
whether we are validating

Constructor Detail

AxisService

public AxisService()
default

Method Detail

copyChildren

protected void copyChildren(org.w3c.dom.Document sourceDoc,
                            org.w3c.dom.Element source,
                            java.lang.String match,
                            org.w3c.dom.Element target)
this tiny helper copies all children of the given element that are elements and match the given name to the other element


startAxisDeployment

protected void startAxisDeployment(java.lang.String deploymentName,
                                   org.w3c.dom.Element root,
                                   java.lang.ClassLoader deploymentLoader)
                            throws DeploymentException (src) 
starts a single axis deployment

Throws:
DeploymentException (src)

stopAxisDeployment

protected void stopAxisDeployment(org.w3c.dom.Element root)
                           throws DeploymentException (src) 
stops a single axis deployment

Throws:
DeploymentException (src)

deployExternalWebService

protected void deployExternalWebService(org.w3c.dom.Element deployElement)
                                 throws DeploymentException (src) 
deploy an external web service reference

Throws:
DeploymentException (src)

undeployExternalWebService

protected void undeployExternalWebService(org.w3c.dom.Element deployElement)
undeploys an external web service reference


startService

protected void startService()
                     throws java.lang.Exception
start service means - initialise axis engine - register Axis servlet in WebContainer - contact the maindeployer

Overrides:
startService in class SubDeployerSupport (src)
Throws:
java.lang.Exception

stopService

protected void stopService()
                    throws java.lang.Exception
what to do to stop axis temporarily --> undeploy the servlet

Overrides:
stopService in class SubDeployerSupport (src)
Throws:
java.lang.Exception

accepts

public boolean accepts(DeploymentInfo (src)  sdi)
Description copied from interface: SubDeployer (src)
The accepts method is called by MainDeployer to determine which deployer is suitable for a DeploymentInfo.

Specified by:
accepts in interface SubDeployer (src)
Parameters:
sdi - a DeploymentInfo value
Returns:
a boolean value

init

public void init(DeploymentInfo (src)  sdi)
          throws DeploymentException (src) 
Description copied from class: SubDeployerSupport (src)
Sub-classes should override this method to provide custom 'init' logic.

This method calls the processNestedDeployments(di) method and then issues a JMX notification of type SubDeployer.INIT_NOTIFICATION. This behaviour can overridden by concrete sub-classes. If further initialization needs to be done, and you wish to preserve the functionality, be sure to call super.init(di) at the end of your implementation.

Specified by:
init in interface SubDeployer (src)
Overrides:
init in class SubDeployerSupport (src)
Throws:
DeploymentException (src)

create

public void create(DeploymentInfo (src)  sdi)
            throws DeploymentException (src) 
Description copied from class: SubDeployerSupport (src)
Sub-classes should override this method to provide custom 'create' logic. This method issues a JMX notification of type SubDeployer.CREATE_NOTIFICATION.

Specified by:
create in interface SubDeployer (src)
Overrides:
create in class SubDeployerSupport (src)
Throws:
DeploymentException (src)

start

public void start(DeploymentInfo (src)  sdi)
           throws DeploymentException (src) 
Description copied from class: SubDeployerSupport (src)
Sub-classes should override this method to provide custom 'start' logic. This method issues a JMX notification of type SubDeployer.START_NOTIFICATION.

Specified by:
start in interface SubDeployer (src)
Overrides:
start in class SubDeployerSupport (src)
Throws:
DeploymentException (src)

start

public void start(java.lang.String deploymentName,
                  org.w3c.dom.Document doc,
                  java.lang.ClassLoader serviceLoader)
           throws DeploymentException (src) 
start method for usage with immediately known documents

Throws:
DeploymentException (src)

stop

public void stop(DeploymentInfo (src)  sdi)
          throws DeploymentException (src) 
Description copied from class: SubDeployerSupport (src)
Sub-classes should override this method to provide custom 'stop' logic. This method issues a JMX notification of type SubDeployer.START_NOTIFICATION.

Specified by:
stop in interface SubDeployer (src)
Overrides:
stop in class SubDeployerSupport (src)
Throws:
DeploymentException (src)

stop

public void stop(org.w3c.dom.Document doc)
          throws DeploymentException (src) 
stop a given deployment by document

Throws:
DeploymentException (src)

destroy

public void destroy(DeploymentInfo (src)  sdi)
             throws DeploymentException (src) 
Description copied from class: SubDeployerSupport (src)
Sub-classes should override this method to provide custom 'destroy' logic. This method issues a JMX notification of type SubDeployer.DESTROY_NOTIFICATION.

Specified by:
destroy in interface SubDeployer (src)
Overrides:
destroy in class SubDeployerSupport (src)
Throws:
DeploymentException (src)

getClientEngineConfiguration

public EngineConfiguration (src)  getClientEngineConfiguration()
return the associated client configuration


getServerEngineConfiguration

public EngineConfiguration (src)  getServerEngineConfiguration()
return the associated server configuration


getAxisServer

public AxisServer (src)  getAxisServer()
return the associated server