com.ibm.security.access.httpclient
Class Parameters

java.lang.Object
  extended by com.ibm.security.access.httpclient.Parameters

public class Parameters
extends java.lang.Object

This class stores the parameters for a HTTP request.


Field Summary
static java.lang.String Parameters_java_copyright
           
static java.lang.String Parameters_java_sourceCodeID
           
 
Constructor Summary
Parameters()
           
 
Method Summary
 boolean addParameter(java.lang.String name, java.util.List values)
          Add a parameter
 boolean addParameter(java.lang.String name, java.lang.String value)
          Add a parameter
 java.lang.String[] getParameter(java.lang.String name)
          Get the parameter values with the specified name.
 java.lang.String[] getParameterNames()
          Get all the parameter names.
 java.util.Map getParameters()
          Get all the parameters
protected  java.lang.String getParameterString(java.lang.String name)
          Get a String representation of the parameter values associated with the parameter name.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

Parameters_java_sourceCodeID

public static final java.lang.String Parameters_java_sourceCodeID
See Also:
Constant Field Values

Parameters_java_copyright

public static final java.lang.String Parameters_java_copyright
See Also:
Constant Field Values
Constructor Detail

Parameters

public Parameters()
Method Detail

addParameter

public boolean addParameter(java.lang.String name,
                            java.util.List values)
Add a parameter

Parameters:
name - Parameter name
values - A List(String) of parameter values
Returns:
True if successful. False otherwise.

addParameter

public boolean addParameter(java.lang.String name,
                            java.lang.String value)
Add a parameter

Parameters:
name - Parameter name
value - Parameter value
Returns:
True if successful. False otherwise.

getParameterNames

public java.lang.String[] getParameterNames()
Get all the parameter names. Returns null if there are no parameters.

Returns:
Parameter names. Null if no parameters.

getParameters

public java.util.Map getParameters()
Get all the parameters

Returns:
A Map(String,List(String)) of all parameters

getParameter

public java.lang.String[] getParameter(java.lang.String name)
Get the parameter values with the specified name. Returns null if no such parameter name or name was null/empty string.

Parameters:
name - The parameter name
Returns:
A List(String) of values associated with that parameter name. Null if no such parameter name exists or name was null/empty string.

getParameterString

protected java.lang.String getParameterString(java.lang.String name)
Get a String representation of the parameter values associated with the parameter name. This is in the form of a comma-separated value. e.g. value1,value2,value3

Parameters:
name - Parameter name
Returns:
String presentation of parameter value. Null if parameter name does not exist or parameter name is invalid (null or empty string).