Package org.apache.catalina.deploy
Class NamingResourcesImpl
- java.lang.Object
-
- org.apache.catalina.util.LifecycleBase
-
- org.apache.catalina.util.LifecycleMBeanBase
-
- org.apache.catalina.deploy.NamingResourcesImpl
-
- All Implemented Interfaces:
java.io.Serializable,javax.management.MBeanRegistration,JmxEnabled,Lifecycle,NamingResources
public class NamingResourcesImpl extends LifecycleMBeanBase implements java.io.Serializable, NamingResources
Holds and manages the naming resources defined in the Jakarta EE Naming Context and their associated JNDI context.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.apache.catalina.Lifecycle
Lifecycle.SingleUse
-
-
Field Summary
Fields Modifier and Type Field Description protected java.beans.PropertyChangeSupportsupportThe property change support for this component.-
Fields inherited from interface org.apache.catalina.Lifecycle
AFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT
-
-
Constructor Summary
Constructors Constructor Description NamingResourcesImpl()Create a new NamingResources instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddEjb(ContextEjb ejb)Add an EJB resource reference for this web application.voidaddEnvironment(ContextEnvironment environment)Add an environment entry for this web application.voidaddLocalEjb(ContextLocalEjb ejb)Add a local EJB resource reference for this web application.voidaddMessageDestinationRef(MessageDestinationRef mdr)Add a message destination reference for this web application.voidaddPropertyChangeListener(java.beans.PropertyChangeListener listener)Add a property change listener to this component.voidaddResource(ContextResource resource)Add a resource reference for this web application.voidaddResourceEnvRef(ContextResourceEnvRef resource)Add a resource environment reference for this web application.voidaddResourceLink(ContextResourceLink resourceLink)Add a resource link for this web application.voidaddService(ContextService service)Add a web service reference for this web application.protected voiddestroyInternal()Subclasses implement this method to perform any instance destruction required.ContextEjbfindEjb(java.lang.String name)Return the EJB resource reference with the specified name.ContextEjb[]findEjbs()Return the defined EJB resource references for this application.ContextEnvironmentfindEnvironment(java.lang.String name)Return the environment entry with the specified name.ContextEnvironment[]findEnvironments()Return the array of defined environment entries for this web application.ContextLocalEjbfindLocalEjb(java.lang.String name)Return the local EJB resource reference with the specified name.ContextLocalEjb[]findLocalEjbs()Return the defined local EJB resource references for this application.MessageDestinationReffindMessageDestinationRef(java.lang.String name)Return the message destination reference with the specified name.MessageDestinationRef[]findMessageDestinationRefs()Return the defined message destination references for this application.ContextResourcefindResource(java.lang.String name)Return the resource reference with the specified name.ContextResourceEnvReffindResourceEnvRef(java.lang.String name)Return the resource environment reference type for the specified name.ContextResourceEnvRef[]findResourceEnvRefs()Return the array of resource environment reference names for this web application.ContextResourceLinkfindResourceLink(java.lang.String name)Return the resource link with the specified name.ContextResourceLink[]findResourceLinks()Return the defined resource links for this application.ContextResource[]findResources()Return the defined resource references for this application.ContextServicefindService(java.lang.String name)Return the web service reference for the specified name.ContextService[]findServices()Return the defined web service references for this application.java.lang.ObjectgetContainer()Returns the container with which the naming resources are associated.protected java.lang.StringgetDomainInternal()Method implemented by subclasses to identify the domain in which MBeans should be registered.protected java.lang.StringgetObjectNameKeyProperties()Allow subclasses to specify the key properties component of theObjectNamethat will be used to register this component.ContextTransactiongetTransaction()Return the transaction object.protected voidinitInternal()Subclasses implement this method to perform any instance initialisation required.voidremoveEjb(java.lang.String name)Remove any EJB resource reference with the specified name.voidremoveEnvironment(java.lang.String name)Remove any environment entry with the specified name.voidremoveLocalEjb(java.lang.String name)Remove any local EJB resource reference with the specified name.voidremoveMessageDestinationRef(java.lang.String name)Remove any message destination reference with the specified name.voidremovePropertyChangeListener(java.beans.PropertyChangeListener listener)Remove a property change listener from this component.voidremoveResource(java.lang.String name)Remove any resource reference with the specified name.voidremoveResourceEnvRef(java.lang.String name)Remove any resource environment reference with the specified name.voidremoveResourceLink(java.lang.String name)Remove any resource link with the specified name.voidremoveService(java.lang.String name)Remove any web service reference with the specified name.voidsetContainer(java.lang.Object container)Set the container with which the naming resources are associated.voidsetTransaction(ContextTransaction transaction)Set the transaction object.protected voidstartInternal()Subclasses must ensure that the state is changed toLifecycleState.STARTINGduring the execution of this method.protected voidstopInternal()Subclasses must ensure that the state is changed toLifecycleState.STOPPINGduring the execution of this method.-
Methods inherited from class org.apache.catalina.util.LifecycleMBeanBase
getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister, unregister
-
Methods inherited from class org.apache.catalina.util.LifecycleBase
addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, removeLifecycleListener, setState, setState, setThrowOnFailure, start, stop
-
-
-
-
Method Detail
-
getContainer
public java.lang.Object getContainer()
Description copied from interface:NamingResourcesReturns the container with which the naming resources are associated.- Specified by:
getContainerin interfaceNamingResources- Returns:
- the container with which the naming resources are associated
-
setContainer
public void setContainer(java.lang.Object container)
Set the container with which the naming resources are associated.- Parameters:
container- the associated with the resources
-
setTransaction
public void setTransaction(ContextTransaction transaction)
Set the transaction object.- Parameters:
transaction- the transaction descriptor
-
getTransaction
public ContextTransaction getTransaction()
Return the transaction object.- Returns:
- the transaction object
-
addEjb
public void addEjb(ContextEjb ejb)
Add an EJB resource reference for this web application.- Parameters:
ejb- New EJB resource reference
-
addEnvironment
public void addEnvironment(ContextEnvironment environment)
Description copied from interface:NamingResourcesAdd an environment entry for this web application.- Specified by:
addEnvironmentin interfaceNamingResources- Parameters:
environment- New environment entry
-
addLocalEjb
public void addLocalEjb(ContextLocalEjb ejb)
Add a local EJB resource reference for this web application.- Parameters:
ejb- New EJB resource reference
-
addMessageDestinationRef
public void addMessageDestinationRef(MessageDestinationRef mdr)
Add a message destination reference for this web application.- Parameters:
mdr- New message destination reference
-
addPropertyChangeListener
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Add a property change listener to this component.- Parameters:
listener- The listener to add
-
addResource
public void addResource(ContextResource resource)
Description copied from interface:NamingResourcesAdd a resource reference for this web application.- Specified by:
addResourcein interfaceNamingResources- Parameters:
resource- New resource reference
-
addResourceEnvRef
public void addResourceEnvRef(ContextResourceEnvRef resource)
Add a resource environment reference for this web application.- Parameters:
resource- The resource
-
addResourceLink
public void addResourceLink(ContextResourceLink resourceLink)
Description copied from interface:NamingResourcesAdd a resource link for this web application.- Specified by:
addResourceLinkin interfaceNamingResources- Parameters:
resourceLink- New resource link
-
addService
public void addService(ContextService service)
Add a web service reference for this web application.- Parameters:
service- New web service reference
-
findEjb
public ContextEjb findEjb(java.lang.String name)
Return the EJB resource reference with the specified name.- Parameters:
name- Name of the desired EJB resource reference- Returns:
- the EJB resource reference, or
nullif not found
-
findEjbs
public ContextEjb[] findEjbs()
Return the defined EJB resource references for this application.- Returns:
- the EJB resource references, or a zero-length array if none
-
findEnvironment
public ContextEnvironment findEnvironment(java.lang.String name)
Return the environment entry with the specified name.- Parameters:
name- Name of the desired environment entry- Returns:
- the environment entry, or
nullif not found
-
findEnvironments
public ContextEnvironment[] findEnvironments()
Return the array of defined environment entries for this web application.- Returns:
- the environment entries, or a zero-length array if none
-
findLocalEjb
public ContextLocalEjb findLocalEjb(java.lang.String name)
Return the local EJB resource reference with the specified name.- Parameters:
name- Name of the desired EJB resource reference- Returns:
- the local EJB resource reference, or
nullif not found
-
findLocalEjbs
public ContextLocalEjb[] findLocalEjbs()
Return the defined local EJB resource references for this application.- Returns:
- the local EJB resource references, or a zero-length array if none
-
findMessageDestinationRef
public MessageDestinationRef findMessageDestinationRef(java.lang.String name)
Return the message destination reference with the specified name.- Parameters:
name- Name of the desired message destination reference- Returns:
- the message destination reference, or
nullif not found
-
findMessageDestinationRefs
public MessageDestinationRef[] findMessageDestinationRefs()
Return the defined message destination references for this application.- Returns:
- the message destination references, or a zero-length array if none
-
findResource
public ContextResource findResource(java.lang.String name)
Return the resource reference with the specified name.- Parameters:
name- Name of the desired resource reference- Returns:
- the resource reference, or
nullif not found
-
findResourceLink
public ContextResourceLink findResourceLink(java.lang.String name)
Return the resource link with the specified name.- Parameters:
name- Name of the desired resource link- Returns:
- the resource link, or
nullif not found
-
findResourceLinks
public ContextResourceLink[] findResourceLinks()
Return the defined resource links for this application.- Returns:
- the resource links, or a zero-length array if none
-
findResources
public ContextResource[] findResources()
Return the defined resource references for this application.- Returns:
- the resource references, or a zero-length array if none
-
findResourceEnvRef
public ContextResourceEnvRef findResourceEnvRef(java.lang.String name)
Return the resource environment reference type for the specified name.- Parameters:
name- Name of the desired resource environment reference- Returns:
- the resource environment reference, or
nullif not found
-
findResourceEnvRefs
public ContextResourceEnvRef[] findResourceEnvRefs()
Return the array of resource environment reference names for this web application.- Returns:
- the resource environment references, or a zero-length array if none
-
findService
public ContextService findService(java.lang.String name)
Return the web service reference for the specified name.- Parameters:
name- Name of the desired web service- Returns:
- the web service reference, or
nullif not found
-
findServices
public ContextService[] findServices()
Return the defined web service references for this application.- Returns:
- the web service references, or a zero-length array if none
-
removeEjb
public void removeEjb(java.lang.String name)
Remove any EJB resource reference with the specified name.- Parameters:
name- Name of the EJB resource reference to remove
-
removeEnvironment
public void removeEnvironment(java.lang.String name)
Description copied from interface:NamingResourcesRemove any environment entry with the specified name.- Specified by:
removeEnvironmentin interfaceNamingResources- Parameters:
name- Name of the environment entry to remove
-
removeLocalEjb
public void removeLocalEjb(java.lang.String name)
Remove any local EJB resource reference with the specified name.- Parameters:
name- Name of the EJB resource reference to remove
-
removeMessageDestinationRef
public void removeMessageDestinationRef(java.lang.String name)
Remove any message destination reference with the specified name.- Parameters:
name- Name of the message destination resource reference to remove
-
removePropertyChangeListener
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Remove a property change listener from this component.- Parameters:
listener- The listener to remove
-
removeResource
public void removeResource(java.lang.String name)
Description copied from interface:NamingResourcesRemove any resource reference with the specified name.- Specified by:
removeResourcein interfaceNamingResources- Parameters:
name- Name of the resource reference to remove
-
removeResourceEnvRef
public void removeResourceEnvRef(java.lang.String name)
Remove any resource environment reference with the specified name.- Parameters:
name- Name of the resource environment reference to remove
-
removeResourceLink
public void removeResourceLink(java.lang.String name)
Description copied from interface:NamingResourcesRemove any resource link with the specified name.- Specified by:
removeResourceLinkin interfaceNamingResources- Parameters:
name- Name of the resource link to remove
-
removeService
public void removeService(java.lang.String name)
Remove any web service reference with the specified name.- Parameters:
name- Name of the web service reference to remove
-
initInternal
protected void initInternal() throws LifecycleExceptionDescription copied from class:LifecycleBaseSubclasses implement this method to perform any instance initialisation required.- Overrides:
initInternalin classLifecycleMBeanBase- Throws:
LifecycleException- If the initialisation fails
-
startInternal
protected void startInternal() throws LifecycleExceptionDescription copied from class:LifecycleBaseSubclasses must ensure that the state is changed toLifecycleState.STARTINGduring the execution of this method. Changing state will trigger theLifecycle.START_EVENTevent. If a component fails to start it may either throw aLifecycleExceptionwhich will cause it's parent to fail to start, or it can place itself in the error state in which caseLifecycleBase.stop()will be called on the failed component but the parent component will continue to start normally.- Specified by:
startInternalin classLifecycleBase- Throws:
LifecycleException- Start error occurred
-
stopInternal
protected void stopInternal() throws LifecycleExceptionDescription copied from class:LifecycleBaseSubclasses must ensure that the state is changed toLifecycleState.STOPPINGduring the execution of this method. Changing state will trigger theLifecycle.STOP_EVENTevent.- Specified by:
stopInternalin classLifecycleBase- Throws:
LifecycleException- Stop error occurred
-
destroyInternal
protected void destroyInternal() throws LifecycleExceptionDescription copied from class:LifecycleBaseSubclasses implement this method to perform any instance destruction required.- Overrides:
destroyInternalin classLifecycleMBeanBase- Throws:
LifecycleException- If the destruction fails
-
getDomainInternal
protected java.lang.String getDomainInternal()
Description copied from class:LifecycleMBeanBaseMethod implemented by subclasses to identify the domain in which MBeans should be registered.- Specified by:
getDomainInternalin classLifecycleMBeanBase- Returns:
- The name of the domain to use to register MBeans.
-
getObjectNameKeyProperties
protected java.lang.String getObjectNameKeyProperties()
Description copied from class:LifecycleMBeanBaseAllow subclasses to specify the key properties component of theObjectNamethat will be used to register this component.- Specified by:
getObjectNameKeyPropertiesin classLifecycleMBeanBase- Returns:
- The string representation of the key properties component of the desired
ObjectName
-
-