org.eclipse.jst.j2ee.jca
Interface OutboundResourceAdapter

All Superinterfaces:
J2EEEObject

public interface OutboundResourceAdapter
extends J2EEEObject

A representation of the model object 'Outbound Resource Adapter'.

Version:
J2EE1.4 The outbound-resourceadapterType specifies information about an outbound resource adapter. The information includes fully qualified names of classes/interfaces required as part of the connector architecture specified contracts for connection management, level of transaction support provided, 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.

The following features are supported:

See Also:
JcaPackage.getOutboundResourceAdapter()

Method Summary
 EList getAuthenticationMechanisms()
          Returns the value of the 'Authentication Mechanisms' containment reference list.
 EList getConnectionDefinitions()
          Returns the value of the 'Connection Definitions' containment reference list.
 TransactionSupportKind getTransactionSupport()
          Returns the value of the 'Transaction Support' attribute.
 boolean isReauthenticationSupport()
          Returns the value of the 'Reauthentication Support' attribute
 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 setReauthenticationSupport(boolean value)
          Sets the value of the 'Reauthentication Support' 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

isReauthenticationSupport

public boolean isReauthenticationSupport()
Returns the value of the 'Reauthentication Support' attribute.

If the meaning of the 'Reauthentication Support' attribute isn't clear, there really should be more of a description here...

The element reauthentication-support 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. This element must have either a "true" or "false" value.

Returns:
the value of the 'Reauthentication Support' attribute.
See Also:
isSetReauthenticationSupport(), unsetReauthenticationSupport(), setReauthenticationSupport(boolean), JcaPackage.getOutboundResourceAdapter_ReauthenticationSupport()

setReauthenticationSupport

public void setReauthenticationSupport(boolean value)
Sets the value of the 'Reauthentication Support' attribute.

Parameters:
value - the new value of the 'Reauthentication Support' attribute.
See Also:
isSetReauthenticationSupport(), unsetReauthenticationSupport(), isReauthenticationSupport()

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)

getTransactionSupport

public TransactionSupportKind getTransactionSupport()
Returns the value of the 'Transaction Support' attribute. The literals are from the enumeration TransactionSupportKind.

If the meaning of the 'Transaction Support' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Transaction Support' attribute.
See Also:
TransactionSupportKind, isSetTransactionSupport(), unsetTransactionSupport(), setTransactionSupport(TransactionSupportKind), JcaPackage.getOutboundResourceAdapter_TransactionSupport()

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)

getConnectionDefinitions

public EList getConnectionDefinitions()
Returns the value of the 'Connection Definitions' containment reference list. The list contents are of type ConnectionDefinition.

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

Returns:
the value of the 'Connection Definitions' containment reference list.
See Also:
JcaPackage.getOutboundResourceAdapter_ConnectionDefinitions()

getAuthenticationMechanisms

public EList getAuthenticationMechanisms()
Returns the value of the 'Authentication Mechanisms' containment reference list. The list contents are of type AuthenticationMechanism.

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

Returns:
the value of the 'Authentication Mechanisms' containment reference list.
See Also:
JcaPackage.getOutboundResourceAdapter_AuthenticationMechanisms()