org.apache.cocoon.webapps.authentication.generation
Class ConfigurationGenerator

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.xml.AbstractXMLProducer
          org.apache.cocoon.generation.AbstractGenerator
              org.apache.cocoon.generation.ServiceableGenerator
                  org.apache.cocoon.webapps.authentication.generation.ConfigurationGenerator

All Implemented Interfaces:

Poolable, Recyclable, Disposable, Component, LogEnabled, Serviceable, Generator, SitemapModelComponent, XMLProducer

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

public final class ConfigurationGenerator
extends ServiceableGenerator

This is the authentication Configuration Generator.

Version:

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

Author:

Carsten Ziegeler

Field Summary

static String	REQ_PARAMETER_ID Deprecated.
static String	REQ_PARAMETER_ROLE Deprecated.
static String	REQ_PARAMETER_STATE Deprecated. Request parameter
static String	REQ_PARAMETER_USER Deprecated.
protected XPathProcessor	xpathProcessor Deprecated. The XPath Processor

Fields inherited from class org.apache.cocoon.generation.ServiceableGenerator

manager

Fields inherited from class org.apache.cocoon.generation.AbstractGenerator

objectModel, parameters, resolver, source

Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer

contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer

Fields inherited from interface org.apache.cocoon.generation.Generator

ROLE

Constructor Summary

ConfigurationGenerator()
Deprecated.

Method Summary

boolean	addUser(String role, String ID, SourceParameters parameters, org.apache.cocoon.webapps.authentication.generation.UserManagementHandler handler) Deprecated. Add a user.
void	dispose() Deprecated. Release all resources.
void	generate() Deprecated. Generate the configuration
Document	getRoles(org.apache.cocoon.webapps.authentication.generation.UserManagementHandler handler) Deprecated. Get all roles in a document fragment with the following children: ...
Document	getUsers(String role, String ID, org.apache.cocoon.webapps.authentication.generation.UserManagementHandler handler) Deprecated. Get all users in a document fragment with the following children: ...
void	service(ServiceManager manager) Deprecated. Set the current ServiceManager instance used by this Serviceable.
void	showConfiguration(XMLConsumer consumer, String src, org.apache.cocoon.webapps.authentication.generation.UserManagementHandler handler, AuthenticationContext context) Deprecated. Show the configuration for the admin.

Methods inherited from class org.apache.cocoon.generation.AbstractGenerator

recycle, setup

Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer

setConsumer, setContentHandler, setLexicalHandler

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

Methods inherited from interface org.apache.cocoon.xml.XMLProducer

setConsumer

Field Detail

REQ_PARAMETER_STATE

public static final String REQ_PARAMETER_STATE

Deprecated.

Request parameter

See Also:

Constant Field Values

REQ_PARAMETER_ROLE

public static final String REQ_PARAMETER_ROLE

Deprecated.

See Also:

Constant Field Values

REQ_PARAMETER_ID

public static final String REQ_PARAMETER_ID

Deprecated.

See Also:

Constant Field Values

REQ_PARAMETER_USER

public static final String REQ_PARAMETER_USER

Deprecated.

See Also:

Constant Field Values

xpathProcessor

protected XPathProcessor xpathProcessor

Deprecated.

The XPath Processor

Constructor Detail

ConfigurationGenerator

public ConfigurationGenerator()

Deprecated.

Method Detail

dispose

public void dispose()

Deprecated.

Description copied from class: ServiceableGenerator

Release all resources.

Specified by:

dispose in interface Disposable

Overrides:

dispose in class ServiceableGenerator

service

public void service(ServiceManager manager)
             throws ServiceException

Deprecated.

Description copied from class: ServiceableGenerator

Set the current ServiceManager instance used by this Serviceable.

Specified by:

service in interface Serviceable

Overrides:

service in class ServiceableGenerator

Throws:

ServiceException

generate

public void generate()
              throws IOException,
                     SAXException,
                     ProcessingException

Deprecated.

Generate the configuration

Throws:

IOException

SAXException

ProcessingException

showConfiguration

public void showConfiguration(XMLConsumer consumer,
                              String src,
                              org.apache.cocoon.webapps.authentication.generation.UserManagementHandler handler,
                              AuthenticationContext context)
                       throws ProcessingException,
                              SAXException,
                              IOException

Deprecated.

Show the configuration for the admin. If src is "admin" or null the admin configuration is shown. If src is "user" the configuration of the current user is shown.

Throws:

ProcessingException

SAXException

IOException

getUsers

public Document getUsers(String role,
                         String ID,
                         org.apache.cocoon.webapps.authentication.generation.UserManagementHandler handler)
                  throws IOException,
                         ProcessingException,
                         SAXException

Deprecated.

Get all users in a document fragment with the following children: ... ... ... .... The document fragment might contain further nodes at the root! If role is null all users are fetched, otherwise only the users for this role. If also ID is not null only the single user is fetched.

Throws:

IOException

ProcessingException

SAXException

getRoles

public Document getRoles(org.apache.cocoon.webapps.authentication.generation.UserManagementHandler handler)
                  throws IOException,
                         ProcessingException,
                         SAXException

Deprecated.

Get all roles in a document fragment with the following children: ... .... The document fragment might contain further nodes at the root!

Throws:

IOException

ProcessingException

SAXException

addUser

public boolean addUser(String role,
                       String ID,
                       SourceParameters parameters,
                       org.apache.cocoon.webapps.authentication.generation.UserManagementHandler handler)
                throws IOException,
                       ProcessingException,
                       SAXException

Deprecated.

Add a user.

Returns:

If a user with ID already exists false is returned.

Throws:

IOException

ProcessingException

SAXException