com.netegrity.sdk.apiutil
Class SmUserPasswordState

java.lang.Object
  com.netegrity.sdk.apiutil.SmUserPasswordState

public class SmUserPasswordState
extends java.lang.Object

Allows to set and retrieve information about a user state and password state. The information includes user state(enabled/disbaled) and reason for disabled state. The information also includes the password state of a user which includes login failures, last login time, disabled time,last password change and previous login time. It is possible that all the values are not populated and it depends on which API was called on the object.

Field Summary

static int	ADMIN_DISABLED
static int	DIR_NATIVE_DISABLED
static int	INACTIVITY
static int	MAX_LOGIN_FAIL
static int	PW_EXIRED
static int	PW_MUST_CHANGE

Constructor Summary

SmUserPasswordState()
Construct a user context instance.

Method Summary

int	getDisabledTime() Gets the disabled tiem of the user password state.
boolean	getEmptyPasswordHistory() Gets the password history of the user password state.If true, means password history is empty.
int	getLastLoginTime() Gets the last login time of the user password state.
int	getLastPasswordChange() Gets the last password change time of the user.
int	getLoginFailures() Gets the login failures of the user password state.
int	getPreviousLoginTime() Gets the previous login time of the user password state.
int	getUserState() Gets the user state as enabled/disabled with the reason for disabled state, if disabled.
void	populate(java.util.Hashtable properties) Read specified properties from hashtable into class members.
void	setDisabledTime(int disabledTime) Sets the disabled time of the user password state.
void	setEmptyPasswordHistory(boolean emptyPwdHistory) Sets the password history of the user password state.If true, empty the password history.
void	setLastLoginTime(int lastLoginTime) Sets the last login time of the user password state.
void	setLastPasswordChange(int lastPasswordChange) Sets the last password change time of the user.
void	setLoginFailures(int loginFailures) Sets the login failures of the user password state.
void	setPreviousLoginTime(int previousLoginTime) Sets the previous login time of the user password state.
void	setUserState(int userState) Sets the user state as enabled/disbaled state.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ADMIN_DISABLED

public static final int ADMIN_DISABLED

See Also:

Constant Field Values

MAX_LOGIN_FAIL

public static final int MAX_LOGIN_FAIL

See Also:

Constant Field Values

INACTIVITY

public static final int INACTIVITY

See Also:

Constant Field Values

PW_EXIRED

public static final int PW_EXIRED

See Also:

Constant Field Values

PW_MUST_CHANGE

public static final int PW_MUST_CHANGE

See Also:

Constant Field Values

DIR_NATIVE_DISABLED

public static final int DIR_NATIVE_DISABLED

See Also:

Constant Field Values

Constructor Detail

SmUserPasswordState

public SmUserPasswordState()

Construct a user context instance.

Method Detail

getUserState

public int getUserState()

Gets the user state as enabled/disabled with the reason for disabled state, if disabled.

Returns:

The user state.

setUserState

public void setUserState(int userState)

Sets the user state as enabled/disbaled state. Disbled state is set with the reason for the user disbaled state.

Parameters:

userState - The user state.

getLoginFailures

public int getLoginFailures()

Gets the login failures of the user password state.

Returns:

The number of login failues of user password.

setLoginFailures

public void setLoginFailures(int loginFailures)

Sets the login failures of the user password state.

Parameters:

loginFailures - The number of login failures of user password.

getLastLoginTime

public int getLastLoginTime()

Gets the last login time of the user password state.

Returns:

The last login time of user password.

setLastLoginTime

public void setLastLoginTime(int lastLoginTime)

Sets the last login time of the user password state.

Parameters:

lastLoginTime - The last login time of the user password.

getDisabledTime

public int getDisabledTime()

Gets the disabled tiem of the user password state.

Returns:

The disbaled time of the user password.

setDisabledTime

public void setDisabledTime(int disabledTime)

Sets the disabled time of the user password state.

Parameters:

disabledTime - The disbaled time of user password.

getLastPasswordChange

public int getLastPasswordChange()

Gets the last password change time of the user.

Returns:

The last password change time of user password.

setLastPasswordChange

public void setLastPasswordChange(int lastPasswordChange)

Sets the last password change time of the user.

Parameters:

lastPasswordChange - The last password change time of user password.

getPreviousLoginTime

public int getPreviousLoginTime()

Gets the previous login time of the user password state.

Returns:

The previous login time of the user password.

setPreviousLoginTime

public void setPreviousLoginTime(int previousLoginTime)

Sets the previous login time of the user password state.

Parameters:

previousLoginTime - The previous login time of the user password.

getEmptyPasswordHistory

public boolean getEmptyPasswordHistory()

Gets the password history of the user password state.If true, means password history is empty.

Returns:

boolean indicationg the user password history.

setEmptyPasswordHistory

public void setEmptyPasswordHistory(boolean emptyPwdHistory)

Sets the password history of the user password state.If true, empty the password history.

Parameters:

emptyPwdHistory - boolean indicationg the user password history.

populate

public void populate(java.util.Hashtable properties)

Read specified properties from hashtable into class members.

Parameters:

properties - Properties.