KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > blojsom > authorization > AuthorizationProvider


1 /**
2  * Copyright (c) 2003-2006, David A. Czarnecki
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * Redistributions of source code must retain the above copyright notice, this list of conditions and the
9  * following disclaimer.
10  * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
11  * following disclaimer in the documentation and/or other materials provided with the distribution.
12  * Neither the name of "David A. Czarnecki" and "blojsom" nor the names of its contributors may be used to
13  * endorse or promote products derived from this software without specific prior written permission.
14  * Products derived from this software may not be called "blojsom", nor may "blojsom" appear in their name,
15  * without prior written permission of David A. Czarnecki.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
18  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
19  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
20  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
21  * EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
29  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31 package org.blojsom.authorization;
32
33 import org.blojsom.ConfigurationException;
34 import org.blojsom.blog.Blog;
35 import org.blojsom.blog.User;
36
37 import java.util.Map JavaDoc;
38
39 /**
40  * AuthorizationProvider
41  *
42  * @author David Czarnecki
43  * @version $Id: AuthorizationProvider.java,v 1.4 2006/03/22 21:46:46 czarneckid Exp $
44  * @since blojsom 3.0
45  */
46 public interface AuthorizationProvider {
47
48     /**
49      * Initialization method for the authorization provider
50      *
51      * @throws ConfigurationException If there is an error initializing the provider
52      */
53     public void init() throws ConfigurationException;
54     
55     /**
56      * Authorize a username and password for the given {@link Blog}
57      *
58      * @param blog {@link Blog}
59      * @param authorizationContext {@link Map} to be used to provide other information for authorization. This will
60      * change depending on the authorization provider.
61      * @param userLogin Username
62      * @param password Password
63      * @throws AuthorizationException If there is an error authorizing the username and password
64      */
65     public void authorize(Blog blog, Map JavaDoc authorizationContext, String JavaDoc userLogin, String JavaDoc password) throws AuthorizationException;
66
67     /**
68      * Check a permission for the given {@link Blog}
69      *
70      * @param blog {@link Blog}
71      * @param permissionContext {@link Map} to be used to provide other information for permission check. This will
72      * change depending on the authorization provider.
73      * @param userLogin Username
74      * @param permission Permission
75      * @throws AuthorizationException If there is an error checking the permission for the username and permission
76      */
77     public void checkPermission(Blog blog, Map JavaDoc permissionContext, String JavaDoc userLogin, String JavaDoc permission) throws AuthorizationException;
78 }
Popular Tags