BEA Systems, Inc.

Type-Safe Access to BEA WebLogic Server 9.0 MBeans (Deprecated)


weblogic.management.runtime
Interface UserLockoutManagerRuntimeMBean

All Superinterfaces:
DynamicMBean, MBeanRegistration, NotificationBroadcaster, weblogic.management.runtime.RuntimeMBean, WebLogicMBean

public interface UserLockoutManagerRuntimeMBean
extends weblogic.management.runtime.RuntimeMBean

This class is used to monitor and manage per security realm user lockout information.

Since:
9.0.0.0
Copyright © 2005 BEA Systems, Inc. All Rights Reserved.

Method Summary
 void clearLockout(String userName)
          Unlocks a user account.
 long getInvalidLoginAttemptsTotalCount()
          Returns the number of invalid logins attempted since this server has been started and lockouts have been enabled.
 long getInvalidLoginUsersHighCount()
          Returns the highest number of users with concurrent unexpired or uncleared invalid login attempts.
 long getLastLoginFailure(String userName)
          Returns a string that indicates the time of the last invalid login for this user.
 long getLockedUsersCurrentCount()
          Returns the number of users that are currently locked out of this server.
 long getLoginAttemptsWhileLockedTotalCount()
          Returns the number of invalid logins attempted since this server has been started and lockouts have been enabled.
 long getLoginFailureCount(String userName)
          Returns the current count of login failures for a specific user.
 long getUnlockedUsersTotalCount()
          Returns the number times users have been unlocked since this server has been started.
 long getUserLockoutTotalCount()
          Returns the number of user lockouts that have occured since this server has been started.
 boolean isLockedOut(String userName)
          Indicates whether a user is locked out.
 
Methods inherited from interface weblogic.management.WebLogicMBean
getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent
 
Methods inherited from interface javax.management.DynamicMBean
getAttribute, getAttributes, invoke, setAttribute, setAttributes
 
Methods inherited from interface javax.management.MBeanRegistration
postDeregister, postRegister, preDeregister, preRegister
 
Methods inherited from interface javax.management.NotificationBroadcaster
addNotificationListener, getNotificationInfo, removeNotificationListener
 

Method Detail

clearLockout

public void clearLockout(String userName)
Unlocks a user account.

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

getInvalidLoginAttemptsTotalCount

public long 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.


getInvalidLoginUsersHighCount

public long 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.


getLastLoginFailure

public long getLastLoginFailure(String userName)
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.

getLockedUsersCurrentCount

public long getLockedUsersCurrentCount()
Returns the number of users that are currently locked out of this server.


getLoginAttemptsWhileLockedTotalCount

public long getLoginAttemptsWhileLockedTotalCount()
Returns the number of invalid logins attempted since this server has been started and lockouts have been enabled.


getLoginFailureCount

public long getLoginFailureCount(String userName)
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.

getUnlockedUsersTotalCount

public long getUnlockedUsersTotalCount()
Returns the number times users have been unlocked since this server has been started.


getUserLockoutTotalCount

public long 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.


isLockedOut

public boolean isLockedOut(String userName)
Indicates whether a user is locked out.

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

Documentation is available at
http://download.oracle.com/docs/cd/E13222_01/wls/docs90
Copyright 2005 BEA Systems Inc.