com.netegrity.sdk.dmsapi
Class SmDmsUserPWState

java.lang.Object
  com.netegrity.sdk.dmsapi.SmDmsUserPWState

public class SmDmsUserPWState
extends java.lang.Object

Represents the password state of a user within an organization.

Use the methods in this class to manage password state attributes. Those attributes are:

• The last time the user logged in successfully
• The next-to-last time the user logged in successfully.
• The number of login failures for this user since the user's last successful login.
• The last time the user changed his password.
• The time the user object was disabled.

After using this class to modify a user's password state attributes, call setUserPWState() to set a new password state object for the user that includes the modified attribute values.

Note: Time-related attribute values are represented in system epoch time. This time is the number of milliseconds that have elapsed since 00:00:00 1/1/1970 UTC (Coordinated Universal Time). With get... methods, the time is returned as a java.util.Date object. With set... methods, you can pass the time either as a java.util.Date object or as a numeric value of milliseconds.

Since:

SDK 6.0

Constructor Summary

SmDmsUserPWState()

Method Summary

java.util.Date	getDisabledTime() Retrieves the time the user object was disabled.
java.util.Date	getLastLoginTime() Retrieves the time of the user's last successful login.
java.util.Date	getLastPWChangeTime() Retrieves the time of the user's last password change.
int	getLoginFailures() Retrieves the number of times the user failed to log in since the user’s last successful login.
java.util.Date	getPrevLoginTime() Retrieves the next-to-last time the user logged in successfully.
void	setDisabledTime(java.util.Date date) Sets the time the user object was disabled.
void	setDisabledTime(long date) Sets the time the user object was disabled.
void	setLastLoginTime(java.util.Date date) Sets the time of the user's last successful login.
void	setLastLoginTime(long date) Sets the time of the user's last successful login.
void	setLastPWChangeTime(java.util.Date date) Sets the time of the user's last password change.
void	setLastPWChangeTime(long date) Sets the time of the user's last password change.
void	setLoginFailures(int count) Sets the number of login failures for this user since the user's last successful login.
void	setPrevLoginTime(java.util.Date date) Sets the user's previous login time.
void	setPrevLoginTime(long date) Sets the user's previous login time.
java.lang.String	toString() Converts the password state attribute values to string form.

Methods inherited from class java.lang.Object

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

Constructor Detail

SmDmsUserPWState

public SmDmsUserPWState()

Method Detail

getLoginFailures

public int getLoginFailures()

Retrieves the number of times the user failed to log in since the user’s last successful login.

Returns:

The number of login failures for this user.

setLoginFailures

public void setLoginFailures(int count)

Sets the number of login failures for this user since the user's last successful login.

If the input parameter is not valid, no action is taken.

Parameters:

count - The number of login failures to set for this user.

getLastLoginTime

public java.util.Date getLastLoginTime()

Retrieves the time of the user's last successful login.

The time is a java.util.Date object representing the number of milliseconds since system epoch time.

Returns:

The last time the user successfully loggged in.

setLastLoginTime

public void setLastLoginTime(java.util.Date date)

Sets the time of the user's last successful login.

If the input parameter is not valid, no action is taken.

Parameters:

date - The last successful login time to set for this user. The time is passed as a java.util.Date object representing the number of milliseconds since system epoch time.

setLastLoginTime

public void setLastLoginTime(long date)

Sets the time of the user's last successful login.

If the input parameter is not valid, no action is taken.

Parameters:

date - The last successful login time to set for this user. The time is passed as milliseconds since system epoch time.

getPrevLoginTime

public java.util.Date getPrevLoginTime()

Retrieves the next-to-last time the user logged in successfully. This login occurs just prior to the login represented by getLastLoginTime().

The time is a java.util.Date object representing the number of milliseconds since system epoch time.

Returns:

The next-to-last time the user successfully logged in.

setPrevLoginTime

public void setPrevLoginTime(java.util.Date date)

Sets the user's previous login time. This login occurs just prior to the login represented by getLastLoginTime().

If the input parameter is not valid, no action is taken.

Parameters:

date - The previous login time to set for this user. The time is passed as a java.util.Date object representing the number of milliseconds since system epoch time.

setPrevLoginTime

public void setPrevLoginTime(long date)

Sets the user's previous login time. This login occurs just prior to the login represented by getLastLoginTime().

If the input parameter is not valid, no action is taken.

Parameters:

date - The previous login time to set for this user. The time is passed as milliseconds since system epoch time.

getDisabledTime

public java.util.Date getDisabledTime()

Retrieves the time the user object was disabled.

The time is a java.util.Date object representing the number of milliseconds since system epoch time.

Returns:

The time the user object was disabled.

setDisabledTime

public void setDisabledTime(java.util.Date date)

Sets the time the user object was disabled.

If the input parameter is not valid, no action is taken.

Parameters:

date - The time the user object was disabled. The time is passed as a java.util.Date object representing the number of milliseconds since system epoch time.

setDisabledTime

public void setDisabledTime(long date)

Sets the time the user object was disabled.

If the input parameter is not valid, no action is taken.

Parameters:

date - The time the user object was disabled. The time is passed as milliseconds since system epoch time.

getLastPWChangeTime

public java.util.Date getLastPWChangeTime()

Retrieves the time of the user's last password change.

The time is a java.util.Date object representing the number of milliseconds since system epoch time.

Returns:

The time of the user's last password change.

Note: This method may return system epoch time if the user begins the procedure to change his password but does not complete it.

setLastPWChangeTime

public void setLastPWChangeTime(java.util.Date date)

Sets the time of the user's last password change.

If the value you set changes the user directory, and the password is reset outside of SiteMinder, the password policy preventing password reuse may not work as expected.

If the input parameter is invalid, no action is taken.

Parameters:

date - The time of the user's last password change. The time is passed as a java.util.Date object representing the number of milliseconds since system epoch time.

setLastPWChangeTime

public void setLastPWChangeTime(long date)

Sets the time of the user's last password change.

If the input parameter is not valid, no action is taken.

Parameters:

date - The time the user object was disabled. The time is passed as milliseconds since system epoch time.

toString

public java.lang.String toString()

Converts the password state attribute values to string form.

Overrides:

toString in class java.lang.Object