fr.cnes.doi.resource.mds

Class MetadataResource

java.lang.Object

org.restlet.resource.Resource

org.restlet.resource.ServerResource

org.restlet.ext.wadl.WadlServerResource

fr.cnes.doi.resource.AbstractResource

fr.cnes.doi.resource.mds.BaseMdsResource

fr.cnes.doi.resource.mds.MetadataResource

public class MetadataResource
extends BaseMdsResource

Resources to handle a metadata.

Author:

Jean-Christophe Malapert (jean-christophe.malapert@cnes.fr)

Field Summary

Fields

Modifier and Type	Field and Description
static String	DELETE_METADATA Function of this resource "Delete a Metadata".
private String	doiName DOI name, which is set on the URL template.
static String	GET_METADATA Function of this resource "Get a Metadata".

Fields inherited from class fr.cnes.doi.resource.mds.BaseMdsResource

DOI_PARAMETER, LOG, URL_PARAMETER

Constructor Summary

Constructors

Constructor and Description
MetadataResource()

Method Summary

Modifier and Type	Method and Description
private void	checkInputs(String doiName) Checks input parameters
org.restlet.representation.Representation	deleteMetadata() Deletes a representation for a given DOI.
protected void	describeDelete(org.restlet.ext.wadl.MethodInfo info) Describes the DELETE method.
protected void	describeGet(org.restlet.ext.wadl.MethodInfo info) Describes the GET method.
protected void	doInit() Init by getting a DOI.
org.restlet.representation.Representation	getMetadata() Retuns the metadata for a given DOI.
Resource	getMetadataAsJson() Returns the metadata as JSON.

Methods inherited from class fr.cnes.doi.resource.mds.BaseMdsResource

checkPermission, describePost, explainRepresentation, extractSelectedRoleFromRequestIfExists, getAttributePath, getDoiApp

Methods inherited from class fr.cnes.doi.resource.AbstractResource

addRequestDocToMethod, addRequestDocToMethod, addRequestDocToMethod, addResponseDocToMethod, createQueryParamDoc, createQueryRepresentationDoc, createResponseDoc, createResponseDoc, createResponseDoc, htmlRepresentation, isObjectExist, isObjectNotExist, isValueExist, isValueNotExist, stringRepresentation

Methods inherited from class org.restlet.ext.wadl.WadlServerResource

canDescribe, createHtmlRepresentation, createWadlRepresentation, describe, describe, describe, describe, describe, describe, describe, describe, describeMethod, describeMethod, describeOptions, describeParameters, describePatch, describePut, getDescription, getName, getParameter, getParameters, getPreferredWadlVariant, getResourcePath, getResourcesBase, getWadlVariants, isAutoDescribing, options, setAutoDescribing, setDescription, setName

Methods inherited from class org.restlet.resource.ServerResource

abort, commit, delete, delete, describeVariants, doCatch, doConditionalHandle, doError, doHandle, doHandle, doNegotiatedHandle, get, get, getAttribute, getInfo, getInfo, getOnSent, getPreferredVariant, getRole, getVariants, getVariants, handle, hasAnnotations, head, head, isAnnotated, isAutoCommitting, isCommitted, isConditional, isExisting, isInRole, isNegotiated, options, patch, patch, post, post, put, put, redirectPermanent, redirectPermanent, redirectSeeOther, redirectSeeOther, redirectTemporary, redirectTemporary, setAllowedMethods, setAnnotated, setAttribute, setAutoCommitting, setChallengeRequests, setCommitted, setConditional, setCookieSettings, setDimensions, setExisting, setLocationRef, setLocationRef, setNegotiated, setOnSent, setProxyChallengeRequests, setServerInfo, setStatus, setStatus, setStatus, setStatus, updateAllowedMethods, updateDimensions

Methods inherited from class org.restlet.resource.Resource

doError, doRelease, getAllowedMethods, getApplication, getChallengeRequests, getChallengeResponse, getClientInfo, getConditions, getConnegService, getContext, getConverterService, getCookies, getCookieSettings, getDimensions, getHostRef, getLocationRef, getLogger, getMatrix, getMatrixValue, getMaxForwards, getMetadataService, getMethod, getOriginalRef, getProtocol, getProxyChallengeRequests, getProxyChallengeResponse, getQuery, getQueryValue, getRanges, getReference, getReferrerRef, getRequest, getRequestAttributes, getRequestCacheDirectives, getRequestEntity, getResponse, getResponseAttributes, getResponseCacheDirectives, getResponseEntity, getRootRef, getServerInfo, getStatus, getStatusService, init, isConfidential, isLoggable, release, setApplication, setQueryValue, setRequest, setResponse, toBoolean, toByte, toDouble, toFloat, toInteger, toLong, toObject, toRepresentation, toRepresentation, toRepresentation, toShort, toString

Methods inherited from class java.lang.Object

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

Field Detail

GET_METADATA

public static final String GET_METADATA

Function of this resource "Get a Metadata".

See Also:

Constant Field Values

DELETE_METADATA

public static final String DELETE_METADATA

Function of this resource "Delete a Metadata".

See Also:

Constant Field Values

doiName

private volatile String doiName

DOI name, which is set on the URL template.

Constructor Detail

MetadataResource

public MetadataResource()

Method Detail

doInit

protected void doInit()
               throws DoiServerException

Init by getting a DOI.

Overrides:

doInit in class BaseMdsResource

Throws:

DoiServerException - - if a problem happens

checkInputs

@Requirement(reqId="DOI_INTER_070",
             reqName="V\u00e9rification des entr\u00e9es fournies pour DataCite")
private void checkInputs(String doiName)
                                                                                                                                        throws DoiServerException

Checks input parameters

Parameters:

doiName - DOI number

Throws:

DoiServerException - - 400 Bad Request if DOI_PARAMETER is not set

getMetadata

@Requirement(reqId="DOI_SRV_060",reqName="R\u00e9cup\u00e9ration des m\u00e9tadonn\u00e9es") @Requirement(reqId="DOI_MONIT_020",reqName="Monitoring de l\'\u00e9tat de DataCite")
 @Get(value="xml")
public org.restlet.representation.Representation getMetadata()
                                                                                                                                                                                                                                                           throws DoiServerException

Retuns the metadata for a given DOI. 200 status is returned when the operation is successful.

Returns:

the metadata for a given DOI as Json or XML

Throws:

DoiServerException - - if the response is not a success

• ClientMDS.DATACITE_API_RESPONSE.BAD_REQUEST
• ClientMDS.DATACITE_API_RESPONSE.DOI_NOT_FOUND
• DoiMdsApplication.API_MDS.DATACITE_PROBLEM

getMetadataAsJson

@Get(value="json")
public Resource getMetadataAsJson()
                                              throws IOException

Returns the metadata as JSON.

Returns:

JSON representation.

Throws:

IOException - - if JSON conversion problem occurs

deleteMetadata

@Requirement(reqId="DOI_SRV_050",reqName="D\u00e9sactivation d\u2019un DOI") @Requirement(reqId="DOI_MONIT_020",reqName="Monitoring de l\'\u00e9tat de DataCite") @Requirement(reqId="DOI_INTER_070",reqName="V\u00e9rification des entr\u00e9es fournies pour DataCite") @Requirement(reqId="DOI_AUTO_020",reqName="S\u00e9lection du r\u00f4le") @Requirement(reqId="DOI_AUTO_030",reqName="V\u00e9rification du projet")
 @Delete
public org.restlet.representation.Representation deleteMetadata()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              throws DoiServerException

Deletes a representation for a given DOI. 200 status when the operation is successful.

Returns:

the deleted representation

Throws:

DoiServerException - - if the response is not a success

• DoiMdsApplication.API_MDS.SECURITY_USER_NO_ROLE
• DoiMdsApplication.API_MDS.SECURITY_USER_NOT_IN_SELECTED_ROLE
• DoiMdsApplication.API_MDS.SECURITY_USER_PERMISSION
• DoiMdsApplication.API_MDS.SECURITY_USER_CONFLICT
• ClientMDS.DATACITE_API_RESPONSE.DOI_NOT_FOUND
• DoiMdsApplication.API_MDS.DATACITE_PROBLEM

describeGet

@Requirement(reqId="DOI_DOC_010",
             reqName="Documentation des interfaces")
protected final void describeGet(org.restlet.ext.wadl.MethodInfo info)

Describes the GET method. The different representations are the followings:

• ClientMDS.DATACITE_API_RESPONSE.SUCCESS
• ClientMDS.DATACITE_API_RESPONSE.DOI_NOT_FOUND
• ClientMDS.DATACITE_API_RESPONSE.DOI_INACTIVE
• DoiMdsApplication.API_MDS.DATACITE_PROBLEM

Overrides:

describeGet in class org.restlet.ext.wadl.WadlServerResource

Parameters:

info - Wadl description for GET method

describeDelete

@Requirement(reqId="DOI_DOC_010",
             reqName="Documentation des interfaces")
protected final void describeDelete(org.restlet.ext.wadl.MethodInfo info)

Describes the DELETE method. The different representations are the followings:

• ClientMDS.DATACITE_API_RESPONSE.SUCCESS
• ClientMDS.DATACITE_API_RESPONSE.DOI_NOT_FOUND
• DoiMdsApplication.API_MDS.SECURITY_USER_NO_ROLE
• DoiMdsApplication.API_MDS.SECURITY_USER_NOT_IN_SELECTED_ROLE
• DoiMdsApplication.API_MDS.SECURITY_USER_PERMISSION
• DoiMdsApplication.API_MDS.SECURITY_USER_CONFLICT
• DoiMdsApplication.API_MDS.DATACITE_PROBLEM

Overrides:

describeDelete in class BaseMdsResource

Parameters:

info - Wadl description for DELETE method