This project has retired. For details please refer to its Attic page.

org.apache.cocoon.webapps.session.components
Class ContextInputModule

java.lang.Object
  org.apache.cocoon.webapps.session.components.ContextInputModule

All Implemented Interfaces:

Disposable, Component, Serviceable, ThreadSafe, InputModule

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

public class ContextInputModule
extends Object
implements ThreadSafe, Serviceable, Disposable, InputModule

This input module provides access to the information of a session context using an XPath. The XPath expression that can be used is the same as for the session transformer. The first information in the path is the context, so for example {session-context:authentication/authentication/ID} delivers the ID of the current user and therefore delivers the same information as: <session:getxml context="authentication" path="/authentication/ID"/> using the session transformer.

Version:

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

Author:

Carsten Ziegeler

Field Summary

protected ContextManager	contextManager Deprecated.
protected ServiceManager	manager Deprecated.

Fields inherited from interface org.apache.cocoon.components.modules.input.InputModule

ROLE

Constructor Summary

ContextInputModule()
Deprecated.

Method Summary

void	dispose() Deprecated.
Object	getAttribute(String name, Configuration modeConf, Map objectModel) Deprecated. Standard access to an attribute's value.
Iterator	getAttributeNames(Configuration modeConf, Map objectModel) Deprecated. Returns an Iterator of String objects containing the names of the attributes available.
Object[]	getAttributeValues(String name, Configuration modeConf, Map objectModel) Deprecated. Returns an array of String objects containing all of the values the given attribute has, or null if the attribute does not exist.
void	service(ServiceManager manager) Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

manager

protected ServiceManager manager

Deprecated.

contextManager

protected ContextManager contextManager

Deprecated.

Constructor Detail

ContextInputModule

public ContextInputModule()

Deprecated.

Method Detail

getAttribute

public Object getAttribute(String name,
                           Configuration modeConf,
                           Map objectModel)
                    throws ConfigurationException

Deprecated.

Description copied from interface: InputModule

Standard access to an attribute's value. If more than one value exists, the first is returned. If the value does not exist, null is returned. To get all values, use InputModule.getAttributeValues(String, Configuration, Map) or InputModule.getAttributeNames(Configuration, Map) and InputModule.getAttribute(String, Configuration, Map) to get them one by one.

Specified by:

getAttribute in interface InputModule

Parameters:

name - a String that specifies what the caller thinks would identify an attribute. This is mainly a fallback if no modeConf is present.

modeConf - column's mode configuration from resource description. This argument is optional.

Throws:

ConfigurationException

getAttributeNames

public Iterator getAttributeNames(Configuration modeConf,
                                  Map objectModel)
                           throws ConfigurationException

Deprecated.

Description copied from interface: InputModule

Returns an Iterator of String objects containing the names of the attributes available. If no attributes are available, the method returns an empty Iterator.

Specified by:

getAttributeNames in interface InputModule

Parameters:

modeConf - column's mode configuration from resource description. This argument is optional.

Throws:

ConfigurationException

getAttributeValues

public Object[] getAttributeValues(String name,
                                   Configuration modeConf,
                                   Map objectModel)
                            throws ConfigurationException

Deprecated.

Description copied from interface: InputModule

Returns an array of String objects containing all of the values the given attribute has, or null if the attribute does not exist. As an alternative, InputModule.getAttributeNames(Configuration, Map) together with InputModule.getAttribute(String, Configuration, Map) can be used to get the values one by one.

Specified by:

getAttributeValues in interface InputModule

Parameters:

name - a String that specifies what the caller thinks would identify an attributes. This is mainly a fallback if no modeConf is present.

modeConf - column's mode configuration from resource description. This argument is optional.

Throws:

ConfigurationException

service

public void service(ServiceManager manager)
             throws ServiceException

Deprecated.

Specified by:

service in interface Serviceable

Throws:

ServiceException

dispose

public void dispose()

Deprecated.

Specified by:

dispose in interface Disposable