wamblee.org Git - utils/blob - security/usermgt/src/main/java/org/wamblee/security/authorization/package-info.java

   1 /*
   2  * Copyright 2005-2010 the original author or authors.
   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  * The authorization package provides an authorization service that can be used to
  18  * check whether users have the rights to perform certain operations:
  19  * <br/>
  20  * <img src="doc-files/Class_Diagram__org.wamblee.security.authorization__main.jpg"/>
  21  * <br/>
  22  *
  23  * {@link AuthorizationService} is the entry point. There is one POJO based implementation
  24  * {@link DefaultAuthorizationService}. In addition, there is {@link org.wamblee.security.authorization.jpa.JpaAuthorizationService}
  25  * which caches an authorization service for efficiency (i.e. {@link DefaultAuthorizationService} is an entity);
  26  *
  27  * The {@link DefaultAuthorizationService} uses a number of authorization rules to determine
  28  * whether access allowed. One generic {@link UrlAuthorizationRule} is provided which
  29  * determines whether a given user can perform a specific operation for a specific resource
  30  * type at a specific URL is allowed.
  31  *
  32  * The authorization service needs to access the current user through the
  33  * {@link org.wamblee.security.authentication.UserAccessor} and needs access to the
  34  * {@link org.wamblee.security.authentication.UserAdministration} to check whether the
  35  * user belongs to certain groups.
  36  *
  37  */
  38 package org.wamblee.security.authorization;