X-Git-Url: http://wamblee.org/gitweb/?a=blobdiff_plain;f=security%2Fusermgt%2Fsrc%2Fmain%2Fjava%2Forg%2Fwamblee%2Fsecurity%2Fauthorization%2Fpackage-info.java;fp=security%2Fusermgt%2Fsrc%2Fmain%2Fjava%2Forg%2Fwamblee%2Fsecurity%2Fauthorization%2Fpackage-info.java;h=ceaa813651db8321d79a557a225c3905241929e0;hb=86c580fd452e3b03fe752d4908f010e10989e09e;hp=0000000000000000000000000000000000000000;hpb=9cd9d0f6f0dc9c27faa2a173b657cfe715e2d34d;p=utils
diff --git a/security/usermgt/src/main/java/org/wamblee/security/authorization/package-info.java b/security/usermgt/src/main/java/org/wamblee/security/authorization/package-info.java
new file mode 100644
index 00000000..ceaa8136
--- /dev/null
+++ b/security/usermgt/src/main/java/org/wamblee/security/authorization/package-info.java
@@ -0,0 +1,38 @@
+/*
+ * Copyright 2005-2010 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * The authorization package provides an authorization service that can be used to
+ * check whether users have the rights to perform certain operations:
+ *
+ *
+ *
+ *
+ * {@link AuthorizationService} is the entry point. There is one POJO based implementation
+ * {@link DefaultAuthorizationService}. In addition, there is {@link org.wamblee.security.authorization.jpa.JpaAuthorizationService}
+ * which caches an authorization service for efficiency (i.e. {@link DefaultAuthorizationService} is an entity);
+ *
+ * The {@link DefaultAuthorizationService} uses a number of authorization rules to determine
+ * whether access allowed. One generic {@link UrlAuthorizationRule} is provided which
+ * determines whether a given user can perform a specific operation for a specific resource
+ * type at a specific URL is allowed.
+ *
+ * The authorization service needs to access the current user through the
+ * {@link org.wamblee.security.authentication.UserAccessor} and needs access to the
+ * {@link org.wamblee.security.authentication.UserAdministration} to check whether the
+ * user belongs to certain groups.
+ *
+ */
+package org.wamblee.security.authorization;
\ No newline at end of file