fr.cnes.doi.application

Enum DoiMdsApplication.API_MDS

java.lang.Object

java.lang.Enum<DoiMdsApplication.API_MDS>

fr.cnes.doi.application.DoiMdsApplication.API_MDS

All Implemented Interfaces:

Serializable, Comparable<DoiMdsApplication.API_MDS>

Enclosing class:

DoiMdsApplication

public static enum DoiMdsApplication.API_MDS
extends Enum<DoiMdsApplication.API_MDS>

API related only to the code in this webservice. Other codes can be returned by the ClientMDS

Enum Constant Summary

Enum Constants

Enum Constant and Description
CREATE_METADATA Create metadata.
DATACITE_PROBLEM Internal server error.
DOI_VALIDATION DOI validation error.
LANGING_PAGE_VALIDATION Fail to create the landing page related to the DOI.
MEDIA_VALIDATION Fail to create the media related to the DOI.
METADATA_VALIDATION Fail to validate user input parameter for creating the DOI.
NETWORK_PROBLEM Cannot access to Datacite.
SECURITY_USER_CONFLICT Fail to know privileges of a user.
SECURITY_USER_NO_ROLE Fail to authorize the user.
SECURITY_USER_NOT_IN_SELECTED_ROLE Forbidden to use this role.
SECURITY_USER_PERMISSION Fail to create a DOI.

Field Summary

Fields

Modifier and Type	Field and Description
private String	shortMessage Short message.
private org.restlet.data.Status	status Message status.

Method Summary

Modifier and Type	Method and Description
String	getShortMessage() Returns the short message.
org.restlet.data.Status	getStatus() Returns the status
static DoiMdsApplication.API_MDS	valueOf(String name) Returns the enum constant of this type with the specified name.
static DoiMdsApplication.API_MDS[]	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

CREATE_METADATA

public static final DoiMdsApplication.API_MDS CREATE_METADATA

Create metadata. SUCCESS_CREATED is used as status meaning "Operation successful"

SECURITY_USER_NOT_IN_SELECTED_ROLE

public static final DoiMdsApplication.API_MDS SECURITY_USER_NOT_IN_SELECTED_ROLE

Forbidden to use this role. It happens when a user provides a role to the server whereas he is unknown in this role. CLIENT_ERROR_FORBIDDEN is used as status meaning "Forbidden to use this role"

SECURITY_USER_NO_ROLE

public static final DoiMdsApplication.API_MDS SECURITY_USER_NO_ROLE

Fail to authorize the user. It happens when a client is authentified but unauthorized to use the resource. CLIENT_ERROR_UNAUTHORIZED is used as status meaning "Fail to authorize the user"

SECURITY_USER_CONFLICT

public static final DoiMdsApplication.API_MDS SECURITY_USER_CONFLICT

Fail to know privileges of a user. It happens when an user is associated to several roles without selecting one. CLIENT_ERROR_CONFLICT is used as status meaning "Error when an user is associated to more than one role without setting selectedRole parameter"

SECURITY_USER_PERMISSION

public static final DoiMdsApplication.API_MDS SECURITY_USER_PERMISSION

Fail to create a DOI. It happens when a user try to create a DOI with the wrong role. Actually, the role is contained in the DOI name. So if a user is authentified with a right role and try to create a DOI for another role, an exception is raised. SECURITY_USER_PERMISSION is used as status meaning "User is not allowed to make this operation"

NETWORK_PROBLEM

public static final DoiMdsApplication.API_MDS NETWORK_PROBLEM

Cannot access to Datacite. It happens when a network problem may happen with Datacite. SERVER_ERROR_GATEWAY_TIMEOUT is used as status meaning "Cannot access to Datacite"

METADATA_VALIDATION

public static final DoiMdsApplication.API_MDS METADATA_VALIDATION

Fail to validate user input parameter for creating the DOI. It happens in the following cases:

• the DOI or metadata are not provided
• the prefix is not allowed
• some characters are not allowed in the DOI name

CLIENT_ERROR_BAD_REQUEST is used as status meaning "Failed to validate the user inputs parameters"

MEDIA_VALIDATION

public static final DoiMdsApplication.API_MDS MEDIA_VALIDATION

Fail to create the media related to the DOI. CLIENT_ERROR_BAD_REQUEST is used as status meaning "DOI not provided or one or more of the specified mime-types or urls are invalid (e.g. non supported mime-type, not allowed url domain, etc.)"

LANGING_PAGE_VALIDATION

public static final DoiMdsApplication.API_MDS LANGING_PAGE_VALIDATION

Fail to create the landing page related to the DOI. CLIENT_ERROR_BAD_REQUEST is used as status meaning "Validation error when defining the DOI and its landing page"

DOI_VALIDATION

public static final DoiMdsApplication.API_MDS DOI_VALIDATION

DOI validation error. CLIENT_ERROR_BAD_REQUEST is used as status meaning "Character or prefix not allowed in the DOI"

DATACITE_PROBLEM

public static final DoiMdsApplication.API_MDS DATACITE_PROBLEM

Internal server error. Fail to communicate with DataCite using the interface specification meaning "Interface problem between Datacite and DOI-Server"

Field Detail

status

private final org.restlet.data.Status status

Message status.

shortMessage

private final String shortMessage

Short message.

Method Detail

values

public static DoiMdsApplication.API_MDS[] 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 (DoiMdsApplication.API_MDS c : DoiMdsApplication.API_MDS.values())
    System.out.println(c);

Returns:

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

valueOf

public static DoiMdsApplication.API_MDS 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