org.forgerock.http.client.request

Class SimpleHttpClientRequest

java.lang.Object

org.forgerock.http.client.request.SimpleHttpClientRequest

All Implemented Interfaces:

HttpClientRequest

public class SimpleHttpClientRequest
extends Object
implements HttpClientRequest

A basic implementation of HttpClientRequest that a script can send over a org.forgerock.http.client.HttpClient.

Since:

12.0.0

Constructor Summary

Constructors

Constructor and Description
SimpleHttpClientRequest()

Method Summary

Modifier and Type	Method and Description
void	addCookie(String domain, String field, String value) Add a cookie to the request.
void	addHeader(String field, String value) Add a header field to the request.
void	addQueryParameter(String field, String value) Add a query parameter to the request.
Set<HttpClientRequestCookie>	getCookies() Retrieve the cookies set on the request.
String	getEntity() Retrieve the entity set on the request.
Map<String,String>	getHeaders() Retrieve the headers set on the request.
String	getMethod() Retrieve the method set on the request.
Map<String,String>	getQueryParameters() Retrieve the query parameters set on the request.
String	getUri() Retrieve the URI that the request targets.
void	setEntity(String entity) Set the message entity.
void	setMethod(String method) Set the method the request will use.
void	setUri(String uri) Set the URI that the request targets.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimpleHttpClientRequest

public SimpleHttpClientRequest()

Method Detail

addHeader

public void addHeader(String field,
                      String value)

Add a header field to the request.

Specified by:

addHeader in interface HttpClientRequest

Parameters:

field - The name of the header field to add.

value - The value of the header field.

addQueryParameter

public void addQueryParameter(String field,
                              String value)

Add a query parameter to the request.

Specified by:

addQueryParameter in interface HttpClientRequest

Parameters:

field - The name of the query parameter field to add.

value - The value of the query parameter field.

addCookie

public void addCookie(String domain,
                      String field,
                      String value)

Add a cookie to the request.

Specified by:

addCookie in interface HttpClientRequest

field - The name of the cookie field to add.

value - The value of the cookie field.

setMethod

public void setMethod(String method)

Set the method the request will use.

Specified by:

setMethod in interface HttpClientRequest

Parameters:

method - The method to use. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html#sec5.1.1

setUri

public void setUri(String uri)

Set the URI that the request targets.

Specified by:

setUri in interface HttpClientRequest

Parameters:

uri - The URI of the resource.

setEntity

public void setEntity(String entity)

Set the message entity.

Specified by:

setEntity in interface HttpClientRequest

getHeaders

public Map<String,String> getHeaders()

Retrieve the headers set on the request.

Specified by:

getHeaders in interface HttpClientRequest

Returns:

The headers set on the request.

getQueryParameters

public Map<String,String> getQueryParameters()

Retrieve the query parameters set on the request.

Specified by:

getQueryParameters in interface HttpClientRequest

Returns:

The query parameters set on the request.

getMethod

public String getMethod()

Retrieve the method set on the request.

Specified by:

getMethod in interface HttpClientRequest

Returns:

The method set on the request.

getUri

public String getUri()

Retrieve the URI that the request targets.

Specified by:

getUri in interface HttpClientRequest

Returns:

The URI that the request targets.

getEntity

public String getEntity()

Retrieve the entity set on the request.

Specified by:

getEntity in interface HttpClientRequest

Returns:

The entity set on the request.

getCookies

public Set<HttpClientRequestCookie> getCookies()

Retrieve the cookies set on the request.

Specified by:

getCookies in interface HttpClientRequest

Returns:

The cookies set on the request.