com.ibm.retail.AEF.mgmt
Interface SessionMBean

All Superinterfaces:
MgmtExtendedControlMBean

public interface SessionMBean
extends MgmtExtendedControlMBean

Specifies the management interface for the AEFSession object.

An AEFSession represents a POS terminal (virtual or real) that can be used to access POS terminal application functionality without regard to the particular type of application that is providing that functionality. The purpose of this MBean is to expose certain information about the AEFSession and to emit notifications when various status changes occur.

This interface extends the com.ibm.retail.si.mgmt.MgmtExtendedControlMBean interface which allows "helper" MBeans to be dynamically created to provide extended control functions (e.g., debug and logging). See SessionDebugMBean and SessionControlMBean for more information.

The ObjectName of this MBean includes the following attributes, in addition to the SIF attributes of StoreID and DeviceID:

This management interface includes the following attributes. These attributes are described in more detail in the accessor methods. No operations are included in this management interface other than those specified by the MgmtExtendedControlMbean interface.

An RtlDebugNotification is emitted by classes implementing this interface when the following conditions occur. The type of the notification is SESSION_TYPE. The constants referenced in the notification description indicate the possible values of the notification userData. Unless otherwise noted, the userData will be of type String. The notification names in the list below indicate the constants that are used for the notification message text.


Field Summary
static java.lang.String ONLINE_STATUS_UPDATE
          Used as notification message text
static java.lang.String OPERATOR_LOGGED_OFF
          Used as a return value for getOperatorStatus to indicate that the operator is logged off
static java.lang.String OPERATOR_LOGGED_ON
          Used as a return value for getOperatorStatus to indicate that the operator is logged on
static java.lang.String OPERATOR_STATUS_UPDATE
          Used as notification message text
static java.lang.String POS_APPLICATION_ACTIVE
          Used as a return value for getPOSApplicationStatus to indicate that the application is active
static java.lang.String POS_APPLICATION_INACTIVE
          Used as a return value for getPOSApplicationStatus to indicate that the application is inactive
static java.lang.String SESSION_TYPE
          Used as notification type for notifications generated by classes implementing this interface
static java.lang.String TERMINAL_OFFLINE
          Used as a return value for getOnlineStatus to indicate that the terminal is offline
static java.lang.String TERMINAL_ONLINE
          Used as a return value for getOnlineStatus to indicate that the terminal is online
static java.lang.String TERMINAL_SECURED
          Used as a return value for getOperatorStatus to indicate that the terminal is in "secured" mode (i.e., password needed to unlock)
 
Fields inherited from interface com.ibm.retail.si.mgmt.MgmtExtendedControlMBean
EXTENDED_CTRL, EXTENDED_DEBUG, EXTENDED_LOG
 
Method Summary
 int destroyDebug()
          Destroy the instance of the extended debug MBean.
 int destroyDetailedControl()
          Destroy the instance of the extended debug MBean.
 int destroyDetailedLogControl()
          Not supported.
 javax.management.ObjectName enableDebug()
          Enable, if available, the extended Debug facilities of this component.
 javax.management.ObjectName enableDetailedControl()
          Enable, if available, the extended Control facilities of this component.
 javax.management.ObjectName enableDetailedLogControl()
          Not supported.
 int getCurrentlyActiveCapabilities()
          Query the which extened functions are currenly active.
 int getExtendedCapabilities()
          Query the capabilities of this implemetation of this interface.
 java.lang.String getOnlineStatus()
           
 java.lang.String getOperatorStatus()
           
 java.lang.String getPOSApplicationStatus()
           
 java.lang.String getSessionID()
           
 boolean isSessionAvailable()
           
 boolean isSessionReady()
           
 boolean isSessionReserved()
           
 

Field Detail

SESSION_TYPE

public static final java.lang.String SESSION_TYPE
Used as notification type for notifications generated by classes implementing this interface

See Also:
Constant Field Values

ONLINE_STATUS_UPDATE

public static final java.lang.String ONLINE_STATUS_UPDATE
Used as notification message text

See Also:
Constant Field Values

OPERATOR_STATUS_UPDATE

public static final java.lang.String OPERATOR_STATUS_UPDATE
Used as notification message text

See Also:
Constant Field Values

TERMINAL_ONLINE

public static final java.lang.String TERMINAL_ONLINE
Used as a return value for getOnlineStatus to indicate that the terminal is online

See Also:
Constant Field Values

TERMINAL_OFFLINE

public static final java.lang.String TERMINAL_OFFLINE
Used as a return value for getOnlineStatus to indicate that the terminal is offline

See Also:
Constant Field Values

POS_APPLICATION_ACTIVE

public static final java.lang.String POS_APPLICATION_ACTIVE
Used as a return value for getPOSApplicationStatus to indicate that the application is active

See Also:
Constant Field Values

POS_APPLICATION_INACTIVE

public static final java.lang.String POS_APPLICATION_INACTIVE
Used as a return value for getPOSApplicationStatus to indicate that the application is inactive

See Also:
Constant Field Values

OPERATOR_LOGGED_ON

public static final java.lang.String OPERATOR_LOGGED_ON
Used as a return value for getOperatorStatus to indicate that the operator is logged on

See Also:
Constant Field Values

OPERATOR_LOGGED_OFF

public static final java.lang.String OPERATOR_LOGGED_OFF
Used as a return value for getOperatorStatus to indicate that the operator is logged off

See Also:
Constant Field Values

TERMINAL_SECURED

public static final java.lang.String TERMINAL_SECURED
Used as a return value for getOperatorStatus to indicate that the terminal is in "secured" mode (i.e., password needed to unlock)

See Also:
Constant Field Values
Method Detail

destroyDebug

public int destroyDebug()
Description copied from interface: MgmtExtendedControlMBean
Destroy the instance of the extended debug MBean.

Specified by:
destroyDebug in interface MgmtExtendedControlMBean
Returns:
int - General return code.

destroyDetailedControl

public int destroyDetailedControl()
Description copied from interface: MgmtExtendedControlMBean
Destroy the instance of the extended debug MBean.

Specified by:
destroyDetailedControl in interface MgmtExtendedControlMBean
Returns:
int - General return code.

destroyDetailedLogControl

public int destroyDetailedLogControl()
Not supported. Throws UnsupportedOperationException.

Specified by:
destroyDetailedLogControl in interface MgmtExtendedControlMBean
Returns:
int - General return code.
See Also:
MgmtExtendedControlMBean.destroyDetailedLogControl()

enableDebug

public javax.management.ObjectName enableDebug()
Description copied from interface: MgmtExtendedControlMBean
Enable, if available, the extended Debug facilities of this component.

Specified by:
enableDebug in interface MgmtExtendedControlMBean
Returns:
ObjectName - The ObjectName of the newly created MBean.

enableDetailedControl

public javax.management.ObjectName enableDetailedControl()
Description copied from interface: MgmtExtendedControlMBean
Enable, if available, the extended Control facilities of this component.

Specified by:
enableDetailedControl in interface MgmtExtendedControlMBean
Returns:
ObjectName - The ObjectName of the newly created MBean.

enableDetailedLogControl

public javax.management.ObjectName enableDetailedLogControl()
Not supported. Throws UnsupportedOperationException.

Specified by:
enableDetailedLogControl in interface MgmtExtendedControlMBean
Returns:
ObjectName - The ObjectName of the newly created MBean.
See Also:
MgmtExtendedControlMBean.enableDetailedLogControl()

getCurrentlyActiveCapabilities

public int getCurrentlyActiveCapabilities()
Description copied from interface: MgmtExtendedControlMBean
Query the which extened functions are currenly active.

Specified by:
getCurrentlyActiveCapabilities in interface MgmtExtendedControlMBean
Returns:
int - A mask indicating the functions that are currenly active.

getExtendedCapabilities

public int getExtendedCapabilities()
Description copied from interface: MgmtExtendedControlMBean
Query the capabilities of this implemetation of this interface.

Specified by:
getExtendedCapabilities in interface MgmtExtendedControlMBean
Returns:
com.ibm.retail.si.mgmt.MgmtExtendedControlMBean.EXTENDED_CTRL || com.ibm.retail.si.mgmt.MgmtExtendedControlMBean.EXTENDED_DEBUG
See Also:
MgmtExtendedControlMBean.getExtendedCapabilities()

getSessionID

public java.lang.String getSessionID()
Returns:
the identifier of this AEFSession. This ID is typically a String of three digits.

isSessionReady

public boolean isSessionReady()
Returns:
an indicator of whether the session is ready to be used. The session is not considered ready until it has completed initialization and is ready to accept input.

isSessionAvailable

public boolean isSessionAvailable()
Returns:
an indicator of whether the session is available (not in use).

isSessionReserved

public boolean isSessionReserved()
Returns:
an indicator of whether the session is reserved. A session that is not reserved can be obtained via SessionServer.getAvailableSession(); a reserved session can only be obtained via SessionServer.getSession().

getOnlineStatus

public java.lang.String getOnlineStatus()
Returns:
the online status of the terminal associated with this AEFSession. The terminal is considered "online" if it is able to communicate with its local controller. Valid values include TERMINAL_ONLINE and TERMINAL_OFFLINE.

Note: Virtual sessions are always considered to be online. Only real (non-virtual) sessions can ever be offline.


getPOSApplicationStatus

public java.lang.String getPOSApplicationStatus()
Returns:
the status of the POS application associated with this AEFSession. The application is considered "active" if it is able to accept and process requests. Valid values include POS_APPLICATION_ACTIVE and POS_APPLICATION_INACTIVE.

Note: For real (non-virtual) sessions the application is always considered to be active.


getOperatorStatus

public java.lang.String getOperatorStatus()
Returns:
the status of the operator associated with this AEFSession. Valid values include OPERATOR_LOGGED_ON, OPERATOR_LOGGED_OFF, and SECURED_MODE.


Copyright © 2004 IBM. All Rights Reserved.
Generated: July 19 2004