fr.cnes.doi.client

Enum ClientMDS.DATACITE_API_RESPONSE

java.lang.Object

java.lang.Enum<ClientMDS.DATACITE_API_RESPONSE>

fr.cnes.doi.client.ClientMDS.DATACITE_API_RESPONSE

All Implemented Interfaces:

Serializable, Comparable<ClientMDS.DATACITE_API_RESPONSE>

Enclosing class:

ClientMDS

public static enum ClientMDS.DATACITE_API_RESPONSE
extends Enum<ClientMDS.DATACITE_API_RESPONSE>

Datacite API.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BAD_REQUEST Fail to create a media or the metadata.
DOI_INACTIVE Get an inactive DOI.
DOI_NOT_FOUND Fail to get the DOI.
FORBIDDEN Fail to create/delete media/metadata/Landing page.
INTERNAL_SERVER_ERROR Internal server Error.
PROCESS_ERROR Fail to create a DOI because metadata must be uploaded first.
SUCCESS Get/Delete successfully a DOI or a media.
SUCCESS_NO_CONTENT Get a DOI without metadata.
SUCESS_CREATED Create successfully a DOI.
UNAUTHORIZED Fail to authorize the user to create/delete a DOI.

Field Summary

Fields

Modifier and Type	Field and Description
private String	message message.
private org.restlet.data.Status	status HTTP status.

Method Summary

Modifier and Type	Method and Description
static String	getMessageFromStatus(org.restlet.data.Status statusToFind) Returns the message for a specific Status.
String	getShortMessage() Returns the short message
org.restlet.data.Status	getStatus() Returns the status
static ClientMDS.DATACITE_API_RESPONSE	valueOf(String name) Returns the enum constant of this type with the specified name.
static ClientMDS.DATACITE_API_RESPONSE[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUCCESS

public static final ClientMDS.DATACITE_API_RESPONSE SUCCESS

Get/Delete successfully a DOI or a media. SUCCESS_OK is used as status

SUCESS_CREATED

public static final ClientMDS.DATACITE_API_RESPONSE SUCESS_CREATED

Create successfully a DOI. SUCCESS_CREATED is as used as status.

SUCCESS_NO_CONTENT

public static final ClientMDS.DATACITE_API_RESPONSE SUCCESS_NO_CONTENT

Get a DOI without metadata. SUCCESS_NO_CONTENT is used as status

BAD_REQUEST

public static final ClientMDS.DATACITE_API_RESPONSE BAD_REQUEST

Fail to create a media or the metadata. CLIENT_ERROR_BAD_REQUEST is used as status

UNAUTHORIZED

public static final ClientMDS.DATACITE_API_RESPONSE UNAUTHORIZED

Fail to authorize the user to create/delete a DOI. CLIENT_ERROR_UNAUTHORIZED is used as status

FORBIDDEN

public static final ClientMDS.DATACITE_API_RESPONSE FORBIDDEN

Fail to create/delete media/metadata/Landing page. CLIENT_ERROR_FORBIDDEN is used as status

DOI_NOT_FOUND

public static final ClientMDS.DATACITE_API_RESPONSE DOI_NOT_FOUND

Fail to get the DOI. CLIENT_ERROR_NOT_FOUND is used as status

DOI_INACTIVE

public static final ClientMDS.DATACITE_API_RESPONSE DOI_INACTIVE

Get an inactive DOI. CLIENT_ERROR_GONE is used as status

PROCESS_ERROR

public static final ClientMDS.DATACITE_API_RESPONSE PROCESS_ERROR

Fail to create a DOI because metadata must be uploaded first. CLIENT_ERROR_PRECONDITION_FAILED is used as status

INTERNAL_SERVER_ERROR

public static final ClientMDS.DATACITE_API_RESPONSE INTERNAL_SERVER_ERROR

Internal server Error. INTERNAL_SERVER_ERROR is used as status.

Field Detail

status

private final org.restlet.data.Status status

HTTP status.

message

private final String message

message.

Method Detail

values

public static ClientMDS.DATACITE_API_RESPONSE[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ClientMDS.DATACITE_API_RESPONSE c : ClientMDS.DATACITE_API_RESPONSE.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ClientMDS.DATACITE_API_RESPONSE valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getStatus

public org.restlet.data.Status getStatus()

Returns the status

Returns:

the status

getShortMessage

public String getShortMessage()

Returns the short message

Returns:

the short message

getMessageFromStatus

public static String getMessageFromStatus(org.restlet.data.Status statusToFind)

Returns the message for a specific Status.

Parameters:

statusToFind - status to search

Returns:

the message or empty string