01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: *
17: */
18:
19: package org.apache.lenya.ac;
20:
21: import org.apache.avalon.framework.component.Component;
22: import org.apache.cocoon.environment.Request;
23:
24: /**
25: * An access controller allows authenticating and authorizing identities.
26: * @version $Id: AccessController.java 473861 2006-11-12 03:51:14Z gregor $
27: */
28: public interface AccessController extends Component {
29:
30: /**
31: * The access control namespace URI.
32: */
33: String NAMESPACE = "http://apache.org/cocoon/lenya/ac/1.0";
34:
35: /**
36: * The default prefix for the access control namespace.
37: */
38: String DEFAULT_PREFIX = "ac";
39:
40: /**
41: * The Avalon role.
42: */
43: String ROLE = AccessController.class.getName();
44:
45: /**
46: * Authenticates a request.
47: * @param request A request.
48: * @return A boolean value.
49: * @throws AccessControlException when something went wrong.
50: */
51: boolean authenticate(Request request) throws AccessControlException;
52:
53: /**
54: * Authorizes a request inside a publication.
55: * @param request A request.
56: * @return A boolean value.
57: * @throws AccessControlException when something went wrong.
58: */
59: boolean authorize(Request request) throws AccessControlException;
60:
61: /**
62: * Initializes the identity for this access controller.
63: * @param request The request that contains the identity information.
64: * @throws AccessControlException when something went wrong.
65: */
66: void setupIdentity(Request request) throws AccessControlException;
67:
68: /**
69: * Returns the accreditable manager.
70: * @return An accreditable manager.
71: */
72: AccreditableManager getAccreditableManager();
73:
74: /**
75: * Returns the policy manager.
76: * @return A policy manager.
77: */
78: PolicyManager getPolicyManager();
79:
80: /**
81: * @return The authorizers.
82: */
83: Authorizer[] getAuthorizers();
84:
85: }
|