Interface WSCredential

All Superinterfaces:
Serializable

public interface WSCredential extends Serializable

Interface that defines a Credential used represent an authenticated principal to WebSphere.

Authentication mechanisms are expected to implement this interface.

Several of the method return types in this interface are array types. If implementors internally store instance data as arrays for these methods, they should return a deep copy of the array so that modifying the return result does not also modify the internally stored array.

Once a credential has been created, it is typically immutable except for expiration time.

If a credential is expired, any method access generates a CredentialExpiredException. The refresh() method of the Refreshable interface is not implemented. A new login must be performed.

If a credential is destroyed, any method access generates a CredentialDestroyedException. A destroyed credential can not be used.

Since:
1.0
See Also:
  • Method Summary

    Modifier and Type
    Method
    Description
    get(String key)
    Allows user to get an Object based on a key.
    Returns a string value that represents the access-Id of the principal.
    byte[]
    Returns the credential token.
    long
    Returns a long value that indicates when a credential will expire.
    Returns a ArrayList which indicates the groups the authenticated principal is a member of.
    Returns the OID that identifies the authentication mechanism, for example:
    Returns a string value that indicates the primary group the authenticated principal is a member of.
    Return the realm name.
    Returns the realm and the user principal name, the default implementation format is realm/user principal name.
    Returns the realm and the unique user name, the default implementation format is realm/unique user name.
    Returns the user principal name.
    Returns the unique user name as it applies to the configured user registry.
    boolean
    Determines if the credential is a BasicAuth credential or not.
    boolean
    Returns a boolean value that indicates if the credential is forwardable.
    boolean
    Return true if the credential is an Unauthenticated Credential.
    set(String key, Object value)
    Allows user to set an Object based on a key.