fr.cnes.doi.resource.admin

Class SuffixProjectsResource

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.admin.SuffixProjectsResource

public class SuffixProjectsResource
extends AbstractResource

Provides a unique identifier to the project. This identifier is used as part of the DOI name.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.logging.log4j.Logger	LOG Logger.
static int	NB_DIGITS Number of digits (6) in which the suffix project is encoded.
static String	PROJECT_NAME_PARAMETER Parameter for the project name "projectName".
static String	USER_PARAMETER Query parameter for user "user".
private String	userName The user name

Constructor Summary

Constructors

Constructor and Description
SuffixProjectsResource()

Method Summary

Modifier and Type	Method and Description
private void	checkInputs(org.restlet.data.Form mediaForm) Tests if the PROJECT_NAME_PARAMETER is set.
org.restlet.representation.Representation	createProject(org.restlet.data.Form mediaForm) Creates a suffix projet based on the project name.
protected void	describeGet(org.restlet.ext.wadl.MethodInfo info) Describes a GET method.
protected void	describePost(org.restlet.ext.wadl.MethodInfo info) Describes a POST method.
protected void	doInit() Set-up method that can be overridden in order to initialize the state of the resource.
Map<String,Integer>	getProjectsNameAsJson() Returns the list of projects as Json or xml format.
private org.restlet.ext.wadl.RepresentationInfo	projectsRepresentation() projects representation

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

PROJECT_NAME_PARAMETER

public static final String PROJECT_NAME_PARAMETER

Parameter for the project name "projectName". This parameter is send to create an identifier for the project.

See Also:

Constant Field Values

NB_DIGITS

public static final int NB_DIGITS

Number of digits (6) in which the suffix project is encoded.

See Also:

Constant Field Values

USER_PARAMETER

public static final String USER_PARAMETER

Query parameter for user "user".

See Also:

Constant Field Values

LOG

private volatile org.apache.logging.log4j.Logger LOG

Logger.

userName

private volatile String userName

The user name

Constructor Detail

SuffixProjectsResource

public SuffixProjectsResource()

Method Detail

doInit

protected void doInit()
               throws org.restlet.resource.ResourceException

Set-up method that can be overridden in order to initialize the state of the resource.

Overrides:

doInit in class AbstractResource

Throws:

org.restlet.resource.ResourceException - - if a problem happens

getProjectsNameAsJson

@Requirement(reqId="DOI_SRV_140",
             reqName="R\u00e9cup\u00e9ration du nom du projet \u00e0 partir du suffixe projet")
 @Get(value="json|xml")
public Map<String,Integer> getProjectsNameAsJson()

Returns the list of projects as Json or xml format.

Returns:

the list of projects as Json or xml format

createProject

@Requirement(reqId="DOI_SRV_130",
             reqName="Cr\u00e9ation d\'un suffixe projet")
 @Post
public org.restlet.representation.Representation createProject(org.restlet.data.Form mediaForm)

Creates a suffix projet based on the project name. The project name is passed as parameter( PROJECT_NAME_PARAMETER ) in the mediaForm. When a project suffix is created, a role with the same name is also automatically created.

Parameters:

mediaForm - submitted form

Returns:

A text representation of the encoded project name

checkInputs

private void checkInputs(org.restlet.data.Form mediaForm)
                  throws org.restlet.resource.ResourceException

Tests if the PROJECT_NAME_PARAMETER is set.

Parameters:

mediaForm - the parameters

Throws:

org.restlet.resource.ResourceException - - if PROJECT_NAME_PARAMETER is not set

projectsRepresentation

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

projects representation

Returns:

Wadl representation for projects

describeGet

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

Describes a GET method.

Overrides:

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

Parameters:

info - method information

describePost

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

Describes a POST method.

Overrides:

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

Parameters:

info - method information