org.eclipse.jst.j2ee.jca
Interface ConfigProperty
- All Superinterfaces:
- org.eclipse.emf.ecore.EObject, J2EEEObject, org.eclipse.emf.common.notify.Notifier
public interface ConfigProperty
- extends J2EEEObject
The config property contains a declaration of a single
configuration property for a ManagedConnectionFactory instance.
Each ManagedConnectionFactory instance creates connections to a specific EIS instance based on the properties configured on the ManagedConnectionFactory instance. The configurable properties are specified only once in the deployment descriptor, even though a resource adapter can be used to configure multiple ManagedConnnection-Factory instances (that create connections to different instances of the same EIS).
The declaration consists of an optional description, name, type
and an optional value of the configuration property. If the resource
adapter provider does not specify a value than the deployer is
responsible for providing a valid value for a configuration property.
Any bounds or well-defined values of properties should be described in the description.
- 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
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
Contains the name of a configuration property.
The connector architecture defines a set of well-defined properties all of type
java.lang.String. These are as follows:
ServerName
PortNumber
UserName
Password
ConnectionURL
A resource adapter provider can extend this property set to include properties
specific to the resource adapter and its underlying EIS.
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
Contains the fully qualified Java type of a configuration property as required
by ManagedConnection-Factory instance.
The following are the legal values of config-property-type:
java.lang.Boolean, java.lang.String, java.lang.Integer,
java.lang.Double, java.lang.Byte, java.lang.Short,
java.lang.Long, java.lang.Float, java.lang.Character
setType
void setType(java.lang.String value)
- Parameters:
value
- The new value of the Type attribute
getValue
java.lang.String getValue()
- Returns:
- The value of the Value attribute
Contains the value of a configuration entry.
setValue
void setValue(java.lang.String value)
- Parameters:
value
- The new value of the Value attribute
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:
JcaPackage.getConfigProperty_Descriptions()