01: /*
02: * Copyright (c) 1998-2008 Caucho Technology -- all rights reserved
03: *
04: * This file is part of Resin(R) Open Source
05: *
06: * Each copy or derived work must preserve the copyright notice and this
07: * notice unmodified.
08: *
09: * Resin Open Source is free software; you can redistribute it and/or modify
10: * it under the terms of the GNU General Public License as published by
11: * the Free Software Foundation; either version 2 of the License, or
12: * (at your option) any later version.
13: *
14: * Resin Open Source is distributed in the hope that it will be useful,
15: * but WITHOUT ANY WARRANTY; without even the implied warranty of
16: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
17: * of NON-INFRINGEMENT. See the GNU General Public License for more
18: * details.
19: *
20: * You should have received a copy of the GNU General Public License
21: * along with Resin Open Source; if not, write to the
22: * Free SoftwareFoundation, Inc.
23: * 59 Temple Place, Suite 330
24: * Boston, MA 02111-1307 USA
25: *
26: * @author Scott Ferguson
27: */
28:
29: package com.caucho.security;
30:
31: import java.security.Principal;
32:
33: /**
34: * Defines the interface any security provider must implement.
35: */
36: public interface SecurityContextProvider {
37: /**
38: * Returns the Principal for the context.
39: *
40: * @return the principal in the context or null.
41: */
42: public Principal getUserPrincipal() throws SecurityContextException;
43:
44: /**
45: * Returns true if the user principal plays the named role.
46: *
47: * @param permission the permission to test against.
48: */
49: public boolean isUserInRole(String permission);
50:
51: /**
52: * Sets the current runAs role/principal. This should affect
53: * <code>isUserInRole</code> and <code>getUserPrincipal</code>.
54: *
55: * @param roleName the new role
56: * @return the old run-as role
57: */
58: public String runAs(String roleName);
59:
60: /**
61: * Returns true if the transport context is secure (SSL).
62: */
63: public boolean isTransportSecure() throws SecurityContextException;
64:
65: /**
66: * Logs the principal out.
67: */
68: public void logout() throws SecurityContextException;
69: }
|