com.helger.commons.scope

Interface IRequestScope

All Superinterfaces:

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

All Known Implementing Classes:

RequestScope

public interface IRequestScope
extends IScope

Interface for a single request scope object.

Author:

Philip Helger

Method Summary

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

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

destroyScope, getAllScopeRenewalAwareAttributes, getID, initScope, 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, getIterator, getTypedAttribute, getTypedAttribute

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

clear

Method Detail

getSessionID

@Nonnull
 @Nonempty
String getSessionID()

Shortcut for getSessionID(true)

Returns:

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

getSessionID

@Nullable
String getSessionID(boolean bCreateIfNotExisting)

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.

getAttributeAsList

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

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

Parameters:

sName - The name of the attribute to query.

Returns:

null if no such attribute value exists

getAttributeAsList

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

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

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

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

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

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

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

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.

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.