Package org.apache.tomcat.util.descriptor.web

Class ResourceBase

java.lang.Object

org.apache.tomcat.util.descriptor.web.ResourceBase

All Implemented Interfaces:

java.io.Serializable, Injectable

Direct Known Subclasses:

ContextEjb, ContextEnvironment, ContextHandler, ContextLocalEjb, ContextResource, ContextResourceEnvRef, ContextResourceLink, ContextService, MessageDestination, MessageDestinationRef

public class ResourceBase
extends java.lang.Object
implements java.io.Serializable, Injectable

Representation of a Context element.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ResourceBase()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	addInjectionTarget(java.lang.String injectionTargetName, java.lang.String jndiName)	Adds an injection target to this injectable.
boolean	equals(java.lang.Object obj)
java.lang.String	getDescription()	Return the description of this resource.
java.util.List<InjectionTarget>	getInjectionTargets()	Returns the list of injection targets.
java.lang.String	getLookupName()	Return the JNDI lookup name for this resource.
java.lang.String	getName()	Returns the name of this injectable.
NamingResources	getNamingResources()	Return the NamingResources with which this resource is associated.
java.lang.Object	getProperty(java.lang.String name)	Returns the value of the specified property.
java.lang.String	getType()	Return the name of the resource implementation class.
int	hashCode()
java.util.Iterator<java.lang.String>	listProperties()	List properties.
void	removeProperty(java.lang.String name)	Remove a configured property.
void	setDescription(java.lang.String description)	Set the description of this resource.
void	setLookupName(java.lang.String lookupName)	Set the JNDI lookup name for this resource.
void	setName(java.lang.String name)	Set the name of this resource.
void	setNamingResources(NamingResources resources)	Set the NamingResources with which this resource is associated.
void	setProperty(java.lang.String name, java.lang.Object value)	Set a configured property.
void	setType(java.lang.String type)	Set the name of the resource implementation class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResourceBase

public ResourceBase()

Default constructor.

Method Detail

getDescription

public java.lang.String getDescription()

Return the description of this resource.

Returns:

The description of this resource

setDescription

public void setDescription(java.lang.String description)

Set the description of this resource.

Parameters:

description - The description of this resource

getName

public java.lang.String getName()

Description copied from interface: Injectable

Returns the name of this injectable.

Specified by:

getName in interface Injectable

Returns:

the name

setName

public void setName(java.lang.String name)

Set the name of this resource.

Parameters:

name - The name of this resource

getType

public java.lang.String getType()

Return the name of the resource implementation class.

Returns:

The name of the resource implementation class

setType

public void setType(java.lang.String type)

Set the name of the resource implementation class.

Parameters:

type - The name of the resource implementation class

getLookupName

public java.lang.String getLookupName()

Return the JNDI lookup name for this resource.

Returns:

The JNDI lookup name

setLookupName

public void setLookupName(java.lang.String lookupName)

Set the JNDI lookup name for this resource.

Parameters:

lookupName - The JNDI lookup name

getProperty

public java.lang.Object getProperty(java.lang.String name)

Returns the value of the specified property.

Parameters:

name - The property name

Returns:

the configured property value

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)

Set a configured property.

Parameters:

name - The property name

value - The property value

removeProperty

public void removeProperty(java.lang.String name)

Remove a configured property.

Parameters:

name - The property name

listProperties

public java.util.Iterator<java.lang.String> listProperties()

List properties.

Returns:

the property names iterator

addInjectionTarget

public void addInjectionTarget(java.lang.String injectionTargetName,
                               java.lang.String jndiName)

Description copied from interface: Injectable

Adds an injection target to this injectable.

Specified by:

addInjectionTarget in interface Injectable

Parameters:

injectionTargetName - the name of the injection target

jndiName - the JNDI name for the injection

getInjectionTargets

public java.util.List<InjectionTarget> getInjectionTargets()

Description copied from interface: Injectable

Returns the list of injection targets.

Specified by:

getInjectionTargets in interface Injectable

Returns:

the list of injection targets

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getNamingResources

public NamingResources getNamingResources()

Return the NamingResources with which this resource is associated.

Returns:

The NamingResources with which this resource is associated

setNamingResources

public void setNamingResources(NamingResources resources)

Set the NamingResources with which this resource is associated.

Parameters:

resources - The NamingResources with which this resource is associated