fr.cnes.doi.resource.mds

Class MediaResource

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

public class MediaResource
extends BaseMdsResource

Resource to handle the Media.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
private String	mediaName DOI parsed from the URL.

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

DOI_PARAMETER, LOG, URL_PARAMETER

Constructor Summary

Constructors

Constructor and Description
MediaResource()

Method Summary

Modifier and Type	Method and Description
private void	checkInputs(String doi, org.restlet.data.Form mediaForm) Checks input parameters
org.restlet.representation.Representation	createMedia(org.restlet.data.Form mediaForm) Creates a media related to an URL for a given DOI.
protected void	describeGet(org.restlet.ext.wadl.MethodInfo info) Describes the GET method.
protected void	describePost(org.restlet.ext.wadl.MethodInfo info) Describes the POST method.
protected void	doInit() Init by getting the media name.
org.restlet.representation.Representation	getMedias() Returns the media related to a DOI.
private org.restlet.ext.wadl.RepresentationInfo	mediaRepresentation() Media representation.

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

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

mediaName

private volatile String mediaName

DOI parsed from the URL.

Constructor Detail

MediaResource

public MediaResource()

Method Detail

doInit

protected void doInit()
               throws DoiServerException

Init by getting the media name.

Overrides:

doInit in class BaseMdsResource

Throws:

DoiServerException - - if a problem happens

getMedias

@Requirement(reqId="DOI_SRV_090",reqName="R\u00e9cup\u00e9ration des m\u00e9dias") @Requirement(reqId="DOI_MONIT_020",reqName="Monitoring de l\'\u00e9tat de DataCite")
 @Get
public org.restlet.representation.Representation getMedias()
                                                                                                                                                                                                                                  throws DoiServerException

Returns the media related to a DOI. This request returns list of pairs of media type and URLs associated with a given DOI when 200 status is returned (operation successful).

Returns:

the media related to a DOI

Throws:

DoiServerException - - if the response is not a success

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

createMedia

@Requirement(reqId="DOI_SRV_080",reqName="Cr\u00e9ation d\u2019un m\u00e9dia") @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")
 @Post
public org.restlet.representation.Representation createMedia(org.restlet.data.Form mediaForm)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           throws DoiServerException

Creates a media related to an URL for a given DOI. Will add/update media type/urls pairs to a DOI. Standard domain restrictions check will be performed. 200 status is returned when the operation is successful.

Parameters:

mediaForm - Form

Returns:

short explanation of status code

Throws:

DoiServerException - - if the response is not a success :

• ClientMDS.DATACITE_API_RESPONSE.BAD_REQUEST
• DoiMdsApplication.API_MDS.DATACITE_PROBLEM
• 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

checkInputs

@Requirement(reqId="DOI_INTER_070",
             reqName="V\u00e9rification des entr\u00e9es fournies pour DataCite")
private void checkInputs(String doi,
                                                                                                                                               org.restlet.data.Form mediaForm)
                                                                                                                                        throws DoiServerException

Checks input parameters

Parameters:

doi - DOI number

mediaForm - the parameters

Throws:

DoiServerException - - 400 Bad Request if DOI_PARAMETER is not set

mediaRepresentation

private org.restlet.ext.wadl.RepresentationInfo mediaRepresentation()

Media representation.

Returns:

Wadl description for a Media representation

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
• DoiMdsApplication.API_MDS.DATACITE_PROBLEM

Overrides:

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

Parameters:

info - Wadl description for a GET method

describePost

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

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

• ClientMDS.DATACITE_API_RESPONSE.SUCCESS
• DoiMdsApplication.API_MDS.MEDIA_VALIDATION
• DoiMdsApplication.API_MDS.DATACITE_PROBLEM
• 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

Overrides:

describePost in class BaseMdsResource

Parameters:

info - Wadl description for describing POST method