com.ibm.websphere.objectgrid.stats
Interface SessionStatsModule

All Superinterfaces:

StatsModule

public interface SessionStatsModule
extends StatsModule

This interface represents a statistic module for HTTP sessions in an ObjectGrid server.

Since:

WAS XD 6.0.1

Field Summary

Fields inherited from interface com.ibm.websphere.objectgrid.stats.StatsModule

MODULE_TYPE_AGENT, MODULE_TYPE_HASHINDEX, MODULE_TYPE_MAP, MODULE_TYPE_OBJECT_GRID, MODULE_TYPE_QUERY, MODULE_TYPE_SESSION, MODULE_TYPE_UNDEFINED, PATH_DELIMITER

Method Summary

ActiveCountStatistic	getAccessedSessions(boolean copyMode) Get the access to sessions statistic.
ActiveCountStatistic	getAccessToNonExistentSession(boolean copyMode) Get the access to nonexistent sessions statistic.
ActiveCountStatistic	getActiveSessions(boolean copyMode) Get the active sessions statistic.
ActiveCountStatistic	getAffinityBreaks(boolean copyMode) Get the affinity breaks statistic.
ActiveCountStatistic	getCacheDiscards(boolean copyMode) Get the discarded sessions statistic.
ActiveCountStatistic	getCreatedSessions(boolean copyMode) Get the created sessions statistic.
ActiveCountStatistic	getInvalidatedByTimeout(boolean copyMode) Get the sessions invalidated by timeout statistic.
ActiveCountStatistic	getInvalidatedSessions(boolean copyMode) Get the invalidated sessions statistic.
ActiveCountStatistic	getMemoryCount(boolean copyMode) Get the sessions in memory count statistic.
String	getSessionID() Get the session ID.
void	setAccessedSessions(long stat) Set the access to sessions statistic.
void	setAccessToNonExistentSession(long stat) Set the access to nonexistent sessions statistic.
void	setActiveSessions(long stat) Set the active sessions statistic.
void	setAffinityBreaks(long stat) Set the affinity breaks statistic.
void	setCacheDiscards(long stat) Set the discarded sessions statistic.
void	setCreatedSessions(long stat) Set the created sessions statistic.
void	setInvalidatedByTimeout(long stat) Set the sessions invalidated by timeout statistic.
void	setInvalidatedSessions(long stat) Set the invalidated sessions statistic.
void	setMemoryCount(long stat) Set the sessions in memory count statistic.
void	setSessionID(String id) Set the session ID.

Methods inherited from interface com.ibm.websphere.objectgrid.stats.StatsModule

combine, copy, getPath, getStatsSpec, reset, setGroupModule, statsToString, update

Method Detail

getSessionID

String getSessionID()

Get the session ID.

Returns:

the session ID

setSessionID

void setSessionID(String id)

Set the session ID.

Parameters:

id - session ID.

getCreatedSessions

ActiveCountStatistic getCreatedSessions(boolean copyMode)

Get the created sessions statistic.

If the copyMode is set to true, a copy is returned. It is recommended to set the copy mode to true when this method is called in the same JVM as the JVM in which the statistics are gathered.

Parameters:

copyMode - if set to true, a copy is returned.

Returns:

the number of created sessions count statistic

See Also:

ActiveCountStatistic

setCreatedSessions

void setCreatedSessions(long stat)

Set the created sessions statistic.

Parameters:

stat - number of created sessions.

getInvalidatedSessions

ActiveCountStatistic getInvalidatedSessions(boolean copyMode)

Get the invalidated sessions statistic.

If the copyMode is set to true, a copy is returned. It is recommended to set the copy mode to true when this method is called in the same JVM as the JVM in which the statistics are gathered.

Parameters:

copyMode - if set to true, a copy is returned.

Returns:

the number of invalidated sessions count statistic

See Also:

ActiveCountStatistic

setInvalidatedSessions

void setInvalidatedSessions(long stat)

Set the invalidated sessions statistic.

Parameters:

stat - number of invalidated sessions.

getActiveSessions

ActiveCountStatistic getActiveSessions(boolean copyMode)

Get the active sessions statistic.

If the copyMode is set to true, a copy is returned. It is recommended to set the copy mode to true when this method is called in the same JVM as the JVM in which the statistics are gathered.

Parameters:

copyMode - if set to true, a copy is returned.

Returns:

the number of active sessions count statistic

See Also:

ActiveCountStatistic

setActiveSessions

void setActiveSessions(long stat)

Set the active sessions statistic.

Parameters:

stat - number of active sessions.

getMemoryCount

ActiveCountStatistic getMemoryCount(boolean copyMode)

Get the sessions in memory count statistic.

If the copyMode is set to true, a copy is returned. It is recommended to set the copy mode to true when this method is called in the same JVM as the JVM in which the statistics are gathered.

Parameters:

copyMode - if set to true, a copy is returned.

Returns:

the number of sessions in memory count statistic

See Also:

ActiveCountStatistic

setMemoryCount

void setMemoryCount(long stat)

Set the sessions in memory count statistic.

Parameters:

stat - number of sessions in memory.

getCacheDiscards

ActiveCountStatistic getCacheDiscards(boolean copyMode)

Get the discarded sessions statistic.

If the copyMode is set to true, a copy is returned. It is recommended to set the copy mode to true when this method is called in the same JVM as the JVM in which the statistics are gathered.

Parameters:

copyMode - if set to true, a copy is returned.

Returns:

the number of discarded sessions count statistic

See Also:

ActiveCountStatistic

setCacheDiscards

void setCacheDiscards(long stat)

Set the discarded sessions statistic.

Parameters:

stat - number of discarded sessions.

getAffinityBreaks

ActiveCountStatistic getAffinityBreaks(boolean copyMode)

Get the affinity breaks statistic.

If the copyMode is set to true, a copy is returned. It is recommended to set the copy mode to true when this method is called in the same JVM as the JVM in which the statistics are gathered.

Parameters:

copyMode - if set to true, a copy is returned.

Returns:

the number of affinity breaks count statistic

See Also:

ActiveCountStatistic

setAffinityBreaks

void setAffinityBreaks(long stat)

Set the affinity breaks statistic.

Parameters:

stat - number of affinity breaks.

getInvalidatedByTimeout

ActiveCountStatistic getInvalidatedByTimeout(boolean copyMode)

Get the sessions invalidated by timeout statistic.

If the copyMode is set to true, a copy is returned. It is recommended to set the copy mode to true when this method is called in the same JVM as the JVM in which the statistics are gathered.

Parameters:

copyMode - if set to true, a copy is returned.

Returns:

the number of sessions invalidated by timeout count statistic

See Also:

ActiveCountStatistic

setInvalidatedByTimeout

void setInvalidatedByTimeout(long stat)

Set the sessions invalidated by timeout statistic.

Parameters:

stat - number of sessions invalidated by timeout.

getAccessToNonExistentSession

ActiveCountStatistic getAccessToNonExistentSession(boolean copyMode)

Get the access to nonexistent sessions statistic.

If the copyMode is set to true, a copy is returned. It is recommended to set the copy mode to true when this method is called in the same JVM as the JVM in which the statistics are gathered.

Parameters:

copyMode - if set to true, a copy is returned.

Returns:

the number of accesses to nonexistent sessions count statistic

See Also:

ActiveCountStatistic

setAccessToNonExistentSession

void setAccessToNonExistentSession(long stat)

Set the access to nonexistent sessions statistic.

Parameters:

stat - number of accesses to nonexistent sessions.

getAccessedSessions

ActiveCountStatistic getAccessedSessions(boolean copyMode)

Get the access to sessions statistic.

If the copyMode is set to true, a copy is returned. It is recommended to set the copy mode to true when this method is called in the same JVM as the JVM in which the statistics are gathered.

Parameters:

copyMode - if set to true, a copy is returned.

Returns:

the number of sessions accessed count statistic

See Also:

ActiveCountStatistic

setAccessedSessions

void setAccessedSessions(long stat)

Set the access to sessions statistic.

Parameters:

stat - number of accessed sessions.