com.goldencode.p2j.security

Class RelatedThread

java.lang.Object

java.lang.Thread

com.goldencode.p2j.security.ContextAwareThread

com.goldencode.p2j.security.RelatedThread

All Implemented Interfaces:

java.lang.Runnable

public class RelatedThread
extends ContextAwareThread

Provides a thread which automatically inherits the account of the creating thread but uses a "related" security context. A related context is one that shares only thread-safe context. When the thread exits, it will automatically cleanup the context (decrementing the reference counts of any related resources and so forth). This makes it easy to implement additional threads which all share the same thread-safe resources, the same subjects and the same rights without sharing all context-local data.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Thread	main The "main" thread of the related threads.
private static java.util.HashMap<java.lang.Thread,java.util.Map<java.lang.Object,java.lang.Object>>	storage Stores a map that is shared between all related sessions.

Fields inherited from class com.goldencode.p2j.security.ContextAwareThread

sm, stack

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
RelatedThread(java.lang.Runnable core) Constructor which allows the core logic to be specified.

Method Summary

Modifier and Type	Method and Description
static java.lang.Object	get(java.lang.Object key) Obtain the common object mapped by the given key for the current thread's related thread group.
boolean	needsSession() Report if this thread should create a new session when the security context is pushed or if the existing session should be reused.
private static java.util.Map<java.lang.Object,java.lang.Object>	relatedStorage() Lookup the related thread storage for the given thread.
static java.lang.Object	remove(java.lang.Object key) Remove the mapping (both the key and the value), if one is present for that key.
static void	set(java.lang.Object key, java.lang.Object value) Store the common object using the given key for the current thread's related thread group.

Methods inherited from class com.goldencode.p2j.security.ContextAwareThread

run

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Field Detail

storage

private static final java.util.HashMap<java.lang.Thread,java.util.Map<java.lang.Object,java.lang.Object>> storage

Stores a map that is shared between all related sessions.

main

private final java.lang.Thread main

The "main" thread of the related threads.

Constructor Detail

RelatedThread

public RelatedThread(java.lang.Runnable core)
              throws java.lang.NullPointerException

Constructor which allows the core logic to be specified.

Parameters:

core - The logic to execute when the thread is started. Must not be null.

Throws:

java.lang.NullPointerException - If the instantiating thread has no security context or if core is null.

Method Detail

get

public static java.lang.Object get(java.lang.Object key)

Obtain the common object mapped by the given key for the current thread's related thread group. If the current thread is not part of a group of related threads (either as the main thread or as a RelatedThread instance), then there will be no object returned.

Parameters:

key - Object used as a key in the lookup.

Returns:

The object mapped for the related thread group or null if there is no object mapped under that key OR if the current thread is not part of a related thread group.

set

public static void set(java.lang.Object key,
                       java.lang.Object value)

Store the common object using the given key for the current thread's related thread group. If the current thread is not part of a group of related threads (either as the main thread or as a RelatedThread instance), then there will be no object stored.

Do NOT use an easily guessed key (e.g. a string) for any stored resource. This storage facility is by nature a public facility. Any code that can run on the current thread can read a stored value if the key is known. If you have a named resource that you need to store, do not use the name as a key. Keep your own private map of the names to keys and use a new Object instance as the keys.

Parameters:

key - Object used as a key in the mapping.

value - The object to be stored.

remove

public static java.lang.Object remove(java.lang.Object key)

Remove the mapping (both the key and the value), if one is present for that key.

Parameters:

key - Object used as a key in the mapping.

Returns:

The object which was mapped, if present, otherwise null.

needsSession

public boolean needsSession()

Report if this thread should create a new session when the security context is pushed or if the existing session should be reused.

Overrides:

needsSession in class ContextAwareThread

Returns:

true if a new session must be created.

relatedStorage

private static java.util.Map<java.lang.Object,java.lang.Object> relatedStorage()

Lookup the related thread storage for the given thread. If the current thread is not part of a group of related threads (either as the main thread or as a RelatedThread instance), then there will be no storage returned.

Returns:

The related thread storage or null if this thread is not part of a group of related threads.