|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
com.ibm.b2bi.im.portal.EpicContextBean
This class can be used to hold the interaction context details during user's HTTP session. By default it comes with a root node with empty string as node name and this is used by the logon/initialization process to maintain some generic information that can be used across various services hosted in a solution desktop for e.g user name etc. Create child nodes for each service and use that node and its child nodes to maintain relevant session information for that service. This effectively eliminates various services overwriting data using same name in the HTTPSession object. See the appropriate documentaion for more details.
Field Summary | |
static java.lang.String |
copyrightNotice
|
Constructor Summary | |
EpicContextBean()
EpicContextBean constructor comment. |
Method Summary | |
boolean |
addListener(java.lang.String service,
CleanupConnections impl)
Registers the listener for the given service. |
boolean |
contains(java.lang.String parentContext,
java.lang.String childContext)
Verifies if there is a child context node by the given name in the given parent context node. |
java.lang.String |
createContext(java.lang.String assignedName,
java.lang.String parentContext)
Creates a new context node with the given name under the given parent node. |
void |
destroyContext(java.lang.String contextName)
Removes the named context node from the common root context. |
java.util.Hashtable |
getCompleteContext(java.lang.String contextName)
Gets the entire list of values (contexts) stored under each node starting from the given node as the parent. |
java.lang.Object |
getContextValue(java.lang.String contextNodeName,
java.lang.String contextName)
Gets the value of the context with given name in the given context node. |
java.lang.String |
getCurrentContext(javax.servlet.http.HttpServletRequest request)
Gets the name of the current context stored in given Request object. |
java.lang.String |
getParamDescription(java.lang.String contextID)
Returns the context ID in the name/vale pair format. |
boolean |
hasChildContexts(java.lang.String context)
Checks if the given node has any child nodes. |
boolean |
hasContextValues(java.lang.String context,
boolean searchChildren)
Checks if the given context has any context values in it. |
void |
removeContextValue(java.lang.String context,
java.lang.String name)
Removes the named value from the given context. |
void |
removeListener(java.lang.String service,
CleanupConnections impl)
Remove the registered cleanup connections listener for the given service. |
void |
setContextValue(java.lang.String context,
java.lang.String name,
java.lang.Object value)
Puts the given context name and its value in the given node. |
void |
setCurrentContext(java.lang.String contextid,
javax.servlet.http.HttpServletRequest request)
Sets the context name associated with the request object. |
void |
updateListener(java.lang.String service,
CleanupConnections impl)
Updates the listener for existing service. |
void |
valueBound(javax.servlet.http.HttpSessionBindingEvent se)
|
void |
valueUnbound(javax.servlet.http.HttpSessionBindingEvent se)
|
Field Detail |
public static final java.lang.String copyrightNotice
Constructor Detail |
public EpicContextBean()
Method Detail |
public boolean addListener(java.lang.String service, CleanupConnections impl)
public boolean contains(java.lang.String parentContext, java.lang.String childContext) throws NodeNotFoundException
parentContext
- java.lang.String Parent context node under which, the child context node should be searched for.childContext
- java.lang.String Child context node name that is being searched for it existence.public java.lang.String createContext(java.lang.String assignedName, java.lang.String parentContext)
assignedName
- Name of the new context node.parentContext
- Name of the parent node.public void destroyContext(java.lang.String contextName)
contextName
- Name of the context node to be removed.public java.util.Hashtable getCompleteContext(java.lang.String contextName)
Name
- of the node from which all context values have to be retrieved.public java.lang.Object getContextValue(java.lang.String contextNodeName, java.lang.String contextName) throws NodeNotFoundException
contextNodeName
- Name of the context node.contextName
- Name of the context whose value is being requested.public java.lang.String getCurrentContext(javax.servlet.http.HttpServletRequest request)
request
- The request object which holds the name of the context.public java.lang.String getParamDescription(java.lang.String contextID)
contextID
- Name of the context.public boolean hasChildContexts(java.lang.String context)
context
- Name of the node to check for contexts.public boolean hasContextValues(java.lang.String context, boolean searchChildren)
context
- Name of the context.searchChildren
- If true, specifies API to look for context value in children if no value is found in the given context itself.public void removeContextValue(java.lang.String context, java.lang.String name)
context
- name String indicating the name of the context node.name
- String indicating the name of the value to be removed from the given context node.public void removeListener(java.lang.String service, CleanupConnections impl) throws IMException
public void setContextValue(java.lang.String context, java.lang.String name, java.lang.Object value)
context
- The name of the context node into which the context value has to be stored.name
- Name of the context.value
- Value of the context.public void setCurrentContext(java.lang.String contextid, javax.servlet.http.HttpServletRequest request)
public void updateListener(java.lang.String service, CleanupConnections impl) throws IMException
service
- java.lang.Stringimpl
- com.ibm.b2bi.im.portal.CleanupConnectionspublic void valueBound(javax.servlet.http.HttpSessionBindingEvent se)
public void valueUnbound(javax.servlet.http.HttpSessionBindingEvent se)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |