Class HttpClientParams
java.lang.Object
edu.internet2.middleware.grouperClientExt.org.apache.commons.httpclient.params.DefaultHttpParams
edu.internet2.middleware.grouperClientExt.org.apache.commons.httpclient.params.HttpMethodParams
edu.internet2.middleware.grouperClientExt.org.apache.commons.httpclient.params.HttpClientParams
- All Implemented Interfaces:
HttpParams
,Serializable
,Cloneable
This class represents a collection of HTTP protocol parameters applicable to
instances of HttpClient
.
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: 480424 $
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Defines whether circular redirects (redirects to the same location) should be allowed.static final String
Defines the defaultHTTP connection manager
class.static final String
Sets the timeout in milliseconds used when retrieving anHTTP connection
from theHTTP connection manager
.static final String
Defines the maximum number of redirects to be followed.static final String
Defines whether authentication should be attempted preemptively.static final String
Defines whether relative redirects should be rejected.Fields inherited from class edu.internet2.middleware.grouperClientExt.org.apache.commons.httpclient.params.HttpMethodParams
BUFFER_WARN_TRIGGER_LIMIT, COOKIE_POLICY, CREDENTIAL_CHARSET, DATE_PATTERNS, HEAD_BODY_CHECK_TIMEOUT, HTTP_CONTENT_CHARSET, HTTP_ELEMENT_CHARSET, HTTP_URI_CHARSET, MULTIPART_BOUNDARY, PROTOCOL_VERSION, REJECT_HEAD_BODY, RETRY_HANDLER, SINGLE_COOKIE_HEADER, SO_TIMEOUT, STATUS_LINE_GARBAGE_LIMIT, STRICT_TRANSFER_ENCODING, UNAMBIGUOUS_STATUS_LINE, USE_EXPECT_CONTINUE, USER_AGENT, VIRTUAL_HOST, WARN_EXTRA_INPUT
-
Constructor Summary
ConstructorDescriptionCreates a new collection of parameters with the collection returned byDefaultHttpParams.getDefaultParams()
as a parent.HttpClientParams
(HttpParams defaults) Creates a new collection of parameters with the given parent. -
Method Summary
Modifier and TypeMethodDescriptionReturns the defaultHTTP connection manager
class.long
Returns the timeout in milliseconds used when retrieving anHTTP connection
from theHTTP connection manager
.boolean
Returns true if authentication should be attempted preemptively, false otherwise.void
Makes theHTTP methods
attempt to mimic the exact behaviour of commonly used HTTP agents, which many HTTP servers expect, even though such behaviour may violate the HTTP protocol specification (RFC 2616 and other relevant RFCs).void
Makes theHTTP methods
strictly follow the HTTP protocol specification (RFC 2616 and other relevant RFCs).void
setAuthenticationPreemptive
(boolean value) Sets whether authentication should be attempted preemptively.void
setConnectionManagerClass
(Class clazz) SetsHTTP connection manager
class to be used der default.void
setConnectionManagerTimeout
(long timeout) Sets the timeout in milliseconds used when retrieving anHTTP connection
from theHTTP connection manager
.Methods inherited from class edu.internet2.middleware.grouperClientExt.org.apache.commons.httpclient.params.HttpMethodParams
getContentCharset, getCookiePolicy, getCredentialCharset, getHttpElementCharset, getSoTimeout, getUriCharset, getVersion, getVirtualHost, setContentCharset, setCookiePolicy, setCredentialCharset, setHttpElementCharset, setSoTimeout, setUriCharset, setVersion, setVirtualHost
Methods inherited from class edu.internet2.middleware.grouperClientExt.org.apache.commons.httpclient.params.DefaultHttpParams
clear, clone, getBooleanParameter, getDefaultParams, getDefaults, getDoubleParameter, getIntParameter, getLongParameter, getParameter, isParameterFalse, isParameterSet, isParameterSetLocally, isParameterTrue, setBooleanParameter, setDefaults, setDoubleParameter, setHttpParamsFactory, setIntParameter, setLongParameter, setParameter, setParameters
-
Field Details
-
CONNECTION_MANAGER_TIMEOUT
Sets the timeout in milliseconds used when retrieving anHTTP connection
from theHTTP connection manager
.This parameter expects a value of type
Long
.- See Also:
-
CONNECTION_MANAGER_CLASS
Defines the defaultHTTP connection manager
class.This parameter expects a value of type
Class
.- See Also:
-
PREEMPTIVE_AUTHENTICATION
Defines whether authentication should be attempted preemptively.This parameter expects a value of type
Boolean
.- See Also:
-
REJECT_RELATIVE_REDIRECT
Defines whether relative redirects should be rejected.This parameter expects a value of type
Boolean
.- See Also:
-
MAX_REDIRECTS
Defines the maximum number of redirects to be followed. The limit on number of redirects is intended to prevent infinite loops.This parameter expects a value of type
Integer
.- See Also:
-
ALLOW_CIRCULAR_REDIRECTS
Defines whether circular redirects (redirects to the same location) should be allowed. The HTTP spec is not sufficiently clear whether circular redirects are permitted, therefore optionally they can be enabledThis parameter expects a value of type
Boolean
.- See Also:
-
-
Constructor Details
-
HttpClientParams
public HttpClientParams()Creates a new collection of parameters with the collection returned byDefaultHttpParams.getDefaultParams()
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:
-
HttpClientParams
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.- See Also:
-
-
Method Details
-
getConnectionManagerTimeout
public long getConnectionManagerTimeout()Returns the timeout in milliseconds used when retrieving anHTTP connection
from theHTTP connection manager
.- Returns:
- timeout in milliseconds.
-
setConnectionManagerTimeout
public void setConnectionManagerTimeout(long timeout) Sets the timeout in milliseconds used when retrieving anHTTP connection
from theHTTP connection manager
.- Parameters:
timeout
- the timeout in milliseconds
-
getConnectionManagerClass
Returns the defaultHTTP connection manager
class.- Returns:
HTTP connection manager
factory class.
-
setConnectionManagerClass
SetsHTTP connection manager
class to be used der default.- Parameters:
clazz
-HTTP connection manager
factory class.
-
isAuthenticationPreemptive
public boolean isAuthenticationPreemptive()Returns true if authentication should be attempted preemptively, false otherwise.- Returns:
- true if authentication should be attempted preemptively, false otherwise.
-
setAuthenticationPreemptive
public void setAuthenticationPreemptive(boolean value) Sets whether authentication should be attempted preemptively.- Parameters:
value
- true if authentication should be attempted preemptively, false otherwise.
-
makeStrict
public void makeStrict()Description copied from class:HttpMethodParams
Makes theHTTP methods
strictly follow the HTTP protocol specification (RFC 2616 and other relevant RFCs). It must be noted that popular HTTP agents have different degree of HTTP protocol compliance and some HTTP serves are programmed to expect the behaviour that does not strictly adhere to the HTTP specification.- Overrides:
makeStrict
in classHttpMethodParams
-
makeLenient
public void makeLenient()Description copied from class:HttpMethodParams
Makes theHTTP methods
attempt to mimic the exact behaviour of commonly used HTTP agents, which many HTTP servers expect, even though such behaviour may violate the HTTP protocol specification (RFC 2616 and other relevant RFCs).- Overrides:
makeLenient
in classHttpMethodParams
-