org.apache.cocoon.webapps.session
Interface ContextManager

All Known Implementing Classes:

DefaultContextManager

Deprecated. This block is deprecated and will be removed in future versions.

public interface ContextManager

This is the context manager. The main purpose of this component is maintaining contexts. Each application can have one or more session contexts. A context is a data container that can hold arbitrary information. The contained information can either be an XML tree or custom objects.

Version:

CVS $Id: ContextManager.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Carsten Ziegeler

Field Summary

static String

ROLE Deprecated. Avalon role

Method Summary

SessionContext	createContext(String name, String loadURI, String saveURI) Deprecated. Create a new public context in the session.
void	deleteContext(String name) Deprecated. Delete a public context in the session.
boolean	existsContext(String name) Deprecated. Check if a public context exists.
SessionContext	getContext(String name) Deprecated. Get a public context.
boolean	hasSessionContext() Deprecated. Check if a context exists

Field Detail

ROLE

static final String ROLE

Deprecated.

Avalon role

Method Detail

createContext

SessionContext createContext(String name,
                             String loadURI,
                             String saveURI)
                             throws IOException,
                                    SAXException,
                                    ProcessingException

Deprecated.

Create a new public context in the session. Create a new public session context for this user. If this context already exists no new context is created and the old one will be used instead.

Throws:

IOException

SAXException

ProcessingException

deleteContext

void deleteContext(String name)
                   throws ProcessingException

Deprecated.

Delete a public context in the session. If the context exists for this user, it and all of its information is deleted.

Throws:

ProcessingException

getContext

SessionContext getContext(String name)
                          throws ProcessingException

Deprecated.

Get a public context. The session context with the given name is returned. If the context does not exist null is returned.

Throws:

ProcessingException

hasSessionContext

boolean hasSessionContext()
                          throws ProcessingException

Deprecated.

Check if a context exists

Throws:

ProcessingException

existsContext

boolean existsContext(String name)
                      throws ProcessingException

Deprecated.

Check if a public context exists. If the session context with the given name exists, true is returned.

Throws:

ProcessingException