public interface

WebStandardLoginInfo

com.microstrategy.web.objects.admin.users.WebStandardLoginInfo

Class Overview

This interface represents the settings related to the standard login method which can be set on a user. This interface is obtained from the WebUser interface, and can be used to read and write those settings related to standard authentication on a user or group object.

Summary

Public Methods
abstract Date getPasswordExpirationDate()
Returns the password expiration date set for the user.
abstract int getPasswordExpirationFrequency()
Returns the current setting for the password expiration frequency.
abstract boolean getPasswordExpiresAutomatically()
Returns whether the password is currently set to expire automatically.
abstract boolean getRequiresNewPassword()
Returns whether the user is required to set a new password upon the next login.
abstract boolean isPasswordModifiable()
Returns whether the password is modifiable by the user.
abstract boolean isStandardAuthAllowed()
Returns whether the user is allowed to login using standard authentication.
abstract void setPassword(String password)
This method sets the password on the user account.
abstract void setPasswordExpirationDate(Date date)
Sets the password expiration date for the user.
abstract void setPasswordExpirationFrequency(int freq)
Sets the password expiration frequency for this user.
abstract void setPasswordExpiresAutomatically(boolean expires)
Sets the password to expire automatically at either a given date or a given frequency.
abstract void setPasswordModifiable(boolean isModifiable)
Sets whether the user is allowed to modify his/her own password.
abstract void setRequiresNewPassword(boolean val)
Sets whether the user is required to set a new password upon the next login.
abstract void setStandardAuthAllowed(boolean isAllowed)
Sets whether a user is allowed to login using standard authentication.

Public Methods

public abstract Date getPasswordExpirationDate ()

Returns the password expiration date set for the user.

Returns
  • The current setting of the password expiration date for the user.

public abstract int getPasswordExpirationFrequency ()

Returns the current setting for the password expiration frequency.

Returns
  • The current password expiration frequency setting.

public abstract boolean getPasswordExpiresAutomatically ()

Returns whether the password is currently set to expire automatically.

Returns
  • True if the password is currently set to expire automatically, false otherwise.

public abstract boolean getRequiresNewPassword ()

Returns whether the user is required to set a new password upon the next login.

Returns
  • Whether the user must change password upon the next login.

public abstract boolean isPasswordModifiable ()

Returns whether the password is modifiable by the user.

Returns
  • True if the password is modifiable, false otherwise.

public abstract boolean isStandardAuthAllowed ()

Returns whether the user is allowed to login using standard authentication.

Returns
  • True if the user is allowed to login using standard authentication, false otherwise.

public abstract void setPassword (String password)

This method sets the password on the user account. Note that it cannot be read from this interface, for security reasons.

Parameters
password The user's new password.

public abstract void setPasswordExpirationDate (Date date)

Sets the password expiration date for the user.

Parameters
date The new password expiration date to set for the user.

public abstract void setPasswordExpirationFrequency (int freq)

Sets the password expiration frequency for this user.

Parameters
freq The new password expiration frequency for the user.

public abstract void setPasswordExpiresAutomatically (boolean expires)

Sets the password to expire automatically at either a given date or a given frequency.

Parameters
expires Whether the password is set to expire automatically.

public abstract void setPasswordModifiable (boolean isModifiable)

Sets whether the user is allowed to modify his/her own password.

Parameters
isModifiable True if the user's password should be modifiable, false otherwise.

public abstract void setRequiresNewPassword (boolean val)

Sets whether the user is required to set a new password upon the next login.

Parameters
val The new setting for whether the user must set a new password upon the next login.

public abstract void setStandardAuthAllowed (boolean isAllowed)

Sets whether a user is allowed to login using standard authentication.

Parameters
isAllowed True if the user is allowed to log in using standard authentication, false otherwise.