|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Specifies the management interface for the AEF
SessionServer
object.
The AEF SessionServer
controls access to
AEFSession
s, which represent POS terminals
(either real or virtual). A SessionServer
can allocate sessions from
multiple AEFSessionFactory
s, each of
which are active on a different store controller. The purpose of this MBean is to expose
information about the various AEFSessionFactory
s that the SessionServer
is aware of. In addition, classes implementing this interface may emit notifications when
factories are discovered or removed, or if an AEFSession
is unable to be
allocated due to insufficient capacity.
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).
The ObjectName
of this MBean includes the following attributes, in addition to the SIF
attributes of StoreID
and DeviceID
:
Notifications are generated by classes implementing this interface when the following
conditions occur. The type of the notification is SESSION_SERVER_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
.
There are additional constants defined in this interface that are used for the notification message.
The Notification
class is a subclass of
com.ibm.retail.si.mgmt.notifications.RtlNotification
and is identified in the
description of each notification. The notification names in the list below indicate the
constants that are used for the notification message text.
SERVER_INITIALIZING
or SERVER_ACTIVE
. The
notification class is RtlInformationNotification
.RtlInformationNotification
.getAvailableSession()
requests. This can
occur when a known SessionFactory does not respond to requests or
a RemoteException occurs attempting to access it. The ID of the
SessionFactory is the userData of the notification. The notification
class is RtlInformationNotification
.SessionFactory
objects are at their maximum capacity. This notification does not
include a userData object. The notification class is
RtlWarningNotification
.
Field Summary | |
---|---|
static java.lang.String |
NO_SESSION_AVAILABLE
Used as notification message text |
static java.lang.String |
SERVER_ACTIVE
Used as a return value for getServerState to indicate that the server is active |
static java.lang.String |
SERVER_INITIALIZING
Used as a return value for getServerState to indicate that the server is initializing |
static java.lang.String |
SERVER_STATE_CHANGE
Used as notification message text |
static java.lang.String |
SESSION_FACTORY_ADDED
Used as notification message text |
static java.lang.String |
SESSION_FACTORY_REMOVED
Used as notification message text |
static java.lang.String |
SESSION_FACTORY_UPDATED
Used as notification message text |
static java.lang.String |
SESSION_SERVER_TYPE
Used as notification type for notifications generated by classes implementing this interface |
Fields inherited from interface com.ibm.retail.si.mgmt.MgmtExtendedControlMBean |
---|
EXTENDED_CTRL, EXTENDED_DEBUG, EXTENDED_LOG |
Method Summary | |
---|---|
int |
destroyDebug()
Not supported. |
int |
destroyDetailedControl()
Destroy the instance of the extended debug MBean. |
int |
destroyDetailedLogControl()
Not supported. |
javax.management.ObjectName |
enableDebug()
Not supported. |
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 |
getServerID()
|
java.lang.String |
getServerState()
|
java.util.List |
getSessionFactoryIDs()
|
Field Detail |
public static final java.lang.String SESSION_SERVER_TYPE
public static final java.lang.String SERVER_STATE_CHANGE
public static final java.lang.String SESSION_FACTORY_ADDED
public static final java.lang.String SESSION_FACTORY_REMOVED
public static final java.lang.String SESSION_FACTORY_UPDATED
public static final java.lang.String NO_SESSION_AVAILABLE
public static final java.lang.String SERVER_ACTIVE
getServerState
to indicate that the server is active
public static final java.lang.String SERVER_INITIALIZING
getServerState
to indicate that the server is initializing
Method Detail |
public int destroyDebug()
UnsupportedOperationException
.
destroyDebug
in interface MgmtExtendedControlMBean
MgmtExtendedControlMBean.destroyDebug()
public int destroyDetailedControl()
MgmtExtendedControlMBean
destroyDetailedControl
in interface MgmtExtendedControlMBean
public int destroyDetailedLogControl()
UnsupportedOperationException
.
destroyDetailedLogControl
in interface MgmtExtendedControlMBean
MgmtExtendedControlMBean.destroyDetailedLogControl()
public javax.management.ObjectName enableDebug()
UnsupportedOperationException
.
enableDebug
in interface MgmtExtendedControlMBean
MgmtExtendedControlMBean.enableDebug()
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 getServerID()
SessionServer
, as specified in the AEF configuration file.
This ID is used to derive the RMI name of the SessionServer
if it is able to be
accessed remotely.public java.lang.String getServerState()
SERVER_INITIALIZING
and SERVER_ACTIVE
.public java.util.List getSessionFactoryIDs()
SessionFactory
IDs as String
objects.
These IDs can be used to query the MBeanServer since each SessionFactory MBean includes
its ID in its ObjectNameSessionFactoryMBean
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |