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

org.apache.lenya.cms.cocoon.components.modules.input
Class AccessControlModule

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.components.modules.input.AbstractInputModule
          org.apache.lenya.cms.cocoon.components.modules.input.AccessControlModule

All Implemented Interfaces:

org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.component.Component, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.logger.LogEnabled, org.apache.avalon.framework.service.Serviceable, org.apache.cocoon.components.modules.input.InputModule

public class AccessControlModule
extends org.apache.cocoon.components.modules.input.AbstractInputModule
implements org.apache.avalon.framework.service.Serviceable

Input module for access control attributes.

Field Summary

static java.lang.String	GROUP_MANAGER
static java.lang.String	IP_ADDRESS
static java.lang.String	IP_RANGE_MANAGER
static java.lang.String[]	PARAMETER_NAMES The names of the AccessControlModule parameters.
static java.lang.String	ROLE_IDS
static java.lang.String	ROLE_MANAGER
static java.lang.String	USER_EMAIL
static java.lang.String	USER_ID
static java.lang.String	USER_MANAGER
static java.lang.String	USER_NAME

Fields inherited from class org.apache.cocoon.components.modules.input.AbstractInputModule

settings

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

ROLE

Constructor Summary

AccessControlModule()

Method Summary

java.lang.Object	getAttribute(java.lang.String name, org.apache.avalon.framework.configuration.Configuration modeConf, java.util.Map objectModel)
java.util.Iterator	getAttributeNames(org.apache.avalon.framework.configuration.Configuration modeConf, java.util.Map objectModel)
java.lang.Object[]	getAttributeValues(java.lang.String name, org.apache.avalon.framework.configuration.Configuration modeConf, java.util.Map objectModel)
protected ItemManager	getItemManager(org.apache.cocoon.environment.Request request, java.lang.String name) Returns the item manager for a certain name.
void	service(org.apache.avalon.framework.service.ServiceManager manager)

Methods inherited from class org.apache.cocoon.components.modules.input.AbstractInputModule

configure, dispose

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

USER_ID

public static final java.lang.String USER_ID

See Also:

Constant Field Values

USER_NAME

public static final java.lang.String USER_NAME

See Also:

Constant Field Values

USER_EMAIL

public static final java.lang.String USER_EMAIL

See Also:

Constant Field Values

IP_ADDRESS

public static final java.lang.String IP_ADDRESS

See Also:

Constant Field Values

ROLE_IDS

public static final java.lang.String ROLE_IDS

See Also:

Constant Field Values

USER_MANAGER

public static final java.lang.String USER_MANAGER

See Also:

Constant Field Values

GROUP_MANAGER

public static final java.lang.String GROUP_MANAGER

See Also:

Constant Field Values

ROLE_MANAGER

public static final java.lang.String ROLE_MANAGER

See Also:

Constant Field Values

IP_RANGE_MANAGER

public static final java.lang.String IP_RANGE_MANAGER

See Also:

Constant Field Values

PARAMETER_NAMES

public static final java.lang.String[] PARAMETER_NAMES

The names of the AccessControlModule parameters.

Constructor Detail

AccessControlModule

public AccessControlModule()

Method Detail

getAttribute

public java.lang.Object getAttribute(java.lang.String name,
                                     org.apache.avalon.framework.configuration.Configuration modeConf,
                                     java.util.Map objectModel)
                              throws org.apache.avalon.framework.configuration.ConfigurationException

Specified by:

getAttribute in interface org.apache.cocoon.components.modules.input.InputModule

Overrides:

getAttribute in class org.apache.cocoon.components.modules.input.AbstractInputModule

Throws:

org.apache.avalon.framework.configuration.ConfigurationException

See Also:

InputModule.getAttribute(java.lang.String, org.apache.avalon.framework.configuration.Configuration, java.util.Map)

getAttributeNames

public java.util.Iterator getAttributeNames(org.apache.avalon.framework.configuration.Configuration modeConf,
                                            java.util.Map objectModel)
                                     throws org.apache.avalon.framework.configuration.ConfigurationException

Specified by:

getAttributeNames in interface org.apache.cocoon.components.modules.input.InputModule

Overrides:

getAttributeNames in class org.apache.cocoon.components.modules.input.AbstractInputModule

Throws:

org.apache.avalon.framework.configuration.ConfigurationException

See Also:

InputModule.getAttributeNames(org.apache.avalon.framework.configuration.Configuration, java.util.Map)

getAttributeValues

public java.lang.Object[] getAttributeValues(java.lang.String name,
                                             org.apache.avalon.framework.configuration.Configuration modeConf,
                                             java.util.Map objectModel)
                                      throws org.apache.avalon.framework.configuration.ConfigurationException

Specified by:

getAttributeValues in interface org.apache.cocoon.components.modules.input.InputModule

Overrides:

getAttributeValues in class org.apache.cocoon.components.modules.input.AbstractInputModule

Throws:

org.apache.avalon.framework.configuration.ConfigurationException

See Also:

InputModule.getAttributeValues(java.lang.String, org.apache.avalon.framework.configuration.Configuration, java.util.Map)

getItemManager

protected ItemManager getItemManager(org.apache.cocoon.environment.Request request,
                                     java.lang.String name)
                              throws org.apache.avalon.framework.configuration.ConfigurationException

Returns the item manager for a certain name.

Parameters:

request - The request.

name - The name of the manager (USER_MANAGER, ROLE_MANAGER, GROUP_MANAGER, or IP_RANGE_MANAGER

Returns:

An item manager.

Throws:

org.apache.avalon.framework.configuration.ConfigurationException - when something went wrong.

service

public void service(org.apache.avalon.framework.service.ServiceManager manager)
             throws org.apache.avalon.framework.service.ServiceException

Specified by:

service in interface org.apache.avalon.framework.service.Serviceable

Throws:

org.apache.avalon.framework.service.ServiceException

See Also:

Serviceable.service(org.apache.avalon.framework.service.ServiceManager)