com.helger.commons.scope

Class GlobalScope

java.lang.Object

com.helger.commons.collection.attr.MapBasedReadOnlyAttributeContainer<KEYTYPE,VALUETYPE>

com.helger.commons.collection.attr.MapBasedAttributeContainer<KEYTYPE,Object>

com.helger.commons.collection.attr.MapBasedAttributeContainerAny<String>

com.helger.commons.scope.AbstractMapBasedScope

com.helger.commons.scope.GlobalScope

All Implemented Interfaces:

IAttributeContainer<String,Object>, IMutableAttributeContainer<String,Object>, IMutableAttributeContainerAny<String>, IHasID<String>, ICloneable<MapBasedAttributeContainer<String,Object>>, IGlobalScope, IScope, IClearable, Serializable

@ThreadSafe
public class GlobalScope
extends AbstractMapBasedScope
implements IGlobalScope

Base implementation of the IGlobalScope interface.
Note: for synchronization issues, this class stores the attributes in a separate map.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields inherited from class com.helger.commons.scope.AbstractMapBasedScope

m_aRWLock

Fields inherited from class com.helger.commons.collection.attr.MapBasedReadOnlyAttributeContainer

m_aAttrs

Constructor Summary

Constructors

Constructor and Description
GlobalScope(String sScopeID)

Method Summary

Modifier and Type	Method and Description
protected IApplicationScope	createApplicationScope(String sApplicationID) This method creates a new application scope.
protected void	destroyOwnedScopes() Override this method to destroy all scopes owned by this scope.
boolean	equals(Object o)
ICommonsMap<String,IApplicationScope>	getAllApplicationScopes()
IApplicationScope	getApplicationScope(String sApplicationID, boolean bCreateIfNotExisting) Get or create an application scope with the given ID.
int	getApplicationScopeCount()
int	hashCode()
void	initScope() Init the scope.
protected void	postDestroy() Override this method to perform further actions AFTER the scope was destroyed.
protected void	preDestroy() Override this method to perform further actions BEFORE the scope is destroyed.
String	toString()

Methods inherited from class com.helger.commons.scope.AbstractMapBasedScope

destroyScope, getAllScopeRenewalAwareAttributes, getID, isDestroyed, isInDestruction, isInPreDestruction, isValid, runAtomic, runAtomic

Methods inherited from class com.helger.commons.collection.attr.MapBasedAttributeContainerAny

getClone

Methods inherited from class com.helger.commons.collection.attr.MapBasedAttributeContainer

clear, onBeforeRemoveAllAttributes, onBeforeRemoveAttribute, onBeforeSetAttributeValue, removeAttribute, setAttribute, setAttributes, setAttributes

Methods inherited from class com.helger.commons.collection.attr.MapBasedReadOnlyAttributeContainer

containsAttribute, getAllAttributeNames, getAllAttributes, getAllAttributeValues, getAttributeCount, getAttributeObject, getIterator, isEmpty

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.scope.IScope

destroyScope, getAllScopeRenewalAwareAttributes, getID, isDestroyed, isInDestruction, isValid, runAtomic, runAtomic

Methods inherited from interface com.helger.commons.collection.attr.IMutableAttributeContainerAny

getAndSetAttributeFlag, setAttribute, setAttribute, setAttribute, setAttribute

Methods inherited from interface com.helger.commons.collection.attr.IMutableAttributeContainer

removeAttribute, setAttribute, setAttributes, setAttributes

Methods inherited from interface com.helger.commons.collection.attr.IAttributeContainer

containsAttribute, getAllAttributeNames, getAllAttributes, getAllAttributeValues, getAttributeAsBigDecimal, getAttributeAsBigDecimal, getAttributeAsBigInteger, getAttributeAsBigInteger, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDouble, getAttributeAsDouble, getAttributeAsInt, getAttributeAsInt, getAttributeAsLong, getAttributeAsLong, getAttributeAsString, getAttributeAsString, getAttributeCount, getAttributeObject, getCastedAttribute, getCastedAttribute, getIterator, getTypedAttribute, getTypedAttribute, isEmpty, isNotEmpty

Methods inherited from interface com.helger.commons.state.IClearable

clear

Methods inherited from interface com.helger.commons.id.IHasID

getComparatorID

Constructor Detail

GlobalScope

public GlobalScope(@Nonnull @Nonempty
                   String sScopeID)

Method Detail

initScope

public void initScope()

Description copied from interface: IScope

Init the scope. In contrast to the constructor of a scope, this happens after the scope has been registered in the scope manager.

Specified by:

initScope in interface IScope

destroyOwnedScopes

protected void destroyOwnedScopes()

Description copied from class: AbstractMapBasedScope

Override this method to destroy all scopes owned by this scope.

Overrides:

destroyOwnedScopes in class AbstractMapBasedScope

preDestroy

protected void preDestroy()

Description copied from class: AbstractMapBasedScope

Override this method to perform further actions BEFORE the scope is destroyed. The state is "in pre destruction".

Overrides:

preDestroy in class AbstractMapBasedScope

postDestroy

protected void postDestroy()

Description copied from class: AbstractMapBasedScope

Override this method to perform further actions AFTER the scope was destroyed. The state is "destroyed".

Overrides:

postDestroy in class AbstractMapBasedScope

createApplicationScope

@Nonnull
 @OverrideOnDemand
protected IApplicationScope createApplicationScope(@Nonnull @Nonempty
                                                                                 String sApplicationID)

This method creates a new application scope. Override in WebScopeManager to create an IApplicationWebScope!

Parameters:

sApplicationID - The application ID to use

Returns:

Never null.

getApplicationScope

@Nullable
public IApplicationScope getApplicationScope(@Nonnull @Nonempty
                                                        String sApplicationID,
                                                        boolean bCreateIfNotExisting)

Description copied from interface: IGlobalScope

Get or create an application scope with the given ID.

Specified by:

getApplicationScope in interface IGlobalScope

Parameters:

sApplicationID - The ID of the application scope to create. May neither be null nor empty.

bCreateIfNotExisting - if true the scope is created on first demand if it is not yet existing.

Returns:

null if bCreateIfNotExisting is false and the scope is not present

getAllApplicationScopes

@Nonnull
 @ReturnsMutableCopy
public ICommonsMap<String,IApplicationScope> getAllApplicationScopes()

Specified by:

getAllApplicationScopes in interface IGlobalScope

Returns:

A non-null map with all available application scopes. The key is the application ID and the value is the scope.

getApplicationScopeCount

@Nonnegative
public int getApplicationScopeCount()

Specified by:

getApplicationScopeCount in interface IGlobalScope

Returns:

The number of contained application scopes. Always ≥ 0.

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractMapBasedScope

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractMapBasedScope

toString

public String toString()

Overrides:

toString in class AbstractMapBasedScope