jrun.j2ee
Class J2EEModuleFactory

jrunx.kernel.ServiceAdapter
  |
  +--jrun.j2ee.J2EEModuleFactory

All Implemented Interfaces:

J2EEModuleFactoryMBean, javax.naming.Referenceable, java.io.Serializable, Service, ServiceMBean

Direct Known Subclasses:

ApplicationContainerFactory, EJBContainerFactory, EnterpriseApplicationFactory, J2EEConnectorFactory, ServiceFactory, WebApplicationFactory

public abstract class J2EEModuleFactory

extends ServiceAdapter

implements J2EEModuleFactoryMBean

Parent class for all J2EE Module factories.

Author:

Paul Reilly

See Also:

Serialized Form

Field Summary

protected static java.lang.String

DEFAULT_JMX_DOMAIN

Fields inherited from class jrunx.kernel.ServiceAdapter

DEFAULT_DEACTIVATED, DEFAULT_DOMAIN, DOMAIN_NAME_SEPARATOR, DOMAIN_NAME_SUFFIX, domainName, jndiBindable, LOGGER_CACHE_TIME, SCHEDULER_SERVICE, SECURITY_MANAGER, server, status, TRANSACTION_MANAGER

Fields inherited from interface jrunx.kernel.Service

INITIALIZED, STARTED, STARTING, STOPPED, STOPPING, UNINITIALIZED

Constructor Summary

J2EEModuleFactory()

Method Summary

void	addMandatoryFingerPrint(java.lang.String fingerPrint)
void	addOptionalFingerPrint(java.lang.String fingerPrint)
void	addPotentialFingerPrint(java.lang.String fingerPrint)
protected void	cacheResource(java.net.URL url, java.net.URL resourceURL)
protected void	cacheResources(java.net.URL url, java.util.Collection resourceURLs)
void	clearResources(java.net.URL url)
abstract java.util.Collection	create(java.net.URL url, java.lang.String deploymentOrigin, java.lang.String moduleName) This method is used by the DeployerService.
protected XMLReader	createXMLReader()
java.util.Iterator	getMandatoryFingerPrintList()
abstract java.lang.String	getObjectName()
java.util.Iterator	getOptionalFingerPrintList()
java.util.Iterator	getPotentialFingerPrintList()
protected java.net.URL	getResource(java.net.URL url, java.lang.ClassLoader descriptorLoader, java.lang.String resource)
java.net.URL	getResource(java.net.URL url, java.lang.String resource) Subclasses should implement this method to provide additional logic for finding resources.
java.util.Collection	getResources(java.net.URL url)
java.lang.String	getTemporaryDirectory()
boolean	isPersistXML() If true and the module factory supports XML persistence, the module factory will try to persist the deployment descriptors.
boolean	isValidateXML() If true, the module factory will tell the XML reader to report XML parse warning and errors.
boolean	matchesFingerPrints(java.net.URL url, java.net.URL originURL)
protected void	register(java.lang.Object mbean, java.lang.String jmxDomain, java.lang.String name)
void	setMandatoryFingerPrint(java.lang.String fingerPrint) This is used by JMX which requires JavaBean style getters and setters.
void	setOptionalFingerPrint(java.lang.String fingerPrint) This is used by JMX which requires JavaBean style getters and setters.
void	setPersistXML(boolean persistXML) If the module factory supports XML persistence, tells the module factory to attempt to persist the deployment descriptors.
void	setPotentialFingerPrint(java.lang.String fingerPrint) This is used by JMX which requires JavaBean style getters and setters.
void	setTemporaryDirectory(java.lang.String temporaryDirectory)
void	setValidateXML(boolean validateXML) Tells the module factory to report XML parse warning and errors.

Methods inherited from class jrunx.kernel.ServiceAdapter

bind, destroy, findObjectInstance, findObjectInstance, findObjectInstance, getBindToJNDI, getDeactivated, getDomainName, getDomainSearchPath, getJRunService, getLogger, getName, getParentService, getReference, getResourceManager, getServerName, getServerProperties, getStatus, init, invokeMethod, isInPartition, isPartition, lookup, postDeregister, postRegister, preDeregister, preRegister, requestServer, scheduleRunnable, setBindToJNDI, setDeactivated, setDomainName, setName, setParentService, start, stop, toString, unbind, unscheduleRunnable, updateStatus

Methods inherited from interface jrunx.kernel.ServiceMBean

bind, getBindToJNDI, getDeactivated, getDomainName, getJRunService, getLogger, getName, getParentService, getServerName, requestServer, setBindToJNDI, setDeactivated, setDomainName, setName, setParentService, unbind

Methods inherited from interface jrunx.kernel.Service

destroy, getStatus, init, start, stop, updateStatus

Field Detail

DEFAULT_JMX_DOMAIN

protected static final java.lang.String DEFAULT_JMX_DOMAIN

Constructor Detail

J2EEModuleFactory

public J2EEModuleFactory()

Method Detail

addMandatoryFingerPrint

public void addMandatoryFingerPrint(java.lang.String fingerPrint)

Specified by:

addMandatoryFingerPrint in interface J2EEModuleFactoryMBean

addOptionalFingerPrint

public void addOptionalFingerPrint(java.lang.String fingerPrint)

addPotentialFingerPrint

public void addPotentialFingerPrint(java.lang.String fingerPrint)

Specified by:

addPotentialFingerPrint in interface J2EEModuleFactoryMBean

cacheResource

protected void cacheResource(java.net.URL url,
                             java.net.URL resourceURL)

cacheResources

protected void cacheResources(java.net.URL url,
                              java.util.Collection resourceURLs)

clearResources

public void clearResources(java.net.URL url)

Specified by:

clearResources in interface J2EEModuleFactoryMBean

create

public abstract java.util.Collection create(java.net.URL url,
                                            java.lang.String deploymentOrigin,
                                            java.lang.String moduleName)
                                     throws DeploymentException

Description copied from interface: J2EEModuleFactoryMBean

This method is used by the DeployerService.

Specified by:

create in interface J2EEModuleFactoryMBean

createXMLReader

protected XMLReader createXMLReader()

getMandatoryFingerPrintList

public java.util.Iterator getMandatoryFingerPrintList()

Specified by:

getMandatoryFingerPrintList in interface J2EEModuleFactoryMBean

getObjectName

public abstract java.lang.String getObjectName()

getOptionalFingerPrintList

public java.util.Iterator getOptionalFingerPrintList()

getPotentialFingerPrintList

public java.util.Iterator getPotentialFingerPrintList()

Specified by:

getPotentialFingerPrintList in interface J2EEModuleFactoryMBean

getResource

public java.net.URL getResource(java.net.URL url,
                                java.lang.String resource)

Subclasses should implement this method to provide additional logic for finding resources. For example looking in the parent directory of the URL.

Specified by:

getResource in interface J2EEModuleFactoryMBean

getResource

protected java.net.URL getResource(java.net.URL url,
                                   java.lang.ClassLoader descriptorLoader,
                                   java.lang.String resource)

getResources

public java.util.Collection getResources(java.net.URL url)

Specified by:

getResources in interface J2EEModuleFactoryMBean

getTemporaryDirectory

public java.lang.String getTemporaryDirectory()

Specified by:

getTemporaryDirectory in interface J2EEModuleFactoryMBean

isPersistXML

public boolean isPersistXML()

Description copied from interface: J2EEModuleFactoryMBean

If true and the module factory supports XML persistence, the module factory will try to persist the deployment descriptors.

Specified by:

isPersistXML in interface J2EEModuleFactoryMBean

isValidateXML

public boolean isValidateXML()

Description copied from interface: J2EEModuleFactoryMBean

If true, the module factory will tell the XML reader to report XML parse warning and errors.

Specified by:

isValidateXML in interface J2EEModuleFactoryMBean

matchesFingerPrints

public boolean matchesFingerPrints(java.net.URL url,
                                   java.net.URL originURL)

register

protected void register(java.lang.Object mbean,
                        java.lang.String jmxDomain,
                        java.lang.String name)
                 throws DeploymentException

setMandatoryFingerPrint

public void setMandatoryFingerPrint(java.lang.String fingerPrint)

This is used by JMX which requires JavaBean style getters and setters.

Specified by:

setMandatoryFingerPrint in interface J2EEModuleFactoryMBean

setPersistXML

public void setPersistXML(boolean persistXML)

Description copied from interface: J2EEModuleFactoryMBean

If the module factory supports XML persistence, tells the module factory to attempt to persist the deployment descriptors.

Specified by:

setPersistXML in interface J2EEModuleFactoryMBean

setValidateXML

public void setValidateXML(boolean validateXML)

Description copied from interface: J2EEModuleFactoryMBean

Tells the module factory to report XML parse warning and errors.

Specified by:

setValidateXML in interface J2EEModuleFactoryMBean

setOptionalFingerPrint

public void setOptionalFingerPrint(java.lang.String fingerPrint)

This is used by JMX which requires JavaBean style getters and setters.

setPotentialFingerPrint

public void setPotentialFingerPrint(java.lang.String fingerPrint)

This is used by JMX which requires JavaBean style getters and setters.

Specified by:

setPotentialFingerPrint in interface J2EEModuleFactoryMBean

setTemporaryDirectory

public void setTemporaryDirectory(java.lang.String temporaryDirectory)
                           throws java.io.IOException

Specified by:

setTemporaryDirectory in interface J2EEModuleFactoryMBean