org.apache.lenya.ac
Interface AccessController

All Superinterfaces:

org.apache.avalon.framework.component.Component

All Known Implementing Classes:

BypassableAccessController, DefaultAccessController

public interface AccessController
extends org.apache.avalon.framework.component.Component

An access controller allows authenticating and authorizing identities.

Version:

$Id: AccessController.java 494708 2007-01-10 04:36:36Z antonio $

Field Summary

static java.lang.String	DEFAULT_PREFIX
static java.lang.String	NAMESPACE
static java.lang.String	ROLE

Method Summary

boolean	authenticate(org.apache.cocoon.environment.Request request) Authenticates a request.
boolean	authorize(org.apache.cocoon.environment.Request request) Authorizes a request inside a publication.
void	setupIdentity(org.apache.cocoon.environment.Request request) Initializes the identity for this access controller.

Field Detail

NAMESPACE

static final java.lang.String NAMESPACE

See Also:

Constant Field Values

DEFAULT_PREFIX

static final java.lang.String DEFAULT_PREFIX

See Also:

Constant Field Values

ROLE

static final java.lang.String ROLE

Method Detail

authenticate

boolean authenticate(org.apache.cocoon.environment.Request request)
                     throws AccessControlException

Authenticates a request.

Parameters:

request - A request.

Returns:

A boolean value.

Throws:

AccessControlException - when something went wrong.

authorize

boolean authorize(org.apache.cocoon.environment.Request request)
                  throws AccessControlException

Authorizes a request inside a publication.

Parameters:

request - A request.

Returns:

A boolean value.

Throws:

AccessControlException - when something went wrong.

setupIdentity

void setupIdentity(org.apache.cocoon.environment.Request request)
                   throws AccessControlException

Initializes the identity for this access controller.

Parameters:

request - The request that contains the identity information.

Throws:

AccessControlException - when something went wrong.