atg.repository

Class MembershipContext

java.lang.Object

atg.repository.MembershipContext

public class MembershipContext
extends java.lang.Object

Static methods to add/remove membership filtering contexts to a java thread. Repository getItem() calls and queries can be restricted to include items from certain membership contexts using static methods of this class.

For example: if I only wants repository calls or queries to work on items which are members of context 'contextA', I would push a collection with a single element 'contextA'.

 try{
    MembershipContext.pushMembershipContexts(Collections.singleton("contextA"));
    // repository calls or query executions here.  
    
  }finally
  {
    MembershipContext.popMembershipContexts();
  }
  

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MembershipContext.MembershipContextService An instance to use to expose logging and other settings to nucleus.
static class	MembershipContext.MembershipContextsSnapshot An opaque class representing the state of the MembershipContext stack for this thread.
static class	MembershipContext.MembershipContextsThreadLocalCopier A JobThreadLocalValueCopier that copies our ThreadLocal for passing to another thread.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION
static boolean	sDumpStackOnMembershipContextChange Whether to dump stack on add/remove/clears.
static boolean	sTrackPushers Whether we are tracking the stacks of callers who enable membership filters These build up until a clear is called.

Constructor Summary

Constructors

Constructor and Description
MembershipContext(java.lang.String pContextID)
MembershipContext(java.lang.String pContextID, boolean pExclusion)

Method Summary

Modifier and Type	Method and Description
static void	dumpPushers() Dumps pushers for this thread to stdout.
boolean	equals(java.lang.Object obj)
static java.lang.String	format(java.lang.String key, java.lang.Object[] args)
java.lang.String	getContextID()
static java.util.Collection<MembershipContext>	getCurrentMembershipContexts() Get the current set of membership Contexts for the this thread.
static MembershipContext.MembershipContextsSnapshot	getSnapshot() Return a snapshot of the state of the membership context.
int	hashCode()
boolean	isExclusion()
static java.util.Collection<MembershipContext>	popMembershipContexts()
static void	pushMembershipContexts(java.util.Collection<MembershipContext> pContextStringCollection) Push a collection of membership contexts to the stack of contexts and make it current in this thread.
static void	pushMembershipContexts(GlobalContextType pGlobalType) Push a global membership context on the stack.
static void	reset() Clears the state.
static java.util.Collection<MembershipContext>	singleton(java.lang.String pContextID) Utility method to create a single element object of this kind.
static java.util.Collection<MembershipContext>	singletonNegation(java.lang.String pContextID)
static ContextFilteringRules	toContextFilteringRules() Convert current membership context to corresponding ContextFilteringRules object
static ContextFilteringRules	toContextFilteringRules(java.util.Collection<MembershipContext> pMembershipContexts) Convert current membership context to corresponding ContextFilteringRules object

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

sTrackPushers

public static boolean sTrackPushers

Whether we are tracking the stacks of callers who enable membership filters These build up until a clear is called.

sDumpStackOnMembershipContextChange

public static boolean sDumpStackOnMembershipContextChange

Whether to dump stack on add/remove/clears. Only has an effect if loggingDebug is true.

Constructor Detail

MembershipContext

public MembershipContext(java.lang.String pContextID)

Parameters:

pContextID -

MembershipContext

public MembershipContext(java.lang.String pContextID,
                         boolean pExclusion)

Parameters:

pContextID - the value

pExclusion - If this is an exclusion.

Method Detail

getContextID

public java.lang.String getContextID()

isExclusion

public boolean isExclusion()

singleton

public static java.util.Collection<MembershipContext> singleton(java.lang.String pContextID)

Utility method to create a single element object of this kind. This is useful when you only want to push a single context on the ThreadLocal stack and don't want to create this object yourself

Parameters:

pContextID -

Returns:

singletonNegation

public static java.util.Collection<MembershipContext> singletonNegation(java.lang.String pContextID)

toContextFilteringRules

public static ContextFilteringRules toContextFilteringRules()

Convert current membership context to corresponding ContextFilteringRules object

Returns:

toContextFilteringRules

public static ContextFilteringRules toContextFilteringRules(java.util.Collection<MembershipContext> pMembershipContexts)

Convert current membership context to corresponding ContextFilteringRules object

Returns:

pushMembershipContexts

public static void pushMembershipContexts(java.util.Collection<MembershipContext> pContextStringCollection)

Push a collection of membership contexts to the stack of contexts and make it current in this thread. You can call this method with a single membership context ID, say 'contextA' using the utility method singleton:

    MembershipContext.pushMembershipContexts(MembershipContext.singleton('contextA'));
 

Parameters:

pContextStringCollection -

pushMembershipContexts

public static void pushMembershipContexts(GlobalContextType pGlobalType)

Push a global membership context on the stack. A global membership context can be any element of GlobalContextType enumeration.

Parameters:

pGlobalType -

popMembershipContexts

public static java.util.Collection<MembershipContext> popMembershipContexts()

getCurrentMembershipContexts

public static java.util.Collection<MembershipContext> getCurrentMembershipContexts()

Get the current set of membership Contexts for the this thread. If a membership Context hasn't been explicitly set, this method will return null

Returns:

the current Contexts or null

format

public static java.lang.String format(java.lang.String key,
                                      java.lang.Object[] args)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

reset

public static void reset()

Clears the state. This should only be used by thread pools which need to reuse this thread.

getSnapshot

public static MembershipContext.MembershipContextsSnapshot getSnapshot()

Return a snapshot of the state of the membership context. Can be used to later revert the state.

dumpPushers

public static void dumpPushers()

Dumps pushers for this thread to stdout.