public abstract class

CaseInsensitiveRequestKeys

extends GenericRequestKeys

java.lang.Object
↳	com.microstrategy.web.beans.GenericRequestKeys
	↳	com.microstrategy.web.app.beans.CaseInsensitiveRequestKeys

Known Direct Subclasses

StringRequestKeys

Class Overview

The CaseInsensitiveRequestKeys abstract class makes available the architecture required for being able to handle request keys as case insensitive. If one key is recorded as "abc" with value "1" and another with key as "ABC" and value "2", both values will be accessible via the same key (that can be requested as "abc", "ABC", "aBC", etc).
Any child of this class should call the getKeyToSearch(String) and updateKeyMapping(String) whenever requests with keys are directly called. These methods take care of mapping the user-given key to the one actually used for storing the values.

Summary

[Expand]

Inherited Fields

From class com.microstrategy.web.beans.GenericRequestKeys

Public Constructors
	CaseInsensitiveRequestKeys() Class constructor.

Public Methods
Enumeration	getKeyListByPrefix(String prefix) Returns an enumeration over all the keys with the specified prefix.
String	getValue(String keyName) Returns from this collection a comma separated string of all the values mapped by the specified `keyName`.
String	getValue(String keyName, int valueIndex) Returns the value at the specified position mapped by the specified `keyName`.
int	getValueCount(String keyName) Returns from this collection the number of values mapped with the `keyName`.

Protected Methods
String	getKeyToSearch(String originalKey) Get which key to search, for supporting case insensitive scenarios.
void	updateKeyMapping(String originalKey) Keep the key mapping list updated by calling this method with the key name requested by the user.

[Expand]

Inherited Methods

From class com.microstrategy.web.beans.GenericRequestKeys

String	add(String key, String value) Appends a value to a collection mapped by the key specified.
String	add(String key, String value, String delimiter) Appends a value to a collection mapped by the key specified.
LinkedList	addKeyValue(String key, Object value) Adds an Object to the collection defined by the key.
Object	addObject(String key, Object value) Appends an Object to a collection mapped by the key specified.
LinkedList	getAllValues(String keyName) Retrieves all values associated with the key.
MarkupOutput	getDebugOut() Get the Debug Information into the output
int	getIntValue(String keyName, int valueIndex) Parses the value of given request key to an integer.
int	getIntValue(String keyName, int valueIndex, int defaultValue) Parses the value of given request key to an integer.
Enumeration	getKeyListByPrefix(String prefix) Returns an enumeration over all the keys with the specified prefix.
String	getName(int nameIndex) Returns the key at the specified position from the current collection.
int	getNameCount() Returns the total number of keys stored in the collection.
Object	getObjectAtIndex(String keyName, int valueIndex) Retrieves the Object located at a specific index within the collection defined by keyName.
Source	getSource(String key) Determines where a given request key was sourced from.
String	getValue(String keyName) Returns from this collection a comma separated string of all the values mapped by the specified `keyName`.
String	getValue(String keyName, int valueIndex) Returns the value at the specified position mapped by the specified `keyName`.
int	getValueCount(String keyName) Returns from this collection the number of values mapped with the `keyName`.
Object	getValueObject(String keyName, int valueIndex) Returns the Object at the specified position mapped by the specified `keyName`.
Enumeration	getValueObject(String key) Returns the collection of all the values mapped by the specified `keyName`.
void	initializeRequestKeys() Initializes the key-value collection from various sources.
boolean	isEmpty() Returns whether the value collection is empty.
void	remove(String key) Removes the argument with the given key.
void	setInitialized(boolean initialized) Sets a flag indicating whether this collection has been initialized.
void	setObjectAtIndex(String key, Object value, int index) Used by setValue and setValueObject to do the actual work.
void	setSource(String key, Source source)
void	setValue(String key, String value, int index) Replaces the value at a specific index for a given key.
void	setValueObject(String key, Object value, int index) Replaces the Object at a specific index for a given key.
String	toString()

From class java.lang.Object

From interface com.microstrategy.web.beans.RequestKeys

abstract String	add(String key, String value) Adds a key/value pair to this collection.
abstract Object	addObject(String key, Object value) Adds a key/value pair to this collection.
abstract MarkupOutput	getDebugOut() Get the Debug Information into the output
abstract int	getIntValue(String key, int index) Parses the value of given request key to an integer.
abstract int	getIntValue(String keyName, int valueIndex, int defaultValue) Parses the value of given request key to an integer.
abstract Enumeration	getKeyListByPrefix(String prefix) Returns an enumeration over all the keys with the specified prefix.
abstract String	getName(int nameIndex) Returns the name at the specified index from the current collection.
abstract int	getNameCount() Returns the number of names stored in the current collection.
abstract Source	getSource(String key) Determines where a given request key was sourced from.
abstract String	getValue(String keyName) Returns from this collection a comma separated string of all the values mapped by the specified `keyName`.
abstract String	getValue(String keyName, int valueIndex) Returns at the specified index the value from the collection mapped by the specified keyName.
abstract int	getValueCount(String keyName) Returns the number of values from the collection mapped by the specified keyName.
abstract Object	getValueObject(String key, int index) Returns at the specified index the value from the collection mapped by the specified key.
abstract Enumeration	getValueObject(String key) Returns from this collection a list of all the objects mapped by the specified `key`.
abstract boolean	isEmpty() Returns a boolean value indicating whether the current collection is empty
abstract void	remove(String key) Removes the argument with the given key.
abstract void	setValue(String key, String value, int index) Replaces the value at a specific index for a given key.
abstract void	setValueObject(String key, Object value, int index) Replaces the Object at a specific index for a given key.

Public Constructors

public CaseInsensitiveRequestKeys ()

Class constructor.

Public Methods

public Enumeration getKeyListByPrefix (String prefix)

Returns an enumeration over all the keys with the specified prefix.
Returns all the keys if the specified prefix is null or empty.
Returns an empty list if no key is found.

Parameters

prefix	the prefix of keys.

Returns

an enumeration over all the keys that have the specified prefix.

public String getValue (String keyName)

Returns from this collection a comma separated string of all the values mapped by the specified keyName.

Parameters

keyName	a key in this collection

Returns

all the values mapped to the keyName, separated by the character comma; null if the key does not exist.

public String getValue (String keyName, int valueIndex)

Returns the value at the specified position mapped by the specified keyName.

Parameters

keyName	a key in this collection
valueIndex	the index of a value mapped to the key specified

Returns

the value at the specified position mapped by the specified key; null if the key does not exist.

public int getValueCount (String keyName)

Returns from this collection the number of values mapped with the keyName.

Parameters

keyName	a key to a value collection

Returns

the count of values to which the specified key is mapped in this collection; 0 if the key is not found.

Protected Methods

protected String getKeyToSearch (String originalKey)

Get which key to search, for supporting case insensitive scenarios.

Parameters

originalKey	the original key requested by the user

Returns

a String value with the key with the correct casing that should be used for accessing the stored request values.

protected void updateKeyMapping (String originalKey)

Keep the key mapping list updated by calling this method with the key name requested by the user. If the key has already been mapped calling this method has no effect (it should still be done for security).

Parameters

originalKey	`String` with the key used for storing or retrieving values.

Interfaces

Classes

Exceptions

CaseInsensitiveRequestKeys

Class Overview

Summary

Public Constructors

public CaseInsensitiveRequestKeys ()

Public Methods

public Enumeration getKeyListByPrefix (String prefix)

Parameters

Returns

public String getValue (String keyName)

Parameters

Returns

public String getValue (String keyName, int valueIndex)

Parameters

Returns

public int getValueCount (String keyName)

Parameters

Returns

Protected Methods

protected String getKeyToSearch (String originalKey)

Parameters

Returns

protected void updateKeyMapping (String originalKey)

Parameters