AbstractLoggingResource (Silverpeas Core 6.3 API)

java.lang.Object
- org.silverpeas.core.web.rs.RESTWebService
- - org.silverpeas.core.webapi.util.logging.AbstractLoggingResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource

Direct Known Subclasses:

LogResource, SilverLoggerConfigurationResource
```
public abstract class AbstractLoggingResource
extends RESTWebService
```
Abstract class to gather all the common features for the web resources about the logging system in Silverpeas.

Author:

mmoquillon

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

AbstractLoggingResource()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getComponentId()`	Gets the identifier of the component instance to which the requested resource belongs to.
`void`	`validateUserAuthorization(UserPrivilegeValidation validation)`	Validates the authorization of the user to request this web service.

Methods inherited from class org.silverpeas.core.web.rs.RESTWebService
fromPage, getBundle, getBundleLocation, getHighestUserRole, getHttpRequest, getHttpServletRequest, getHttpServletResponse, getOrganisationController, getResourceBasePath, 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.WebAuthenticationValidation
validateUserAuthentication

- Constructor Detail
  - AbstractLoggingResource
```
public AbstractLoggingResource()
```
- Method Detail
  - validateUserAuthorization
```
public void validateUserAuthorization(UserPrivilegeValidation validation)
```
    Description copied from interface: ProtectedWebResource
    
    Validates the authorization of the user to request this web service. For doing, the user must have the rights to access the component instance that manages this web resource. If no such component instance exists, a Not Found HTTP error is thrown (status code 404). Otherwise the validation is delegated to the validation service by passing it the required information.
    This method should be invoked for web service requiring an authorized access. For doing, the authentication of the user must be first valdiated. Otherwise, the annotation Authorized can be also used instead at class level for both authentication and authorization.
    
    Parameters:
    
    validation - the validation instance to use.
    
    See Also:
    
    UserPrivilegeValidator
  - getComponentId
```
public String getComponentId()
```
    Gets the identifier of the component instance to which the requested resource belongs to.
    
    Returns:
    
    the identifier of the Silverpeas component instance.