站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > JBoss 3.2.7 server API Documentation 英文版文档

SecurityAssociation (JBoss Server API) - JBoss 3.2.7 server API Documentation 英文版文档

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.jboss.security
Class SecurityAssociation

java.lang.Object
  extended byorg.jboss.security.SecurityAssociation
public final class SecurityAssociation
extends Object

The SecurityAssociation class maintains the security principal and credentials. This can be done on either a singleton basis or a thread local basis depending on the server property. When the server property has been set to true, the security information is maintained in thread local storage. The type of thread local storage depends on the org.jboss.security.SecurityAssociation.ThreadLocal property. If this property is true, then the thread local storage object is of type java.lang.ThreadLocal which results in the current thread's security information NOT being propagated to child threads. When the property is false or does not exist, the thread local storage object is of type java.lang.InheritableThreadLocal, and any threads spawned by the current thread will inherit the security information of the current thread. Subseqent changes to the current thread's security information are NOT propagated to any previously spawned child threads. When the server property is false, security information is maintained in class variables which makes the information available to all threads within the current VM.

Version:
$Revision: 1.10.4.5 $
Author:
Daniel O'Connor (docodan@nycap.rr.com), Scott.Stark@jboss.org

Constructor Summary
SecurityAssociation()
           
 
Method Summary
static void clear()
          Clear all principal information.
static Object getContextInfo(Object key)
          Get the current thread context info.
static Object getCredential()
          Get the current principal credential information.
static Principal getPrincipal()
          Get the current principal information.
static Subject getSubject()
          Get the current Subject information.
static Principal peekRunAsRole()
          Look at the current thread of control's run-as principal role.
static Principal popRunAsRole()
          Pop the current thread of control's run-as principal role.
static void pushRunAsRole(Principal runAsRole)
          Push the current thread of control's run-as principal role.
static Object setContextInfo(Object key, Object value)
          Set the current thread context info.
static void setCredential(Object credential)
          Set the current principal credential information.
static void setPrincipal(Principal principal)
          Set the current principal information.
static void setServer()
          Set the server mode of operation.
static void setSubject(Subject subject)
          Set the current Subject information.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SecurityAssociation

public SecurityAssociation()
Method Detail

getPrincipal

public static Principal getPrincipal()
Get the current principal information. If a security manager is present, then this method calls the security manager's checkPermission method with a RuntimePermission("org.jboss.security.SecurityAssociation.getPrincipalInfo") permission to ensure it's ok to access principal information. If not, a SecurityException will be thrown.

Returns:
Principal, the current principal identity.

getCredential

public static Object getCredential()
Get the current principal credential information. This can be of any type including: a String password, a char[] password, an X509 cert, etc. If a security manager is present, then this method calls the security manager's checkPermission method with a RuntimePermission("org.jboss.security.SecurityAssociation.getPrincipalInfo") permission to ensure it's ok to access principal information. If not, a SecurityException will be thrown.

Returns:
Object, the credential that proves the principal identity.

getSubject

public static Subject getSubject()
Get the current Subject information. If a security manager is present, then this method calls the security manager's checkPermission method with a RuntimePermission("org.jboss.security.SecurityAssociation.getSubject") permission to ensure it's ok to access principal information. If not, a SecurityException will be thrown.

Returns:
Subject, the current Subject identity.

setPrincipal

public static void setPrincipal(Principal principal)
Set the current principal information. If a security manager is present, then this method calls the security manager's checkPermission method with a RuntimePermission("org.jboss.security.SecurityAssociation.setPrincipalInfo") permission to ensure it's ok to access principal information. If not, a SecurityException will be thrown.

Parameters:
principal - - the current principal identity.

setCredential

public static void setCredential(Object credential)
Set the current principal credential information. This can be of any type including: a String password, a char[] password, an X509 cert, etc. If a security manager is present, then this method calls the security manager's checkPermission method with a RuntimePermission("org.jboss.security.SecurityAssociation.setPrincipalInfo") permission to ensure it's ok to access principal information. If not, a SecurityException will be thrown.

Parameters:
credential - - the credential that proves the principal identity.

setSubject

public static void setSubject(Subject subject)
Set the current Subject information. If a security manager is present, then this method calls the security manager's checkPermission method with a RuntimePermission("org.jboss.security.SecurityAssociation.setPrincipalInfo") permission to ensure it's ok to access principal information. If not, a SecurityException will be thrown.

Parameters:
subject - - the current identity.

getContextInfo

public static Object getContextInfo(Object key)
Get the current thread context info. If a security manager is present, then this method calls the security manager's checkPermission method with a RuntimePermission("org.jboss.security.SecurityAssociation.accessContextInfo", "get") permission to ensure it's ok to access context information. If not, a SecurityException will be thrown.

Parameters:
key - - the context key
Returns:
the mapping for the key in the current thread context

setContextInfo

public static Object setContextInfo(Object key,
                                    Object value)
Set the current thread context info. If a security manager is present, then this method calls the security manager's checkPermission method with a RuntimePermission("org.jboss.security.SecurityAssociation.accessContextInfo", "set") permission to ensure it's ok to access context information. If not, a SecurityException will be thrown.

Parameters:
key - - the context key
value - - the context value to associate under key
Returns:
the previous mapping for the key if one exists

clear

public static void clear()
Clear all principal information. If a security manager is present, then this method calls the security manager's checkPermission method with a RuntimePermission("org.jboss.security.SecurityAssociation.setPrincipalInfo") permission to ensure it's ok to access principal information. If not, a SecurityException will be thrown.

pushRunAsRole

public static void pushRunAsRole(Principal runAsRole)
Push the current thread of control's run-as principal role.

popRunAsRole

public static Principal popRunAsRole()
Pop the current thread of control's run-as principal role.

peekRunAsRole

public static Principal peekRunAsRole()
Look at the current thread of control's run-as principal role.

setServer

public static void setServer()
Set the server mode of operation. When the server property has been set to true, the security information is maintained in thread local storage. This should be called to enable property security semantics in any multi-threaded environment where more than one thread requires that security information be restricted to the thread's flow of control. If a security manager is present, then this method calls the security manager's checkPermission method with a RuntimePermission("org.jboss.security.SecurityAssociation.setServer") permission to ensure it's ok to access principal information. If not, a SecurityException will be thrown.

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2002 JBoss Group, LLC. All Rights Reserved.