Package org.webswing.server.services.rest.resources.api

Interface ManageSessionsApi

All Known Implementing Classes:

SwingAppRestService

@Path("/")
public interface ManageSessionsApi

Webswing REST API

The public REST API provided by Webswing Server

Method Summary

Modifier and Type	Method	Description
File	downloadSessionsLog()	Download Session Logs
String	generateCsrfToken()	CSRF Token
List<String>	getLogInstanceIds()	Get session-logging Instances
SwingSession	getMetrics(String uuid)	Get Session Metrics
SwingSession	getSession(String id)	Get Session details
LogResponse	getSessionLogs(LogRequest logRequest)	Request Session Log Content
String	getThreadDump(String instanceId, String timestamp)	Get Thread Dump
void	requestThreadDump(String instanceId)	Create Thread Dump
void	shutdown(String id, String force)	Request session shutdown
SwingSession	startRecording(String id)	Start Session Recording
void	toggleStatisticsLogging(String instanceId, Boolean enabled)	Set statistics logging value

Method Detail

downloadSessionsLog

@GET
@Path("/rest/session/logs")
@Produces("application/octet-stream")
File downloadSessionsLog()
                  throws RestException

Download Session Logs

Throws:

RestException

generateCsrfToken

@GET
@Path("/rest/CSRFToken")
@Produces("text/plain")
String generateCsrfToken()
                  throws RestException

CSRF Token

Throws:

RestException

getLogInstanceIds

@GET
@Path("/rest/session/logs/instanceIds")
@Produces("application/json")
List<String> getLogInstanceIds()
                        throws RestException

Get session-logging Instances

Throws:

RestException

getMetrics

@GET
@Path("/rest/metrics/{uuid}")
@Produces("application/json")
SwingSession getMetrics(@PathParam("uuid")
                        String uuid)
                 throws RestException

Get Session Metrics

Throws:

RestException

getSession

@GET
@Path("/rest/session/{id}")
@Produces("application/json")
SwingSession getSession(@PathParam("id")
                        String id)
                 throws RestException

Get Session details

Throws:

RestException

getSessionLogs

@POST
@Path("/rest/session/logs")
@Consumes("application/json")
@Produces("application/json")
LogResponse getSessionLogs(LogRequest logRequest)
                    throws RestException

Request Session Log Content

Throws:

RestException

getThreadDump

@GET
@Path("/rest/threadDump/{instanceId}")
@Produces("text/plain")
String getThreadDump(@PathParam("instanceId")
                     String instanceId,
                     @QueryParam("timestamp")
                     String timestamp)
              throws RestException

Get Thread Dump

Throws:

RestException

requestThreadDump

@POST
@Path("/rest/threadDump/{instanceId}")
void requestThreadDump(@PathParam("instanceId")
                       String instanceId)
                throws RestException

Create Thread Dump

Throws:

RestException

shutdown

@DELETE
@Path("/rest/session/{id}")
void shutdown(@PathParam("id")
              String id,
              @QueryParam("force")
              String force)
       throws RestException

Request session shutdown

Throws:

RestException

startRecording

@GET
@Path("/rest/record/{id}")
@Produces("application/json")
SwingSession startRecording(@PathParam("id")
                            String id)
                     throws RestException

Start Session Recording

Throws:

RestException

toggleStatisticsLogging

@POST
@Path("/rest/toggleStatisticsLogging/{instanceId}/{enabled}")
void toggleStatisticsLogging(@PathParam("instanceId")
                             String instanceId,
                             @PathParam("enabled")
                             Boolean enabled)
                      throws RestException

Set statistics logging value

Throws:

RestException