|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This class provides several routines through which one can retrieve implementations of SASL OTP User Databases. Implementors of any other UserDatabase implementations will want to expose them through this, or provide similar functionality elsewhere.
Field Summary | |
static java.lang.String |
ERR_DB_PARSE
|
static java.lang.String |
OTP_ALGO
|
static java.lang.String |
OTP_AUTHENTICATOR
|
static java.lang.String |
OTP_HEADER
|
static java.lang.String |
OTP_LAST_HASH
|
static java.lang.String |
OTP_MECH
|
static java.lang.String |
OTP_SEED
|
static java.lang.String |
OTP_SEQUENCE
|
static java.lang.String |
OTP_SUFFIX
|
Method Summary | |
void |
addUser(java.lang.String username,
java.lang.String algorithm,
java.lang.String hash,
java.lang.String seed,
java.lang.String sequence)
Method addUser |
UserDatabase |
getUser(java.lang.String username)
Method getUser This method is provided as a means for users of the OTP databases to retrieve the information contained in them, in the form of an instance of UserDatabase. |
void |
removeUserDB(java.lang.String username)
Method purgeUserDatabase is a routine designed to allow for the removal of a user db. |
void |
updateUserDB(UserDatabase ud)
Method updateUserDB causes the long-term representation (e.g. file) of the user's OTP database to be updated after a successful authentication. |
Field Detail |
public static final java.lang.String OTP_ALGO
public static final java.lang.String OTP_AUTHENTICATOR
public static final java.lang.String OTP_HEADER
public static final java.lang.String OTP_LAST_HASH
public static final java.lang.String OTP_MECH
public static final java.lang.String OTP_SEED
public static final java.lang.String OTP_SEQUENCE
public static final java.lang.String OTP_SUFFIX
public static final java.lang.String ERR_DB_PARSE
Method Detail |
public UserDatabase getUser(java.lang.String username) throws SASLException
username
- Indicates which OTP database should
be retrieved, based on who wishes to authenticate using it.
SASLException
- is thrown if the parameter is null or
some error is encountered during the reading or processing
of the user's OTP database file.public void addUser(java.lang.String username, java.lang.String algorithm, java.lang.String hash, java.lang.String seed, java.lang.String sequence) throws SASLException
username
- The identity of the user for whom this OTP
database is used.
SASLException
public void updateUserDB(UserDatabase ud) throws SASLException
ud
- The updated form of the OTP database.
SASLException
- if any issues are encountered during the
storage of the user's OTP DB.public void removeUserDB(java.lang.String username) throws SASLException
username
- The username associated with a given db.
SASLException
- if any errors are encountered in the
removal of the data (such as it not being there in the first place
or encountering some rights issue, it can't be removed right now
cuz it's being used etc.)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |