java.lang.Object
- com.sun.enterprise.security.common.AbstractSecurityContext
- - com.sun.enterprise.security.SecurityContext

All Implemented Interfaces:

AppServSecurityContext, Serializable
```
@Service
@PerLookup
public class SecurityContext
extends AbstractSecurityContext
```
This class that extends AbstractSecurityContext that gets stored in Thread Local Storage. If the current thread creates child threads, the SecurityContext stored in the current thread is automatically propagated to the child threads. This class is used on the server side to represent the security context.

Author:

Harish Prabandham, Harpreet Singh

See Also:

ThreadLocal, InheritableThreadLocal, Serialized Form

Field Summary
- Fields inherited from class com.sun.enterprise.security.common.AbstractSecurityContext
  additionalPrincipal, callerPrincipal, subject

Constructor Summary

Constructors
Constructor	Description
`SecurityContext()`
`SecurityContext(String username, Subject subject)`
`SecurityContext(String username, Subject subject, String realm)`
`SecurityContext(Subject subject)`	Create a SecurityContext with the given subject having a DistinguishedPrincipalCredential.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`didServerGenerateCredentials()`
`Principal`	`getCallerPrincipal()`	This method returns the caller principal.
`static SecurityContext`	`getCurrent()`	This method gets the SecurityContext stored in the Thread Local Store (TLS) of the current thread.
`AppServSecurityContext`	`getCurrentSecurityContext()`
`static Principal`	`getDefaultCallerPrincipal()`
`static SecurityContext`	`getDefaultSecurityContext()`
`static Subject`	`getDefaultSubject()`
`Set<Principal>`	`getPrincipalSet()`
`Subject`	`getSubject()`	This method should be implemented by the subclasses to return the Credentials of the caller principal.
`static SecurityContext`	`init()`	Initialize the SecurityContext and handle the unauthenticated principal case
`AppServSecurityContext`	`newInstance(String username, Subject subject)`
`AppServSecurityContext`	`newInstance(String username, Subject subject, String realm)`
`void`	`postConstruct()`
`static void`	`reset(SecurityContext securityContext)`	No need to unmarshall the unauthenticated principal....
`static void`	`setCurrent(SecurityContext securityContext)`	This method sets the SecurityContext stored in the TLS.
`void`	`setCurrentSecurityContext(AppServSecurityContext context)`	set the current security context
`void`	`setSecurityContextWithPrincipal(Principal principal)`	set the SecurityContext with given Principal
`static void`	`setUnauthenticatedContext()`
`void`	`setUnauthenticatedSecurityContext()`	set the unauthenticated context
`String`	`toString()`

Methods inherited from class com.sun.enterprise.security.common.AbstractSecurityContext
getAdditionalPrincipal, setAdditionalPrincipal

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SecurityContext
```
public SecurityContext(String username,
                       Subject subject)
```
  - SecurityContext
```
public SecurityContext(Subject subject)
```
    Create a SecurityContext with the given subject having a DistinguishedPrincipalCredential.
    This is used for a JASPIC environment.
    
    Parameters:
    
    subject -
  - SecurityContext
```
public SecurityContext(String username,
                       Subject subject,
                       String realm)
```
  - SecurityContext
```
public SecurityContext()
```
- Method Detail
  - init
```
public static SecurityContext init()
```
    Initialize the SecurityContext and handle the unauthenticated principal case
  - getDefaultSecurityContext
```
public static SecurityContext getDefaultSecurityContext()
```
  - getDefaultSubject
```
public static Subject getDefaultSubject()
```
  - getDefaultCallerPrincipal
```
public static Principal getDefaultCallerPrincipal()
```
  - reset
```
public static void reset(SecurityContext securityContext)
```
    No need to unmarshall the unauthenticated principal....
  - getCurrent
```
public static SecurityContext getCurrent()
```
    This method gets the SecurityContext stored in the Thread Local Store (TLS) of the current thread.
    
    Returns:
    
    The current Security Context stored in TLS. It returns null if SecurityContext could not be found in the current thread.
  - setCurrent
```
public static void setCurrent(SecurityContext securityContext)
```
    This method sets the SecurityContext stored in the TLS.
    
    Parameters:
    
    securityContext - The Security Context that should be stored in TLS. This public static method needs to be protected such that it can only be called by container code. Otherwise it can be called by application code to set its subject (which the EJB security manager will use to create a domain combiner, and then everything the ejb does will be run as the corresponding subject.
  - setUnauthenticatedContext
```
public static void setUnauthenticatedContext()
```
  - didServerGenerateCredentials
```
public boolean didServerGenerateCredentials()
```
  - getCallerPrincipal
```
public Principal getCallerPrincipal()
```
    This method returns the caller principal. This information may be redundant since the same information can be inferred by inspecting the Credentials of the caller.
    
    Specified by:
    
    getCallerPrincipal in interface AppServSecurityContext
    
    Specified by:
    
    getCallerPrincipal in class AbstractSecurityContext
    
    Returns:
    
    The caller Principal.
  - getSubject
```
public Subject getSubject()
```
    Description copied from class: AbstractSecurityContext
    
    This method should be implemented by the subclasses to return the Credentials of the caller principal.
    
    Specified by:
    
    getSubject in interface AppServSecurityContext
    
    Specified by:
    
    getSubject in class AbstractSecurityContext
    
    Returns:
    
    A credentials object associated with the current client invocation.
  - getPrincipalSet
```
public Set<Principal> getPrincipalSet()
```
  - postConstruct
```
public void postConstruct()
```
  - newInstance
```
public AppServSecurityContext newInstance(String username,
                                          Subject subject,
                                          String realm)
```
    Returns:
    
    a new instance
  - newInstance
```
public AppServSecurityContext newInstance(String username,
                                          Subject subject)
```
    Returns:
    
    a new instance
  - setCurrentSecurityContext
```
public void setCurrentSecurityContext(AppServSecurityContext context)
```
    Description copied from interface: AppServSecurityContext
    
    set the current security context
  - getCurrentSecurityContext
```
public AppServSecurityContext getCurrentSecurityContext()
```
    Returns:
    
    the current security context
  - setUnauthenticatedSecurityContext
```
public void setUnauthenticatedSecurityContext()
```
    Description copied from interface: AppServSecurityContext
    
    set the unauthenticated context
  - setSecurityContextWithPrincipal
```
public void setSecurityContextWithPrincipal(Principal principal)
```
    Description copied from interface: AppServSecurityContext
    
    set the SecurityContext with given Principal
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SecurityContext

Field Summary

Fields inherited from class com.sun.enterprise.security.common.AbstractSecurityContext

Constructor Summary

Method Summary

Methods inherited from class com.sun.enterprise.security.common.AbstractSecurityContext

Methods inherited from class java.lang.Object

Constructor Detail

SecurityContext

SecurityContext

SecurityContext

SecurityContext

Method Detail

init

getDefaultSecurityContext

getDefaultSubject

getDefaultCallerPrincipal

reset

getCurrent

setCurrent

setUnauthenticatedContext

didServerGenerateCredentials

getCallerPrincipal

getSubject

getPrincipalSet

postConstruct

newInstance

newInstance

setCurrentSecurityContext

getCurrentSecurityContext

setUnauthenticatedSecurityContext

setSecurityContextWithPrincipal

toString