Class DefaultHttpParams
java.lang.Object
edu.internet2.middleware.grouperClientExt.org.apache.commons.httpclient.params.DefaultHttpParams
- All Implemented Interfaces:
HttpParams
,Serializable
,Cloneable
- Direct Known Subclasses:
HostParams
,HttpConnectionParams
,HttpMethodParams
This class represents a collection of HTTP protocol parameters. Protocol parameters
may be linked together to form a hierarchy. If a particular parameter value has not been
explicitly defined in the collection itself, its value will be drawn from the parent
collection of parameters.
- Since:
- 3.0
- Version:
- $Revision: 510589 $
- See Also:
-
Constructor Summary
ConstructorDescriptionCreates a new collection of parameters with the collection returned bygetDefaultParams()
as a parent.DefaultHttpParams
(HttpParams defaults) Creates a new collection of parameters with the given parent. -
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
Removes all parameters from this collection.clone()
Clones this collection of parameters.boolean
getBooleanParameter
(String name, boolean defaultValue) Returns aBoolean
parameter value with the given name.static HttpParams
Gets the default HttpParams to be used.Returns the parent collection that this collection will defer to for a default value if a particular parameter is not explicitly set in the collection itselfdouble
getDoubleParameter
(String name, double defaultValue) Returns aDouble
parameter value with the given name.int
getIntParameter
(String name, int defaultValue) Returns anInteger
parameter value with the given name.long
getLongParameter
(String name, long defaultValue) Returns aLong
parameter value with the given name.getParameter
(String name) Returns a parameter value with the given name.boolean
isParameterFalse
(String name) Returns true if the parameter is either not set or is false, false otherwise.boolean
isParameterSet
(String name) Returns true if the parameter is set at any level, false otherwise.boolean
isParameterSetLocally
(String name) Returns true if the parameter is set locally, false otherwise.boolean
isParameterTrue
(String name) Returns true if the parameter is set and is true, false otherwise.void
setBooleanParameter
(String name, boolean value) Assigns aBoolean
to the parameter with the given namevoid
setDefaults
(HttpParams params) Assigns the parent collection that this collection will defer to for a default value if a particular parameter is not explicitly set in the collection itselfvoid
setDoubleParameter
(String name, double value) Assigns aDouble
to the parameter with the given namestatic void
setHttpParamsFactory
(HttpParamsFactory httpParamsFactory) Sets the factory that will provide the default HttpParams.void
setIntParameter
(String name, int value) Assigns anInteger
to the parameter with the given namevoid
setLongParameter
(String name, long value) Assigns aLong
to the parameter with the given namevoid
setParameter
(String name, Object value) Assigns the value to the parameter with the given namevoid
setParameters
(String[] names, Object value) Assigns the value to all the parameter with the given names
-
Constructor Details
-
DefaultHttpParams
Creates a new collection of parameters with the given parent. The collection will defer to its parent for a default value if a particular parameter is not explicitly set in the collection itself.- Parameters:
defaults
- the parent collection to defer to, if a parameter is not explictly set in the collection itself.
-
DefaultHttpParams
public DefaultHttpParams()Creates a new collection of parameters with the collection returned bygetDefaultParams()
as a parent. The collection will defer to its parent for a default value if a particular parameter is not explicitly set in the collection itself.- See Also:
-
-
Method Details
-
getDefaultParams
Gets the default HttpParams to be used.- Returns:
- the value returned from
HttpParamsFactory#getDefaultParams()
- See Also:
-
setHttpParamsFactory
Sets the factory that will provide the default HttpParams.- Parameters:
httpParamsFactory
- an instance of HttpParamsFactory- See Also:
-
getDefaults
Description copied from interface:HttpParams
Returns the parent collection that this collection will defer to for a default value if a particular parameter is not explicitly set in the collection itself- Specified by:
getDefaults
in interfaceHttpParams
- Returns:
- the parent collection to defer to, if a particular parameter is not explictly set in the collection itself.
- See Also:
-
setDefaults
Description copied from interface:HttpParams
Assigns the parent collection that this collection will defer to for a default value if a particular parameter is not explicitly set in the collection itself- Specified by:
setDefaults
in interfaceHttpParams
- Parameters:
params
- the parent collection to defer to, if a particular parameter is not explictly set in the collection itself.- See Also:
-
getParameter
Description copied from interface:HttpParams
Returns a parameter value with the given name. If the parameter is not explicitly defined in this collection, its value will be drawn from a higer level collection at which this parameter is defined. If the parameter is not explicitly set anywhere up the hierarchy, null value is returned.- Specified by:
getParameter
in interfaceHttpParams
- Parameters:
name
- the parent name.- Returns:
- an object that represents the value of the parameter.
- See Also:
-
setParameter
Description copied from interface:HttpParams
Assigns the value to the parameter with the given name- Specified by:
setParameter
in interfaceHttpParams
- Parameters:
name
- parameter namevalue
- parameter value
-
setParameters
Assigns the value to all the parameter with the given names- Parameters:
names
- array of parameter namevalue
- parameter value
-
getLongParameter
Description copied from interface:HttpParams
Returns aLong
parameter value with the given name. If the parameter is not explicitly defined in this collection, its value will be drawn from a higer level collection at which this parameter is defined. If the parameter is not explicitly set anywhere up the hierarchy, the default value is returned.- Specified by:
getLongParameter
in interfaceHttpParams
- Parameters:
name
- the parent name.defaultValue
- the default value.- Returns:
- a
Long
that represents the value of the parameter. - See Also:
-
setLongParameter
Description copied from interface:HttpParams
Assigns aLong
to the parameter with the given name- Specified by:
setLongParameter
in interfaceHttpParams
- Parameters:
name
- parameter namevalue
- parameter value
-
getIntParameter
Description copied from interface:HttpParams
Returns anInteger
parameter value with the given name. If the parameter is not explicitly defined in this collection, its value will be drawn from a higer level collection at which this parameter is defined. If the parameter is not explicitly set anywhere up the hierarchy, the default value is returned.- Specified by:
getIntParameter
in interfaceHttpParams
- Parameters:
name
- the parent name.defaultValue
- the default value.- Returns:
- a
Integer
that represents the value of the parameter. - See Also:
-
setIntParameter
Description copied from interface:HttpParams
Assigns anInteger
to the parameter with the given name- Specified by:
setIntParameter
in interfaceHttpParams
- Parameters:
name
- parameter namevalue
- parameter value
-
getDoubleParameter
Description copied from interface:HttpParams
Returns aDouble
parameter value with the given name. If the parameter is not explicitly defined in this collection, its value will be drawn from a higer level collection at which this parameter is defined. If the parameter is not explicitly set anywhere up the hierarchy, the default value is returned.- Specified by:
getDoubleParameter
in interfaceHttpParams
- Parameters:
name
- the parent name.defaultValue
- the default value.- Returns:
- a
Double
that represents the value of the parameter. - See Also:
-
setDoubleParameter
Description copied from interface:HttpParams
Assigns aDouble
to the parameter with the given name- Specified by:
setDoubleParameter
in interfaceHttpParams
- Parameters:
name
- parameter namevalue
- parameter value
-
getBooleanParameter
Description copied from interface:HttpParams
Returns aBoolean
parameter value with the given name. If the parameter is not explicitly defined in this collection, its value will be drawn from a higer level collection at which this parameter is defined. If the parameter is not explicitly set anywhere up the hierarchy, the default value is returned.- Specified by:
getBooleanParameter
in interfaceHttpParams
- Parameters:
name
- the parent name.defaultValue
- the default value.- Returns:
- a
Boolean
that represents the value of the parameter. - See Also:
-
setBooleanParameter
Description copied from interface:HttpParams
Assigns aBoolean
to the parameter with the given name- Specified by:
setBooleanParameter
in interfaceHttpParams
- Parameters:
name
- parameter namevalue
- parameter value
-
isParameterSet
Description copied from interface:HttpParams
Returns true if the parameter is set at any level, false otherwise.- Specified by:
isParameterSet
in interfaceHttpParams
- Parameters:
name
- parameter name- Returns:
- true if the parameter is set at any level, false otherwise.
-
isParameterSetLocally
Description copied from interface:HttpParams
Returns true if the parameter is set locally, false otherwise.- Specified by:
isParameterSetLocally
in interfaceHttpParams
- Parameters:
name
- parameter name- Returns:
- true if the parameter is set locally, false otherwise.
-
isParameterTrue
Description copied from interface:HttpParams
Returns true if the parameter is set and is true, false otherwise.- Specified by:
isParameterTrue
in interfaceHttpParams
- Parameters:
name
- parameter name- Returns:
- true if the parameter is set and is true, false otherwise.
-
isParameterFalse
Description copied from interface:HttpParams
Returns true if the parameter is either not set or is false, false otherwise.- Specified by:
isParameterFalse
in interfaceHttpParams
- Parameters:
name
- parameter name- Returns:
- true if the parameter is either not set or is false, false otherwise.
-
clear
public void clear()Removes all parameters from this collection. -
clone
Clones this collection of parameters. Please note that paramter values themselves are not cloned.- Overrides:
clone
in classObject
- Throws:
CloneNotSupportedException
- See Also:
-