org.eclipse.jst.j2ee.jca
Interface ResourceAdapter

All Superinterfaces:
J2EEEObject

public interface ResourceAdapter
extends J2EEEObject

Specifies information about the resource adapter. The information includes fully-qualified names of class//interfaces required as part of the connector architecture specified contracts, level of transaction support provided, configurable properties for ManagedConnectionFactory instances, one or more authentication mechanisms supported and additional required security permissions. If there is no authentication-mechanism specified as part of resource adapter element then the resource adapter does not support any standard security authentication mechanisms as part of security contract. The application server ignores the security part of the system contracts in this case.

Since:
1.0

Method Summary
 EList getAdminObjects()
          Returns the value of the 'Admin Objects' containment reference list.
 EList getAuthenticationMechanisms()
           
 EList getConfigProperties()
           
 java.lang.String getConnectionFactoryImplClass()
           
 java.lang.String getConnectionFactoryInterface()
           
 java.lang.String getConnectionImplClass()
           
 java.lang.String getConnectionInterface()
           
 InboundResourceAdapter getInboundResourceAdapter()
          Returns the value of the 'Inbound Resource Adapter' containment reference
 java.lang.String getManagedConnectionFactoryClass()
           
 OutboundResourceAdapter getOutboundResourceAdapter()
          Returns the value of the 'Outbound Resource Adapter' containment reference
 java.lang.String getResourceAdapterClass()
          Returns the value of the 'Resource Adapter Class' attribute
 EList getSecurityPermissions()
           
 TransactionSupportKind getTransactionSupport()
           
 boolean isReauthenticationSupport()
           
 boolean isSetReauthenticationSupport()
          Returns whether the value of the 'Reauthentication Support' attribute is set
 boolean isSetTransactionSupport()
          Returns whether the value of the 'Transaction Support' attribute is set
 void setConnectionFactoryImplClass(java.lang.String value)
           
 void setConnectionFactoryInterface(java.lang.String value)
           
 void setConnectionImplClass(java.lang.String value)
           
 void setConnectionInterface(java.lang.String value)
           
 void setInboundResourceAdapter(InboundResourceAdapter value)
          Sets the value of the 'Inbound Resource Adapter' containment reference
 void setManagedConnectionFactoryClass(java.lang.String value)
           
 void setOutboundResourceAdapter(OutboundResourceAdapter value)
          Sets the value of the 'Outbound Resource Adapter' containment reference
 void setReauthenticationSupport(boolean value)
           
 void setResourceAdapterClass(java.lang.String value)
          Sets the value of the 'Resource Adapter Class' attribute
 void setTransactionSupport(TransactionSupportKind value)
          Sets the value of the 'Transaction Support' attribute
 void unsetReauthenticationSupport()
          Unsets the value of the 'Reauthentication Support' attribute
 void unsetTransactionSupport()
          Unsets the value of the 'Transaction Support' attribute
 

Method Detail

getManagedConnectionFactoryClass

public java.lang.String getManagedConnectionFactoryClass()
Returns:
The value of the ManagedConnectionFactoryClass attribute Specifies the fully qualified name of the Java class that implements the javax.resource.spi.Managed-ConnectionFactory interface. This Java class is provided as part of resource adapter's implementation of connector architecture specified contracts.

setManagedConnectionFactoryClass

public void setManagedConnectionFactoryClass(java.lang.String value)
Parameters:
value - The new value of the ManagedConnectionFactoryClass attribute

getConnectionFactoryInterface

public java.lang.String getConnectionFactoryInterface()
Returns:
The value of the ConnectionFactoryInterface attribute Specifies the fully-qualified name of the ConnectionFactory interface supported by the resource adapter.

setConnectionFactoryInterface

public void setConnectionFactoryInterface(java.lang.String value)
Parameters:
value - The new value of the ConnectionFactoryInterface attribute

getConnectionFactoryImplClass

public java.lang.String getConnectionFactoryImplClass()
Returns:
The value of the ConnectionFactoryImplClass attribute Specifies the fully-qualified name of the ConnectionFactory class that implements resource adapter specific ConnectionFactory interface.

setConnectionFactoryImplClass

public void setConnectionFactoryImplClass(java.lang.String value)
Parameters:
value - The new value of the ConnectionFactoryImplClass attribute

getConnectionInterface

public java.lang.String getConnectionInterface()
Returns:
The value of the ConnectionInterface attribute

setConnectionInterface

public void setConnectionInterface(java.lang.String value)
Parameters:
value - The new value of the ConnectionInterface attribute

getConnectionImplClass

public java.lang.String getConnectionImplClass()
Returns:
The value of the ConnectionImplClass attribute Specifies the fully-qualified name of the Connection interface supported by the resource adapter.

setConnectionImplClass

public void setConnectionImplClass(java.lang.String value)
Parameters:
value - The new value of the ConnectionImplClass attribute

getTransactionSupport

public TransactionSupportKind getTransactionSupport()
Returns:
The value of the TransactionSupport attribute The transaction-support element specifies the level of transaction support provided by the resource adapter. The value of transaction-support must be one of the following: NoTransaction LocalTransaction XATransaction

setTransactionSupport

public void setTransactionSupport(TransactionSupportKind value)
Sets the value of the 'Transaction Support' attribute.

Parameters:
value - the new value of the 'Transaction Support' attribute.
See Also:
TransactionSupportKind, isSetTransactionSupport(), unsetTransactionSupport(), getTransactionSupport()

unsetTransactionSupport

public void unsetTransactionSupport()
Unsets the value of the 'Transaction Support' attribute.

See Also:
isSetTransactionSupport(), getTransactionSupport(), setTransactionSupport(TransactionSupportKind)

isSetTransactionSupport

public boolean isSetTransactionSupport()
Returns whether the value of the 'Transaction Support' attribute is set.

Returns:
whether the value of the 'Transaction Support' attribute is set.
See Also:
unsetTransactionSupport(), getTransactionSupport(), setTransactionSupport(TransactionSupportKind)

isReauthenticationSupport

public boolean isReauthenticationSupport()
Returns:
The value of the ReauthenticationSupport attribute Specifies whether the resource adapter implementation supports re-authentication of existing Managed-Connection instance. Note that this information is for the resource adapter implementation and not for the underlying EIS instance.

setReauthenticationSupport

public void setReauthenticationSupport(boolean value)
Parameters:
value - The new value of the ReauthenticationSupport attribute

unsetReauthenticationSupport

public void unsetReauthenticationSupport()
Unsets the value of the 'Reauthentication Support' attribute.

See Also:
isSetReauthenticationSupport(), isReauthenticationSupport(), setReauthenticationSupport(boolean)

isSetReauthenticationSupport

public boolean isSetReauthenticationSupport()
Returns whether the value of the 'Reauthentication Support' attribute is set.

Returns:
whether the value of the 'Reauthentication Support' attribute is set.
See Also:
unsetReauthenticationSupport(), isReauthenticationSupport(), setReauthenticationSupport(boolean)

getResourceAdapterClass

public java.lang.String getResourceAdapterClass()
Returns the value of the 'Resource Adapter Class' attribute.

If the meaning of the 'Resource Adapter Class' attribute isn't clear, there really should be more of a description here...

The element resourceadapter-class specifies the fully qualified name of a Java class that implements the javax.resource.spi.ResourceAdapter interface. This Java class is provided as part of resource adapter's implementation of connector architecture specified contracts. The implementation of this class is required to be a JavaBean.

Returns:
the value of the 'Resource Adapter Class' attribute.
See Also:
setResourceAdapterClass(String), JcaPackage.getResourceAdapter_ResourceAdapterClass()

setResourceAdapterClass

public void setResourceAdapterClass(java.lang.String value)
Sets the value of the 'Resource Adapter Class' attribute.

Parameters:
value - the new value of the 'Resource Adapter Class' attribute.
See Also:
getResourceAdapterClass()

getSecurityPermissions

public EList getSecurityPermissions()
Returns:
The list of SecurityPermissions references

getAuthenticationMechanisms

public EList getAuthenticationMechanisms()
Returns:
The list of AuthenticationMechanisms references

getConfigProperties

public EList getConfigProperties()
Returns:
The list of ConfigProperties references

getOutboundResourceAdapter

public OutboundResourceAdapter getOutboundResourceAdapter()
Returns the value of the 'Outbound Resource Adapter' containment reference.

If the meaning of the 'Outbound Resource Adapter' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Outbound Resource Adapter' containment reference.
See Also:
setOutboundResourceAdapter(OutboundResourceAdapter), JcaPackage.getResourceAdapter_OutboundResourceAdapter()

setOutboundResourceAdapter

public void setOutboundResourceAdapter(OutboundResourceAdapter value)
Sets the value of the 'Outbound Resource Adapter' containment reference.

Parameters:
value - the new value of the 'Outbound Resource Adapter' containment reference.
See Also:
getOutboundResourceAdapter()

getInboundResourceAdapter

public InboundResourceAdapter getInboundResourceAdapter()
Returns the value of the 'Inbound Resource Adapter' containment reference.

If the meaning of the 'Inbound Resource Adapter' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Inbound Resource Adapter' containment reference.
See Also:
setInboundResourceAdapter(InboundResourceAdapter), JcaPackage.getResourceAdapter_InboundResourceAdapter()

setInboundResourceAdapter

public void setInboundResourceAdapter(InboundResourceAdapter value)
Sets the value of the 'Inbound Resource Adapter' containment reference.

Parameters:
value - the new value of the 'Inbound Resource Adapter' containment reference.
See Also:
getInboundResourceAdapter()

getAdminObjects

public EList getAdminObjects()
Returns the value of the 'Admin Objects' containment reference list. The list contents are of type AdminObject.

If the meaning of the 'Admin Objects' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Admin Objects' containment reference list.
See Also:
JcaPackage.getResourceAdapter_AdminObjects()