org.eclipse.jst.j2ee.common
Interface ResourceRef
- All Superinterfaces:
- org.eclipse.emf.ecore.EObject, J2EEEObject, org.eclipse.emf.common.notify.Notifier
public interface ResourceRef
- extends J2EEEObject
The resource-ref element contains a declaration of application clients's reference to an external resource. It consists of an optional description, the resource factory reference name, the indication of the resource factory type expected by the application client's code, and the type of authentication (bean or container).
Example:
EmployeeAppDB/res-ref-name>
javax.sql.DataSource/res-type>
Container/res-auth>
/resource-ref>
- Since:
- 1.0
Methods inherited from interface org.eclipse.emf.ecore.EObject |
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset |
Methods inherited from interface org.eclipse.emf.common.notify.Notifier |
eAdapters, eDeliver, eNotify, eSetDeliver |
getDescription
java.lang.String getDescription()
- Returns:
- The value of the Description attribute
The description element is used by the ejb-jar file producer to provide text
describing the parent element. The description element should include any
information that the ejb-jar file producer wants to provide to the consumer of
the ejb-jar file (i.e. to the Deployer). Typically, the tools used by the
ejb-jar file consumer will display the description when processing the parent
element.
setDescription
void setDescription(java.lang.String value)
- Parameters:
value
- The new value of the Description attribute
getName
java.lang.String getName()
- Returns:
- The value of the Name attribute
The res-ref-name element specifies the name of the resource factory reference
name. The resource factory reference name is the name of the application
client's environment entry whose value contains the JNDI name of the data
source.
setName
void setName(java.lang.String value)
- Parameters:
value
- The new value of the Name attribute
getType
java.lang.String getType()
- Returns:
- The value of the Type attribute
The res-type element specifies the type of the data source. The type is
specified by the Java interface (or class) expected to be implemented by the
data source.
setType
void setType(java.lang.String value)
- Parameters:
value
- The new value of the Type attribute
getAuth
ResAuthTypeBase getAuth()
- Returns:
- The value of the Auth attribute
The res-auth element specifies whether the enterprise bean code signs on
programmatically to the resource manager, or whether the Container will sign on
to the resource manager on behalf of the bean. In the latter case, the
Container uses information that is supplied by the Deployer. The value of this
element must be one of the two following:
Application/res-auth>
Container/res-auth>
setAuth
void setAuth(ResAuthTypeBase value)
- Sets the value of the '
Auth
' attribute.
- Parameters:
value
- the new value of the 'Auth' attribute.- See Also:
ResAuthTypeBase
,
isSetAuth()
,
unsetAuth()
,
getAuth()
unsetAuth
void unsetAuth()
- Unsets the value of the '
Auth
' attribute.
- See Also:
isSetAuth()
,
getAuth()
,
setAuth(ResAuthTypeBase)
isSetAuth
boolean isSetAuth()
- Returns whether the value of the '
Auth
' attribute is set.
- Returns:
- whether the value of the 'Auth' attribute is set.
- See Also:
unsetAuth()
,
getAuth()
,
setAuth(ResAuthTypeBase)
getLink
java.lang.String getLink()
- Returns:
- The value of the Link attribute
setLink
void setLink(java.lang.String value)
- Parameters:
value
- The new value of the Link attribute
getResSharingScope
ResSharingScopeType getResSharingScope()
- Returns:
- The value of the ResSharingScope attribute
The res-sharing-scope element specifies whether connections obtained
through the given resource manager connection factory reference can be
shared. The value of this element, if specified, must be one of the
two following: Shareable, Unshareable
The default value is Shareable.
setResSharingScope
void setResSharingScope(ResSharingScopeType value)
- Sets the value of the '
Res Sharing Scope
' attribute.
- Parameters:
value
- the new value of the 'Res Sharing Scope' attribute.- See Also:
ResSharingScopeType
,
isSetResSharingScope()
,
unsetResSharingScope()
,
getResSharingScope()
unsetResSharingScope
void unsetResSharingScope()
- Unsets the value of the '
Res Sharing Scope
' attribute.
- See Also:
isSetResSharingScope()
,
getResSharingScope()
,
setResSharingScope(ResSharingScopeType)
isSetResSharingScope
boolean isSetResSharingScope()
- Returns whether the value of the '
Res Sharing Scope
' attribute is set.
- Returns:
- whether the value of the 'Res Sharing Scope' attribute is set.
- See Also:
unsetResSharingScope()
,
getResSharingScope()
,
setResSharingScope(ResSharingScopeType)
getDescriptions
org.eclipse.emf.common.util.EList getDescriptions()
- Returns the value of the 'Descriptions' containment reference list.
The list contents are of type
Description
.
If the meaning of the 'Descriptions' containment reference list isn't clear,
there really should be more of a description here...
- Returns:
- the value of the 'Descriptions' containment reference list.
- See Also:
CommonPackage.getResourceRef_Descriptions()