|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Specifies the management interface for the
AEFSessionFactory
object.
There is at most one AEFSessionFactory
object per AEF JVM.
AEFSessionFactory
s are responsible for supporting AEF client requests
for AEFSession
s. AEFSessionFactory
s 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
:
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.
AEFSession
has been created. This occurs
1) during AEF initialization if sessions are to be pre-created and
2) when a client requests an available session and there are no sessions
available and the factory capacity has not been reached. The notification userData
contains the ID (of type String
) of the session that was created.AEFSession
has been destroyed. This occurs
when the SessionServer.destroySession()
method is invoked.
The notification userData contains the ID (of type String
)
of the session that was destroyed.
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 |
public static final java.lang.String SESSION_FACTORY_TYPE
public static final java.lang.String SESSION_CREATED
public static final java.lang.String SESSION_DESTROYED
Method Detail |
public java.lang.String getFactoryID()
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.public int getTotalCapacity()
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.public int getCurrentPoolSize()
AEFSession
s that currently exist for this factory, where
0 <= CurrentPoolSize <= TotalCapacity.public int getTotalAvailable()
AEFSession
s 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.public int getTotalReserved()
AEFSession
s.
Refer to getReservedSessionIDs()
for a description of a reserved session.public java.util.Collection getSessionIDs()
SessionFactory
in the system; i.e., there should never be
more than one factory that is able to create a given AEFSession
.public java.util.Collection getActiveSessionIDs()
public java.util.Collection getReservedSessionIDs()
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()
.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |