KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > lenya > ac > AccessController


1 /*
2  * Copyright 1999-2004 The Apache Software Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17
18 package org.apache.lenya.ac;
19
20 import org.apache.avalon.framework.component.Component;
21 import org.apache.cocoon.environment.Request;
22
23 /**
24  * An access controller allows authenticating and authorizing identities.
25  * @version $Id: AccessController.java 43240 2004-08-16 16:21:22Z andreas $
26  */
27 public interface AccessController extends Component {
28
29     String JavaDoc NAMESPACE = "http://apache.org/cocoon/lenya/ac/1.0";
30     String JavaDoc DEFAULT_PREFIX = "ac";
31     
32     String JavaDoc ROLE = AccessController.class.getName();
33
34     /**
35      * Authenticates a request.
36      * @param request A request.
37      * @return A boolean value.
38      * @throws AccessControlException when something went wrong.
39      */
40     boolean authenticate(Request request) throws AccessControlException;
41
42     /**
43      * Authorizes a request inside a publication.
44      * @param request A request.
45      * @return A boolean value.
46      * @throws AccessControlException when something went wrong.
47      */
48     boolean authorize(Request request) throws AccessControlException;
49     
50     /**
51      * Initializes the identity for this access controller.
52      * @param request The request that contains the identity information.
53      * @throws AccessControlException when something went wrong.
54      */
55     void setupIdentity(Request request) throws AccessControlException;
56
57 }
58
Popular Tags