EZBSecurityContext


1   /**
2    * EasyBeans
3    * Copyright (C) 2006 Bull S.A.S.
4    * Contact: easybeans@objectweb.org
5    *
6    * This library is free software; you can redistribute it and/or
7    * modify it under the terms of the GNU Lesser General Public
8    * License as published by the Free Software Foundation; either
9    * version 2.1 of the License, or any later version.
10   *
11   * This library is distributed in the hope that it will be useful,
12   * but WITHOUT ANY WARRANTY; without even the implied warranty of
13   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14   * Lesser General Public License for more details.
15   *
16   * You should have received a copy of the GNU Lesser General Public
17   * License along with this library; if not, write to the Free Software
18   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
19   * USA
20   *
21   * --------------------------------------------------------------------------
22   * $Id: EZBSecurityContext.java 1121 2006-09-27 08:51:06Z benoitf $
23   * --------------------------------------------------------------------------
24   */
25  
26  package org.objectweb.easybeans.security.api;
27  
28  import java.security.Principal  ;
29  
30  import javax.security.auth.Subject  ;
31  
32  /**
33   * Interface used to describe operations on a security context.
34   * @author Florent Benoit
35   */
36  public interface EZBSecurityContext {
37  
38      /**
39       * Gets the caller's principal.
40       * @param runAsBean if true, the bean is a run-as bean.
41       * @return principal of the caller.
42       */
43      Principal   getCallerPrincipal(final boolean runAsBean);
44  
45      /**
46       * Enters in run-as mode with the given subject.<br>
47       * The previous subject is stored and will be restored when run-as mode will
48       * be ended.
49       * @param runAsSubject the subject to used in run-as mode.
50       * @return the previous subject.
51       */
52      Subject   enterRunAs(final Subject   runAsSubject);
53  
54      /**
55       * Ends the run-as mode and then restore the context stored by container.
56       * @param oldSubject subject kept by container and restored.
57       */
58      void endsRunAs(final Subject   oldSubject);
59  
60      /**
61       * Gets the caller's roles.
62       * @param runAsBean if true, the bean is a run-as bean.
63       * @return array of roles of the caller.
64       */
65      Principal  [] getCallerRoles(final boolean runAsBean);
66  
67  }
68
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags