net.sf.jpam
Class PamReturnValue

java.lang.Object
  net.sf.jpam.PamReturnValue

public class PamReturnValue
extends java.lang.Object

A type-safe enum for PAM return values.

Warning. When comparing values do not use ==. Use the .equals(Object o) method.

These are based on the Linux PAM projects return values.

Field Summary

static PamReturnValue	PAM_ABORT A constant PamReturnValue
static PamReturnValue	PAM_ACCT_EXPIRED A constant PamReturnValue
static PamReturnValue	PAM_AUTH_ERR A constant PamReturnValue
static PamReturnValue	PAM_AUTHINFO_UNAVAIL A constant PamReturnValue
static PamReturnValue	PAM_AUTHTOK_DISABLE_AGING A constant PamReturnValue
static PamReturnValue	PAM_AUTHTOK_ERR A constant PamReturnValue
static PamReturnValue	PAM_AUTHTOK_EXPIRED A constant PamReturnValue
static PamReturnValue	PAM_AUTHTOK_LOCK_BUSY A constant PamReturnValue
static PamReturnValue	PAM_AUTHTOK_RECOVER_ERR A constant PamReturnValue
static PamReturnValue	PAM_BAD_ITEM A constant PamReturnValue
static PamReturnValue	PAM_BUF_ERR A constant PamReturnValue
static PamReturnValue	PAM_CONV_AGAIN A constant PamReturnValue
static PamReturnValue	PAM_CONV_ERR A constant PamReturnValue
static PamReturnValue	PAM_CRED_ERR A constant PamReturnValue
static PamReturnValue	PAM_CRED_EXPIRED A constant PamReturnValue
static PamReturnValue	PAM_CRED_INSUFFICIENT A constant PamReturnValue
static PamReturnValue	PAM_CRED_UNAVAIL A constant PamReturnValue
static PamReturnValue	PAM_IGNORE A constant PamReturnValue
static PamReturnValue	PAM_INCOMPLETE A constant PamReturnValue
static PamReturnValue	PAM_MAXTRIES A constant PamReturnValue
static PamReturnValue	PAM_MODULE_UNKNOWN A constant PamReturnValue
static PamReturnValue	PAM_NEW_AUTHTOK_REQD A constant PamReturnValue
static PamReturnValue	PAM_NO_MODULE_DATA A constant PamReturnValue
static PamReturnValue	PAM_OPEN_ERR A constant PamReturnValue
static PamReturnValue	PAM_PERM_DENIED A constant PamReturnValue
static PamReturnValue	PAM_SERVICE_ERR A constant PamReturnValue
static PamReturnValue	PAM_SESSION_ERR A constant PamReturnValue
static PamReturnValue	PAM_SUCCESS A constant PamReturnValue
static PamReturnValue	PAM_SYMBOL_ERR A constant PamReturnValue
static PamReturnValue	PAM_SYSTEM_ERR A constant PamReturnValue
static PamReturnValue	PAM_TRY_AGAIN A constant PamReturnValue
static PamReturnValue	PAM_USER_UNKNOWN A constant PamReturnValue
static java.util.List	VALUES The enumeration of possible values

Method Summary

boolean	equals(java.lang.Object o) Returns true if the supplied object is of the same type and has the same id.
static PamReturnValue	fromId(int id) Gets the PamReturnValue that matches the given id
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PAM_SUCCESS

public static final PamReturnValue PAM_SUCCESS

A constant PamReturnValue

PAM_OPEN_ERR

public static final PamReturnValue PAM_OPEN_ERR

A constant PamReturnValue

PAM_SYMBOL_ERR

public static final PamReturnValue PAM_SYMBOL_ERR

A constant PamReturnValue

PAM_SERVICE_ERR

public static final PamReturnValue PAM_SERVICE_ERR

A constant PamReturnValue

PAM_SYSTEM_ERR

public static final PamReturnValue PAM_SYSTEM_ERR

A constant PamReturnValue

PAM_BUF_ERR

public static final PamReturnValue PAM_BUF_ERR

A constant PamReturnValue

PAM_PERM_DENIED

public static final PamReturnValue PAM_PERM_DENIED

A constant PamReturnValue

PAM_AUTH_ERR

public static final PamReturnValue PAM_AUTH_ERR

A constant PamReturnValue

PAM_CRED_INSUFFICIENT

public static final PamReturnValue PAM_CRED_INSUFFICIENT

A constant PamReturnValue

PAM_AUTHINFO_UNAVAIL

public static final PamReturnValue PAM_AUTHINFO_UNAVAIL

A constant PamReturnValue

PAM_USER_UNKNOWN

public static final PamReturnValue PAM_USER_UNKNOWN

A constant PamReturnValue

PAM_MAXTRIES

public static final PamReturnValue PAM_MAXTRIES

A constant PamReturnValue

PAM_NEW_AUTHTOK_REQD

public static final PamReturnValue PAM_NEW_AUTHTOK_REQD

A constant PamReturnValue

PAM_ACCT_EXPIRED

public static final PamReturnValue PAM_ACCT_EXPIRED

A constant PamReturnValue

PAM_SESSION_ERR

public static final PamReturnValue PAM_SESSION_ERR

A constant PamReturnValue

PAM_CRED_UNAVAIL

public static final PamReturnValue PAM_CRED_UNAVAIL

A constant PamReturnValue

PAM_CRED_EXPIRED

public static final PamReturnValue PAM_CRED_EXPIRED

A constant PamReturnValue

PAM_CRED_ERR

public static final PamReturnValue PAM_CRED_ERR

A constant PamReturnValue

PAM_NO_MODULE_DATA

public static final PamReturnValue PAM_NO_MODULE_DATA

A constant PamReturnValue

PAM_CONV_ERR

public static final PamReturnValue PAM_CONV_ERR

A constant PamReturnValue

PAM_AUTHTOK_ERR

public static final PamReturnValue PAM_AUTHTOK_ERR

A constant PamReturnValue

PAM_AUTHTOK_RECOVER_ERR

public static final PamReturnValue PAM_AUTHTOK_RECOVER_ERR

A constant PamReturnValue

PAM_AUTHTOK_LOCK_BUSY

public static final PamReturnValue PAM_AUTHTOK_LOCK_BUSY

A constant PamReturnValue

PAM_AUTHTOK_DISABLE_AGING

public static final PamReturnValue PAM_AUTHTOK_DISABLE_AGING

A constant PamReturnValue

PAM_TRY_AGAIN

public static final PamReturnValue PAM_TRY_AGAIN

A constant PamReturnValue

PAM_IGNORE

public static final PamReturnValue PAM_IGNORE

A constant PamReturnValue

PAM_ABORT

public static final PamReturnValue PAM_ABORT

A constant PamReturnValue

PAM_AUTHTOK_EXPIRED

public static final PamReturnValue PAM_AUTHTOK_EXPIRED

A constant PamReturnValue

PAM_MODULE_UNKNOWN

public static final PamReturnValue PAM_MODULE_UNKNOWN

A constant PamReturnValue

PAM_BAD_ITEM

public static final PamReturnValue PAM_BAD_ITEM

A constant PamReturnValue

PAM_CONV_AGAIN

public static final PamReturnValue PAM_CONV_AGAIN

A constant PamReturnValue

PAM_INCOMPLETE

public static final PamReturnValue PAM_INCOMPLETE

A constant PamReturnValue

VALUES

public static final java.util.List VALUES

The enumeration of possible values

Method Detail

equals

public boolean equals(java.lang.Object o)

Returns true if the supplied object is of the same type and has the same id.

Overrides:

equals in class java.lang.Object

fromId

public static PamReturnValue fromId(int id)
                             throws java.lang.IllegalArgumentException

Gets the PamReturnValue that matches the given id

Parameters:

id - a valid Integer with a value between 0 and 31

Returns:

the PamReturnValue matching the id

Throws:

java.lang.IllegalArgumentException - if the id is outside the range of possible return values

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code for the object.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

the String description of the return value