Package com.microstrategy.web.app
Class StringRequestKeys
- java.lang.Object
-
- com.microstrategy.web.beans.GenericRequestKeys
-
- com.microstrategy.web.app.beans.CaseInsensitiveRequestKeys
-
- com.microstrategy.web.app.StringRequestKeys
-
- All Implemented Interfaces:
RequestKeys
public class StringRequestKeys extends CaseInsensitiveRequestKeys
The StringRequestKeys class makes available to the application the values of parameters passed on a specified string, with URL format. For example, the format of the string should be likeabc=1&def=one&g=false
- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Field Summary
-
Fields inherited from class com.microstrategy.web.beans.GenericRequestKeys
src
-
-
Constructor Summary
Constructors Constructor Description StringRequestKeys()
Constructor.StringRequestKeys(WebEvent webEvent, int eventElements)
Packages the information inside a WebEvent into a RequestKeys object.StringRequestKeys(java.lang.String urlString)
Constructor.StringRequestKeys(java.lang.String urlString, boolean hasTargetReference)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addKey(java.lang.String key, java.lang.String value)
Adds parameter into request keys.Source
getSource(java.lang.String key)
Determines where a given request key was sourced from.protected void
initializeRequestKeys()
Initializes the collection with the values from the Request and/or Session, according to what was specified by the keySpace.void
replaceKey(java.lang.String key, java.lang.String value, int index)
Replaces parameter value for any existing parameter.-
Methods inherited from class com.microstrategy.web.app.beans.CaseInsensitiveRequestKeys
getKeyListByPrefix, getKeyToSearch, getValue, getValue, getValueCount, updateKeyMapping
-
Methods inherited from class com.microstrategy.web.beans.GenericRequestKeys
add, add, addKeyValue, addObject, getAllValues, getDebugOut, getIntValue, getIntValue, getName, getNameCount, getObjectAtIndex, getValueObject, getValueObject, isEmpty, remove, setInitialized, setObjectAtIndex, setSource, setValue, setValueObject, toString
-
-
-
-
Constructor Detail
-
StringRequestKeys
public StringRequestKeys()
Constructor. Initializes a new empty instance of the StringRequestKeys class.
-
StringRequestKeys
public StringRequestKeys(java.lang.String urlString, boolean hasTargetReference)
Constructor.- Parameters:
urlString
- The URL string contains request parameters.hasTargetReference
- A boolean value indicates whether there is target information included in the URL. For example, URL Stringabc=1&def=one
doesn't contain target, but URL Stringhttp://localhost/page?abc=1&def=one
contains target information. Target will be ingored when building request keys.
-
StringRequestKeys
public StringRequestKeys(java.lang.String urlString)
Constructor.- Parameters:
urlString
- The URL string contains request parameters, such asabc=1&def=one
.
-
StringRequestKeys
public StringRequestKeys(WebEvent webEvent, int eventElements)
Packages the information inside a WebEvent into a RequestKeys object.- Parameters:
webEvent
- The event to retrieve information from.eventElements
- This parameter is used to control what should be added into request keys, such as event id, soruce, etc. The elements to add to this RequestKeys object. This is a bit-OR of the Event elements defined in EnumEventElement.EnumEventElement
.- Since:
- MicroStrategy Web 8.0.0
-
-
Method Detail
-
addKey
public void addKey(java.lang.String key, java.lang.String value)
Adds parameter into request keys.- Parameters:
key
- The parameter name.value
- The parameter value.
-
replaceKey
public void replaceKey(java.lang.String key, java.lang.String value, int index)
Replaces parameter value for any existing parameter.- Parameters:
key
- The name of the parameter.value
- The new value of the parameter.index
- The position to add the key-value pair.
-
initializeRequestKeys
protected void initializeRequestKeys()
Initializes the collection with the values from the Request and/or Session, according to what was specified by the keySpace.- Overrides:
initializeRequestKeys
in classGenericRequestKeys
-
getSource
public Source getSource(java.lang.String key)
Description copied from interface:RequestKeys
Determines where a given request key was sourced from.- Specified by:
getSource
in interfaceRequestKeys
- Overrides:
getSource
in classGenericRequestKeys
-
-