EE4J 10.0.0 · jakarta.resource.spi.security.GenericCredential

The interface jakarta.resource.spi.security.GenericCredential defines a security mechanism independent interface for accessing security credential of a resource principal.

The GenericCredential interface provides a Java wrapper over an underlying mechanism specific representation of a security credential. For example, the GenericCredential interface can be used to wrap Kerberos credentials.

The connector architecture does not define any standard format and requirements for security mechanism specific credentials. For example, a security credential wrapped by a GenericCredential interface can have a native representation specific to an operating system.

The GenericCredential interface enables a resource adapter to extract information about a security credential. The resource adapter can then manage EIS sign-on for a resource principal by either:

using the credentials in an EIS specific manner if the underlying EIS supports the security mechanism type represented by the GenericCredential instance, or,
using GSS-API if the resource adapter and underlying EIS instance support GSS-API.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object another) Tests if this GenericCredential instance refers to the same entity as the supplied object.
public byte[]	Returns: credential representation as an array of bytes. getCredentialData() Gets security data for a specific security mechanism represented by the GenericCredential.
public String	Returns: mechanism type getMechType() Returns the mechanism type for the GenericCredential instance.
public String	Returns: Name of the principal getName() Returns the name of the resource principal associated with a GenericCredential instance.
public int	Returns: hash code for this GenericCredential hashCode() Returns the hash code for this GenericCredential

Method Detail

equals	back to summary
public boolean equals(Object another) Tests if this GenericCredential instance refers to the same entity as the supplied object. The two credentials must be acquired over the same mechanisms and must refer to the same principal. Returns true if the two GenericCredentials refer to the same entity; false otherwise.

getCredentialData	back to summary
public byte[] getCredentialData() throws SecurityException Gets security data for a specific security mechanism represented by the GenericCredential. An example is authentication data required for establishing a secure association with an EIS instance on behalf of the associated resource principal. The getCredentialData method returns the credential representation as an array of bytes. Note that the connector architecture does not define any standard format for the returned credential data. Returns:byte[] credential representation as an array of bytes. Exceptions SecurityException: Failed operation due to security related error condition

getCredentialData

back to summary

public byte[] getCredentialData() throws SecurityException

Gets security data for a specific security mechanism represented by the GenericCredential. An example is authentication data required for establishing a secure association with an EIS instance on behalf of the associated resource principal.

The getCredentialData method returns the credential representation as an array of bytes. Note that the connector architecture does not define any standard format for the returned credential data.

Returns:byte[]

credential representation as an array of bytes.

Exceptions

SecurityException:: Failed operation due to security related error condition

getMechType	back to summary
public String getMechType() Returns the mechanism type for the GenericCredential instance. The mechanism type definition for GenericCredential should be consistent with the Object Identifier (OID) based representation specified in the GSS specification. In the GenericCredential interface, the mechanism type is returned as a stringified representation of the OID specification. Returns:String mechanism type

getMechType

back to summary

public String getMechType()

Returns the mechanism type for the GenericCredential instance. The mechanism type definition for GenericCredential should be consistent with the Object Identifier (OID) based representation specified in the GSS specification. In the GenericCredential interface, the mechanism type is returned as a stringified representation of the OID specification.

Returns:String: mechanism type

getName	back to summary
public String getName() Returns the name of the resource principal associated with a GenericCredential instance. Returns:String Name of the principal

getName

back to summary

public String getName()

Returns the name of the resource principal associated with a GenericCredential instance.

Returns:String: Name of the principal

hashCode	back to summary
public int hashCode() Returns the hash code for this GenericCredential Returns:int hash code for this GenericCredential

hashCode

back to summary

public int hashCode()

Returns the hash code for this GenericCredential

Returns:int: hash code for this GenericCredential

public Interface GenericCredential

Method Summary

Method Detail