com.starbase.starteam
Class SystemPolicy

java.lang.Object
  |
  +--com.starbase.starteam.SystemPolicy

public class SystemPolicy

extends java.lang.Object

Field Summary

static int	ALLOW_BLANK_PASSWORDS Indicates that blank passwords are permitted.
static int	FAILED_LOGIN_NO_LIMIT Indicates that the number of failed login attempts is unlimited.
static int	LOCKOUT_FOREVER Indicates that the user will be locked out until explicitly unlocked by the administrator.
static int	PASSWORDS_NEVER_EXPIRE Indicates that passwords never expire.
static int	SECURITYLOG_AUTOPURGE_DEFAULT By default, the security log is purged after this many days.
static int	SECURITYLOG_AUTOPURGE_NEVER Indicates that the security log is never purged.

Constructor Summary

SystemPolicy(SystemPolicy source)
construct a SystemPolicy instance from the specified source

Method Summary

SystemPolicy	copy() returns a copy of this SystemPolicy instance
boolean	equals(java.lang.Object theOther) returns true if the paramter is a System Policy whose values are identical to those of this instance
int	getFailedLoginLimit() Gets the number of acceptable failed login attempts.
int	getFailedLoginLockout() Gets the number of minutes a user will be locked out after exceeding the failed login limit.
int	getMinimumPasswordLength() Gets the minimum allowable password length.
boolean	getNotifyByEmail() Indicates whether or not security administrators will be notified of login lockouts by email.
int	getPasswordExpirationPeriod() Gets the number of days after which a password will expire.
int	getSecurityLogAutoPurgeDays() Gets the number of days of information that will be saved in the server's security log.
boolean	getSkipGroupPrivilegesCheck() Indicates whether or not access validation will ignore group privileges.
boolean	getSkipOwnershipCheck() Indicates whether or not access validation will ignore object ownership.
boolean	getStrongPasswordRulesEnforced() Indicates whether or not strong password rules are enforced.
int	hashCode() returns a unique hash for all instances of this type
boolean	isEqualTo(SystemPolicy theOther) returns true if the paramter is a System Policy whose values are identical to those of this instance
boolean	isStrongPasswordRulesSupported() Deprecated. All supported versions of the StarTeam server support strong password rules. This method always returns true.
void	setFailedLoginLimit(int nAttempts) Sets the number of acceptable failed login attempts.
void	setFailedLoginLockout(int nMinutes) Sets the number of minutes a user will be locked out after exceeding the failed login limit.
void	setMinimumPasswordLength(int length) Sets the minimum allowable password length.
void	setNotifyByEmail(boolean bAlert) Sets whether or not security administrators will be notified of login lockouts by email.
void	setPasswordExpirationPeriod(int nDays) Sets the number of days after which a password will expire.
void	setSecurityLogAutoPurgeDays(int nDays) Sets the number of days of information that will be saved in the server's security log.
void	setSkipGroupPrivilegesCheck(boolean bSkip) Sets whether or not access validation will ignore group privileges.
void	setSkipOwnershipCheck(boolean bSkip) Sets whether or not access validation will ignore object ownership.
void	setStrongPasswordRulesEnforced(boolean bStrongPasswords) Sets whether or not strong password rules will be enforced.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALLOW_BLANK_PASSWORDS

public static final int ALLOW_BLANK_PASSWORDS

Indicates that blank passwords are permitted.

See Also:

SystemPolicy.setMinimumPasswordLength(int), Constant Field Values

PASSWORDS_NEVER_EXPIRE

public static final int PASSWORDS_NEVER_EXPIRE

Indicates that passwords never expire.

See Also:

SystemPolicy.setPasswordExpirationPeriod(int), Constant Field Values

FAILED_LOGIN_NO_LIMIT

public static final int FAILED_LOGIN_NO_LIMIT

Indicates that the number of failed login attempts is unlimited.

See Also:

SystemPolicy.setFailedLoginLimit(int), Constant Field Values

LOCKOUT_FOREVER

public static final int LOCKOUT_FOREVER

Indicates that the user will be locked out until explicitly unlocked by the administrator.

See Also:

SystemPolicy.setFailedLoginLockout(int), Constant Field Values

SECURITYLOG_AUTOPURGE_NEVER

public static final int SECURITYLOG_AUTOPURGE_NEVER

Indicates that the security log is never purged.

See Also:

SystemPolicy.setSecurityLogAutoPurgeDays(int), Constant Field Values

SECURITYLOG_AUTOPURGE_DEFAULT

public static final int SECURITYLOG_AUTOPURGE_DEFAULT

By default, the security log is purged after this many days.

See Also:

SystemPolicy.setSecurityLogAutoPurgeDays(int), Constant Field Values

Constructor Detail

SystemPolicy

public SystemPolicy(SystemPolicy source)

construct a SystemPolicy instance from the specified source

Parameters:

source - SystemPolicy a SystemPolicy instance to copy from

Method Detail

copy

public SystemPolicy copy()

returns a copy of this SystemPolicy instance

Returns:

SystemPolicy a copy of this SystemPolicy instance

equals

public boolean equals(java.lang.Object theOther)

returns true if the paramter is a System Policy whose values are identical to those of this instance

Overrides:

equals in class java.lang.Object

Parameters:

theOther - Object the other System Policy instance to be evaluated

Returns:

boolean true if the the other System Policy has values identical to those of this instance

isEqualTo

public boolean isEqualTo(SystemPolicy theOther)

returns true if the paramter is a System Policy whose values are identical to those of this instance

Parameters:

theOther - Object the other System Policy instance to be evaluated

Returns:

boolean true if the the other System Policy has values identical to those of this instance

getSkipOwnershipCheck

public boolean getSkipOwnershipCheck()

Indicates whether or not access validation will ignore object ownership. This property is supported by StarTeam 4.2 or later.

Returns:

true if access validation will ignore object ownership, and false otherwise.

setSkipOwnershipCheck

public void setSkipOwnershipCheck(boolean bSkip)

Sets whether or not access validation will ignore object ownership. This property is supported by StarTeam 4.2 or later.

Parameters:

bSkip - true if access validation should ignore object ownership, and false otherwise.

See Also:

SystemPolicy.setSkipGroupPrivilegesCheck(boolean)

getSkipGroupPrivilegesCheck

public boolean getSkipGroupPrivilegesCheck()

Indicates whether or not access validation will ignore group privileges. This property is supported by StarTeam 4.2 or later.

Returns:

true if access validation will ignore group privileges, and false otherwise.

setSkipGroupPrivilegesCheck

public void setSkipGroupPrivilegesCheck(boolean bSkip)

Sets whether or not access validation will ignore group privileges. This property is supported by StarTeam 4.2 or later.

Parameters:

bSkip - true if access validation should group privileges ownership, and false otherwise.

See Also:

SystemPolicy.setSkipOwnershipCheck(boolean)

isStrongPasswordRulesSupported

public boolean isStrongPasswordRulesSupported()

Deprecated. All supported versions of the StarTeam server support strong password rules. This method always returns true.

Indicates whether or not the "strong password rules" feature is supported by the server.

Returns:

true if the "strong password rules" feature is supported by the server.

See Also:

SystemPolicy.getStrongPasswordRulesEnforced()

getStrongPasswordRulesEnforced

public boolean getStrongPasswordRulesEnforced()

Indicates whether or not strong password rules are enforced.

Returns:

true if strong password rules are enforced, and false otherwise.

setStrongPasswordRulesEnforced

public void setStrongPasswordRulesEnforced(boolean bStrongPasswords)

Sets whether or not strong password rules will be enforced.

Parameters:

bStrongPasswords - true if strong password rules will be enforced, and false otherwise.

See Also:

SystemPolicy.isStrongPasswordRulesSupported()

getMinimumPasswordLength

public int getMinimumPasswordLength()

Gets the minimum allowable password length.

Returns:

The minimum password length.

setMinimumPasswordLength

public void setMinimumPasswordLength(int length)

Sets the minimum allowable password length.

Parameters:

length - The minimum password length.

See Also:

SystemPolicy.ALLOW_BLANK_PASSWORDS

getPasswordExpirationPeriod

public int getPasswordExpirationPeriod()

Gets the number of days after which a password will expire.

Returns:

The number of days after which a password will expire.

setPasswordExpirationPeriod

public void setPasswordExpirationPeriod(int nDays)

Sets the number of days after which a password will expire.

Parameters:

nDays - The password expiration period, in days.

See Also:

SystemPolicy.PASSWORDS_NEVER_EXPIRE

getFailedLoginLimit

public int getFailedLoginLimit()

Gets the number of acceptable failed login attempts.

Returns:

The number of acceptable failed login attempts.

setFailedLoginLimit

public void setFailedLoginLimit(int nAttempts)

Sets the number of acceptable failed login attempts.

Parameters:

nAttempts - The number of acceptable failed login attempts.

See Also:

SystemPolicy.FAILED_LOGIN_NO_LIMIT

getFailedLoginLockout

public int getFailedLoginLockout()

Gets the number of minutes a user will be locked out after exceeding the failed login limit.

Returns:

The number of minutes a user will be locked out after exceeding the failed login limit.

setFailedLoginLockout

public void setFailedLoginLockout(int nMinutes)

Sets the number of minutes a user will be locked out after exceeding the failed login limit.

Parameters:

nMinutes - The number of minutes a user will be locked out after exceeding the failed login limit.

See Also:

SystemPolicy.LOCKOUT_FOREVER

getNotifyByEmail

public boolean getNotifyByEmail()

Indicates whether or not security administrators will be notified of login lockouts by email.

Returns:

true if security administrators will be notified by email.

setNotifyByEmail

public void setNotifyByEmail(boolean bAlert)

Sets whether or not security administrators will be notified of login lockouts by email.

Parameters:

bAlert - true if security administrators will be notified by email, and false otherwise.

getSecurityLogAutoPurgeDays

public int getSecurityLogAutoPurgeDays()

Gets the number of days of information that will be saved in the server's security log. This property is supported by StarTeam 4.1 or later.

Returns:

The number of days of information that will be saved.

setSecurityLogAutoPurgeDays

public void setSecurityLogAutoPurgeDays(int nDays)

Sets the number of days of information that will be saved in the server's security log. This property is supported by StarTeam 4.1 or later.

Parameters:

nDays - The number of days of information that will be saved.

See Also:

SystemPolicy.SECURITYLOG_AUTOPURGE_NEVER, SystemPolicy.SECURITYLOG_AUTOPURGE_DEFAULT

hashCode

public int hashCode()

returns a unique hash for all instances of this type

Overrides:

hashCode in class java.lang.Object

Returns:

int a unique hash for all instances of this type