Overview | Package | Class | Tree | Index | Help

Oracle® Coherence Java API Reference
v3.5.3
E15583-01
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.tangosol.coherence.servlet.management
Class HttpSessionManager

    java.lang.Object
      com.tangosol.util.Base
          com.tangosol.coherence.servlet.management.HttpSessionManager

All Implemented Interfaces:
  HttpSessionManagerMBean

    public class HttpSessionManager

extends Base
implements HttpSessionManagerMBean

HttpSessionManagerMBean implementation class.

Since:
  Coherence 3.1
Author:
  jh 2005.11.18

Field Summary

Fields inherited from interface com.tangosol.coherence.servlet.management.HttpSessionManagerMBean
`OBJECT_TYPE`

Constructor Summary
`HttpSessionManager(SessionHelper helper)` Create a new HttpSessionManager object.

Method Summary
`protected AbstractHttpSessionCollection` | `getAbstractHttpSessionCollection()` Return the AbstractHttpSessionCollection currently in use.
`java.lang.String` | `getCollectionClassName()` Return the fully qualified class name of the `HttpSessionCollection` implementation in use.
`java.lang.String` | `getFactoryClassName()` Return the fully qualified class name of the `SessionHelper.Factory` implementation in use.
`java.lang.String` | `getLocalAttributeCacheName()` Return the name of the local cache that stores non-distributed session attributes or null if local session attribute storage is disabled.
`int` | `getLocalAttributeCount()` Return the number of non-distributed session attributes stored in the local session attribute cache or -1 if local session attribute storage is disabled.
`java.lang.String` | `getLocalSessionCacheName()` Return the name of the local cache that stores non-distributed sessions or null if local session storage is disabled.
`int` | `getLocalSessionCount()` Return the number of non-distributed sessions stored in the local session cache or -1 if local session storage is disabled.
`int` | `getOverflowAverageSize()` Return the average size (in bytes) of the session attributes stored in the "overflow" clustered cache since the last time statistics were reset or -1 if a `SplitHttpSessionCollection` is not in use.
`java.lang.String` | `getOverflowCacheName()` Return the name of the clustered cache that stores the "large attributes" that exceed a certain size and thus are determined to be more efficiently managed as separate cache entries and not as part of the serialized session object itself.
`int` | `getOverflowMaxSize()` Return the maximum size (in bytes) of a session attribute stored in the "overflow" clustered cache since the last time statistics were reset or -1 if a `SplitHttpSessionCollection` is not in use.
`int` | `getOverflowThreshold()` Return the minimum length (in bytes) that the serialized form of an attribute value must be in order for that attribute value to be stored in the separate "overflow" cache that is reserved for large attributes.
`int` | `getOverflowUpdates()` Return the number of updates to session attributes stored in the "overflow" clustered cache since the last time statistics were reset or -1 if a `SplitHttpSessionCollection` is not in use.
`java.lang.String` | `getServletContextCacheName()` Return the name of the clustered cache that stores ServletContext attributes or null if the ServletContext is not clustered.
`java.lang.String` | `getServletContextName()` Return the name of the web application ServletContext.
`int` | `getSessionAverageLifetime()` Return the average lifetime (in seconds) of session objects invalidated (either due to expiration or to an explicit invalidation) since the last time statistics were reset.
`int` | `getSessionAverageSize()` Return the average size (in bytes) of session objects placed in the session storage clustered cache since the last time statistics were reset.
`java.lang.String` | `getSessionCacheName()` Return the name of the clustered cache that stores serialized session objects.
`protected SessionHelper.Factory` | `getSessionFactory()` Return the SessionHelper.Factory currently in use.
`protected SessionHelper` | `getSessionHelper()` Return the SessionHelper used by this HttpSessionManager object to expose Coherence*Web management attributes and operations.
`int` | `getSessionIdLength()` Return the length (in characters) of generated session IDs.
`int` | `getSessionMaxSize()` Return the maximum size (in bytes) of a session object placed in the session storage clustered cache since the last time statistics were reset.
`int` | `getSessionMinSize()` Return the minimum size (in bytes) of a session object placed in the session storage clustered cache since the last time statistics were reset.
`int` | `getSessionStickyCount()` Return the number of session objects that are pinned to this instance of the web application or -1 if sticky session optimizations are disabled.
`int` | `getSessionTimeout()` Return the session expiration time (in seconds) or -1 if sessions never expire.
`int` | `getSessionUpdates()` Return the number of updates of session object stored in the session storage clustered cache since the last time statistics were reset.
`protected SplitHttpSessionCollection` | `getSplitHttpSessionCollection()` Return the SplitHttpSessionCollection currently in use.
`void` | `resetStatistics()` Reset the session management statistics.
`java.lang.String` | `toString()` Returns a string representation of the object.

Constructor Detail

### HttpSessionManager

    public HttpSessionManager(SessionHelper helper)

  Create a new HttpSessionManager object.

  Parameters:
    `helper` - the SessionHelper for the web application in which Coherence*Web is installed

Method Detail

### getCollectionClassName

    public java.lang.String getCollectionClassName()

  Return the fully qualified class name of the `HttpSessionCollection` implementation in use.

  Specified by:
    `getCollectionClassName` in interface `HttpSessionManagerMBean`
  Returns:
    the value of the `CollectionClassName` attribute

### getFactoryClassName

    public java.lang.String getFactoryClassName()

  Return the fully qualified class name of the `SessionHelper.Factory` implementation in use.

  Specified by:
    `getFactoryClassName` in interface `HttpSessionManagerMBean`
  Returns:
    the value of the `FactoryClassName` attribute

### getLocalAttributeCacheName

    public java.lang.String getLocalAttributeCacheName()

  Return the name of the local cache that stores non-distributed session attributes or null if local session attribute storage is disabled.

  Specified by:
    `getLocalAttributeCacheName` in interface `HttpSessionManagerMBean`
  Returns:
    the value of the `LocalAttributeCacheName` attribute

### getLocalAttributeCount

    public int getLocalAttributeCount()

  Return the number of non-distributed session attributes stored in the local session attribute cache or -1 if local session attribute storage is disabled.

  Specified by:
    `getLocalAttributeCount` in interface `HttpSessionManagerMBean`
  Returns:
    the value of the `LocalAttributeCount` attribute
  See Also:
    `HttpSessionManagerMBean.getLocalAttributeCacheName()`

### getLocalSessionCacheName

    public java.lang.String getLocalSessionCacheName()

  Return the name of the local cache that stores non-distributed sessions or null if local session storage is disabled.

  Specified by:
    `getLocalSessionCacheName` in interface `HttpSessionManagerMBean`
  Returns:
    the value of the `LocalSessionCacheName` attribute

### getLocalSessionCount

    public int getLocalSessionCount()

  Return the number of non-distributed sessions stored in the local session cache or -1 if local session storage is disabled.

  Specified by:
    `getLocalSessionCount` in interface `HttpSessionManagerMBean`
  Returns:
    the value of the `LocalSessionCount` attribute
  See Also:
    `HttpSessionManagerMBean.getLocalSessionCacheName()`

### getOverflowAverageSize

    public int getOverflowAverageSize()

  Return the average size (in bytes) of the session attributes stored in the "overflow" clustered cache since the last time statistics were reset or -1 if a `SplitHttpSessionCollection` is not in use.

  Specified by:
    `getOverflowAverageSize` in interface `HttpSessionManagerMBean`
  Returns:
    the value of the `OverflowAverageSize` attribute
  See Also:
    `HttpSessionManagerMBean.getCollectionClassName()`, `HttpSessionManagerMBean.getOverflowCacheName()`, `HttpSessionManagerMBean.getOverflowThreshold()`

### getOverflowCacheName

    public java.lang.String getOverflowCacheName()

  Return the name of the clustered cache that stores the "large attributes" that exceed a certain size and thus are determined to be more efficiently managed as separate cache entries and not as part of the serialized session object itself.

  If a `SplitHttpSessionCollection` is not in use, null is returned.

  Specified by:
    `getOverflowCacheName` in interface `HttpSessionManagerMBean`
  Returns:
    the value of the `OverflowCacheName` attribute
  See Also:
    `HttpSessionManagerMBean.getCollectionClassName()`, `HttpSessionManagerMBean.getOverflowThreshold()`

### getOverflowMaxSize

    public int getOverflowMaxSize()

  Return the maximum size (in bytes) of a session attribute stored in the "overflow" clustered cache since the last time statistics were reset or -1 if a `SplitHttpSessionCollection` is not in use.

  Specified by:
    `getOverflowMaxSize` in interface `HttpSessionManagerMBean`
  Returns:
    the value of the `OverflowMaxSize` attribute
  See Also:
    `HttpSessionManagerMBean.getCollectionClassName()`, `HttpSessionManagerMBean.getOverflowCacheName()`, `HttpSessionManagerMBean.getOverflowThreshold()`

### getOverflowThreshold

    public int getOverflowThreshold()

  Return the minimum length (in bytes) that the serialized form of an attribute value must be in order for that attribute value to be stored in the separate "overflow" cache that is reserved for large attributes.

  If a `SplitHttpSessionCollection` is not in use, -1 is returned.

  Specified by:
    `getOverflowThreshold` in interface `HttpSessionManagerMBean`
  Returns:
    the value of the `OverflowThreshold` attribute
  See Also:
    `HttpSessionManagerMBean.getCollectionClassName()`, `HttpSessionManagerMBean.getOverflowCacheName()`

### getOverflowUpdates

    public int getOverflowUpdates()

  Return the number of updates to session attributes stored in the "overflow" clustered cache since the last time statistics were reset or -1 if a `SplitHttpSessionCollection` is not in use.

  Specified by:
    `getOverflowUpdates` in interface `HttpSessionManagerMBean`
  Returns:
    the value of the `OverflowUpdates` attribute
  See Also:
    `HttpSessionManagerMBean.getCollectionClassName()`, `HttpSessionManagerMBean.getOverflowCacheName()`, `HttpSessionManagerMBean.getOverflowThreshold()`

### getSessionAverageLifetime

    public int getSessionAverageLifetime()

  Return the average lifetime (in seconds) of session objects invalidated (either due to expiration or to an explicit invalidation) since the last time statistics were reset.

  Specified by:
    `getSessionAverageLifetime` in interface `HttpSessionManagerMBean`
  Returns:
    the value of the `SessionAverageLifetime` attribute

### getSessionAverageSize

    public int getSessionAverageSize()

  Return the average size (in bytes) of session objects placed in the session storage clustered cache since the last time statistics were reset.

  Specified by:
    `getSessionAverageSize` in interface `HttpSessionManagerMBean`
  Returns:
    the value of the `SessionAverageSize` attribute

### getSessionCacheName

    public java.lang.String getSessionCacheName()

  Return the name of the clustered cache that stores serialized session objects.

  Specified by:
    `getSessionCacheName` in interface `HttpSessionManagerMBean`
  Returns:
    the value of the `SessionCacheName` attribute

### getSessionIdLength

    public int getSessionIdLength()

  Return the length (in characters) of generated session IDs.

  Specified by:
    `getSessionIdLength` in interface `HttpSessionManagerMBean`
  Returns:
    the value of the `SessionIdLength` attribute

### getSessionMaxSize

    public int getSessionMaxSize()

  Return the maximum size (in bytes) of a session object placed in the session storage clustered cache since the last time statistics were reset.

  Specified by:
    `getSessionMaxSize` in interface `HttpSessionManagerMBean`
  Returns:
    the value of the `SessionMaxSize` attribute

### getSessionMinSize

    public int getSessionMinSize()

  Return the minimum size (in bytes) of a session object placed in the session storage clustered cache since the last time statistics were reset.

  Specified by:
    `getSessionMinSize` in interface `HttpSessionManagerMBean`
  Returns:
    the value of the `SessionMinSize` attribute

### getSessionStickyCount

    public int getSessionStickyCount()

  Return the number of session objects that are pinned to this instance of the web application or -1 if sticky session optimizations are disabled.

  Specified by:
    `getSessionStickyCount` in interface `HttpSessionManagerMBean`
  Returns:
    the value of the `SessionStickyCount` attribute

### getSessionTimeout

    public int getSessionTimeout()

  Return the session expiration time (in seconds) or -1 if sessions never expire.

  Specified by:
    `getSessionTimeout` in interface `HttpSessionManagerMBean`
  Returns:
    the value of the `SessionTimeout` attribute

### getSessionUpdates

    public int getSessionUpdates()

  Return the number of updates of session object stored in the session storage clustered cache since the last time statistics were reset.

  Specified by:
    `getSessionUpdates` in interface `HttpSessionManagerMBean`
  Returns:
    the value of the `SessionUpdates` attribute

### getServletContextCacheName

    public java.lang.String getServletContextCacheName()

  Return the name of the clustered cache that stores ServletContext attributes or null if the ServletContext is not clustered.

  Specified by:
    `getServletContextCacheName` in interface `HttpSessionManagerMBean`
  Returns:
    the value of the `ServletContextCacheName` attribute

### getServletContextName

    public java.lang.String getServletContextName()

  Return the name of the web application ServletContext.

  Specified by:
    `getServletContextName` in interface `HttpSessionManagerMBean`
  Returns:
    the value of the `ServletContextName` attribute

### resetStatistics

    public void resetStatistics()

  Reset the session management statistics.

  Specified by:
    `resetStatistics` in interface `HttpSessionManagerMBean`

### getSessionHelper

    protected SessionHelper getSessionHelper()

  Return the SessionHelper used by this HttpSessionManager object to expose Coherence*Web management attributes and operations.

  Returns:
    the SessionHelper used by this HttpSessionManager

### getSessionFactory

    protected SessionHelper.Factory getSessionFactory()

  Return the SessionHelper.Factory currently in use.

  Returns:
    the SessionHelper.Factory or null if one could not be retrieved

### getAbstractHttpSessionCollection

    protected AbstractHttpSessionCollection getAbstractHttpSessionCollection()

  Return the AbstractHttpSessionCollection currently in use.

  Returns:
    the AbstractHttpSessionCollection or null if one could not be retrieved

### getSplitHttpSessionCollection

    protected SplitHttpSessionCollection getSplitHttpSessionCollection()

  Return the SplitHttpSessionCollection currently in use.

  Returns:
    the SplitHttpSessionCollection or null if one could not be retrieved

### toString

    public java.lang.String toString()

  Returns a string representation of the object.

  Returns:
    a string representation of the object

Overview | Package | Class | Tree | Index | Help

Oracle® Coherence Java API Reference
v3.5.3
E15583-01
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000, 2010, Oracle. All rights reserved.