Package weblogic.management.security.authentication

Interface UserLockoutManagerMBean

All Superinterfaces:

DescriptorBean, SettableBean, StandardInterface

public interface UserLockoutManagerMBean
extends StandardInterface, DescriptorBean

Lists and manages lockouts on user accounts.

Method Summary

Modifier and Type	Method	Description
void	clearLockout(java.lang.String userName)	Deprecated. 9.0.0.0 Replaced by UserLockoutManagerRuntimeMBean.clearLockout(String)
long	getInvalidLoginAttemptsTotalCount()	Deprecated. 9.0.0.0 Replaced by UserLockoutManagerRuntimeMBean.getInvalidLoginAttemptsTotalCount()
long	getInvalidLoginUsersHighCount()	Deprecated. 9.0.0.0 Replaced by UserLockoutManagerRuntimeMBean.getInvalidLoginUsersHighCount()
long	getLastLoginFailure(java.lang.String userName)	Deprecated. 9.0.0.0 Replaced by UserLockoutManagerRuntimeMBean.getLastLoginFailure(String)
long	getLockedUsersCurrentCount()	Deprecated. 9.0.0.0 Replaced by UserLockoutManagerRuntimeMBean.getLockedUsersCurrentCount()
long	getLockoutCacheSize()	Returns the number of invalid login records that the server places in a cache.
long	getLockoutDuration()	Returns the number of minutes that a user account is locked out.
long	getLockoutGCThreshold()	Returns the maximum number of invalid login records that the server keeps in memory.
long	getLockoutResetDuration()	The number of minutes within which consecutive invalid login attempts cause the user account to be locked out.
long	getLockoutThreshold()	Returns the maximum number of consecutive invalid login attempts before account is locked out.
long	getLoginAttemptsWhileLockedTotalCount()	Deprecated. 9.0.0.0 Replaced by UserLockoutManagerRuntimeMBean.getLoginAttemptsWhileLockedTotalCount()
long	getLoginFailureCount(java.lang.String userName)	Deprecated. 9.0.0.0 Replaced by UserLockoutManagerRuntimeMBean.getLoginFailureCount(String)
java.lang.String	getName()	The name of this configuration.
RealmMBean	getRealm()	Returns the realm that contains this user lockout manager.
long	getUnlockedUsersTotalCount()	Deprecated. 9.0.0.0 Replaced by UserLockoutManagerRuntimeMBean.getUnlockedUsersTotalCount()
long	getUserLockoutTotalCount()	Deprecated. 9.0.0.0 Replaced by UserLockoutManagerRuntimeMBean.getUserLockoutTotalCount()
boolean	isLockedOut(java.lang.String userName)	Deprecated. 9.0.0.0 Replaced by UserLockoutManagerRuntimeMBean.isLockedOut(String)
boolean	isLockoutEnabled()	Returns whether the server locks out users when there are invalid login attempts.
void	setLockoutCacheSize(long lockoutCacheSize)	Sets the number of invalid login records that the server places in a cache.
void	setLockoutDuration(long lockoutDuration)	Sets the number of minutes that a user account is locked out.
void	setLockoutEnabled(boolean lockoutEnabled)	Sets whether the server locks out users when there are invalid login attempts.
void	setLockoutGCThreshold(long lockoutGCThreshold)	Sets the maximum number of invalid login records that the server keeps in memory.
void	setLockoutResetDuration(long newValue)	The number of minutes within which consecutive invalid login attempts cause the user account to be locked out.
void	setLockoutThreshold(long lockoutThreshold)	Sets the maximum number of consecutive invalid login attempts before account is locked out.

Methods inherited from interface weblogic.descriptor.DescriptorBean

addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener

Method Detail

getUserLockoutTotalCount

@Deprecated
long getUserLockoutTotalCount()

Deprecated.

9.0.0.0 Replaced by UserLockoutManagerRuntimeMBean.getUserLockoutTotalCount()

Returns the number of user lockouts that have occured since this server has been started. In a cluster, this method returns the number of user lockouts that have occured since the cluster has been started because all servers share login failure information.

getInvalidLoginAttemptsTotalCount

@Deprecated
long getInvalidLoginAttemptsTotalCount()

Deprecated.

9.0.0.0 Replaced by UserLockoutManagerRuntimeMBean.getInvalidLoginAttemptsTotalCount()

Returns the number of invalid logins attempted since this server has been started and lockouts have been enabled. In a cluster, this method returns the number of invalid logins attempted that have occured since the cluster has been started because all servers share login failure information.

getLoginAttemptsWhileLockedTotalCount

@Deprecated
long getLoginAttemptsWhileLockedTotalCount()

Deprecated.

9.0.0.0 Replaced by UserLockoutManagerRuntimeMBean.getLoginAttemptsWhileLockedTotalCount()

Returns the number of invalid logins attempted since this server has been started and lockouts have been enabled.

getInvalidLoginUsersHighCount

@Deprecated
long getInvalidLoginUsersHighCount()

Deprecated.

9.0.0.0 Replaced by UserLockoutManagerRuntimeMBean.getInvalidLoginUsersHighCount()

Returns the highest number of users with concurrent unexpired or uncleared invalid login attempts. Invalid login attempts expire as specified by LockoutResetDuration. This count is useful in determining whether the LockoutCacheSize needs to be modified.

getUnlockedUsersTotalCount

@Deprecated
long getUnlockedUsersTotalCount()

Deprecated.

9.0.0.0 Replaced by UserLockoutManagerRuntimeMBean.getUnlockedUsersTotalCount()

Returns the number times users have been unlocked since this server has been started.

getLockedUsersCurrentCount

@Deprecated
long getLockedUsersCurrentCount()

Deprecated.

9.0.0.0 Replaced by UserLockoutManagerRuntimeMBean.getLockedUsersCurrentCount()

Returns the number of users that are currently locked out of this server.

getRealm

RealmMBean getRealm()

Returns the realm that contains this user lockout manager. Returns null if this security provider is not contained by a realm.

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

isLockoutEnabled

boolean isLockoutEnabled()

Returns whether the server locks out users when there are invalid login attempts. A true value for this attribute causes the server to consider the other attributes of this MBean. A false value causes the server to ignore the other attributes of this MBean."

Default Value:

true

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

setLockoutEnabled

void setLockoutEnabled(boolean lockoutEnabled)
                throws javax.management.InvalidAttributeValueException

Sets whether the server locks out users when there are invalid login attempts.

Parameters:

lockoutEnabled - - the new lockout enabled value

Throws:

javax.management.InvalidAttributeValueException

See Also:

isLockoutEnabled()

getLockoutThreshold

long getLockoutThreshold()

Returns the maximum number of consecutive invalid login attempts before account is locked out. When the number of invalid logins within a specified period of time is greater than LockoutThresholdvalue, the user is locked out. For example, with the default setting of 1, the user is locked out on the second consecutive invalid login. With a setting of 2, the user is locked out on the third consecutive invalid login.

Default Value:

5

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

1

setLockoutThreshold

void setLockoutThreshold(long lockoutThreshold)
                  throws javax.management.InvalidAttributeValueException

Sets the maximum number of consecutive invalid login attempts before account is locked out.

Parameters:

lockoutThreshold - - the new lockout threshold

Throws:

javax.management.InvalidAttributeValueException

See Also:

getLockoutThreshold()

getLockoutDuration

long getLockoutDuration()

Returns the number of minutes that a user account is locked out.

Default Value:

30

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

0

setLockoutDuration

void setLockoutDuration(long lockoutDuration)
                 throws javax.management.InvalidAttributeValueException

Sets the number of minutes that a user account is locked out.

Parameters:

lockoutDuration - - the new lockout duration in minutes

Throws:

javax.management.InvalidAttributeValueException

See Also:

getLockoutDuration()

getLockoutResetDuration

long getLockoutResetDuration()

The number of minutes within which consecutive invalid login attempts cause the user account to be locked out.

Default Value:

5

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

1

setLockoutResetDuration

void setLockoutResetDuration(long newValue)
                      throws javax.management.InvalidAttributeValueException

The number of minutes within which consecutive invalid login attempts cause the user account to be locked out.

Parameters:

newValue - - new value for attribute LockoutResetDuration

Throws:

javax.management.InvalidAttributeValueException

See Also:

getLockoutResetDuration()

getLockoutCacheSize

long getLockoutCacheSize()

Returns the number of invalid login records that the server places in a cache. The server creates one record for each invalid login.

Default Value:

5

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

0

setLockoutCacheSize

void setLockoutCacheSize(long lockoutCacheSize)
                  throws javax.management.InvalidAttributeValueException

Sets the number of invalid login records that the server places in a cache.

Parameters:

lockoutCacheSize - - the new lockout cache size

Throws:

javax.management.InvalidAttributeValueException

See Also:

getLockoutCacheSize()

getLockoutGCThreshold

long getLockoutGCThreshold()

Returns the maximum number of invalid login records that the server keeps in memory.

If the number of invalid login records is equal to or greater than this value, the server's garbage collection purges the records that have expired. A record expires when the user associated with the record has been locked out.

The lower the threshold, the more often the server uses its resources to collect garbage.

Default Value:

400

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

0

setLockoutGCThreshold

void setLockoutGCThreshold(long lockoutGCThreshold)
                    throws javax.management.InvalidAttributeValueException

Sets the maximum number of invalid login records that the server keeps in memory.

Parameters:

lockoutGCThreshold - - the new lockout garbage collection threshold

Throws:

javax.management.InvalidAttributeValueException

See Also:

getLockoutGCThreshold()

isLockedOut

@Deprecated
boolean isLockedOut(java.lang.String userName)

Deprecated.

9.0.0.0 Replaced by UserLockoutManagerRuntimeMBean.isLockedOut(String)

Indicates whether a user is locked out.

Parameters:

userName - - A user name. If the user does not exist, this method returns false.

clearLockout

@Deprecated
void clearLockout(java.lang.String userName)

Deprecated.

9.0.0.0 Replaced by UserLockoutManagerRuntimeMBean.clearLockout(String)

Unlocks a user account.

Parameters:

userName - - A user name. If the user does not exist, this method returns false.

getLastLoginFailure

@Deprecated
long getLastLoginFailure(java.lang.String userName)

Deprecated.

9.0.0.0 Replaced by UserLockoutManagerRuntimeMBean.getLastLoginFailure(String)

Returns a string that indicates the time of the last invalid login for this user.

Parameters:

userName - - A user name. If the user does not exist, this method returns false.

getLoginFailureCount

@Deprecated
long getLoginFailureCount(java.lang.String userName)

Deprecated.

9.0.0.0 Replaced by UserLockoutManagerRuntimeMBean.getLoginFailureCount(String)

Returns the current count of login failures for a specific user. This value returns to

Parameters:

userName - - A user name. If the user does not exist, this method returns false.

getName

java.lang.String getName()

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Specified by:

getName in interface StandardInterface

Default Value:

"UserLockoutManager"

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.