|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface ResourceRefType<T>
This interface defines the contract for the resource-refType xsd type
Original Documentation:
[
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:
| Method Summary | |
|---|---|
java.util.List<java.lang.String> |
getDescriptionList()
Returns all description elements |
java.util.List<InjectionTargetType<ResourceRefType<T>>> |
getInjectionTargetList()
Returns all injection-target elements |
java.lang.String |
getLookupName()
Returns the lookup-name element |
java.lang.String |
getMappedName()
Returns the mapped-name element |
ResAuthType |
getResAuth()
Returns the res-auth element |
java.lang.String |
getResAuthAsString()
Returns the res-auth element |
java.lang.String |
getResRefName()
Returns the res-ref-name element |
ResSharingScopeType |
getResSharingScope()
Returns the res-sharing-scope element |
java.lang.String |
getResSharingScopeAsString()
Returns the res-sharing-scope element |
java.lang.String |
getResType()
Returns the res-type element |
InjectionTargetType<ResourceRefType<T>> |
injectionTarget()
Returns the injection-target element |
ResourceRefType<T> |
removeAllDescription()
Removes the description element |
ResourceRefType<T> |
removeAllInjectionTarget()
Removes all injection-target elements |
ResourceRefType<T> |
removeLookupName()
Removes the lookup-name element |
ResourceRefType<T> |
removeMappedName()
Removes the mapped-name element |
ResourceRefType<T> |
removeResRefName()
Removes the res-ref-name element |
ResourceRefType<T> |
removeResType()
Removes the res-type element |
ResourceRefType<T> |
setDescription(java.lang.String description)
Creates a new description element |
ResourceRefType<T> |
setDescriptionList(java.lang.String... values)
Creates for all String objects representing description elements,
a new description element |
ResourceRefType<T> |
setLookupName(java.lang.String lookupName)
If not already created, a new lookup-name element with the given value will be created. |
ResourceRefType<T> |
setMappedName(java.lang.String mappedName)
If not already created, a new mapped-name element with the given value will be created. |
ResourceRefType<T> |
setResAuth(ResAuthType resAuth)
If not already created, a new res-auth element with the given value will be created. |
ResourceRefType<T> |
setResAuth(java.lang.String resAuth)
If not already created, a new res-auth element with the given value will be created. |
ResourceRefType<T> |
setResRefName(java.lang.String resRefName)
If not already created, a new res-ref-name element with the given value will be created. |
ResourceRefType<T> |
setResSharingScope(ResSharingScopeType resSharingScope)
If not already created, a new res-sharing-scope element with the given value will be created. |
ResourceRefType<T> |
setResSharingScope(java.lang.String resSharingScope)
If not already created, a new res-sharing-scope element with the given value will be created. |
ResourceRefType<T> |
setResType(java.lang.String resType)
If not already created, a new res-type element with the given value will be created. |
| Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child |
|---|
up |
| Method Detail |
|---|
ResourceRefType<T> setLookupName(java.lang.String lookupName)
lookup-name element with the given value will be created.
Otherwise, the existing lookup-name element will be updated with the given value.
ResourceRefTypeResourceRefType<T> removeLookupName()
lookup-name element
ResourceRefTypejava.lang.String getLookupName()
lookup-name element
lookup-nameResourceRefType<T> setMappedName(java.lang.String mappedName)
mapped-name element with the given value will be created.
Otherwise, the existing mapped-name element will be updated with the given value.
ResourceRefTypeResourceRefType<T> removeMappedName()
mapped-name element
ResourceRefTypejava.lang.String getMappedName()
mapped-name element
mapped-nameResourceRefType<T> removeAllInjectionTarget()
injection-target elements
ResourceRefTypeInjectionTargetType<ResourceRefType<T>> injectionTarget()
injection-target element
injection-targetjava.util.List<InjectionTargetType<ResourceRefType<T>>> getInjectionTargetList()
injection-target elements
injection-targetResourceRefType<T> setDescription(java.lang.String description)
description element
ResourceRefTypeResourceRefType<T> setDescriptionList(java.lang.String... values)
description elements,
a new description element
list - of description objects
ResourceRefTypeResourceRefType<T> removeAllDescription()
description element
ResourceRefTypejava.util.List<java.lang.String> getDescriptionList()
description elements
descriptionResourceRefType<T> setResRefName(java.lang.String resRefName)
res-ref-name element with the given value will be created.
Otherwise, the existing res-ref-name element will be updated with the given value.
ResourceRefTypeResourceRefType<T> removeResRefName()
res-ref-name element
ResourceRefTypejava.lang.String getResRefName()
res-ref-name element
res-ref-nameResourceRefType<T> setResType(java.lang.String resType)
res-type element with the given value will be created.
Otherwise, the existing res-type element will be updated with the given value.
ResourceRefTypeResourceRefType<T> removeResType()
res-type element
ResourceRefTypejava.lang.String getResType()
res-type element
res-typeResourceRefType<T> setResAuth(ResAuthType resAuth)
res-auth element with the given value will be created.
Otherwise, the existing res-auth element will be updated with the given value.
ResourceRefTypeResourceRefType<T> setResAuth(java.lang.String resAuth)
res-auth element with the given value will be created.
Otherwise, the existing res-auth element will be updated with the given value.
ResourceRefTypeResAuthType getResAuth()
res-auth element
res-authjava.lang.String getResAuthAsString()
res-auth element
res-authResourceRefType<T> setResSharingScope(ResSharingScopeType resSharingScope)
res-sharing-scope element with the given value will be created.
Otherwise, the existing res-sharing-scope element will be updated with the given value.
ResourceRefTypeResourceRefType<T> setResSharingScope(java.lang.String resSharingScope)
res-sharing-scope element with the given value will be created.
Otherwise, the existing res-sharing-scope element will be updated with the given value.
ResourceRefTypeResSharingScopeType getResSharingScope()
res-sharing-scope element
res-sharing-scopejava.lang.String getResSharingScopeAsString()
res-sharing-scope element
res-sharing-scope
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||