ResourceRef (OpenEJB :: Container

java.lang.Object
- org.apache.openejb.jee.was.v6.common.ResourceRef

public class ResourceRef
extends 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, the indication of the resource manager connection factory type expected by the Deployment Component code, the type of authentication (Application or Container), and an optional specification of the shareability of connections obtained from the resource (Shareable or Unshareable).

Example:

 <?xml version="1.0" encoding="UTF-8"?><resource-ref xmlns:com.ibm.etools.j2ee.common="common.xmi" xmlns:com.ibm.etools.webservice.wsclient="webservice_client.xmi" xmlns:jaxb="http://java.sun.com/xml/ns/jaxb" xmlns:org.eclipse.jem.java="java.xmi" xmlns:xmi="http://www.omg.org/XMI" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><res-ref-name>jdbc/EmployeeAppDB</res-ref-name><res-type>javax.sql.DataSource</res-type><res-auth>Container</res-auth><res-sharing-scope>Shareable</res-sharing-scope>

                                </resource-ref>

Java class for ResourceRef complex type.

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

 <complexType name="ResourceRef">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <choice>
         <choice maxOccurs="unbounded" minOccurs="0">
           <element name="descriptions" type="{common.xmi}Description"/>
         </choice>
         <choice maxOccurs="unbounded" minOccurs="0">
           <element ref="{http://www.omg.org/XMI}Extension"/>
         </choice>
       </choice>
       <attGroup ref="{http://www.omg.org/XMI}ObjectAttribs"/>
       <attribute name="auth" type="{common.xmi}ResAuthTypeBase" />
       <attribute name="description" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="link" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="name" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="resSharingScope" type="{common.xmi}ResSharingScopeType" />
       <attribute name="type" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute ref="{http://www.omg.org/XMI}id"/>
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected ResAuthEnum`	`auth`
`protected String`	`description`
`protected List<Description>`	`descriptions`
`protected List<Extension>`	`extensions`
`protected String`	`href`
`protected String`	`id`
`protected Object`	`idref`
`protected String`	`label`
`protected String`	`link`
`protected String`	`name`
`protected String`	`resourceRefTypeString`
`protected ResSharingScopeEnum`	`resSharingScope`
`protected QName`	`type`
`protected String`	`uuid`
`protected String`	`version`

Constructor Summary

Constructors
Constructor and Description

ResourceRef()

Constructors
Constructor and Description
`ResourceRef()`

Method Summary

Methods
Modifier and Type	Method and Description
`ResAuthEnum`	`getAuth()` Gets the value of the auth property.
`String`	`getDescription()` Gets the value of the description property.
`List<Description>`	`getDescriptions()` Gets the value of the descriptions property.
`List<Extension>`	`getExtensions()` Gets the value of the extensions property.
`String`	`getHref()` Gets the value of the href property.
`String`	`getId()` Gets the value of the id property.
`Object`	`getIdref()` Gets the value of the idref property.
`String`	`getLabel()` Gets the value of the label property.
`String`	`getLink()` Gets the value of the link property.
`String`	`getName()` Gets the value of the name property.
`String`	`getResourceRefTypeString()` Gets the value of the resourceRefTypeString property.
`ResSharingScopeEnum`	`getResSharingScope()` Gets the value of the resSharingScope property.
`QName`	`getType()` Gets the value of the type property.
`String`	`getUuid()` Gets the value of the uuid property.
`String`	`getVersion()` Gets the value of the version property.
`void`	`setAuth(ResAuthEnum value)` Sets the value of the auth property.
`void`	`setDescription(String value)` Sets the value of the description property.
`void`	`setHref(String value)` Sets the value of the href property.
`void`	`setId(String value)` Sets the value of the id property.
`void`	`setIdref(Object value)` Sets the value of the idref property.
`void`	`setLabel(String value)` Sets the value of the label property.
`void`	`setLink(String value)` Sets the value of the link property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setResourceRefTypeString(String value)` Sets the value of the resourceRefTypeString property.
`void`	`setResSharingScope(ResSharingScopeEnum value)` Sets the value of the resSharingScope property.
`void`	`setType(QName value)` Sets the value of the type property.
`void`	`setUuid(String value)` Sets the value of the uuid property.
`void`	`setVersion(String value)` Sets the value of the version property.

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

- Field Detail
  - descriptions
```
protected List<Description> descriptions
```
  - extensions
```
protected List<Extension> extensions
```
  - auth
```
protected ResAuthEnum auth
```
  - description
```
protected String description
```
  - link
```
protected String link
```
  - name
```
protected String name
```
  - resSharingScope
```
protected ResSharingScopeEnum resSharingScope
```
  - resourceRefTypeString
```
protected String resourceRefTypeString
```
  - id
```
protected String id
```
  - type
```
protected QName type
```
  - version
```
protected String version
```
  - href
```
protected String href
```
  - idref
```
protected Object idref
```
  - label
```
protected String label
```
  - uuid
```
protected String uuid
```
- Constructor Detail
  - ResourceRef
```
public ResourceRef()
```
- Method Detail
  - getDescriptions
```
public List<Description> getDescriptions()
```
    Gets the value of the descriptions 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 descriptions property.
    
    For example, to add a new item, do as follows:
```
 getDescriptions().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Description
  - getExtensions
```
public List<Extension> getExtensions()
```
    Gets the value of the extensions 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 extensions property.
    
    For example, to add a new item, do as follows:
```
 getExtensions().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Extension
  - getAuth
```
public ResAuthEnum getAuth()
```
    Gets the value of the auth property.
    
    Returns:
    possible object is ResAuthEnum
  - setAuth
```
public void setAuth(ResAuthEnum value)
```
    Sets the value of the auth property.
    
    Parameters:
    value - allowed object is ResAuthEnum
  - getDescription
```
public String getDescription()
```
    Gets the value of the description property.
    
    Returns:
    possible object is String
  - setDescription
```
public void setDescription(String value)
```
    Sets the value of the description property.
    
    Parameters:
    value - allowed object is String
  - getLink
```
public String getLink()
```
    Gets the value of the link property.
    
    Returns:
    possible object is String
  - setLink
```
public void setLink(String value)
```
    Sets the value of the link property.
    
    Parameters:
    value - allowed object is String
  - getName
```
public String getName()
```
    Gets the value of the name property.
    
    Returns:
    possible object is String
  - setName
```
public void setName(String value)
```
    Sets the value of the name property.
    
    Parameters:
    value - allowed object is String
  - getResSharingScope
```
public ResSharingScopeEnum getResSharingScope()
```
    Gets the value of the resSharingScope property.
    
    Returns:
    possible object is ResSharingScopeEnum
  - setResSharingScope
```
public void setResSharingScope(ResSharingScopeEnum value)
```
    Sets the value of the resSharingScope property.
    
    Parameters:
    value - allowed object is ResSharingScopeEnum
  - getResourceRefTypeString
```
public String getResourceRefTypeString()
```
    Gets the value of the resourceRefTypeString property.
    
    Returns:
    possible object is String
  - setResourceRefTypeString
```
public void setResourceRefTypeString(String value)
```
    Sets the value of the resourceRefTypeString property.
    
    Parameters:
    value - allowed object is String
  - getId
```
public String getId()
```
    Gets the value of the id property.
    
    Returns:
    possible object is String
  - setId
```
public void setId(String value)
```
    Sets the value of the id property.
    
    Parameters:
    value - allowed object is String
  - getType
```
public QName getType()
```
    Gets the value of the type property.
    
    Returns:
    possible object is QName
  - setType
```
public void setType(QName value)
```
    Sets the value of the type property.
    
    Parameters:
    value - allowed object is QName
  - getVersion
```
public String getVersion()
```
    Gets the value of the version property.
    
    Returns:
    possible object is String
  - setVersion
```
public void setVersion(String value)
```
    Sets the value of the version property.
    
    Parameters:
    value - allowed object is String
  - getHref
```
public String getHref()
```
    Gets the value of the href property.
    
    Returns:
    possible object is String
  - setHref
```
public void setHref(String value)
```
    Sets the value of the href property.
    
    Parameters:
    value - allowed object is String
  - getIdref
```
public Object getIdref()
```
    Gets the value of the idref property.
    
    Returns:
    possible object is Object
  - setIdref
```
public void setIdref(Object value)
```
    Sets the value of the idref property.
    
    Parameters:
    value - allowed object is Object
  - getLabel
```
public String getLabel()
```
    Gets the value of the label property.
    
    Returns:
    possible object is String
  - setLabel
```
public void setLabel(String value)
```
    Sets the value of the label property.
    
    Parameters:
    value - allowed object is String
  - getUuid
```
public String getUuid()
```
    Gets the value of the uuid property.
    
    Returns:
    possible object is String
  - setUuid
```
public void setUuid(String value)
```
    Sets the value of the uuid property.
    
    Parameters:
    value - allowed object is String

Class ResourceRef

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

descriptions

extensions

auth

description

link

name

resSharingScope

resourceRefTypeString

id

type

version

href

idref

label

uuid

Constructor Detail

ResourceRef

Method Detail

getDescriptions

getExtensions

getAuth

setAuth

getDescription

setDescription

getLink

setLink

getName

setName

getResSharingScope

setResSharingScope

getResourceRefTypeString

setResourceRefTypeString

getId

setId

getType

setType

getVersion

setVersion

getHref

setHref

getIdref

setIdref

getLabel

setLabel

getUuid

setUuid