|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
:
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.
ONLINE
or OFFLINE
.OPERATOR_LOGGED_ON
, OPERATOR_LOGGED_OFF
,
or TERMINAL_SECURED
.
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 |
public static final java.lang.String SESSION_TYPE
public static final java.lang.String ONLINE_STATUS_UPDATE
public static final java.lang.String OPERATOR_STATUS_UPDATE
public static final java.lang.String TERMINAL_ONLINE
getOnlineStatus
to indicate that the terminal is online
public static final java.lang.String TERMINAL_OFFLINE
getOnlineStatus
to indicate that the terminal is offline
public static final java.lang.String POS_APPLICATION_ACTIVE
getPOSApplicationStatus
to indicate that the application is active
public static final java.lang.String POS_APPLICATION_INACTIVE
getPOSApplicationStatus
to indicate that the application is inactive
public static final java.lang.String OPERATOR_LOGGED_ON
getOperatorStatus
to indicate that the operator is logged on
public static final java.lang.String OPERATOR_LOGGED_OFF
getOperatorStatus
to indicate that the operator is logged off
public static final java.lang.String TERMINAL_SECURED
getOperatorStatus
to indicate that the terminal is in "secured" mode (i.e., password needed to unlock)
Method Detail |
public int destroyDebug()
MgmtExtendedControlMBean
destroyDebug
in interface MgmtExtendedControlMBean
public int destroyDetailedControl()
MgmtExtendedControlMBean
destroyDetailedControl
in interface MgmtExtendedControlMBean
public int destroyDetailedLogControl()
UnsupportedOperationException
.
destroyDetailedLogControl
in interface MgmtExtendedControlMBean
MgmtExtendedControlMBean.destroyDetailedLogControl()
public javax.management.ObjectName enableDebug()
MgmtExtendedControlMBean
enableDebug
in interface MgmtExtendedControlMBean
public javax.management.ObjectName enableDetailedControl()
MgmtExtendedControlMBean
enableDetailedControl
in interface MgmtExtendedControlMBean
public javax.management.ObjectName enableDetailedLogControl()
UnsupportedOperationException
.
enableDetailedLogControl
in interface MgmtExtendedControlMBean
MgmtExtendedControlMBean.enableDetailedLogControl()
public int getCurrentlyActiveCapabilities()
MgmtExtendedControlMBean
getCurrentlyActiveCapabilities
in interface MgmtExtendedControlMBean
public int getExtendedCapabilities()
MgmtExtendedControlMBean
getExtendedCapabilities
in interface MgmtExtendedControlMBean
MgmtExtendedControlMBean.getExtendedCapabilities()
public java.lang.String getSessionID()
AEFSession
. This ID is typically a
String of three digits.public boolean isSessionReady()
public boolean isSessionAvailable()
public boolean isSessionReserved()
SessionServer.getAvailableSession()
;
a reserved session can only be obtained via
SessionServer.getSession()
.public java.lang.String getOnlineStatus()
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.
public java.lang.String getPOSApplicationStatus()
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.
public java.lang.String getOperatorStatus()
AEFSession
.
Valid values include OPERATOR_LOGGED_ON
, OPERATOR_LOGGED_OFF
,
and SECURED_MODE
.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |