org.jboss.ejb
Class EJBDeployer

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.ejb.EJBDeployer
All Implemented Interfaces:
MBeanRegistration (src) , NotificationBroadcaster (src) , NotificationEmitter (src) , Service (src) , ServiceMBean (src) , SubDeployer (src)
Direct Known Subclasses:
EMBDeployer (src)

public class EJBDeployer
extends SubDeployerSupport (src)

A EJBDeployer is used to deploy EJB applications. It can be given a URL to an EJB-jar or EJB-JAR XML file, which will be used to instantiate containers and make them available for invocation.

See Also:
Container (src)

Nested Class Summary
 
Nested classes inherited from class org.jboss.deployment.SubDeployerSupport (src)
SubDeployerSupport.ClassConfiguration (src)
 
Field Summary
 
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
EJBDeployer()
           
 
Method Summary
 boolean accepts(DeploymentInfo (src)  di)
          The accepts method is called by MainDeployer to determine which deployer is suitable for a DeploymentInfo.
 void create(DeploymentInfo (src)  di)
          Sub-classes should override this method to provide custom 'create' logic.
 void destroy(DeploymentInfo (src)  di)
          Sub-classes should override this method to provide custom 'destroy' logic.
 boolean getStrictVerifier()
          Returns the mode of the bean verifier (strict/non-strict mode)
 ObjectName (src) getTransactionManagerServiceName()
          Get the TransactionManagerServiceName value.
 boolean getValidateDTDs()
          Get the flag indicating that ejb-jar.dtd, jboss.dtd & jboss-web.dtd conforming documents should be validated against the DTD.
 boolean getVerifierVerbose()
          Returns the state of the bean verifier (verbose/non-verbose mode)
 boolean getVerifyDeployments()
          Returns the state of bean verifier (on/off)
 ObjectName (src) getWebServiceName()
          Get the WebServiceName value.
 void init(DeploymentInfo (src)  di)
          Sub-classes should override this method to provide custom 'init' logic.
 boolean isCallByValue()
           
 boolean isMetricsEnabled()
          Checks if this container factory initializes the metrics interceptor.
 java.util.Iterator listDeployedApplications()
          Returns the deployed applications.
protected  void processNestedDeployments(DeploymentInfo (src)  di)
          This is here as a reminder that we may not want to allow ejb jars to have arbitrary sub deployments.
 void setCallByValue(boolean callByValue)
           
 void setMetricsEnabled(boolean enable)
          Enables/disables the metrics interceptor for containers.
 void setStrictVerifier(boolean strictVerifier)
          Enables/disables the strict mode on the verifier.
 void setTransactionManagerServiceName(ObjectName (src)  transactionManagerServiceName)
          Set the TransactionManagerServiceName value.
 void setValidateDTDs(boolean validate)
          Set the flag indicating that ejb-jar.dtd, jboss.dtd & jboss-web.dtd conforming documents should be validated against the DTD.
 void setVerifierVerbose(boolean verbose)
          Enables/disables the verbose mode on the verifier.
 void setVerifyDeployments(boolean verify)
          Enables/disables the application bean verification upon deployment.
 void setWebServiceName(ObjectName (src)  webServiceName)
          Set the WebServiceName value.
 void start(DeploymentInfo (src)  di)
          Sub-classes should override this method to provide custom 'start' logic.
protected  void startService()
          Get a reference to the ServiceController
 void stop(DeploymentInfo (src)  di)
          Sub-classes should override this method to provide custom 'stop' logic.
protected  void stopService()
          Implements the template method in superclass.
 
Methods inherited from class org.jboss.deployment.SubDeployerSupport (src)
addDeployableFiles, addDeployableJar, createService, deployUrl, destroyService, emitNotification, getRelativeOrder, getSuffixes, isDeployable, 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 org.jboss.deployment.SubDeployer (src)
getServiceName
 

Constructor Detail

EJBDeployer

public EJBDeployer()
Method Detail

isCallByValue

public boolean isCallByValue()
Returns:
whether ear deployments should be call by value

setCallByValue

public void setCallByValue(boolean callByValue)
Parameters:
callByValue - whether ear deployments should be call by value

listDeployedApplications

public java.util.Iterator listDeployedApplications()
Returns the deployed applications.


startService

protected void startService()
                     throws java.lang.Exception
Get a reference to the ServiceController

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

stopService

protected void stopService()
                    throws java.lang.Exception
Implements the template method in superclass. This method stops all the applications in this server.

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

setVerifyDeployments

public void setVerifyDeployments(boolean verify)
Enables/disables the application bean verification upon deployment.

Parameters:
verify - true to enable; false to disable

getVerifyDeployments

public boolean getVerifyDeployments()
Returns the state of bean verifier (on/off)

Returns:
true if enabled; false otherwise

setVerifierVerbose

public void setVerifierVerbose(boolean verbose)
Enables/disables the verbose mode on the verifier.

Parameters:
verbose - true to enable; false to disable

getVerifierVerbose

public boolean getVerifierVerbose()
Returns the state of the bean verifier (verbose/non-verbose mode)

Returns:
true if enabled; false otherwise

setStrictVerifier

public void setStrictVerifier(boolean strictVerifier)
Enables/disables the strict mode on the verifier.

Parameters:
strictVerifier - true to enable; false to disable

getStrictVerifier

public boolean getStrictVerifier()
Returns the mode of the bean verifier (strict/non-strict mode)

Returns:
true if the Verifier is in strict mode, false otherwise

setMetricsEnabled

public void setMetricsEnabled(boolean enable)
Enables/disables the metrics interceptor for containers.

Parameters:
enable - true to enable; false to disable

isMetricsEnabled

public boolean isMetricsEnabled()
Checks if this container factory initializes the metrics interceptor.

Returns:
true if metrics are enabled; false otherwise

getValidateDTDs

public boolean getValidateDTDs()
Get the flag indicating that ejb-jar.dtd, jboss.dtd & jboss-web.dtd conforming documents should be validated against the DTD.


setValidateDTDs

public void setValidateDTDs(boolean validate)
Set the flag indicating that ejb-jar.dtd, jboss.dtd & jboss-web.dtd conforming documents should be validated against the DTD.


getWebServiceName

public ObjectName (src)  getWebServiceName()
Get the WebServiceName value.

Returns:
the WebServiceName value.

setWebServiceName

public void setWebServiceName(ObjectName (src)  webServiceName)
Set the WebServiceName value.

Parameters:
webServiceName - The new WebServiceName value.

getTransactionManagerServiceName

public ObjectName (src)  getTransactionManagerServiceName()
Get the TransactionManagerServiceName value.

Returns:
the TransactionManagerServiceName value.

setTransactionManagerServiceName

public void setTransactionManagerServiceName(ObjectName (src)  transactionManagerServiceName)
Set the TransactionManagerServiceName value.

Parameters:
transactionManagerServiceName - The new TransactionManagerServiceName value.

accepts

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

Parameters:
di - a DeploymentInfo value
Returns:
a boolean value

init

public void init(DeploymentInfo (src)  di)
          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)

processNestedDeployments

protected void processNestedDeployments(DeploymentInfo (src)  di)
                                 throws DeploymentException (src) 
This is here as a reminder that we may not want to allow ejb jars to have arbitrary sub deployments. Currently we do.

Overrides:
processNestedDeployments in class SubDeployerSupport (src)
Parameters:
di -
Throws:
DeploymentException (src)

create

public void create(DeploymentInfo (src)  di)
            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)  di)
           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)

stop

public void stop(DeploymentInfo (src)  di)
          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)

destroy

public void destroy(DeploymentInfo (src)  di)
             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)