2 * Copyright 2005-2010 the original author or authors.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 package org.wamblee.security.authorization;
18 import org.wamblee.security.authentication.UserAdministration;
21 * Represents an authorization rule to determine whether an operation is allowed
24 * @author Erik Brakkee
26 public interface AuthorizationRule {
29 * Sets the user admnistration to use.
30 * @param aAdmin User administration.
32 void setUserAdministration(UserAdministration aAdmin);
35 * Returns the supported object types for which this authorization rule
36 * applies. This can be used by the authorization service for optimization.
38 * @return Array of supported types.
40 Class[] getSupportedTypes();
43 * Determines whether an operation is allowed on a certain resource. The
44 * rule implementation must be prepared to deal with resources for which it
45 * does not apply. In those cases it should return
46 * {@link AuthorizationResult#UNSUPPORTED_RESOURCE}.
55 * @return Authorization result.
57 AuthorizationResult isAllowed(Object aResource,
58 Operation aOperation, String aUser);