NamingResources (Apache Tomcat 7.0.109 API Documentation)

java.lang.Object
- org.apache.catalina.util.LifecycleBase
- - org.apache.catalina.util.LifecycleMBeanBase
  - - org.apache.catalina.deploy.NamingResources

All Implemented Interfaces:

Serializable, MBeanRegistration, JmxEnabled, Lifecycle
```
public class NamingResources
extends LifecycleMBeanBase
implements Serializable
```
Holds and manages the naming resources defined in the J2EE Enterprise Naming Context and their associated JNDI context.

Author:

Remy Maucherat

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 and Description

protected PropertyChangeSupport support
The property change support for this component.
- Fields inherited from class org.apache.catalina.util.LifecycleMBeanBase
  mserver
- 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

Fields
Modifier and Type	Field and Description
`protected PropertyChangeSupport`	`support` The property change support for this component.

Constructor Summary

Constructors
Constructor and Description

NamingResources()
Create a new NamingResources instance.

Constructors
Constructor and Description
`NamingResources()` Create a new NamingResources instance.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addEjb(ContextEjb ejb)` Add an EJB resource reference for this web application.
`void`	`addEnvironment(ContextEnvironment environment)` Add an environment entry for this web application.
`void`	`addLocalEjb(ContextLocalEjb ejb)` Add a local EJB resource reference for this web application.
`void`	`addMessageDestinationRef(MessageDestinationRef mdr)` Add a message destination reference for this web application.
`void`	`addPropertyChangeListener(PropertyChangeListener listener)` Add a property change listener to this component.
`void`	`addResource(ContextResource resource)` Add a resource reference for this web application.
`void`	`addResourceEnvRef(ContextResourceEnvRef resource)` Add a resource environment reference for this web application.
`void`	`addResourceLink(ContextResourceLink resourceLink)` Add a resource link for this web application.
`void`	`addService(ContextService service)` Add a web service reference for this web application.
`protected void`	`destroyInternal()` Sub-classes wishing to perform additional clean-up should override this method, ensuring that super.destroyInternal() is the last call in the overriding method.
`boolean`	`exists(String name)` Deprecated.
`ContextEjb`	`findEjb(String name)` Return the EJB resource reference with the specified name, if any; otherwise, return `null`.
`ContextEjb[]`	`findEjbs()` Return the defined EJB resource references for this application.
`ContextEnvironment`	`findEnvironment(String name)` Return the environment entry with the specified name, if any; otherwise, return `null`.
`ContextEnvironment[]`	`findEnvironments()` Return the set of defined environment entries for this web application.
`ContextLocalEjb`	`findLocalEjb(String name)` Return the local EJB resource reference with the specified name, if any; otherwise, return `null`.
`ContextLocalEjb[]`	`findLocalEjbs()` Return the defined local EJB resource references for this application.
`MessageDestinationRef`	`findMessageDestinationRef(String name)` Return the message destination reference with the specified name, if any; otherwise, return `null`.
`MessageDestinationRef[]`	`findMessageDestinationRefs()` Return the defined message destination references for this application.
`ContextResource`	`findResource(String name)` Return the resource reference with the specified name, if any; otherwise return `null`.
`ContextResourceEnvRef`	`findResourceEnvRef(String name)` Return the resource environment reference type for the specified name, if any; otherwise return `null`.
`ContextResourceEnvRef[]`	`findResourceEnvRefs()` Return the set of resource environment reference names for this web application.
`ContextResourceLink`	`findResourceLink(String name)` Return the resource link with the specified name, if any; otherwise return `null`.
`ContextResourceLink[]`	`findResourceLinks()` Return the defined resource links for this application.
`ContextResource[]`	`findResources()` Return the defined resource references for this application.
`ContextService`	`findService(String name)` Return the web service reference for the specified name, if any; otherwise return `null`.
`ContextService[]`	`findServices()` Return the defined web service references for this application.
`Object`	`getContainer()` Get the container with which the naming resources are associated.
`protected String`	`getDomainInternal()` Method implemented by sub-classes to identify the domain in which MBeans should be registered.
`protected String`	`getObjectNameKeyProperties()` Allow sub-classes to specify the key properties component of the `ObjectName` that will be used to register this component.
`ContextTransaction`	`getTransaction()` Get the transaction object.
`protected void`	`initInternal()` Sub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method.
`void`	`removeEjb(String name)` Remove any EJB resource reference with the specified name.
`void`	`removeEnvironment(String name)` Remove any environment entry with the specified name.
`void`	`removeLocalEjb(String name)` Remove any local EJB resource reference with the specified name.
`void`	`removeMessageDestinationRef(String name)` Remove any message destination reference with the specified name.
`void`	`removePropertyChangeListener(PropertyChangeListener listener)` Remove a property change listener from this component.
`void`	`removeResource(String name)` Remove any resource reference with the specified name.
`void`	`removeResourceEnvRef(String name)` Remove any resource environment reference with the specified name.
`void`	`removeResourceLink(String name)` Remove any resource link with the specified name.
`void`	`removeService(String name)` Remove any web service reference with the specified name.
`void`	`setContainer(Object container)` Set the container with which the naming resources are associated.
`void`	`setTransaction(ContextTransaction transaction)` Set the transaction object.
`protected void`	`startInternal()` Sub-classes must ensure that the state is changed to `LifecycleState.STARTING` during the execution of this method.
`protected void`	`stopInternal()` Sub-classes must ensure that the state is changed to `LifecycleState.STOPPING` during the execution of this method.

Methods inherited from class org.apache.catalina.util.LifecycleMBeanBase
getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister

Methods inherited from class org.apache.catalina.util.LifecycleBase
addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, removeLifecycleListener, setState, setState, setThrowOnFailure, start, stop

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - support
```
protected PropertyChangeSupport support
```
    The property change support for this component.
- Constructor Detail
  - NamingResources
```
public NamingResources()
```
    Create a new NamingResources instance.
- Method Detail
  - getContainer
```
public Object getContainer()
```
    Get the container with which the naming resources are associated.
  - setContainer
```
public void setContainer(Object container)
```
    Set the container with which the naming resources are associated.
  - setTransaction
```
public void setTransaction(ContextTransaction transaction)
```
    Set the transaction object.
  - getTransaction
```
public ContextTransaction getTransaction()
```
    Get 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)
```
    Add an environment entry for this web application.
    
    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(PropertyChangeListener listener)
```
    Add a property change listener to this component.
    
    Parameters:
    listener - The listener to add
  - addResource
```
public void addResource(ContextResource resource)
```
    Add a resource reference for this web application.
    
    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)
```
    Add a resource link for this web application.
    
    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(String name)
```
    Return the EJB resource reference with the specified name, if any; otherwise, return null.
    
    Parameters:
    name - Name of the desired EJB resource reference
  - findEjbs
```
public ContextEjb[] findEjbs()
```
    Return the defined EJB resource references for this application. If there are none, a zero-length array is returned.
  - findEnvironment
```
public ContextEnvironment findEnvironment(String name)
```
    Return the environment entry with the specified name, if any; otherwise, return null.
    
    Parameters:
    name - Name of the desired environment entry
  - findEnvironments
```
public ContextEnvironment[] findEnvironments()
```
    Return the set of defined environment entries for this web application. If none have been defined, a zero-length array is returned.
  - findLocalEjb
```
public ContextLocalEjb findLocalEjb(String name)
```
    Return the local EJB resource reference with the specified name, if any; otherwise, return null.
    
    Parameters:
    name - Name of the desired EJB resource reference
  - findLocalEjbs
```
public ContextLocalEjb[] findLocalEjbs()
```
    Return the defined local EJB resource references for this application. If there are none, a zero-length array is returned.
  - findMessageDestinationRef
```
public MessageDestinationRef findMessageDestinationRef(String name)
```
    Return the message destination reference with the specified name, if any; otherwise, return null.
    
    Parameters:
    name - Name of the desired message destination reference
  - findMessageDestinationRefs
```
public MessageDestinationRef[] findMessageDestinationRefs()
```
    Return the defined message destination references for this application. If there are none, a zero-length array is returned.
  - findResource
```
public ContextResource findResource(String name)
```
    Return the resource reference with the specified name, if any; otherwise return null.
    
    Parameters:
    name - Name of the desired resource reference
  - findResourceLink
```
public ContextResourceLink findResourceLink(String name)
```
    Return the resource link with the specified name, if any; otherwise return null.
    
    Parameters:
    name - Name of the desired resource link
  - findResourceLinks
```
public ContextResourceLink[] findResourceLinks()
```
    Return the defined resource links for this application. If none have been defined, a zero-length array is returned.
  - findResources
```
public ContextResource[] findResources()
```
    Return the defined resource references for this application. If none have been defined, a zero-length array is returned.
  - findResourceEnvRef
```
public ContextResourceEnvRef findResourceEnvRef(String name)
```
    Return the resource environment reference type for the specified name, if any; otherwise return null.
    
    Parameters:
    name - Name of the desired resource environment reference
  - findResourceEnvRefs
```
public ContextResourceEnvRef[] findResourceEnvRefs()
```
    Return the set of resource environment reference names for this web application. If none have been specified, a zero-length array is returned.
  - findService
```
public ContextService findService(String name)
```
    Return the web service reference for the specified name, if any; otherwise return null.
    
    Parameters:
    name - Name of the desired web service
  - findServices
```
public ContextService[] findServices()
```
    Return the defined web service references for this application. If none have been defined, a zero-length array is returned.
  - exists
```
@Deprecated
public boolean exists(String name)
```
    Deprecated.
    
    Return true if the name specified already exists.
  - removeEjb
```
public void removeEjb(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(String name)
```
    Remove any environment entry with the specified name.
    
    Parameters:
    name - Name of the environment entry to remove
  - removeLocalEjb
```
public void removeLocalEjb(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(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(PropertyChangeListener listener)
```
    Remove a property change listener from this component.
    
    Parameters:
    listener - The listener to remove
  - removeResource
```
public void removeResource(String name)
```
    Remove any resource reference with the specified name.
    
    Parameters:
    name - Name of the resource reference to remove
  - removeResourceEnvRef
```
public void removeResourceEnvRef(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(String name)
```
    Remove any resource link with the specified name.
    
    Parameters:
    name - Name of the resource link to remove
  - removeService
```
public void removeService(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 LifecycleException
```
    Description copied from class: LifecycleMBeanBase
    
    Sub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method.
    
    Overrides:
    
    initInternal in class LifecycleMBeanBase
    
    Throws:
    
    LifecycleException - If the initialisation fails
  - startInternal
```
protected void startInternal()
                      throws LifecycleException
```
    Description copied from class: LifecycleBase
    
    Sub-classes must ensure that the state is changed to LifecycleState.STARTING during the execution of this method. Changing state will trigger the Lifecycle.START_EVENT event. If a component fails to start it may either throw a LifecycleException which will cause it's parent to fail to start or it can place itself in the error state in which case LifecycleBase.stop() will be called on the failed component but the parent component will continue to start normally.
    
    Specified by:
    
    startInternal in class LifecycleBase
    
    Throws:
    
    LifecycleException - Start error occurred
  - stopInternal
```
protected void stopInternal()
                     throws LifecycleException
```
    Description copied from class: LifecycleBase
    
    Sub-classes must ensure that the state is changed to LifecycleState.STOPPING during the execution of this method. Changing state will trigger the Lifecycle.STOP_EVENT event.
    
    Specified by:
    
    stopInternal in class LifecycleBase
    
    Throws:
    
    LifecycleException - Stop error occurred
  - destroyInternal
```
protected void destroyInternal()
                        throws LifecycleException
```
    Description copied from class: LifecycleMBeanBase
    
    Sub-classes wishing to perform additional clean-up should override this method, ensuring that super.destroyInternal() is the last call in the overriding method.
    
    Overrides:
    
    destroyInternal in class LifecycleMBeanBase
    
    Throws:
    
    LifecycleException - If the destruction fails
  - getDomainInternal
```
protected String getDomainInternal()
```
    Description copied from class: LifecycleMBeanBase
    
    Method implemented by sub-classes to identify the domain in which MBeans should be registered.
    
    Specified by:
    
    getDomainInternal in class LifecycleMBeanBase
    
    Returns:
    The name of the domain to use to register MBeans.
  - getObjectNameKeyProperties
```
protected String getObjectNameKeyProperties()
```
    Description copied from class: LifecycleMBeanBase
    
    Allow sub-classes to specify the key properties component of the ObjectName that will be used to register this component.
    
    Specified by:
    
    getObjectNameKeyProperties in class LifecycleMBeanBase
    
    Returns:
    The string representation of the key properties component of the desired ObjectName

Class NamingResources

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.catalina.Lifecycle

Field Summary

Fields inherited from class org.apache.catalina.util.LifecycleMBeanBase

Fields inherited from interface org.apache.catalina.Lifecycle

Constructor Summary

Method Summary

Methods inherited from class org.apache.catalina.util.LifecycleMBeanBase

Methods inherited from class org.apache.catalina.util.LifecycleBase

Methods inherited from class java.lang.Object

Field Detail

support

Constructor Detail

NamingResources

Method Detail

getContainer

setContainer

setTransaction

getTransaction

addEjb

addEnvironment

addLocalEjb

addMessageDestinationRef

addPropertyChangeListener

addResource

addResourceEnvRef

addResourceLink

addService

findEjb

findEjbs

findEnvironment

findEnvironments

findLocalEjb

findLocalEjbs

findMessageDestinationRef

findMessageDestinationRefs

findResource

findResourceLink

findResourceLinks

findResources

findResourceEnvRef

findResourceEnvRefs

findService

findServices

exists

removeEjb

removeEnvironment

removeLocalEjb

removeMessageDestinationRef

removePropertyChangeListener

removeResource

removeResourceEnvRef

removeResourceLink

removeService

initInternal

startInternal

stopInternal

destroyInternal

getDomainInternal

getObjectNameKeyProperties