Class AbstractSimpleDocumentResource
- java.lang.Object
-
- org.silverpeas.core.web.rs.RESTWebService
-
- org.silverpeas.core.webapi.attachment.AbstractSimpleDocumentResource
-
- All Implemented Interfaces:
ProtectedWebResource
,WebAuthenticationValidation
,WebAuthorizationValidation
,SilverpeasWebResource
- Direct Known Subclasses:
SimpleDocumentListResource
,SimpleDocumentResource
,SimpleDocumentResourceCreator
public abstract class AbstractSimpleDocumentResource extends RESTWebService
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.silverpeas.core.web.rs.RESTWebService
RESTWebService.WebProcess<R>, RESTWebService.WebTreatment<R>
-
-
Field Summary
-
Fields inherited from class org.silverpeas.core.web.rs.RESTWebService
RESPONSE_HEADER_ARRAYSIZE
-
Fields inherited from interface org.silverpeas.core.web.SilverpeasWebResource
BASE_PATH
-
-
Constructor Summary
Constructors Constructor Description AbstractSimpleDocumentResource()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
checkUploadedFile(File fileToCheck)
Check the file.protected String
getBundleLocation()
Gets the location of the bundle to use.String
getComponentId()
Gets the identifier of the component instance to which the requested resource belongs to.protected String
getResourceBasePath()
Gets the base path of the web resource relative to the root path of all the web resources in Silverpeas as given bySilverpeasWebResource.getBasePath()
.protected void
performRuntimeException(RuntimeException re)
Manages the runtime errors.-
Methods inherited from class org.silverpeas.core.web.rs.RESTWebService
createWebResourceUri, fromPage, getBundle, getHighestUserRole, getHttpRequest, getHttpServletRequest, getHttpServletResponse, getOrganisationController, getSilverpeasContext, getUri, getUser, getUserPreferences, getUserRoles, identifiedBy, identifiedBy, initContext, initWebResourceUri, isUserDefined, process
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.silverpeas.core.web.rs.ProtectedWebResource
validateUserAuthorization
-
Methods inherited from interface org.silverpeas.core.web.rs.WebAuthenticationValidation
validateUserAuthentication
-
-
-
-
Method Detail
-
getResourceBasePath
protected String getResourceBasePath()
Description copied from class:RESTWebService
Gets the base path of the web resource relative to the root path of all the web resources in Silverpeas as given bySilverpeasWebResource.getBasePath()
.- Specified by:
getResourceBasePath
in classRESTWebService
- Returns:
- the relative path that identifies this REST web service among all other REST web services.
-
getComponentId
public String getComponentId()
Description copied from interface:SilverpeasWebResource
Gets the identifier of the component instance to which the requested resource belongs to.- Returns:
- the identifier of the Silverpeas component instance.
-
getBundleLocation
protected String getBundleLocation()
Description copied from class:RESTWebService
Gets the location of the bundle to use.- Overrides:
getBundleLocation
in classRESTWebService
- Returns:
- the classpath location of the localization bundle used by this Web service.
-
checkUploadedFile
protected void checkUploadedFile(File fileToCheck)
Check the file.- Parameters:
fileToCheck
-
-
performRuntimeException
protected void performRuntimeException(RuntimeException re)
Manages the runtime errors.- Parameters:
re
-
-
-