com.ibm.retail.AEF.mgmt
Interface SessionFactoryMBean


public interface SessionFactoryMBean

Specifies the management interface for the AEFSessionFactory object.

There is at most one AEFSessionFactory object per AEF JVM. AEFSessionFactorys are responsible for supporting AEF client requests for AEFSessions. AEFSessionFactorys maintain counts of the number of sessions active, the maximum number of sessions the factory can support, the set of session IDs for this factory, etc.

The purpose of this MBean is to expose information related to AEFSessionFactory objects. In addition, notifications are emitted when sessions are created or destroyed.

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.

An RtlDebugNotification is emitted by classes implementing this interface when the following conditions occur. The notification type is SESSION_FACTORY_TYPE. The notification names in the list below indicate the constants that are used for the notification message text.


Field Summary
static java.lang.String SESSION_CREATED
          Used as the notification message text
static java.lang.String SESSION_DESTROYED
          Used as the notification message text
static java.lang.String SESSION_FACTORY_TYPE
          Used as notification type for notifications generated by classes implementing this interface
 
Method Summary
 java.util.Collection getActiveSessionIDs()
           
 int getCurrentPoolSize()
           
 java.lang.String getFactoryID()
           
 java.util.Collection getReservedSessionIDs()
          Return the collection of session IDs that are currently reserved by this particular factory.
 java.util.Collection getSessionIDs()
           
 int getTotalAvailable()
           
 int getTotalCapacity()
           
 int getTotalReserved()
           
 

Field Detail

SESSION_FACTORY_TYPE

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

See Also:
Constant Field Values

SESSION_CREATED

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

See Also:
Constant Field Values

SESSION_DESTROYED

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

See Also:
Constant Field Values
Method Detail

getFactoryID

public java.lang.String getFactoryID()
Returns:
the ID of this SessionFactory, as specified in the AEF configuration file. This ID is used to derive the RMI name of the SessionFactory if it is able to be accessed remotely.

getTotalCapacity

public int getTotalCapacity()
Returns:
the total capacity of this SessionFactory. If this factory is for a real session, the total capacity will always be 1. For virtual sessions, the capacity of the corresponding factory is based on the CSS configuration settings.

getCurrentPoolSize

public int getCurrentPoolSize()
Returns:
the number of AEFSessions that currently exist for this factory, where 0 <= CurrentPoolSize <= TotalCapacity.

getTotalAvailable

public int getTotalAvailable()
Returns:
the total number of existing AEFSessions that are available to be allocated by this factory. This does not include sessions that would be created on demand, and therefore CurrentPoolSize + TotalAvailable <= TotalCapacity.

getTotalReserved

public int getTotalReserved()
Returns:
the total number of reserved AEFSessions. Refer to getReservedSessionIDs() for a description of a reserved session.

getSessionIDs

public java.util.Collection getSessionIDs()
Returns:
the collection of session IDs that this particular factory is responsible for. This includes sessions that exist as well as those that are yet to be created. This set of session IDs should be disjoint for every SessionFactory in the system; i.e., there should never be more than one factory that is able to create a given AEFSession.

getActiveSessionIDs

public java.util.Collection getActiveSessionIDs()
Returns:
the collection of session IDs that are currently active for this particular factory.

getReservedSessionIDs

public java.util.Collection getReservedSessionIDs()
Return the collection of session IDs that are currently reserved by this particular factory.

Reserved sessions are only available to AEF clients that obtain specific sessions via SessionServer.getSession(). Reserved sessions are not considered "available" and therefore are not included in the count of available sessions. Reserved sessions may or may not be active and therefore may or may not be included in the list of active sessions returned by getActiveSessionIDs(). Reserved session IDs are always included in the list of session IDs returned by getSessionIDs().

Returns:
the collection of reserved session IDs


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