01: /**
02: * Copyright (c) 2003-2007, David A. Czarnecki
03: * All rights reserved.
04: *
05: * Redistribution and use in source and binary forms, with or without
06: * modification, are permitted provided that the following conditions are met:
07: *
08: * Redistributions of source code must retain the above copyright notice, this list of conditions and the
09: * 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: */package org.blojsom.authorization;
31:
32: import org.blojsom.ConfigurationException;
33: import org.blojsom.blog.Blog;
34: import org.blojsom.blog.User;
35:
36: import java.util.Map;
37:
38: /**
39: * AuthorizationProvider
40: *
41: * @author David Czarnecki
42: * @version $Id: AuthorizationProvider.java,v 1.5 2007/01/17 02:35:16 czarneckid Exp $
43: * @since blojsom 3.0
44: */
45: public interface AuthorizationProvider {
46:
47: /**
48: * Initialization method for the authorization provider
49: *
50: * @throws ConfigurationException If there is an error initializing the provider
51: */
52: public void init() throws ConfigurationException;
53:
54: /**
55: * Authorize a username and password for the given {@link Blog}
56: *
57: * @param blog {@link Blog}
58: * @param authorizationContext {@link Map} to be used to provide other information for authorization. This will
59: * change depending on the authorization provider.
60: * @param userLogin Username
61: * @param password Password
62: * @throws AuthorizationException If there is an error authorizing the username and password
63: */
64: public void authorize(Blog blog, Map authorizationContext,
65: String userLogin, String password)
66: throws AuthorizationException;
67:
68: /**
69: * Check a permission for the given {@link Blog}
70: *
71: * @param blog {@link Blog}
72: * @param permissionContext {@link Map} to be used to provide other information for permission check. This will
73: * change depending on the authorization provider.
74: * @param userLogin Username
75: * @param permission Permission
76: * @throws AuthorizationException If there is an error checking the permission for the username and permission
77: */
78: public void checkPermission(Blog blog, Map permissionContext,
79: String userLogin, String permission)
80: throws AuthorizationException;
81: }
|