Class AdaptiveHttpRequest
java.lang.Object
ee.jakarta.tck.ws.rs.common.webclient.http.HttpRequest
ee.jakarta.tck.ws.rs.jaxrs21.ee.patch.server.AdaptiveHttpRequest
Represents an HTTP client Request
-
Field Summary
Fields inherited from class ee.jakarta.tck.ws.rs.common.webclient.http.HttpRequest
BASIC_AUTHENTICATION, client, DEFAULT_HTTP_PORT, DEFAULT_SSL_PORT, DIGEST_AUTHENTICATION, NO_AUTHENTICATION
-
Constructor Summary
ConstructorsConstructorDescriptionAdaptiveHttpRequest
(String requestLine, String host, int port) Creates new HttpRequest based of the passed request line. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addRequestHeader
(String header) void
addRequestHeader
(String headerName, String headerValue) addRequestHeader
adds a request header to this request.execute()
execute
will dispatch the current request to the target server.boolean
getFollowRedirects
indicates whether HTTP redirects are followed.getRequestMethod
returns the request type, i.e., GET, POST, etc.getRequestPath
returns the request path for this particular request.org.apache.commons.httpclient.HttpState
getState()
Returns the current state for this request.boolean
isSecureConnection()
indicates if the Request is secure or not.void
setAuthenticationCredentials
(String username, String password, int authType, String realm) setAuthenticationCredentials configures the request to perform authentication.
void
setContent
(String content) setContent
will set the body for this request.void
setFollowRedirects
(boolean followRedirects) setFollowRedirects
indicates whether HTTP redirects are followed.void
setRequestHeader
(String headerName, String headerValue) setRequestHeader
sets a request header for this request overwritting any previously existing header/values with the same name.void
setSecureRequest
(boolean secure) setSecureRequest
configures this request to use SSL.void
setState
(org.apache.commons.httpclient.HttpState state) setState
will set the HTTP state for the current request (i.e.toString()
-
Constructor Details
-
AdaptiveHttpRequest
Creates new HttpRequest based of the passed request line. The request line provied must be in the form of:
METHOD PATH HTTP-VERSION Ex. GET /index.html HTTP/1.0
-
-
Method Details
-
getRequestPath
getRequestPath
returns the request path for this particular request.- Overrides:
getRequestPath
in classHttpRequest
- Returns:
- String request path
-
getRequestMethod
getRequestMethod
returns the request type, i.e., GET, POST, etc.- Overrides:
getRequestMethod
in classHttpRequest
- Returns:
- String request type
-
isSecureRequest
public boolean isSecureRequest()isSecureConnection()
indicates if the Request is secure or not.- Overrides:
isSecureRequest
in classHttpRequest
- Returns:
- boolean whether Request is using SSL or not.
-
setSecureRequest
public void setSecureRequest(boolean secure) setSecureRequest
configures this request to use SSL.- Overrides:
setSecureRequest
in classHttpRequest
- Parameters:
secure
- - whether the Request uses SSL or not.
-
setContent
setContent
will set the body for this request. Note, this is only valid for POST and PUT operations, however, if called and the request represents some other HTTP method, it will be no-op'd.- Overrides:
setContent
in classHttpRequest
- Parameters:
content
- request content
-
setAuthenticationCredentials
public void setAuthenticationCredentials(String username, String password, int authType, String realm) setAuthenticationCredentials configures the request to perform authentication.
username
andpassword
cannot be null.It is legal for
realm
to be null.- Overrides:
setAuthenticationCredentials
in classHttpRequest
- Parameters:
username
- the userpassword
- the user's passwordauthType
- authentication typerealm
- authentication realm
-
addRequestHeader
addRequestHeader
adds a request header to this request. If a request header of the same name already exists, the new value, will be added to the set of already existing values. NOTE: that header names are not case-sensitive.- Overrides:
addRequestHeader
in classHttpRequest
- Parameters:
headerName
- request header nameheaderValue
- request header value
-
addRequestHeader
- Overrides:
addRequestHeader
in classHttpRequest
-
setRequestHeader
setRequestHeader
sets a request header for this request overwritting any previously existing header/values with the same name. NOTE: Header names are not case-sensitive.- Overrides:
setRequestHeader
in classHttpRequest
- Parameters:
headerName
- request header nameheaderValue
- request header value
-
setFollowRedirects
public void setFollowRedirects(boolean followRedirects) setFollowRedirects
indicates whether HTTP redirects are followed. By default, redirects are not followed.- Overrides:
setFollowRedirects
in classHttpRequest
-
getFollowRedirects
public boolean getFollowRedirects()getFollowRedirects
indicates whether HTTP redirects are followed.- Overrides:
getFollowRedirects
in classHttpRequest
-
setState
public void setState(org.apache.commons.httpclient.HttpState state) setState
will set the HTTP state for the current request (i.e. session tracking). This has the side affect- Overrides:
setState
in classHttpRequest
-
execute
execute
will dispatch the current request to the target server.- Overrides:
execute
in classHttpRequest
- Returns:
- HttpResponse the server's response.
- Throws:
IOException
- if an I/O error occurs during dispatch.org.apache.commons.httpclient.HttpException
-
getState
public org.apache.commons.httpclient.HttpState getState()Returns the current state for this request.- Overrides:
getState
in classHttpRequest
- Returns:
- HttpState current state
-
toString
- Overrides:
toString
in classHttpRequest
-