org.eclipse.jst.j2ee.jca
Interface AuthenticationMechanism

All Superinterfaces:
J2EEEObject

public interface AuthenticationMechanism
extends J2EEEObject

The element authentication-mechanism specifies an authentication mechanism supported by the resource adapter. Note that this support is for the resource adapter and not for the underlying EIS instance. The optional description specifies any resource adapter specific requirement for the support of security contract and authentication mechanism. Note that BasicPassword mechanism type should support the javax.resource.spi.security.PasswordCredential interface. The Kerbv5 mechanism type should support the javax.resource.spi.security.GenericCredential interface.

Since:
1.0

Method Summary
 java.lang.String getAuthenticationMechanism()
          Returns the value of the 'Authentication Mechanism' attribute
 AuthenticationMechanismType getAuthenticationMechanismType()
           
 java.lang.String getCredentialInterface()
           
 java.lang.String getCustomAuthMechType()
           
 java.lang.String getDescription()
           
 EList getDescriptions()
          Returns the value of the 'Descriptions' containment reference list.
 boolean isSetAuthenticationMechanismType()
          Returns whether the value of the 'Authentication Mechanism Type' attribute is set
 void setAuthenticationMechanism(java.lang.String value)
          Sets the value of the 'Authentication Mechanism' attribute
 void setAuthenticationMechanismType(AuthenticationMechanismType value)
          Sets the value of the 'Authentication Mechanism Type' attribute
 void setCredentialInterface(java.lang.String value)
           
 void setCustomAuthMechType(java.lang.String value)
           
 void setDescription(java.lang.String value)
           
 void unsetAuthenticationMechanismType()
          Unsets the value of the 'Authentication Mechanism Type' attribute
 

Method Detail

getDescription

public java.lang.String getDescription()
Returns:
The value of the Description attribute

setDescription

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

getAuthenticationMechanism

public java.lang.String getAuthenticationMechanism()
Returns the value of the 'Authentication Mechanism' attribute.

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

Returns:
the value of the 'Authentication Mechanism' attribute.
See Also:
setAuthenticationMechanism(String), JcaPackage.getAuthenticationMechanism_AuthenticationMechanism()

setAuthenticationMechanism

public void setAuthenticationMechanism(java.lang.String value)
Sets the value of the 'Authentication Mechanism' attribute.

Parameters:
value - the new value of the 'Authentication Mechanism' attribute.
See Also:
getAuthenticationMechanism()

getAuthenticationMechanismType

public AuthenticationMechanismType getAuthenticationMechanismType()
Returns:
The value of the AuthenticationMechanismType attribute The authentication-mechanism-type specifies type of an authentication mechanism. The example values are: - BasicPassword - Kerbv5 Any additional security mechanisms are outside the scope of the Connector architecture specification.

setAuthenticationMechanismType

public void setAuthenticationMechanismType(AuthenticationMechanismType value)
Sets the value of the 'Authentication Mechanism Type' attribute.

Parameters:
value - the new value of the 'Authentication Mechanism Type' attribute.
See Also:
AuthenticationMechanismType, isSetAuthenticationMechanismType(), unsetAuthenticationMechanismType(), getAuthenticationMechanismType()

unsetAuthenticationMechanismType

public void unsetAuthenticationMechanismType()
Unsets the value of the 'Authentication Mechanism Type' attribute.

See Also:
isSetAuthenticationMechanismType(), getAuthenticationMechanismType(), setAuthenticationMechanismType(AuthenticationMechanismType)

isSetAuthenticationMechanismType

public boolean isSetAuthenticationMechanismType()
Returns whether the value of the 'Authentication Mechanism Type' attribute is set.

Returns:
whether the value of the 'Authentication Mechanism Type' attribute is set.
See Also:
unsetAuthenticationMechanismType(), getAuthenticationMechanismType(), setAuthenticationMechanismType(AuthenticationMechanismType)

getCredentialInterface

public java.lang.String getCredentialInterface()
Returns:
The value of the CredentialInterface attribute Specifies the interface that the resource adapter implementation supports for the representation of the credentials. This element should be used by application server to find out the Credential interface it should use as part of the security contract. The possible values are: javax.resource.spi.security.PasswordCredential javax.resource.spi.security.GenericCredential

setCredentialInterface

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

getCustomAuthMechType

public java.lang.String getCustomAuthMechType()
Returns:
The value of the CustomAuthMechType attribute This is an internal variable used to store the AthenticationMechanismType when it is something other than BasicPassword or Kerbv5. AuthenticationMecanismType is set to 'Custom' in those cases. This attribute should not be used by runtime. It is only used by the writer to write back out the custom AuthenticationMechanismType string in the case of custom AuthenticationMechanismType's. This variable is internal, used only by the reader//writer classes, and can change or disappear without notice.

setCustomAuthMechType

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

getDescriptions

public 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.getAuthenticationMechanism_Descriptions()