SecurityContextProvider


1   /*
2    * Copyright (c) 1998-2006 Caucho Technology -- all rights reserved
3    *
4    * This file is part of Resin(R) Open Source
5    *
6    * Each copy or derived work must preserve the copyright notice and this
7    * notice unmodified.
8    *
9    * 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()
43      throws SecurityContextException;
44    
45    /**
46     * Returns true if the user principal plays the named role.
47     *
48     * @param roleName the role to test against.
49     */
50    public boolean isUserInRole(String   roleName);
51    
52    /**
53     * Returns true if the transport context is secure (SSL).
54     */
55    public boolean isTransportSecure()
56      throws SecurityContextException;
57    
58    /**
59     * Logs the principal out.
60     */
61    public void logout()
62      throws SecurityContextException;
63  }
64
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags