Package com.atlassian.oai.validator.model

Class SimpleRequest.Builder

java.lang.Object

com.atlassian.oai.validator.model.SimpleRequest.Builder

Enclosing class:

SimpleRequest

public static class SimpleRequest.Builder
extends Object

A builder for constructing new SimpleRequest instances.

Constructor Summary

Constructors

Constructor	Description
Builder(Request.Method method, String path)	Creates a SimpleRequest.Builder with the given HTTP Request.Method and path.
Builder(Request.Method method, String path, boolean queryParametersCaseSensitive)	Creates a SimpleRequest.Builder with the given HTTP Request.Method and path including the specification if the query parameters are handled case sensitive or not.
Builder(String method, String path)	Creates a SimpleRequest.Builder with the given HTTP method and path.
Builder(String method, String path, boolean queryParametersCaseSensitive)	Creates a SimpleRequest.Builder with the given HTTP method and path including the specification if the query parameters are handled case sensitive or not.

Method Summary

Modifier and Type	Method	Description
SimpleRequest	build()	Builds a SimpleRequest out of this builder.
static SimpleRequest.Builder	delete(String path)	A convenience method for creating a SimpleRequest.Builder with HTTP method DELETE and the given path.
static SimpleRequest.Builder	get(String path)	A convenience method for creating a SimpleRequest.Builder with HTTP method GET and the given path.
static SimpleRequest.Builder	head(String path)	A convenience method for creating a SimpleRequest.Builder with HTTP method HEAD and the given path.
static SimpleRequest.Builder	options(String path)	A convenience method for creating a SimpleRequest.Builder with HTTP method OPTIONS and the given path.
static SimpleRequest.Builder	patch(String path)	A convenience method for creating a SimpleRequest.Builder with HTTP method PATCH and the given path.
static SimpleRequest.Builder	post(String path)	A convenience method for creating a SimpleRequest.Builder with HTTP method POST and the given path.
static SimpleRequest.Builder	put(String path)	A convenience method for creating a SimpleRequest.Builder with HTTP method PUT and the given path.
static SimpleRequest.Builder	trace(String path)	A convenience method for creating a SimpleRequest.Builder with HTTP method TRACE and the given path.
SimpleRequest.Builder	withAccept(String... accept)	Sets the accept header on this builder.
SimpleRequest.Builder	withAuthorization(String auth)	Sets the authorization header on this builder.
SimpleRequest.Builder	withBody(byte[] content)	Adds a request body as byte array to this builder.
SimpleRequest.Builder	withBody(Body content)	Adds a request Body to this builder.
SimpleRequest.Builder	withBody(InputStream content)	Adds a request body as InputStream to this builder.
SimpleRequest.Builder	withBody(String content)	Adds a request body as String to this builder.
SimpleRequest.Builder	withBody(String content, Charset charset)	Adds a request body as String and its Charset to this builder.
SimpleRequest.Builder	withContentType(String contentType)	Sets the content type header on this builder.
SimpleRequest.Builder	withHeader(String name, String... values)	Adds a request header to this builder.
SimpleRequest.Builder	withHeader(String name, List<String> values)	Adds a request header to this builder.
SimpleRequest.Builder	withQueryParam(String name, String... values)	Adds a query parameter to this request builder.
SimpleRequest.Builder	withQueryParam(String name, List<String> values)	Adds a query parameter to this request builder.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(String method,
 String path)

Creates a SimpleRequest.Builder with the given HTTP method and path.

Parameters:

method - the HTTP method

path - the requests path

Builder

public Builder(Request.Method method,
 String path)

Creates a SimpleRequest.Builder with the given HTTP Request.Method and path.

Parameters:

method - the HTTP method

path - the requests path

Builder

public Builder(String method,
 String path,
 boolean queryParametersCaseSensitive)

Creates a SimpleRequest.Builder with the given HTTP method and path including the specification if the query parameters are handled case sensitive or not.

Parameters:

method - the HTTP method

path - the requests path

queryParametersCaseSensitive - flag if the query parameters are handled case sensitive or not

Builder

public Builder(Request.Method method,
 String path,
 boolean queryParametersCaseSensitive)

Creates a SimpleRequest.Builder with the given HTTP Request.Method and path including the specification if the query parameters are handled case sensitive or not.

Parameters:

method - the HTTP method

path - the requests path

queryParametersCaseSensitive - flag if the query parameters are handled case sensitive or not

Method Details

get

public static SimpleRequest.Builder get(String path)

A convenience method for creating a SimpleRequest.Builder with HTTP method GET and the given path.

Parameters:

path - the requests path

Returns:

a prepared SimpleRequest.Builder

put

public static SimpleRequest.Builder put(String path)

A convenience method for creating a SimpleRequest.Builder with HTTP method PUT and the given path.

Parameters:

path - the requests path

Returns:

a prepared SimpleRequest.Builder

post

public static SimpleRequest.Builder post(String path)

A convenience method for creating a SimpleRequest.Builder with HTTP method POST and the given path.

Parameters:

path - the requests path

Returns:

a prepared SimpleRequest.Builder

delete

public static SimpleRequest.Builder delete(String path)

A convenience method for creating a SimpleRequest.Builder with HTTP method DELETE and the given path.

Parameters:

path - the requests path

Returns:

a prepared SimpleRequest.Builder

patch

public static SimpleRequest.Builder patch(String path)

A convenience method for creating a SimpleRequest.Builder with HTTP method PATCH and the given path.

Parameters:

path - the requests path

Returns:

a prepared SimpleRequest.Builder

head

public static SimpleRequest.Builder head(String path)

A convenience method for creating a SimpleRequest.Builder with HTTP method HEAD and the given path.

Parameters:

path - the requests path

Returns:

a prepared SimpleRequest.Builder

options

public static SimpleRequest.Builder options(String path)

A convenience method for creating a SimpleRequest.Builder with HTTP method OPTIONS and the given path.

Parameters:

path - the requests path

Returns:

a prepared SimpleRequest.Builder

trace

public static SimpleRequest.Builder trace(String path)

A convenience method for creating a SimpleRequest.Builder with HTTP method TRACE and the given path.

Parameters:

path - the requests path

Returns:

a prepared SimpleRequest.Builder

withBody

public SimpleRequest.Builder withBody(String content)

Adds a request body as String to this builder.

The charset of the request body will be extracted from the content-type header during build(). If no such header is specified UTF-8 is used.

For better performance use withBody(byte[]) or withBody(InputStream) if possible.

Parameters:

content - the request body

Returns:

this builder

See Also:

• withBody(String, Charset)

withBody

public SimpleRequest.Builder withBody(String content,
 Charset charset)

Adds a request body as String and its Charset to this builder.

For better performance use withBody(byte[]) or withBody(InputStream) if possible.

Parameters:

content - the request body

charset - the Charset of the request body

Returns:

this builder

withBody

public SimpleRequest.Builder withBody(byte[] content)

Adds a request body as byte array to this builder.

Parameters:

content - the request body

Returns:

this builder

withBody

public SimpleRequest.Builder withBody(InputStream content)

Adds a request body as InputStream to this builder.

Parameters:

content - the request body stream

Returns:

this builder

withBody

public SimpleRequest.Builder withBody(Body content)

Adds a request Body to this builder.

Parameters:

content - the request Body

Returns:

this builder

withHeader

public SimpleRequest.Builder withHeader(String name,
 List<String> values)

Adds a request header to this builder. If there was already a header with this name the values will be added.

Headers are treated case insensitive.

Parameters:

name - the header name

values - the values for this header

Returns:

this builder

withHeader

public SimpleRequest.Builder withHeader(String name,
 String... values)

Adds a request header to this builder. If there was already a header with this name the values will be added.

Headers are treated case insensitive.

Parameters:

name - the header name

values - the values for this header

Returns:

this builder

withContentType

public SimpleRequest.Builder withContentType(String contentType)

Sets the content type header on this builder.

Equivalent to:

withHeader("Content-Type", contentType);

Parameters:

contentType - The content type to set

Returns:

this builder

withAccept

public SimpleRequest.Builder withAccept(String... accept)

Sets the accept header on this builder.

Equivalent to:

withHeader("Accept", contentType);

Parameters:

accept - The accept type(s) to set

Returns:

this builder

withAuthorization

public SimpleRequest.Builder withAuthorization(String auth)

Sets the authorization header on this builder.

Equivalent to:

withHeader("Authorization", contentType);

Parameters:

auth - The authorization header to set

Returns:

this builder

withQueryParam

public SimpleRequest.Builder withQueryParam(String name,
 List<String> values)

Adds a query parameter to this request builder. If there was already a query parameter with this name the values will be added.

The case sensitivity can be set by this builder's Builder(Method, String, boolean) constructor.

Parameters:

name - the header name

values - the values for this header

Returns:

this builder

withQueryParam

public SimpleRequest.Builder withQueryParam(String name,
 String... values)

Adds a query parameter to this request builder. If there was already a query parameter with this name the values will be added.

The case sensitivity can be set by this builder's Builder(String, String, boolean) constructor.

Parameters:

name - the header name

values - the values for this header

Returns:

this builder

build

public SimpleRequest build()

Builds a SimpleRequest out of this builder.

Returns:

the build SimpleRequest