org.waarp.openr66.protocol.http.restv2.errors

Class RestErrors

java.lang.Object

org.waarp.openr66.protocol.http.restv2.errors.RestErrors

public final class RestErrors
extends Object

Factory class used to create instances of RestError representing input errors in an HTTP request made to the REST API.

Method Summary

Modifier and Type	Method and Description
static RestError	ALREADY_EXISTING(String id) Creates an error saying that the database already contains an entry with the same ID as the one in the entry the user tried to create.
static RestError	DUPLICATE_KEY(String field) Creates an error saying that JSON object given has a duplicate field.
static RestError	FIELD_NOT_ALLOWED(String field) Creates an error saying that the given field is a primary key, and thus cannot be changed when updating an entry.
static RestError	FILE_NOT_FOUND(String path) Creates an error saying that the file requested for import at the given location does not exist on the server.
static RestError	ILLEGAL_FIELD_VALUE(String field, String value) Creates an error saying that the given field has been assigned an illegal value.
static RestError	ILLEGAL_PARAMETER_VALUE(String parameter, String value) Creates an error saying that one of the request's parameters has an illegal value.
static RestError	MALFORMED_JSON(int line, int column, String cause) Creates an error saying that the request content is not a valid JSON object.
static RestError	MISSING_BODY() Creates an error saying that the request is missing a body when one was required.
static RestError	MISSING_FIELD(String field) Creates an error saying that one of the JSON object's field is missing when it was required.
static RestError	RULE_NOT_ALLOWED(String host, String rule) Creates an error saying that the given host is not allowed to use the given rule for its transfers.
static RestError	UNKNOWN_FIELD(String field) Creates an error saying that the JSON object sent had an extra unknown field named with the given name.
static RestError	UNKNOWN_HOST(String host) Creates an error saying that the requested host name entered alongside the newly created transfer does not exist.
static RestError	UNKNOWN_RULE(String rule) Creates an error saying that the transfer rule entered alongside the newly created transfer does not exist.

Methods inherited from class java.lang.Object

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

Method Detail

MISSING_BODY

public static RestError MISSING_BODY()

Creates an error saying that the request is missing a body when one was required.

Returns:

the corresponding new RestError object

MALFORMED_JSON

public static RestError MALFORMED_JSON(int line,
                                       int column,
                                       String cause)

Creates an error saying that the request content is not a valid JSON object.

Returns:

the corresponding new RestError object

DUPLICATE_KEY

public static RestError DUPLICATE_KEY(String field)

Creates an error saying that JSON object given has a duplicate field.

Parameters:

field - the missing parameter's name

Returns:

the corresponding new RestError object

ILLEGAL_PARAMETER_VALUE

public static RestError ILLEGAL_PARAMETER_VALUE(String parameter,
                                                String value)

Creates an error saying that one of the request's parameters has an illegal value. This includes numbers out of their expected range, or invalid enum values.

Parameters:

parameter - the incorrect parameter's name

Returns:

the corresponding new RestError object

UNKNOWN_FIELD

public static RestError UNKNOWN_FIELD(String field)

Creates an error saying that the JSON object sent had an extra unknown field named with the given name.

Parameters:

field - the extra field encountered

Returns:

the corresponding new RestError object

MISSING_FIELD

public static RestError MISSING_FIELD(String field)

Creates an error saying that one of the JSON object's field is missing when it was required. This error can also be sent if the field is present but is missing its' value.

Parameters:

field - the field whose value is missing

Returns:

the corresponding new RestError object

ILLEGAL_FIELD_VALUE

public static RestError ILLEGAL_FIELD_VALUE(String field,
                                            String value)

Creates an error saying that the given field has been assigned an illegal value. This includes values of the wrong type, or values outside the allowed bounds of the field.

Parameters:

field - the name of the field whose value is incorrect

value - the textual representation of the incorrect value

Returns:

the corresponding new RestError object

ALREADY_EXISTING

public static RestError ALREADY_EXISTING(String id)

Creates an error saying that the database already contains an entry with the same ID as the one in the entry the user tried to create. Since the database cannot contain entries with duplicate IDs, the requested entry cannot be created.

Parameters:

id - the duplicate ID in the requested collection

Returns:

the corresponding new RestError object

FILE_NOT_FOUND

public static RestError FILE_NOT_FOUND(String path)

Creates an error saying that the file requested for import at the given location does not exist on the server.

Parameters:

path - the incorrect path

Returns:

the corresponding new RestError object

UNKNOWN_RULE

public static RestError UNKNOWN_RULE(String rule)

Creates an error saying that the transfer rule entered alongside the newly created transfer does not exist.

Parameters:

rule - the unknown rule's name

Returns:

the corresponding new RestError object

UNKNOWN_HOST

public static RestError UNKNOWN_HOST(String host)

Creates an error saying that the requested host name entered alongside the newly created transfer does not exist.

Parameters:

host - the unknown host name

Returns:

the corresponding new RestError object

RULE_NOT_ALLOWED

public static RestError RULE_NOT_ALLOWED(String host,
                                         String rule)

Creates an error saying that the given host is not allowed to use the given rule for its transfers.

Parameters:

host - the host processing the transfer

rule - the rule which the host is not allowed to use

Returns:

the corresponding new RestError object

FIELD_NOT_ALLOWED

public static RestError FIELD_NOT_ALLOWED(String field)

Creates an error saying that the given field is a primary key, and thus cannot be changed when updating an entry.

Parameters:

field - the name of the field which was illegally modified

Returns:

the corresponding new RestError object