org.enhydra.barracuda.core.util.http
Class ContextServices

java.lang.Object
  |
  +--org.enhydra.barracuda.core.util.http.ContextServices

public class ContextServices
extends java.lang.Object

This class defines a convenience method to get the servlet context. It also provides a mechanism to easily cache objects in the session by Reference (which allows them to automatically be removed from the session if the system starts running low on memory)


Field Summary
static java.lang.String KEY
           
protected static org.apache.log4j.Logger logger
           
 
Constructor Summary
ContextServices()
           
 
Method Summary
static javax.servlet.ServletContext getContext(ControlEventContext ec)
          get the servlet context from a ControlEventContext
static javax.servlet.ServletContext getContext(ViewContext vc)
          get the servlet context from a ViewContext
static java.lang.Object getObjectFromCache(ControlEventContext ec, java.lang.Object key, ReferenceFactory factory)
          This method retrieves the servlet context from a ControlEventContext, and then looks for an object in the servlet context based on a given key.
static java.lang.Object getObjectFromCache(javax.servlet.ServletContext context, java.lang.Object key, ReferenceFactory factory)
          This method looks for an object in the servlet context based on a given key.
static java.lang.Object getObjectFromCache(ViewContext vc, java.lang.Object key, ReferenceFactory factory)
          This method retrieves the servlet context from a ViewContext, and then looks for an object in the servlet context based on a given key.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

KEY

public static final java.lang.String KEY

logger

protected static org.apache.log4j.Logger logger
Constructor Detail

ContextServices

public ContextServices()
Method Detail

getContext

public static javax.servlet.ServletContext getContext(ViewContext vc)
get the servlet context from a ViewContext

Parameters:
vc - the ControlEventContext object
Returns:
the users session

getContext

public static javax.servlet.ServletContext getContext(ControlEventContext ec)
get the servlet context from a ControlEventContext

Parameters:
ec - the ControlEventContext object
Returns:
the users session

getObjectFromCache

public static java.lang.Object getObjectFromCache(ViewContext vc,
                                                  java.lang.Object key,
                                                  ReferenceFactory factory)
This method retrieves the servlet context from a ViewContext, and then looks for an object in the servlet context based on a given key. If the object is not present, it will be created using the ReferenceFactory and cached in servlet context for future use.

Parameters:
vc - the ViewContext
key - the key that identifies this object
factory - the ReferenceFactory used to create the object
Returns:
the object from the cache

getObjectFromCache

public static java.lang.Object getObjectFromCache(ControlEventContext ec,
                                                  java.lang.Object key,
                                                  ReferenceFactory factory)
This method retrieves the servlet context from a ControlEventContext, and then looks for an object in the servlet context based on a given key. If the object is not present, it will be created using the ReferenceFactory and cached in servlet context for future use.

Parameters:
ec - the ControlEventContext
key - the key that identifies this object
factory - the ReferenceFactory used to create the object
Returns:
the object from the cache

getObjectFromCache

public static java.lang.Object getObjectFromCache(javax.servlet.ServletContext context,
                                                  java.lang.Object key,
                                                  ReferenceFactory factory)
This method looks for an object in the servlet context based on a given key. If the object is not present, it will be created using the ReferenceFactory and cached in session for future use.

Parameters:
context - the ServletContext
key - the key that identifies this object
factory - the ReferenceFactory used to create the object
Returns:
the object from the cache


Copyright © 2001 Enhydra.org