com.ibm.retail.AEF.mgmt
Interface SessionDebugMBean


public interface SessionDebugMBean

Specifies a "debug" management interface for AEFSession objects.

The purpose of this MBean is to allow more detailed monitoring of an AEFSession than what is available through the base SessionMBean management interface. Due to the potential for excessive notifications because of frequent state changes, MBeans of this type are created on demand through SessionMBean.enableDebug(). When the detailed monitoring is no longer needed, these MBeans should be destroyed via SessionMBean.destroyDebug().

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

This management interface includes the following attributes. These attributes are described in more detail in the accessor methods. The following operations are included in this management interface. These are described in more detail in the corresponding method documentation. An RtlDebugNotification is emitted by classes implementing this interface when the following conditions occur.

If present, the constants referenced in the following notification descriptions indicate the possible values of the notification userData; else, the userData contains the new state data (since all of the notifications represent state changes). 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 CUSTOMER_DISPLAY_UPDATE
           
static java.lang.String NONSALES_TRANSACTION_IN_PROGRESS
           
static java.lang.String NOTIFICATION_TYPE
           
static java.lang.String OPERATOR_DISPLAY_UPDATE
           
static java.lang.String POS_APPLICATION_STATE_UPDATE
           
static java.lang.String POS_APPLICATION_SUBSTATE_UPDATE
           
static java.lang.String PRINT_LINES_UPDATE
           
static java.lang.String SALES_TRANSACTION_IN_PROGRESS
           
static java.lang.String TRANSACTION_NOT_IN_PROGRESS
           
static java.lang.String TRANSACTION_STATUS_UPDATE
           
 
Method Summary
 void dumpSessionTrace()
          Dumps the AEF session trace to a file.
 java.lang.String getCustomerDisplay()
          Returns the current value of the CustomerDisplay attribute.
 java.lang.String getOperatorDisplay()
          Returns the current value of the OperatorDisplay attribute.
 java.lang.String getPOSApplicationState()
          Returns the current value of the POSApplicationState attribute.
 java.lang.String getPOSApplicationSubstate()
          Returns the current value of the POSApplicationSubstate attribute.
 java.util.Collection getPrintLines()
          Returns the current value of the PrintLines attribute.
 int getTraceLevel()
          Returns the current AEF session trace level.
 java.lang.String getTransactionStatus()
          Returns the current TransactionStatus attribute value.
 void setTraceLevel(int level)
          Specifies the AEF session trace level.
 

Field Detail

NOTIFICATION_TYPE

public static final java.lang.String NOTIFICATION_TYPE
See Also:
Constant Field Values

TRANSACTION_STATUS_UPDATE

public static final java.lang.String TRANSACTION_STATUS_UPDATE
See Also:
Constant Field Values

CUSTOMER_DISPLAY_UPDATE

public static final java.lang.String CUSTOMER_DISPLAY_UPDATE
See Also:
Constant Field Values

OPERATOR_DISPLAY_UPDATE

public static final java.lang.String OPERATOR_DISPLAY_UPDATE
See Also:
Constant Field Values

PRINT_LINES_UPDATE

public static final java.lang.String PRINT_LINES_UPDATE
See Also:
Constant Field Values

POS_APPLICATION_STATE_UPDATE

public static final java.lang.String POS_APPLICATION_STATE_UPDATE
See Also:
Constant Field Values

POS_APPLICATION_SUBSTATE_UPDATE

public static final java.lang.String POS_APPLICATION_SUBSTATE_UPDATE
See Also:
Constant Field Values

SALES_TRANSACTION_IN_PROGRESS

public static final java.lang.String SALES_TRANSACTION_IN_PROGRESS
See Also:
Constant Field Values

NONSALES_TRANSACTION_IN_PROGRESS

public static final java.lang.String NONSALES_TRANSACTION_IN_PROGRESS
See Also:
Constant Field Values

TRANSACTION_NOT_IN_PROGRESS

public static final java.lang.String TRANSACTION_NOT_IN_PROGRESS
See Also:
Constant Field Values
Method Detail

getTransactionStatus

public java.lang.String getTransactionStatus()
Returns the current TransactionStatus attribute value. Valid return values are SALES_TRANSACTION_IN_PROGRESS, NONSALES_TRANSACTION_IN_PROGRESS, or TRANSACTION_NOT_IN_PROGRESS.

Returns:
the current contents of the LineDisplay1 device

getOperatorDisplay

public java.lang.String getOperatorDisplay()
Returns the current value of the OperatorDisplay attribute. This may take the form of two or more "lines" of characters, each separated by a newline character.

Returns:
the current contents of the Operator Display device

getCustomerDisplay

public java.lang.String getCustomerDisplay()
Returns the current value of the CustomerDisplay attribute. This may take the form of two or more "lines" of characters, each separated by a newline character.

Returns:
the current contents of the Operator Display device

getPrintLines

public java.util.Collection getPrintLines()
Returns the current value of the PrintLines attribute. This Collection is a composed of Strings that represent output to the printer.

Returns:
the collection of print lines that were last sent to the printer

getPOSApplicationState

public java.lang.String getPOSApplicationState()
Returns the current value of the POSApplicationState attribute. Valid values for the state are defined in the AEFBundle that has "state.properties" as its root.

Returns:
the current state of the POS application

getPOSApplicationSubstate

public java.lang.String getPOSApplicationSubstate()
Returns the current value of the POSApplicationSubstate attribute. Valid values for the substate are defined in the AEFBundle that has "substate.properties" as its root.

Returns:
the current substate of the POS application

setTraceLevel

public void setTraceLevel(int level)
Specifies the AEF session trace level. Refer to AEFSession.setSessionTraceLevel() for information on valid parameter values.

See Also:
AEFSession.setSessionTraceLevel(int)

getTraceLevel

public int getTraceLevel()
Returns the current AEF session trace level. Refer to AEFSession.getSessionTraceLevel() for information on valid return values.

Returns:
the current TraceLevel attribute value
See Also:
AEFSession.getSessionTraceLevel()

dumpSessionTrace

public void dumpSessionTrace()
Dumps the AEF session trace to a file. Refer to AEFSession.dumpSessionTrace() for more information.

See Also:
AEFSession.dumpSessionTrace()


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