com.helger.commons.scope

Class RequestScope

java.lang.Object

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

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.RequestScope

All Implemented Interfaces:

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

public class RequestScope
extends AbstractMapBasedScope
implements IRequestScope

Default implementation for non-web request scopes.

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
RequestScope(String sScopeID, String sSessionID)

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getAttributeAsList(String sName) Get a list of all attribute values with the same name.
List<String>	getAttributeAsList(String sName, List<String> aDefault) Get a list of all attribute values with the same name.
protected List<String>	getAttributeAsListCustom(String sName, Object aValue, List<String> aDefault) Try to convert the passed value into a List of String.
String	getSessionID() Shortcut for getSessionID(true)
String	getSessionID(boolean bCreateIfNotExisting)
boolean	hasAttributeValue(String sName, String sDesiredValue) Check if a attribute with the given name is present in the request and has the specified value.
boolean	hasAttributeValue(String sName, String sDesiredValue, boolean bDefault) Check if a attribute with the given name is present in the request and has the specified value.
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

destroyOwnedScopes, destroyScope, equals, getAllScopeRenewalAwareAttributes, getID, hashCode, isDestroyed, isInDestruction, isInPreDestruction, isValid, runAtomic, runAtomic

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

getAndSetAttributeFlag, getClone, setAttribute, setAttribute, setAttribute, setAttribute

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, containsNoAttribute, getAllAttributeNames, getAllAttributes, getAllAttributeValues, getAttributeCount, getAttributeObject

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

getAsBigDecimal, getAsBigInteger, getAsBoolean, getAsDouble, getAsInt, getAsLong, getAsString, getAttributeAsBigDecimal, getAttributeAsBigDecimal, getAttributeAsBigInteger, getAttributeAsBigInteger, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDouble, getAttributeAsDouble, getAttributeAsInt, getAttributeAsInt, getAttributeAsLong, getAttributeAsLong, getAttributeAsString, getAttributeAsString, getCastedAttribute, getCastedAttribute, getTypedAttribute, getTypedAttribute

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, containsNoAttribute, getAllAttributeNames, getAllAttributes, getAllAttributeValues, getAttributeAsBigDecimal, getAttributeAsBigDecimal, getAttributeAsBigInteger, getAttributeAsBigInteger, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDouble, getAttributeAsDouble, getAttributeAsInt, getAttributeAsInt, getAttributeAsLong, getAttributeAsLong, getAttributeAsString, getAttributeAsString, getAttributeCount, getAttributeObject, getCastedAttribute, getCastedAttribute, getTypedAttribute, getTypedAttribute

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

clear

Constructor Detail

RequestScope

public RequestScope(@Nonnull@Nonempty
            String sScopeID,
            @Nonnull@Nonempty
            String sSessionID)

Method Detail

getSessionID

@Nonnull
@Nonempty
public final String getSessionID()

Description copied from interface: IRequestScope

Shortcut for getSessionID(true)

Specified by:

getSessionID in interface IRequestScope

Returns:

The session ID associated with this request. May be null if no session ID is present and no session should be created.

getSessionID

@Nonnull
@Nonempty
public final String getSessionID(boolean bCreateIfNotExisting)

Specified by:

getSessionID in interface IRequestScope

Parameters:

bCreateIfNotExisting - if true a session ID is created if needed

Returns:

The session ID associated with this request. May be null if no session ID is present and no session should be created.

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

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

getAttributeAsList

@Nullable
public List<String> getAttributeAsList(@Nullable
                                       String sName)

Description copied from interface: IRequestScope

Get a list of all attribute values with the same name.

Specified by:

getAttributeAsList in interface IRequestScope

Parameters:

sName - The name of the attribute to query.

Returns:

null if no such attribute value exists

getAttributeAsListCustom

@Nullable
@OverrideOnDemand
protected List<String> getAttributeAsListCustom(@Nullable
                                                              String sName,
                                                              @Nonnull
                                                              Object aValue,
                                                              @Nullable
                                                              List<String> aDefault)

Try to convert the passed value into a List of String. This method is only called, if the passed value is non-null, if it is not an String array or a single String.

Parameters:

sName - The name of the parameter to be queried. Just for informational purposes.

aValue - The retrieved non-null attribute value which is neither a String nor a String array.

aDefault - The default value to be returned, in case no type conversion could be found.

Returns:

The converted value or the default value.

getAttributeAsList

@Nullable
public List<String> getAttributeAsList(@Nullable
                                       String sName,
                                       @Nullable
                                       List<String> aDefault)

Description copied from interface: IRequestScope

Get a list of all attribute values with the same name.

Specified by:

getAttributeAsList in interface IRequestScope

Parameters:

sName - The name of the attribute to query.

aDefault - The default value to be returned, if no such attribute is present.

Returns:

aDefault if no such attribute value exists

hasAttributeValue

public boolean hasAttributeValue(@Nullable
                        String sName,
                        @Nullable
                        String sDesiredValue)

Description copied from interface: IRequestScope

Check if a attribute with the given name is present in the request and has the specified value.

Specified by:

hasAttributeValue in interface IRequestScope

Parameters:

sName - The name of the attribute to check

sDesiredValue - The value to be matched

Returns:

true if an attribute with the given name is present and has the desired value

hasAttributeValue

public boolean hasAttributeValue(@Nullable
                        String sName,
                        @Nullable
                        String sDesiredValue,
                        boolean bDefault)

Description copied from interface: IRequestScope

Check if a attribute with the given name is present in the request and has the specified value. If no such attribute is present, the passed default value is returned.

Specified by:

hasAttributeValue in interface IRequestScope

Parameters:

sName - The name of the attribute to check

sDesiredValue - The value to be matched

bDefault - the default value to be returned, if the specified attribute is not present

Returns:

true if an attribute with the given name is present and has the desired value, false if the attribute is present but has a different value. If the attribute is not present, the default value is returned.

toString

public String toString()

Overrides:

toString in class AbstractMapBasedScope