psdi.security

Class AdminModeManager

java.lang.Object

psdi.security.AdminModeManager

All Implemented Interfaces:

MaximoCache, FixedLoggerNames, FixedLoggers

public class AdminModeManager
extends java.lang.Object
implements MaximoCache, FixedLoggers

Admin Mode manager, used to start and stop Admin Mode for this instance. Admin Mode is used when it's necessary to run a utility with MXServer up, but with all non-admin users logged off and activities such as Cron Tasks and Events inactivated.

To coordinate Admin Mode for all instances on this database, use MXServer reloadCache method with cache name ADMINMODE and cache key equal to ON or OFF. Call the MXServer method isAdminModeOn(true) to ensure that all instances are in Admin Mode before running the utility.

See Also:

MXServer.reloadMaximoCache(String, String, boolean), MXServer.isAdminModeOn(boolean), isAdminModeOnThisInstance(), isAdminModePendingThisInstance(), isAdminModeForAllInstances(boolean)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADMIN_CANCEL Value for reloadCache key to cancel a request for Admin Mode.
static java.lang.String	ADMIN_LOGOUTMIN Value for reloadCache key change Lotout Minutes for pending Admin Mode.
static java.lang.String	ADMIN_OFF Value for reloadCache key to turn off Admin Mode.
static java.lang.String	ADMIN_ON Value for reloadCache key to turn on Admin Mode.

Fields inherited from interface psdi.util.logging.FixedLoggers

APPLOGGER, CRONTASKLOGGER, CRONTASKMGRLOGGER, CRONTASKMGRSQLLOGGER, DBCONNECTIONLOGGER, DDLOGGER, DMLOGGER, EVENTLOGGER, EXCEPTIONLOGGER, MAILLOGGER, MAXIMOLOGGER, MTLOGGER, NULLMBOPOINTER, SECURITY, SENDFAILEDLOGGER, SERVICELOGGER, SQLLOGGER

Fields inherited from interface psdi.util.logging.FixedLoggerNames

appenderPrefix, LOGGERNAME_APP, LOGGERNAME_CRONTASK, LOGGERNAME_CRONTASKMGR, LOGGERNAME_DBCONNECTION, LOGGERNAME_DD, LOGGERNAME_DM, LOGGERNAME_DMPREVIEW, LOGGERNAME_EVENT, LOGGERNAME_EXCEPTION, LOGGERNAME_MAIL, LOGGERNAME_MAXIMO, LOGGERNAME_MT, LOGGERNAME_NULLMBOPOINTER, LOGGERNAME_SECURITY, LOGGERNAME_SENDFAILED, LOGGERNAME_SERVICE, LOGGERNAME_SQL, LOGGERNAME_SQL_CRONTASKMGR, LOGGERNAME_TXN, loggerPrefix

Constructor Summary

Constructors

Constructor and Description
AdminModeManager()

Method Summary

Modifier and Type	Method and Description
void	clearListeners() Clear adminListeners.
java.lang.String	getName() Return ADMINMODE.
void	init() Set adminMode to false.
boolean	isAdminModeForAllInstances(boolean activeVal) Check whether Admin Mode has the value specified for all instances of MXServer sharing this database.
boolean	isAdminModeOnThisInstance() Identifies whether this instance is in Admin Mode.
boolean	isAdminModePendingThisInstance() Identifies whether this instance is entering Admin Mode.
boolean	isAdminModeTurningOffThisInstance() Identifies whether Admin Mode is in the middle of being turned off for this instance.
boolean	isTenantAdminMode()
void	listenToAdmin(MboRemote listenerMbo, boolean listen) Register another listener for Admin Mode change.
void	reload() Do nothing.
void	reload(java.lang.String key) Turn AdminMode on or off.
void	setTenantAdminMode(boolean tenantAdminMode)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ADMIN_ON

public static java.lang.String ADMIN_ON

Value for reloadCache key to turn on Admin Mode.

ADMIN_OFF

public static java.lang.String ADMIN_OFF

Value for reloadCache key to turn off Admin Mode.

ADMIN_CANCEL

public static java.lang.String ADMIN_CANCEL

Value for reloadCache key to cancel a request for Admin Mode.

ADMIN_LOGOUTMIN

public static java.lang.String ADMIN_LOGOUTMIN

Value for reloadCache key change Lotout Minutes for pending Admin Mode.

Constructor Detail

AdminModeManager

public AdminModeManager()

Method Detail

init

public void init()
          throws MXException

Set adminMode to false.

Specified by:

init in interface MaximoCache

Throws:

MXException

getName

public java.lang.String getName()

Return ADMINMODE.

Specified by:

getName in interface MaximoCache

Returns:

See Also:

MaximoCache.getName()

reload

public void reload()
            throws MXException

Do nothing. To toggle Admin Mode, must reload with key.

Specified by:

reload in interface MaximoCache

Throws:

MXException

reload

public void reload(java.lang.String key)
            throws MXException

Turn AdminMode on or off.

Specified by:

reload in interface MaximoCache

Parameters:

key - "ON" or "OFF". On will turn on Admin Mode. Off will turn it off.

Throws:

MXException

See Also:

setAdminON(), setAdminOFF(boolean), changeLogoutMin()

isAdminModeOnThisInstance

public boolean isAdminModeOnThisInstance()

Identifies whether this instance is in Admin Mode.

Returns:

True if in Admin Mode, else False.

isAdminModePendingThisInstance

public boolean isAdminModePendingThisInstance()

Identifies whether this instance is entering Admin Mode. The variable adminModePending identifies whether the instance is entering Admin Mode. The variable adminMode identifies whether Admin Mode is fully accomplished.

Returns:

True if entering Admin Mode, else False.

isAdminModeTurningOffThisInstance

public boolean isAdminModeTurningOffThisInstance()

Identifies whether Admin Mode is in the middle of being turned off for this instance. The variable adminModeTurningOff identifies whether the instance is Admin Mode is being turned off. The variable adminMode identifies whether Admin Mode is fully accomplished.

Returns:

True if Admin Mode is in the process of being turned off, else False.

isAdminModeForAllInstances

public boolean isAdminModeForAllInstances(boolean activeVal)
                                   throws MXException,
                                          java.rmi.RemoteException

Check whether Admin Mode has the value specified for all instances of MXServer sharing this database.

Parameters:

activeVal - True to check whether Admin Mode is ON for all instances. False to check whether Admin Mode is OFF for all instances.

Returns:

True if all instances have the value of Admin Mode specified in the input parameter.

Throws:

MXException

java.rmi.RemoteException

listenToAdmin

public void listenToAdmin(MboRemote listenerMbo,
                          boolean listen)
                   throws MXException,
                          java.rmi.RemoteException

Register another listener for Admin Mode change.

Parameters:

listenerMbo - ProcessMonitor mbo.

listen - True to start listening, False to stop listening

Throws:

MXException

java.rmi.RemoteException

clearListeners

public void clearListeners()

Clear adminListeners.

isTenantAdminMode

public boolean isTenantAdminMode()

setTenantAdminMode

public void setTenantAdminMode(boolean tenantAdminMode)