org.nuiton.io.rest

Interface RestRequestBuilder

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractRequestFactory.AbstractRequestBuilder

public interface RestRequestBuilder
extends Serializable

The contract of a request builder.

Since:

1.0.3

Author:

tchemit

Method Summary

Methods

Modifier and Type	Method and Description
void	checkRequestArgs(Object... args) Checks that args used to create the request are fine.
RestRequest	create(Object... args) Create the request given the args.
Map<String,File>	getAttachments(Object... args) Computes the map of attachments associated to this request
String	getName()
String[]	getParameters(Object... args) Computes the parameters associated to this requet.
String[]	getPath(Object... args) Computes the path associated to this request.

Method Detail

getName

String getName()

Returns:

the unique name of the request builder

checkRequestArgs

void checkRequestArgs(Object... args)

Checks that args used to create the request are fine.

This method should be invoked just at the begin of the method create(Object...).

Parameters:

args - the args of the request

Since:

1.5

create

RestRequest create(Object... args)

Create the request given the args.

Parameters:

args - args to create the request

Returns:

the created request

getParameters

String[] getParameters(Object... args)

Computes the parameters associated to this requet.

Parameters:

args - the args of the request

Returns:

parameters to use for this request

Since:

1.5

getPath

String[] getPath(Object... args)

Computes the path associated to this request.

Parameters:

args - the args of the request

Returns:

path to use for this request

Since:

1.5

getAttachments

Map<String,File> getAttachments(Object... args)

Computes the map of attachments associated to this request

Parameters:

args - the args of the request

Returns:

map of attachments to use for this request

Since:

1.5