fr.cnes.doi.resource

Class AbstractResource

java.lang.Object

org.restlet.resource.Resource

org.restlet.resource.ServerResource

org.restlet.ext.wadl.WadlServerResource

fr.cnes.doi.resource.AbstractResource

Direct Known Subclasses:

AuthenticateResource, BaseCitationResource, BaseMdsResource, ConfigIhmResource, FooterIhmResource, ManageProjectsResource, ManageSuperUserResource, ManageSuperUsersResource, ManageUsersResource, RedirectingResource, SuffixProjectsDoisResource, SuffixProjectsResource, TokenResource

@Requirement(reqId="DOI_DOC_010",
             reqName="Documentation des interfaces")
public abstract class AbstractResource
extends org.restlet.ext.wadl.WadlServerResource

Abstract resource. Each resource must extend from this abstract class. This abstract class allows the WADL description.

Author:

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

See Also:

WADL

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.logging.log4j.Logger	LOG Logger.

Constructor Summary

Constructors

Constructor and Description
AbstractResource()

Method Summary

Modifier and Type	Method and Description
protected void	addRequestDocToMethod(org.restlet.ext.wadl.MethodInfo info, List<org.restlet.ext.wadl.ParameterInfo> params) Adds Wadl description of the request to the method.
protected void	addRequestDocToMethod(org.restlet.ext.wadl.MethodInfo info, List<org.restlet.ext.wadl.ParameterInfo> params, org.restlet.ext.wadl.RepresentationInfo rep) Adds Wadl description of the request to the method.
protected void	addRequestDocToMethod(org.restlet.ext.wadl.MethodInfo info, org.restlet.ext.wadl.ParameterInfo param) Adds Wadl description of the request to a method.
protected void	addResponseDocToMethod(org.restlet.ext.wadl.MethodInfo info, org.restlet.ext.wadl.ResponseInfo response) Adds Wadl description of the response to a method.
protected org.restlet.ext.wadl.ParameterInfo	createQueryParamDoc(String name, org.restlet.ext.wadl.ParameterStyle style, String doc, boolean isRequired, String datatype) Creates a query parameter.
protected org.restlet.ext.wadl.RepresentationInfo	createQueryRepresentationDoc(String identifier, org.restlet.data.MediaType mediaType, String doc, String xmlElement) Creates query representation.
protected org.restlet.ext.wadl.ResponseInfo	createResponseDoc(org.restlet.data.Status status, String doc) Creates a textual explanation of the response for a given status.
protected org.restlet.ext.wadl.ResponseInfo	createResponseDoc(org.restlet.data.Status status, String doc, org.restlet.ext.wadl.RepresentationInfo representation) Creates a textual explanation of the response for a given status.
protected org.restlet.ext.wadl.ResponseInfo	createResponseDoc(org.restlet.data.Status status, String doc, String refRepresentation) Creates a textual explanation of the response for a given status.
protected void	doInit() Init
protected org.restlet.ext.wadl.RepresentationInfo	htmlRepresentation() projects representation
boolean	isObjectExist(Object obj) Test if an object is null.
boolean	isObjectNotExist(Object obj) Test if an object is not null.
boolean	isValueExist(org.restlet.data.Form form, String parameterName) Tests if the form is not null and the parameter exists in the form.
boolean	isValueNotExist(org.restlet.data.Form form, String parameterName) The opposite of isValueExist(org.restlet.data.Form, java.lang.String)
protected org.restlet.ext.wadl.RepresentationInfo	stringRepresentation() projects representation

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

canDescribe, createHtmlRepresentation, createWadlRepresentation, describe, describe, describe, describe, describe, describe, describe, describe, describeDelete, describeGet, describeMethod, describeMethod, describeOptions, describeParameters, describePatch, describePost, 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

LOG

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

Logger.

Constructor Detail

AbstractResource

public AbstractResource()

Method Detail

doInit

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

Init

Overrides:

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

Throws:

org.restlet.resource.ResourceException - When an Exception happens

isValueExist

public boolean isValueExist(org.restlet.data.Form form,
                            String parameterName)

Tests if the form is not null and the parameter exists in the form.

Parameters:

form - submitted form

parameterName - parameter name in the form

Returns:

True when the form is not null and the parameter exists in the form otherwise False

isValueNotExist

public boolean isValueNotExist(org.restlet.data.Form form,
                               String parameterName)

The opposite of isValueExist(org.restlet.data.Form, java.lang.String)

Parameters:

form - submitted form

parameterName - parameter name

Returns:

False when the form is not null and the parameter exists in the form otherwise True

isObjectExist

public boolean isObjectExist(Object obj)

Test if an object is null.

Parameters:

obj - object to test

Returns:

True when the object is not null otherwise False

isObjectNotExist

public boolean isObjectNotExist(Object obj)

Test if an object is not null.

Parameters:

obj - object to test

Returns:

True when the object is null otherwise False

addRequestDocToMethod

protected void addRequestDocToMethod(org.restlet.ext.wadl.MethodInfo info,
                                     org.restlet.ext.wadl.ParameterInfo param)

Adds Wadl description of the request to a method.

Parameters:

info - method description

param - Request parameters

addRequestDocToMethod

protected void addRequestDocToMethod(org.restlet.ext.wadl.MethodInfo info,
                                     List<org.restlet.ext.wadl.ParameterInfo> params)

Adds Wadl description of the request to the method.

Parameters:

info - Method description

params - Request parameters

addRequestDocToMethod

protected void addRequestDocToMethod(org.restlet.ext.wadl.MethodInfo info,
                                     List<org.restlet.ext.wadl.ParameterInfo> params,
                                     org.restlet.ext.wadl.RepresentationInfo rep)

Adds Wadl description of the request to the method.

Parameters:

info - Method description

params - Request parameters

rep - Representation entity of the request

addResponseDocToMethod

protected void addResponseDocToMethod(org.restlet.ext.wadl.MethodInfo info,
                                      org.restlet.ext.wadl.ResponseInfo response)

Adds Wadl description of the response to a method.

Parameters:

info - Method description

response - Response description

createResponseDoc

protected org.restlet.ext.wadl.ResponseInfo createResponseDoc(org.restlet.data.Status status,
                                                              String doc)

Creates a textual explanation of the response for a given status.

Parameters:

status - HTTP Status

doc - textual explanation

Returns:

Response Wadl description

createResponseDoc

protected org.restlet.ext.wadl.ResponseInfo createResponseDoc(org.restlet.data.Status status,
                                                              String doc,
                                                              String refRepresentation)

Creates a textual explanation of the response for a given status.

Parameters:

status - HTTP status

doc - textual explanation

refRepresentation - reference to the representation of the response

Returns:

the response Wadl description

createResponseDoc

protected org.restlet.ext.wadl.ResponseInfo createResponseDoc(org.restlet.data.Status status,
                                                              String doc,
                                                              org.restlet.ext.wadl.RepresentationInfo representation)

Creates a textual explanation of the response for a given status.

Parameters:

status - HTTP status

doc - textual description

representation - Representation of the response

Returns:

the response Wadl description

createQueryParamDoc

protected org.restlet.ext.wadl.ParameterInfo createQueryParamDoc(String name,
                                                                 org.restlet.ext.wadl.ParameterStyle style,
                                                                 String doc,
                                                                 boolean isRequired,
                                                                 String datatype)

Creates a query parameter.

Parameters:

name - query parameter name

style - Style (header, template, ...)

doc - textual description

isRequired - optional or required

datatype - data type

Returns:

the query Wadl description

createQueryRepresentationDoc

protected org.restlet.ext.wadl.RepresentationInfo createQueryRepresentationDoc(String identifier,
                                                                               org.restlet.data.MediaType mediaType,
                                                                               String doc,
                                                                               String xmlElement)

Creates query representation.

Parameters:

identifier - representation identifier

mediaType - media type

doc - textual description

xmlElement - XML element of the schema

Returns:

Wadl element for the representation

stringRepresentation

protected org.restlet.ext.wadl.RepresentationInfo stringRepresentation()

projects representation

Returns:

Wadl representation for projects

htmlRepresentation

protected org.restlet.ext.wadl.RepresentationInfo htmlRepresentation()

projects representation

Returns:

Wadl representation for projects