Package org.silverpeas.core.webapi.util.logging

Class LogResource

java.lang.Object

org.silverpeas.core.web.rs.RESTWebService

org.silverpeas.core.webapi.util.logging.AbstractLoggingResource

org.silverpeas.core.webapi.util.logging.LogResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource

@WebService
@Authorized
@Path("logging/logs/{logName}")
public class LogResource
extends AbstractLoggingResource

A Web resource representing a given log used by Silverpeas. It is a REST-based Web service.

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
LogResource()

Method Summary

Modifier and Type	Method	Description
String	getLastLogRecordsAsHtml(int count)
List<String>	getLastLogRecordsAsJson(int count)
String	getLastLogRecordsAsText(int count)
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 by SilverpeasWebResource.getBasePath().

Methods inherited from class org.silverpeas.core.webapi.util.logging.AbstractLoggingResource

getComponentId, validateUserAuthorization

Methods inherited from class org.silverpeas.core.web.rs.RESTWebService

createWebResourceUri, fromPage, getBundle, getBundleLocation, 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.WebAuthenticationValidation

validateUserAuthentication

Constructor Detail

LogResource

public LogResource()

Method Detail

getLastLogRecordsAsJson

@GET
@Produces("application/json")
public List<String> getLastLogRecordsAsJson(@QueryParam("count")
                                            int count)

getLastLogRecordsAsHtml

@GET
@Produces("text/html")
public String getLastLogRecordsAsHtml(@QueryParam("count")
                                      int count)

getLastLogRecordsAsText

@GET
@Produces("text/plain")
public String getLastLogRecordsAsText(@QueryParam("count")
                                      int count)

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 by SilverpeasWebResource.getBasePath().

Specified by:

getResourceBasePath in class RESTWebService

Returns:

the relative path that identifies this REST web service among all other REST web services.