ResourceRef

java.lang.Object
- org.apache.openejb.jee.ResourceRef

All Implemented Interfaces:: Injectable, JndiReference, Keyable<java.lang.String>

Direct Known Subclasses:: ContextRef

public class ResourceRef
extends java.lang.Object
implements JndiReference

javaee6.xsd

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

Fields
Modifier and Type	Field and Description
`protected TextMap`	`description`
`protected java.lang.String`	`id`
`protected java.util.Set<InjectionTarget>`	`injectionTarget`
`protected java.lang.String`	`lookupName`
`protected java.lang.String`	`mappedName`
`protected java.lang.String`	`origin`
`protected ResAuth`	`resAuth`
`protected java.lang.String`	`resRefName`
`protected ResSharingScope`	`resSharingScope`
`protected java.lang.String`	`resType`

Constructor Summary

Constructors
Constructor and Description
`ResourceRef()`
`ResourceRef(java.lang.String resRefName, java.lang.String resType)`
`ResourceRef(java.lang.String resRefName, java.lang.String resType, ResAuth resAuth, ResSharingScope resSharingScope)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ResourceRef`	`auth(ResAuth resAuth)`
`java.lang.String`	`getDescription()`
`Text[]`	`getDescriptions()`
`java.lang.String`	`getId()`
`java.util.Set<InjectionTarget>`	`getInjectionTarget()`
`java.lang.String`	`getKey()` Gets the immutable key for this object.
`java.lang.String`	`getLookupName()`
`java.lang.String`	`getMappedName()`
`java.lang.String`	`getName()`
`java.lang.String`	`getOrigin()`
`ResAuth`	`getResAuth()`
`java.lang.String`	`getResRefName()`
`ResSharingScope`	`getResSharingScope()`
`java.lang.String`	`getResType()`
`java.lang.String`	`getType()`
`ResourceRef`	`injectionTarget(java.lang.Class<?> clazz, java.lang.String property)`
`ResourceRef`	`injectionTarget(java.lang.String className, java.lang.String property)`
`ResourceRef`	`lookup(java.lang.String lookupName)`
`ResourceRef`	`mappedName(java.lang.String mappedName)`
`ResourceRef`	`name(java.lang.String resRefName)`
`void`	`setDescriptions(Text[] text)`
`void`	`setId(java.lang.String value)`
`void`	`setLookupName(java.lang.String lookupName)`
`void`	`setMappedName(java.lang.String value)`
`void`	`setName(java.lang.String name)`
`void`	`setOrigin(java.lang.String origin)`
`void`	`setResAuth(ResAuth value)`
`void`	`setResRefName(java.lang.String value)`
`void`	`setResSharingScope(ResSharingScope value)`
`void`	`setResType(java.lang.String value)`
`void`	`setType(java.lang.String type)`
`java.lang.String`	`toString()`
`ResourceRef`	`type(java.lang.String resType)`

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

Field Detail

description
```
protected TextMap description
```

resRefName
```
protected java.lang.String resRefName
```

resType
```
protected java.lang.String resType
```

resAuth
```
protected ResAuth resAuth
```

resSharingScope

protected ResSharingScope resSharingScope

mappedName
```
protected java.lang.String mappedName
```

lookupName
```
protected java.lang.String lookupName
```

injectionTarget

protected java.util.Set<InjectionTarget> injectionTarget

id
```
protected java.lang.String id
```

origin
```
protected java.lang.String origin
```

Constructor Detail

ResourceRef
```
public ResourceRef()
```

ResourceRef

public ResourceRef(java.lang.String resRefName,
                   java.lang.String resType)

ResourceRef

public ResourceRef(java.lang.String resRefName,
                   java.lang.String resType,
                   ResAuth resAuth,
                   ResSharingScope resSharingScope)

Method Detail

name

public ResourceRef name(java.lang.String resRefName)

type

public ResourceRef type(java.lang.String resType)

auth

public ResourceRef auth(ResAuth resAuth)

mappedName

public ResourceRef mappedName(java.lang.String mappedName)

lookup

public ResourceRef lookup(java.lang.String lookupName)

injectionTarget

public ResourceRef injectionTarget(java.lang.String className,
                                   java.lang.String property)

injectionTarget

public ResourceRef injectionTarget(java.lang.Class<?> clazz,
                                   java.lang.String property)

getName
```
public java.lang.String getName()
```
Specified by:

getName in interface JndiReference

getKey
```
public java.lang.String getKey()
```
Description copied from interface: Keyable

Gets the immutable key for this object.

Specified by:

getKey in interface Keyable<java.lang.String>

Returns:

gets the immutable key for this object

getType
```
public java.lang.String getType()
```
Specified by:

getType in interface JndiReference

setName
```
public void setName(java.lang.String name)
```
Specified by:

setName in interface JndiReference

setType
```
public void setType(java.lang.String type)
```
Specified by:

setType in interface JndiReference

getDescriptions
```
public Text[] getDescriptions()
```

setDescriptions

public void setDescriptions(Text[] text)

getDescription

public java.lang.String getDescription()

getResRefName

public java.lang.String getResRefName()

setResRefName

public void setResRefName(java.lang.String value)

getResType
```
public java.lang.String getResType()
```

setResType

public void setResType(java.lang.String value)

getResAuth
```
public ResAuth getResAuth()
```

setResAuth

public void setResAuth(ResAuth value)

getResSharingScope

public ResSharingScope getResSharingScope()

setResSharingScope

public void setResSharingScope(ResSharingScope value)

getMappedName
```
public java.lang.String getMappedName()
```
Specified by:

getMappedName in interface JndiReference

setMappedName
```
public void setMappedName(java.lang.String value)
```
Specified by:

setMappedName in interface JndiReference

getLookupName
```
public java.lang.String getLookupName()
```
Specified by:

getLookupName in interface JndiReference

setLookupName
```
public void setLookupName(java.lang.String lookupName)
```
Specified by:

setLookupName in interface JndiReference

getInjectionTarget
```
public java.util.Set<InjectionTarget> getInjectionTarget()
```
Specified by:

getInjectionTarget in interface Injectable

getId
```
public java.lang.String getId()
```

setId

public void setId(java.lang.String value)

getOrigin
```
public java.lang.String getOrigin()
```

setOrigin

public void setOrigin(java.lang.String origin)

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

Class ResourceRef

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

description

resRefName

resType

resAuth

resSharingScope

mappedName

lookupName

injectionTarget

id

origin

Constructor Detail

ResourceRef

ResourceRef

ResourceRef

Method Detail

name

type

auth

mappedName

lookup

injectionTarget

injectionTarget

getName

getKey

getType

setName

setType

getDescriptions

setDescriptions

getDescription

getResRefName

setResRefName

getResType

setResType

getResAuth

setResAuth

getResSharingScope

setResSharingScope

getMappedName

setMappedName

getLookupName

setLookupName

getInjectionTarget

getId

setId

getOrigin

setOrigin

toString