org.apache.axis2.jaxws.description.xml.handler
Class ResourceRefType

java.lang.Object
  org.apache.axis2.jaxws.description.xml.handler.ResourceRefType

public class ResourceRefType
extends java.lang.Object

The resource-refType contains a declaration of a Deployment Component's reference to an external resource. It consists of an optional description, the resource manager connection factory reference name, an optional indication of the resource manager connection factory type expected by the Deployment Component code, an optional type of authentication (Application or Container), and an optional specification of the shareability of connections obtained from the resource (Shareable or Unshareable).

It also includes optional elements to define injection of the named resource into fields or JavaBeans properties.

The connection factory type must be supplied unless an injection target is specified, in which case the type of the target is used. If both are specified, the type must be assignment compatible with the type of the injection target.

Example:

jdbc/EmployeeAppDB javax.sql.DataSource Container Shareable

Java class for resource-refType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="resource-refType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="description" type="{http://java.sun.com/xml/ns/javaee}descriptionType"
 maxOccurs="unbounded" minOccurs="0"/>
         <element name="res-ref-name" type="{http://java.sun.com/xml/ns/javaee}jndi-nameType"/>
         <element name="res-type" type="{http://java.sun.com/xml/ns/javaee}fully-qualified-classType"
 minOccurs="0"/>
         <element name="res-auth" type="{http://java.sun.com/xml/ns/javaee}res-authType"
 minOccurs="0"/>
         <element name="res-sharing-scope" type="{http://java.sun.com/xml/ns/javaee}res-sharing-scopeType"
 minOccurs="0"/>
         <group ref="{http://java.sun.com/xml/ns/javaee}resourceGroup"/>
       </sequence>
       <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}ID" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

protected java.util.List<DescriptionType>	description
protected java.lang.String	id
protected java.util.List<InjectionTargetType>	injectionTarget
protected XsdStringType	mappedName
protected ResAuthType	resAuth
protected JndiNameType	resRefName
protected ResSharingScopeType	resSharingScope
protected FullyQualifiedClassType	resType

Constructor Summary

ResourceRefType()

Method Summary

java.util.List<DescriptionType>	getDescription() Gets the value of the description property.
java.lang.String	getId() Gets the value of the id property.
java.util.List<InjectionTargetType>	getInjectionTarget() Gets the value of the injectionTarget property.
XsdStringType	getMappedName() Gets the value of the mappedName property.
ResAuthType	getResAuth() Gets the value of the resAuth property.
JndiNameType	getResRefName() Gets the value of the resRefName property.
ResSharingScopeType	getResSharingScope() Gets the value of the resSharingScope property.
FullyQualifiedClassType	getResType() Gets the value of the resType property.
void	setId(java.lang.String value) Sets the value of the id property.
void	setMappedName(XsdStringType value) Sets the value of the mappedName property.
void	setResAuth(ResAuthType value) Sets the value of the resAuth property.
void	setResRefName(JndiNameType value) Sets the value of the resRefName property.
void	setResSharingScope(ResSharingScopeType value) Sets the value of the resSharingScope property.
void	setResType(FullyQualifiedClassType value) Sets the value of the resType property.

Methods inherited from class java.lang.Object

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

Field Detail

description

protected java.util.List<DescriptionType> description

resRefName

protected JndiNameType resRefName

resType

protected FullyQualifiedClassType resType

resAuth

protected ResAuthType resAuth

resSharingScope

protected ResSharingScopeType resSharingScope

mappedName

protected XsdStringType mappedName

injectionTarget

protected java.util.List<InjectionTargetType> injectionTarget

id

protected java.lang.String id

Constructor Detail

ResourceRefType

public ResourceRefType()

Method Detail

getDescription

public java.util.List<DescriptionType> getDescription()

Gets the value of the description property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the description property.

For example, to add a new item, do as follows:

    getDescription().add(newItem);
 

Objects of the following type(s) are allowed in the list DescriptionType

getResRefName

public JndiNameType getResRefName()

Gets the value of the resRefName property.

Returns:

possible object is JndiNameType

setResRefName

public void setResRefName(JndiNameType value)

Sets the value of the resRefName property.

Parameters:

value - allowed object is JndiNameType

getResType

public FullyQualifiedClassType getResType()

Gets the value of the resType property.

Returns:

possible object is FullyQualifiedClassType

setResType

public void setResType(FullyQualifiedClassType value)

Sets the value of the resType property.

Parameters:

value - allowed object is FullyQualifiedClassType

getResAuth

public ResAuthType getResAuth()

Gets the value of the resAuth property.

Returns:

possible object is ResAuthType

setResAuth

public void setResAuth(ResAuthType value)

Sets the value of the resAuth property.

Parameters:

value - allowed object is ResAuthType

getResSharingScope

public ResSharingScopeType getResSharingScope()

Gets the value of the resSharingScope property.

Returns:

possible object is ResSharingScopeType

setResSharingScope

public void setResSharingScope(ResSharingScopeType value)

Sets the value of the resSharingScope property.

Parameters:

value - allowed object is ResSharingScopeType

getMappedName

public XsdStringType getMappedName()

Gets the value of the mappedName property.

Returns:

possible object is XsdStringType

setMappedName

public void setMappedName(XsdStringType value)

Sets the value of the mappedName property.

Parameters:

value - allowed object is XsdStringType

getInjectionTarget

public java.util.List<InjectionTargetType> getInjectionTarget()

Gets the value of the injectionTarget property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the injectionTarget property.

For example, to add a new item, do as follows:

    getInjectionTarget().add(newItem);
 

Objects of the following type(s) are allowed in the list InjectionTargetType

getId

public java.lang.String getId()

Gets the value of the id property.

Returns:

possible object is String

setId

public void setId(java.lang.String value)

Sets the value of the id property.

Parameters:

value - allowed object is String