org.n52.wps.server.request

Class Request

java.lang.Object

org.n52.wps.server.request.Request

All Implemented Interfaces:

Callable<Response>

Direct Known Subclasses:

CapabilitiesRequest, DescribeProcessRequest, ExecuteRequest, RetrieveResultRequest

public abstract class Request
extends Object
implements Callable<Response>

The client requests some operation from the server. The request generates a unique reference based on the client, time and a count. Not secure! Upcoming references are easily guessed or altered.

See Also:

UID

Field Summary

Fields

Modifier and Type	Field and Description
protected Document	doc
protected UUID	id
protected static org.slf4j.Logger	LOGGER
protected org.apache.commons.collections.map.CaseInsensitiveMap	map
static String[]	SUPPORTED_LANGUAGES
static String	SUPPORTED_VERSION

Constructor Summary

Constructors

Constructor and Description
Request(org.apache.commons.collections.map.CaseInsensitiveMap map) Create a Request based on a CaseInsensitiveMap as input (HTTP GET)
Request(Document doc) Create a Request based on a Document as input (HTTP POST)

Method Summary

Modifier and Type	Method and Description
static String	accumulateString(String[] strings) Accumulates the Strings in an array, separated by ", " (without quotes).
abstract Response	call() After creation a Request is handled.
static void	checkLanguageSupported(String language) Checks, if the language is supported by the WPS.
abstract Object	getAttachedResult()
Document	getDocument() Returns the user input in Document form
org.apache.commons.collections.map.CaseInsensitiveMap	getMap() Returns the user input in Map form
protected String[]	getMapArray(String key, boolean required) Retrieve an array of values from the client-input-map with a lookup-key
static String[]	getMapArray(String key, org.apache.commons.collections.map.CaseInsensitiveMap map, boolean required) Retrieve an array of values from an input-map with a lookup-key
protected String	getMapValue(String key, boolean required) Retrieve a value from the client-input-map with a lookup-key
protected String	getMapValue(String key, boolean required, String[] supportedValues) Retrieve a value from the client-input-map with a lookup-key
static String	getMapValue(String key, org.apache.commons.collections.map.CaseInsensitiveMap map, boolean required) Retrieve a value from an input-map with a lookup-key
static String	getMapValue(String key, org.apache.commons.collections.map.CaseInsensitiveMap map, boolean required, String[] supportedValues) Retrieve a value from an input-map with a lookup-key
protected String[]	getRequestedVersions(boolean mandatory) Returns the version that the client requested.
UUID	getUniqueId()
boolean	requireVersion(String version, boolean mandatory) The process (request) on the server could require a specific version on the client
abstract boolean	validate() There should be some validation required on the (input of the) clients Request.

Methods inherited from class java.lang.Object

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

Field Detail

map

protected org.apache.commons.collections.map.CaseInsensitiveMap map

doc

protected Document doc

LOGGER

protected static org.slf4j.Logger LOGGER

id

protected UUID id

SUPPORTED_VERSION

public static final String SUPPORTED_VERSION

See Also:

Constant Field Values

SUPPORTED_LANGUAGES

public static final String[] SUPPORTED_LANGUAGES

Constructor Detail

Request

public Request(org.apache.commons.collections.map.CaseInsensitiveMap map)
        throws org.n52.wps.server.ExceptionReport

Create a Request based on a CaseInsensitiveMap as input (HTTP GET)

Parameters:

map - The Map which holds the client input.

Throws:

org.n52.wps.server.ExceptionReport

Request

public Request(Document doc)
        throws org.n52.wps.server.ExceptionReport

Create a Request based on a Document as input (HTTP POST)

Parameters:

doc - The Document which holds the client input.

Throws:

org.n52.wps.server.ExceptionReport

Method Detail

getDocument

public Document getDocument()

Returns the user input in Document form

Returns:

Document || null if Request(Map, outputstream) was used

getMap

public org.apache.commons.collections.map.CaseInsensitiveMap getMap()

Returns the user input in Map form

Returns:

Map || null if Request(Document, OutputStream) was used

getMapValue

public static String getMapValue(String key,
                                 org.apache.commons.collections.map.CaseInsensitiveMap map,
                                 boolean required)
                          throws org.n52.wps.server.ExceptionReport

Retrieve a value from an input-map with a lookup-key

Parameters:

key - The lookup-key

map - The input-map to look in

required - If the key-value pair must be in the map.

Returns:

The value of the key-value pair

Throws:

org.n52.wps.server.ExceptionReport

getMapValue

public static String getMapValue(String key,
                                 org.apache.commons.collections.map.CaseInsensitiveMap map,
                                 boolean required,
                                 String[] supportedValues)
                          throws org.n52.wps.server.ExceptionReport

Retrieve a value from an input-map with a lookup-key

Parameters:

key - The lookup-key

map - The input-map to look in

required - If the key-value pair must be in the map.

Returns:

The value of the key-value pair

Throws:

org.n52.wps.server.ExceptionReport

getMapArray

public static String[] getMapArray(String key,
                                   org.apache.commons.collections.map.CaseInsensitiveMap map,
                                   boolean required)
                            throws org.n52.wps.server.ExceptionReport

Retrieve an array of values from an input-map with a lookup-key

Parameters:

key - The lookup-key

map - The input-map to look in

required - If the key-value pair must be in the map.

Returns:

The array of values of the key-value pair

Throws:

org.n52.wps.server.ExceptionReport

getMapValue

protected String getMapValue(String key,
                             boolean required)
                      throws org.n52.wps.server.ExceptionReport

Retrieve a value from the client-input-map with a lookup-key

Parameters:

The - lookup-key

Returns:

The value of the key-value pair

Throws:

org.n52.wps.server.ExceptionReport

getMapValue

protected String getMapValue(String key,
                             boolean required,
                             String[] supportedValues)
                      throws org.n52.wps.server.ExceptionReport

Retrieve a value from the client-input-map with a lookup-key

Parameters:

The - lookup-key

Returns:

The value of the key-value pair

Throws:

org.n52.wps.server.ExceptionReport

getMapArray

protected String[] getMapArray(String key,
                               boolean required)
                        throws org.n52.wps.server.ExceptionReport

Retrieve an array of values from the client-input-map with a lookup-key

Parameters:

The - lookup-key

Returns:

The array of values of the key-value pair

Throws:

org.n52.wps.server.ExceptionReport

getRequestedVersions

protected String[] getRequestedVersions(boolean mandatory)
                                 throws org.n52.wps.server.ExceptionReport

Returns the version that the client requested.

Returns:

An array of versions that are compatible with the client

Throws:

org.n52.wps.server.ExceptionReport

requireVersion

public boolean requireVersion(String version,
                              boolean mandatory)
                       throws org.n52.wps.server.ExceptionReport

The process (request) on the server could require a specific version on the client

Parameters:

version - The version that is required on the client

Returns:

True if the required version matches, False otherwise.

Throws:

org.n52.wps.server.ExceptionReport

accumulateString

public static String accumulateString(String[] strings)

Accumulates the Strings in an array, separated by ", " (without quotes).

Parameters:

strings - The array to accumulate

Returns:

The accumulated String

getUniqueId

public UUID getUniqueId()

checkLanguageSupported

public static void checkLanguageSupported(String language)
                                   throws org.n52.wps.server.ExceptionReport

Checks, if the language is supported by the WPS. The language parameter is optional, however, if a wrong language is requested, an ExceptionReport has to be returned to the client. See https://bugzilla.52north.org/show_bug.cgi?id=905.

Parameters:

language - The language to be checked.

Throws:

org.n52.wps.server.ExceptionReport - If a wrong language is requested, this ExceptionReport will be returned to the client.

getAttachedResult

public abstract Object getAttachedResult()

call

public abstract Response call()
                       throws org.n52.wps.server.ExceptionReport

After creation a Request is handled. This is done by calling this method. This handling could contain a lot of computations. These computations should be called from within this method.

Specified by:

call in interface Callable<Response>

Returns:

A Response to the client Request

Throws:

org.n52.wps.server.ExceptionReport

See Also:

Callable.call()

validate

public abstract boolean validate()
                          throws org.n52.wps.server.ExceptionReport

There should be some validation required on the (input of the) clients Request.

Returns:

True if the clients Request can be handled without problems, False otherwise

Throws:

org.n52.wps.server.ExceptionReport