fr.cnes.doi.resource.mds

Class DoiResource

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.DoiResource

public class DoiResource
extends BaseMdsResource

DOI resource to retrieve the landing page for a given DOI.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
private String	doiName DOI template.
static String	GET_DOI Function of this resource "Get DOI".

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

DOI_PARAMETER, LOG, URL_PARAMETER

Constructor Summary

Constructors

Constructor and Description
DoiResource()

Method Summary

Modifier and Type	Method and Description
private void	checkInput(String doiName) Checks if doiName is not empty and contains the institution's prefix
protected void	describeGet(org.restlet.ext.wadl.MethodInfo info) Describes the Get Method.
protected void	doInit() Init by getting the DOI name in the template URL.
private org.restlet.ext.wadl.RepresentationInfo	doiRepresentation() DOI representation
org.restlet.representation.Representation	getDoi() Returns the URL associated to a given DOI or no content.

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

checkPermission, describeDelete, 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_DOI

public static final String GET_DOI

Function of this resource "Get DOI".

See Also:

Constant Field Values

doiName

private volatile String doiName

DOI template.

Constructor Detail

DoiResource

public DoiResource()

Method Detail

doInit

protected void doInit()
               throws DoiServerException

Init by getting the DOI name in the template URL.

Overrides:

doInit in class BaseMdsResource

Throws:

DoiServerException - - if a problem happens

getDoi

@Requirement(reqId="DOI_SRV_070",reqName="R\u00e9cup\u00e9ration de l\u2019URL de la landing page") @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")
 @Get
public org.restlet.representation.Representation getDoi()
                                                                                                                                                                                                                                                                                                                                                        throws DoiServerException

Returns the URL associated to a given DOI or no content. When the status is 200, the URL associated to a DOI is returnes. When the status is 204, the DOI is known to MDS, but is not minted (or not resolvable e.g. due to handle's latency)

Returns:

an URL or no content (DOI is known to MDS, but is not minted (or not resolvable e.g. due to handle's latency))

Throws:

DoiServerException - - if the response is not a success

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

checkInput

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

Checks if doiName is not empty and contains the institution's prefix

Parameters:

doiName - DOI name

Throws:

DoiServerException - 400 Bad Request if the DOI does not contain the institution suffix.

doiRepresentation

@Requirement(reqId="DOI_DOC_010",
             reqName="Documentation des interfaces")
private org.restlet.ext.wadl.RepresentationInfo doiRepresentation()

DOI representation

Returns:

Wadl representation for a DOI

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.SUCCESS_NO_CONTENT
• DoiMdsApplication.API_MDS.DOI_VALIDATION
• ClientMDS.DATACITE_API_RESPONSE.DOI_NOT_FOUND
• DoiMdsApplication.API_MDS.DATACITE_PROBLEM

Overrides:

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

Parameters:

info - Wadl description