com.actional.security.plugin

Interface ICredential

All Known Subinterfaces:

IUsernamePasswordCredential

public interface ICredential

This interface is the base interface for all credentials.

Since:

1.0.

Field Summary

Fields

Modifier and Type	Field and Description
static int	PRIORITY_CERTIFICATE
static int	PRIORITY_KERBEROS
static int	PRIORITY_UNDEFINED
static int	PRIORITY_USERNAME_PASSWORD

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object another) Compares this credential to the specified object.
java.lang.String	getCredentialType() Returns the type of this credential.
java.lang.String	getDetailedInfo() Potentially returns more information about this credential.
int	getPriority() The credential priority.
java.lang.String	getTokenFormat() Returns the format of the token this credential was derived from.
java.lang.String	getUsername() Returns the name of the user represented by this credential.
int	hashCode() Returns a hashcode for this credential.

Field Detail

PRIORITY_UNDEFINED

static final int PRIORITY_UNDEFINED

See Also:

Constant Field Values

PRIORITY_USERNAME_PASSWORD

static final int PRIORITY_USERNAME_PASSWORD

See Also:

Constant Field Values

PRIORITY_CERTIFICATE

static final int PRIORITY_CERTIFICATE

See Also:

Constant Field Values

PRIORITY_KERBEROS

static final int PRIORITY_KERBEROS

See Also:

Constant Field Values

Method Detail

getPriority

int getPriority()

The credential priority. The higher the value, the higher the priority. Once collected, credentials are ordered in descending priority (Credentials of higher priority come first).

getCredentialType

java.lang.String getCredentialType()

Returns the type of this credential.

Returns:

the credential type of this credential See ICredentialTypes for predefined values.

getUsername

java.lang.String getUsername()

Returns the name of the user represented by this credential.

Returns:

the name of the user represented this credential.

getDetailedInfo

java.lang.String getDetailedInfo()

Potentially returns more information about this credential.

Returns:

more information about this credential or the user name otherwise.

getTokenFormat

java.lang.String getTokenFormat()

Returns the format of the token this credential was derived from.

Returns:

the format of the token this credential was derived from, if applicable and known. Can return null. Generated credentials do not have a token format. See com.actional.security.plugin.ITokenFormats for predefined values.

equals

boolean equals(java.lang.Object another)

Compares this credential to the specified object. Returns true if the object passed in matches the principal represented by the implementation of this interface.

Overrides:

equals in class java.lang.Object

Parameters:

another - credential to compare with.

Returns:

true if the credential passed in is the same as that encapsulated by this credential, and false otherwise.

hashCode

int hashCode()

Returns a hashcode for this credential. Two identical credentials must return the same hashcode.

Overrides:

hashCode in class java.lang.Object

Returns:

a hashcode for this credential.