com.ibm.retail.AEF.mgmt
Interface SessionServerMBean

All Superinterfaces:
MgmtExtendedControlMBean

public interface SessionServerMBean
extends MgmtExtendedControlMBean

Specifies the management interface for the AEF SessionServer object.

The AEF SessionServer controls access to AEFSessions, which represent POS terminals (either real or virtual). A SessionServer can allocate sessions from multiple AEFSessionFactorys, each of which are active on a different store controller. The purpose of this MBean is to expose information about the various AEFSessionFactorys 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:

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.

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.


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

SESSION_SERVER_TYPE

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

See Also:
Constant Field Values

SERVER_STATE_CHANGE

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

See Also:
Constant Field Values

SESSION_FACTORY_ADDED

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

See Also:
Constant Field Values

SESSION_FACTORY_REMOVED

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

See Also:
Constant Field Values

SESSION_FACTORY_UPDATED

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

See Also:
Constant Field Values

NO_SESSION_AVAILABLE

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

See Also:
Constant Field Values

SERVER_ACTIVE

public static final java.lang.String SERVER_ACTIVE
Used as a return value for getServerState to indicate that the server is active

See Also:
Constant Field Values

SERVER_INITIALIZING

public static final java.lang.String SERVER_INITIALIZING
Used as a return value for getServerState to indicate that the server is initializing

See Also:
Constant Field Values
Method Detail

destroyDebug

public int destroyDebug()
Not supported. Throws UnsupportedOperationException.

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

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()
Not supported. Throws UnsupportedOperationException.

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

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
See Also:
MgmtExtendedControlMBean.getExtendedCapabilities()

getServerID

public java.lang.String getServerID()
Returns:
the ID of this 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.

getServerState

public java.lang.String getServerState()
Returns:
an indication of the state of the SessionServer. Valid values include SERVER_INITIALIZING and SERVER_ACTIVE.

getSessionFactoryIDs

public java.util.List getSessionFactoryIDs()
Returns:
a list of active SessionFactory IDs as String objects. These IDs can be used to query the MBeanServer since each SessionFactory MBean includes its ID in its ObjectName
See Also:
SessionFactoryMBean


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