com.crystaldecisions.sdk.plugin.authentication.enterprise
Interface IsecEnterpriseBase

All Known Subinterfaces:

IsecEnterprise

public interface IsecEnterpriseBase

Use this interface to set global security options for native Enterprise user accounts. In most cases, the settings that are specified through the IsecEnterprise interface override the password settings specified for a particular Enterprise user through the IUser interface.

Field Summary

static java.lang.String	KIND The Kind used to query for the secEnterprise interface.
static java.lang.String	PROGID The ProgID for the secEnterprise Class.

Method Summary

java.util.Date	getLastSharedSecretChangeTime() Returns the last modification time of the shared secret.
int	getMaxNumberOfAttempts() Returns the number of times users can fail to log on to the system before their account is locked.
int	getMaxPasswordAge() Returns the number of days before the password expires.
int	getMaxSharedSecretAge() Returns the number of days before the shared secret expires.
int	getMinPasswordLength() Returns the minimum number of characters that a password must have to be valid.
int	getMinTimeBetweenPasswordChanges() Returns the number of minutes that must pass before a user can change a password.
int	getReenableAccountTime() Returns the length of time the user must wait before his or her disabled account is re-enabled.
int	getResetLogonAttemptCount() Returns the length of time that must pass before the count for logon attempts is reset to zero.
int	getTrustedPrincipalValidTime() Returns a long that indicates in milliseconds how long the trusted principal will be valid.
int	getUnableToRepeatNPasswords() Returns the number of recent passwords that cannot be reused.
boolean	isAccountDisabledAfterNFailedLogins() Returns true if the account is disabled after a specified number of attempts to log on to the system, and false otherwise.
boolean	isMinPasswordLengthEnforced() Returns true if passwords must contain a minimum number of characters, and false otherwise.
boolean	isMixedCaseEnforced() Returns true if passwords must be mixed-case, and false otherwise.
boolean	isNumericEnforced() Returns true if passwords must have numeric character, and false otherwise.
boolean	isPasswordAgeEnforced() Returns true if users are required to change their password after a specified length of time, and false otherwise.
boolean	isReenableAccountTimeEnforced() Returns true if a disabled account will be re-enabled after a specified length of time, and false otherwise.
boolean	isSharedSecretNotEmpty() Returns a boolean value that indicates whether the password is set and not empty.
boolean	isSpecialcharacterEnforced() Returns true if passwords must have special character, and false otherwise.
boolean	isTrustedAuthenticationEnabled() Returns a boolean value that indicates whether trusted authentication is enabled.
boolean	isUnableToRepeatNPasswordsEnforced() Returns true if previous passwords cannot be repeated, and false otherwise.
void	setAccountDisabledAfterNFailedLogins(boolean disable) Sets whether the account is disabled after a specified number of attempts to log on to the system.
void	setMaxNumberOfAttempts(int attempts) Sets the number of times users can fail to log on to the system before their account is locked.
void	setMaxPasswordAge(int seconds) Sets the number of days before the password expires.
void	setMaxPasswordAgeEnforced(boolean enforce) Sets whether users are required to change their password after a specified length of time.
void	setMaxSharedSecretAge(int days) Sets the number of days before the shared secret expires.
void	setMinPasswordLength(int length) Sets the minimum number of characters that a password must have to be valid.
void	setMinPasswordLengthEnforced(boolean enforce) Sets whether passwords must contain a minimum number of characters.
void	setMinTimeBetweenPasswordChanges(int seconds) Sets the number of minutes that must pass before a user can change a password.
void	setMixedCaseEnforced(boolean enforce) Sets whether passwords must be mixed-case.
void	setNumericEnforced(boolean enforce) Sets whether passwords must be numeric character.
void	setReenableAccountTime(int seconds) Sets the length of time the user must wait before his or her disabled account is re-enabled.
void	setReenableAccountTimeEnforced(boolean enforce) Sets whether a disabled account will be re-enabled after a specified length of time.
void	setResetLogonAttemptCount(int seconds) Sets the length of time that must pass before the count for logon attempts is reset to zero.
void	setSharedSecret(java.lang.String value) Sets a String that indicates the shared secret between client and server.
void	setSpecialcharacterEnforced(boolean enforce) Sets whether passwords must have special character.
void	setTrustedAuthenticationEnabled(boolean value) Sets a boolean value that indicates whether trusted authentication is enabled.
void	setTrustedPrincipalValidTime(int time) Sets a long that indicates in milliseconds how long the trusted principal will be valid.
void	setUnableToRepeatNPasswords(int numPasswords) Sets the number of recent passwords that cannot be reused.
void	setUnableToRepeatNPasswordsEnforced(boolean enforce) Sets whether previous passwords cannot be repeated.

Field Detail

KIND

static final java.lang.String KIND

The Kind used to query for the secEnterprise interface.

See Also:

Constant Field Values

PROGID

static final java.lang.String PROGID

The ProgID for the secEnterprise Class.

ProgID	CrystalEnterprise.SEC_ENTERPRISE
Query Category	CI_SYSTEMOBJECTS
Associated Interface	com.crystaldecisions.sdk.plugin.authentication.enterprise.IsecEnterprise

Query syntax:

SELECT
	SI_MAX_NUMBER_OF_ATTEMPTS, SI_MAX_PASSWORD_AGE, SI_MIN_PASSWORD_LENGTH, SI_MIN_TIME_BETWEEN_PASSWORD_CHANGES, SI_REENABLE_ACCOUNT_TIME, SI_FAILED_LOGIN_COUNTER_RESET_TIME, SI_UNABLE_TO_REPEAT_LAST_N_PASSWORDS, SI_DISABLE_ACCOUNT_AFTER_N_FAILED_LOGINS, SI_ENFORCE_MIN_PASSWORD_LENGTH, SI_FORCE_MIXED_CASE, SI_ENFORCE_MAX_PASSWORD_AGE, SI_ENFORCE_REENABLE_ACCOUNT_TIME, SI_ENFORCE_UNABLE_TO_REPEAT_LAST_N_PASSWORDS
FROM
	CI_SYSTEMOBJECTS
WHERE
	SI_NAME='secENTERPRISE'

Authentication plugins are static and non-creatable. This means that only the plugin itself exists and no instances. As there is only one secEnterprise object, and not multiple versions with the same ProgID, the CrystalEnterprise.SEC_ENTERPRISE plugin must be retrieved using the SI_NAME property.

The CePropertyIDs named in the SELECT statement are those that are required to access data through the IsecEnterprise interface. For more information on their associations with the interface's methods, see IsecEnterprise

See Also:

Constant Field Values

Method Detail

getMaxPasswordAge

int getMaxPasswordAge()

Returns the number of days before the password expires.

Returns:

An int specifying the number of days before the password expires.

InfoObject properties to query for:

SI_MAX_PASSWORD_AGE

setMaxPasswordAge

void setMaxPasswordAge(int seconds)

Sets the number of days before the password expires.

Parameters:

seconds - An int specifying the number of days before the password expires.

isPasswordAgeEnforced

boolean isPasswordAgeEnforced()

Returns true if users are required to change their password after a specified length of time, and false otherwise.

Returns:

true if users are required to change their password after a specified length of time, and false otherwise.

InfoObject properties to query for:

SI_ENFORCE_MAX_PASSWORD_AGE

setMaxPasswordAgeEnforced

void setMaxPasswordAgeEnforced(boolean enforce)

Sets whether users are required to change their password after a specified length of time.

Parameters:

enforce - true if users are required to change their password after a specified length of time, and false otherwise.

getMinPasswordLength

int getMinPasswordLength()

Returns the minimum number of characters that a password must have to be valid.

Returns:

An int specifying the minimum number of characters that a password must have to be valid.

InfoObject properties to query for:

SI_MIN_PASSWORD_LENGTH

setMinPasswordLength

void setMinPasswordLength(int length)

Sets the minimum number of characters that a password must have to be valid.

Parameters:

length - An int specifying the minimum number of characters that a password must have to be valid.

isMinPasswordLengthEnforced

boolean isMinPasswordLengthEnforced()

Returns true if passwords must contain a minimum number of characters, and false otherwise.

Returns:

true if passwords must contain a minimum number of characters, and false otherwise.

InfoObject properties to query for:

SI_ENFORCE_MIN_PASSWORD_LENGTH

setMinPasswordLengthEnforced

void setMinPasswordLengthEnforced(boolean enforce)

Sets whether passwords must contain a minimum number of characters.

Parameters:

enforce - true if passwords must contain a minimum number of characters, and false otherwise.

getUnableToRepeatNPasswords

int getUnableToRepeatNPasswords()

Returns the number of recent passwords that cannot be reused.

Returns:

An int specifying the number of recent passwords that cannot be reused.

InfoObject properties to query for:

SI_UNABLE_TO_REPEAT_LAST_N_PASSWORDS

setUnableToRepeatNPasswords

void setUnableToRepeatNPasswords(int numPasswords)

Sets the number of recent passwords that cannot be reused.

Parameters:

numPasswords - An int specifying the number of recent passwords that cannot be reused.

isUnableToRepeatNPasswordsEnforced

boolean isUnableToRepeatNPasswordsEnforced()

Returns true if previous passwords cannot be repeated, and false otherwise.

Returns:

true if previous passwords cannot be repeated, and false otherwise.

InfoObject properties to query for:

SI_ENFORCE_UNABLE_TO_REPEAT_LAST_N_PASSWORDS

setUnableToRepeatNPasswordsEnforced

void setUnableToRepeatNPasswordsEnforced(boolean enforce)

Sets whether previous passwords cannot be repeated.

Parameters:

enforce - true if previous passwords cannot be repeated, and false otherwise.

getReenableAccountTime

int getReenableAccountTime()

Returns the length of time the user must wait before his or her disabled account is re-enabled.

Returns:

An int specifying the length of time the user must wait before his or her disabled account is re-enabled.

InfoObject properties to query for:

SI_REENABLE_ACCOUNT_TIME

setReenableAccountTime

void setReenableAccountTime(int seconds)

Sets the length of time the user must wait before his or her disabled account is re-enabled.

Parameters:

seconds - An int specifying the length of time the user must wait before his or her disabled account is re-enabled.

isReenableAccountTimeEnforced

boolean isReenableAccountTimeEnforced()

Returns true if a disabled account will be re-enabled after a specified length of time, and false otherwise.

Returns:

true if a disabled account will be re-enabled after a specified length of time, and false otherwise.

InfoObject properties to query for:

SI_ENFORCE_REENABLE_ACCOUNT_TIME

setReenableAccountTimeEnforced

void setReenableAccountTimeEnforced(boolean enforce)

Sets whether a disabled account will be re-enabled after a specified length of time.

Parameters:

enforce - true if a disabled account will be re-enabled after a specified length of time, and false otherwise.

getMinTimeBetweenPasswordChanges

int getMinTimeBetweenPasswordChanges()

Returns the number of minutes that must pass before a user can change a password.

Returns:

An int specifying the number of minutes that must pass before a user can change a password.

InfoObject properties to query for:

SI_MIN_TIME_BETWEEN_PASSWORD_CHANGES

setMinTimeBetweenPasswordChanges

void setMinTimeBetweenPasswordChanges(int seconds)

Sets the number of minutes that must pass before a user can change a password.

Parameters:

seconds - An int specifying the number of minutes that must pass before a user can change a password.

isAccountDisabledAfterNFailedLogins

boolean isAccountDisabledAfterNFailedLogins()

Returns true if the account is disabled after a specified number of attempts to log on to the system, and false otherwise.

Returns:

true if the account is disabled after a specified number of attempts to log on to the system, and false otherwise.

InfoObject properties to query for:

SI_DISABLE_ACCOUNT_AFTER_N_FAILED_LOGINS

setAccountDisabledAfterNFailedLogins

void setAccountDisabledAfterNFailedLogins(boolean disable)

Sets whether the account is disabled after a specified number of attempts to log on to the system.

Parameters:

disable - true if the account is disabled after a specified number of attempts to log on to the system, and false otherwise.

getMaxNumberOfAttempts

int getMaxNumberOfAttempts()

Returns the number of times users can fail to log on to the system before their account is locked.

Returns:

An int specifying the number of times users can fail to log on to the system before their account is locked.

InfoObject properties to query for:

SI_MAX_NUMBER_OF_ATTEMPTS

setMaxNumberOfAttempts

void setMaxNumberOfAttempts(int attempts)

Sets the number of times users can fail to log on to the system before their account is locked.

Parameters:

attempts - An int specifying the number of times users can fail to log on to the system before their account is locked.

getResetLogonAttemptCount

int getResetLogonAttemptCount()

Returns the length of time that must pass before the count for logon attempts is reset to zero.

Returns:

An int specifying the length of time that must pass before the count for logon attempts is reset to zero.

InfoObject properties to query for:

SI_FAILED_LOGIN_COUNTER_RESET_TIME

setResetLogonAttemptCount

void setResetLogonAttemptCount(int seconds)

Sets the length of time that must pass before the count for logon attempts is reset to zero.

Parameters:

seconds - An int specifying the length of time that must pass before the count for logon attempts is reset to zero.

isMixedCaseEnforced

boolean isMixedCaseEnforced()

Returns true if passwords must be mixed-case, and false otherwise.

Returns:

true if passwords must be mixed-case, and false otherwise.

InfoObject properties to query for:

SI_FORCE_MIXED_CASE

setMixedCaseEnforced

void setMixedCaseEnforced(boolean enforce)

Sets whether passwords must be mixed-case.

Parameters:

enforce - true if passwords must be mixed-case, and false otherwise.

isSpecialcharacterEnforced

boolean isSpecialcharacterEnforced()

Returns true if passwords must have special character, and false otherwise.

Returns:

true if passwords must have special character, and false otherwise.

InfoObject properties to query for:

SI_FORCE_SPECIAL_CASE

setSpecialcharacterEnforced

void setSpecialcharacterEnforced(boolean enforce)

Sets whether passwords must have special character.

Parameters:

enforce - true if passwords must have special character, and false otherwise.

isNumericEnforced

boolean isNumericEnforced()

Returns true if passwords must have numeric character, and false otherwise.

Returns:

true if passwords must have numeric character, and false otherwise.

InfoObject properties to query for:

SI_FORCE_NUMBER

setNumericEnforced

void setNumericEnforced(boolean enforce)

Sets whether passwords must be numeric character.

Parameters:

enforce - true if passwords must have numeric characters, and false otherwise.

isTrustedAuthenticationEnabled

boolean isTrustedAuthenticationEnabled()

Returns a boolean value that indicates whether trusted authentication is enabled.

Returns:

A boolean value that indicates whether trusted authentication is enabled.

InfoObject properties to query for:

SI_TRUSTED_AUTH_ENABLED

setTrustedAuthenticationEnabled

void setTrustedAuthenticationEnabled(boolean value)

Sets a boolean value that indicates whether trusted authentication is enabled.

Set to true to enable trusted authentication.

Parameters:

value - A boolean value that indicates whether trusted authentication is enabled.

setSharedSecret

void setSharedSecret(java.lang.String value)
                     throws SDKException

Sets a String that indicates the shared secret between client and server.

Parameters:

value - A String that contains the shared secret.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isSharedSecretNotEmpty

boolean isSharedSecretNotEmpty()
                               throws SDKException

Returns a boolean value that indicates whether the password is set and not empty.

Returns:

A boolean value that indicates whether the password is set and not empty.

Throws:

SDKException - This is thrown if the process is unsuccessful.

InfoObject properties to query for:

SI_SHARED_SECRET

getTrustedPrincipalValidTime

int getTrustedPrincipalValidTime()
                                 throws SDKException

Returns a long that indicates in milliseconds how long the trusted principal will be valid.

Returns:

A long that indicates in milliseconds how long the trusted principal will be valid.

Throws:

SDKException - This is thrown if the process is unsuccessful.

InfoObject properties to query for:

SI_TRUSTEDUSER_VALIDMS

setTrustedPrincipalValidTime

void setTrustedPrincipalValidTime(int time)

Sets a long that indicates in milliseconds how long the trusted principal will be valid.

Parameters:

time - A long that indicates in milliseconds how long the trusted principal will be valid.

getMaxSharedSecretAge

int getMaxSharedSecretAge()

Returns the number of days before the shared secret expires.

Returns:

An int specifying the number of days before the shared secret expires.

InfoObject properties to query for:

SI_MAX_SHAREDSECRET_AGE

setMaxSharedSecretAge

void setMaxSharedSecretAge(int days)

Sets the number of days before the shared secret expires.

Parameters:

days - An int specifying the number of days before the shared secret expires.

getLastSharedSecretChangeTime

java.util.Date getLastSharedSecretChangeTime()

Returns the last modification time of the shared secret.

Returns:

A Date that indicates the last modification time of the shared secret.

InfoObject properties to query for:

SI_LAST_SHAREDSECRET_CHANGE_TIME