Package org.jboss.security.plugins

Class JBossSecurityContextUtil

java.lang.Object

org.jboss.security.SecurityContextUtil

org.jboss.security.plugins.JBossSecurityContextUtil

public class JBossSecurityContextUtil
extends SecurityContextUtil

Utility class for JBossSecurityContext implementation

Since:

Jan 5, 2007

Version:

$Revision$

Author:

Anil Saldhana

Field Summary

Fields inherited from class org.jboss.security.SecurityContextUtil

securityContext

Constructor Summary

Constructors

Constructor	Description
JBossSecurityContextUtil(SecurityContext sc)

Method Summary

Modifier and Type	Method	Description
<T> T	get(String key)	Return an object from the Security Context
Object	getCredential()	Get the credential
RoleGroup	getRoles()	Get the Roles associated with the user for the current security context
SecurityIdentity	getSecurityIdentity()	Get a holder of subject, runAs and caller RunAs
Subject	getSubject()	Get the subject the security context
String	getUserName()	Get the username from the security context
Principal	getUserPrincipal()	Get the user principal the security context
<T> T	remove(String key)	Remove an object represented by the key from the security context
<T> void	set(String key, T obj)	Set an object on the Security Context The context implementation may place the object in its internal data structures (like the Data Map)
void	setRoles(RoleGroup roles)	Set the roles for the user for the current security context
void	setSecurityIdentity(SecurityIdentity sidentity)	Inject subject, runAs and callerRunAs into the security context Mainly used by integration code base to cache the security identity and put back to the security context

Methods inherited from class org.jboss.security.SecurityContextUtil

addIdentity, clearIdentities, createSubjectInfo, createSubjectInfo, getIdentities, setIdentities, setSecurityContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JBossSecurityContextUtil

public JBossSecurityContextUtil(SecurityContext sc)

Method Detail

get

public <T> T get(String key)

Description copied from class: SecurityContextUtil

Return an object from the Security Context

Specified by:

get in class SecurityContextUtil

Parameters:

key - key identifies the type of object we are requesting

Returns:

getUserName

public String getUserName()

Description copied from class: SecurityContextUtil

Get the username from the security context

Specified by:

getUserName in class SecurityContextUtil

Returns:

username

getUserPrincipal

public Principal getUserPrincipal()

Description copied from class: SecurityContextUtil

Get the user principal the security context

Specified by:

getUserPrincipal in class SecurityContextUtil

Returns:

user principal

getCredential

public Object getCredential()

Description copied from class: SecurityContextUtil

Get the credential

Specified by:

getCredential in class SecurityContextUtil

Returns:

getSubject

public Subject getSubject()

Description copied from class: SecurityContextUtil

Get the subject the security context

Specified by:

getSubject in class SecurityContextUtil

Returns:

set

public <T> void set(String key,
                    T obj)

Description copied from class: SecurityContextUtil

Set an object on the Security Context The context implementation may place the object in its internal data structures (like the Data Map)

Specified by:

set in class SecurityContextUtil

Type Parameters:

T - Generic Type

Parameters:

key - Key representing the object being set

remove

public <T> T remove(String key)

Description copied from class: SecurityContextUtil

Remove an object represented by the key from the security context

Specified by:

remove in class SecurityContextUtil

Parameters:

key - key identifies the type of object we are requesting

Returns:

the removed object

setRoles

public void setRoles(RoleGroup roles)

Description copied from class: SecurityContextUtil

Set the roles for the user for the current security context

Specified by:

setRoles in class SecurityContextUtil

setSecurityIdentity

public void setSecurityIdentity(SecurityIdentity sidentity)

Description copied from class: SecurityContextUtil

Inject subject, runAs and callerRunAs into the security context Mainly used by integration code base to cache the security identity and put back to the security context

Specified by:

setSecurityIdentity in class SecurityContextUtil

Parameters:

sidentity - The SecurityIdentity Object

getSecurityIdentity

public SecurityIdentity getSecurityIdentity()

Description copied from class: SecurityContextUtil

Get a holder of subject, runAs and caller RunAs

Specified by:

getSecurityIdentity in class SecurityContextUtil

Returns:

getRoles

public RoleGroup getRoles()

Description copied from class: SecurityContextUtil

Get the Roles associated with the user for the current security context

Specified by:

getRoles in class SecurityContextUtil

Returns: