org.apache.lenya.ac
Interface AccessController

All Superinterfaces:
org.apache.avalon.framework.component.Component

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

An access controller allows authenticating and authorizing identities.

Version:
$Id: AccessController.java 473861 2006-11-12 03:51:14Z gregor $

Field Summary
static java.lang.String DEFAULT_PREFIX
          The default prefix for the access control namespace.
static java.lang.String NAMESPACE
          The access control namespace URI.
static java.lang.String ROLE
          The Avalon 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.
 AccreditableManager getAccreditableManager()
          Returns the accreditable manager.
 Authorizer[] getAuthorizers()
           
 PolicyManager getPolicyManager()
          Returns the policy manager.
 void setupIdentity(org.apache.cocoon.environment.Request request)
          Initializes the identity for this access controller.
 

Field Detail

NAMESPACE

static final java.lang.String NAMESPACE
The access control namespace URI.

See Also:
Constant Field Values

DEFAULT_PREFIX

static final java.lang.String DEFAULT_PREFIX
The default prefix for the access control namespace.

See Also:
Constant Field Values

ROLE

static final java.lang.String ROLE
The Avalon 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.

getAccreditableManager

AccreditableManager getAccreditableManager()
Returns the accreditable manager.

Returns:
An accreditable manager.

getPolicyManager

PolicyManager getPolicyManager()
Returns the policy manager.

Returns:
A policy manager.

getAuthorizers

Authorizer[] getAuthorizers()
Returns:
The authorizers.


Copyright 1999-2006 Apache Software Foundation. All Rights Reserved.