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

Class SwingAppRestService

java.lang.Object

org.webswing.server.services.rest.resources.SwingAppRestService

All Implemented Interfaces:

BasicApi, ManageConfigurationApi, ManageSessionsApi

public class SwingAppRestService
extends Object
implements BasicApi, ManageConfigurationApi, ManageSessionsApi

Constructor Summary

Constructors

Constructor	Description
SwingAppRestService()

Method Summary

Modifier and Type	Method	Description
Integer	activeSessionsCount()	Get Number of Active Sessions
File	downloadSessionsLog()	Download Session Logs
String	generateCsrfToken()	CSRF Token
String	getAdminConsoleUrl()	URL of admin console
List<ApplicationInfoMsg>	getApps()	Get Applications
MetaObject	getConfig()	Get Config
File	getIcon()	Get Application Icon
ApplicationInfo	getInfo()	Get Path Info
List<String>	getLogInstanceIds()	Get session-logging Instances
Manifest	getManifest()	PWA manifest
MetaObject	getMeta(Map<String,Object> requestBody)	Describe Configuration
SwingSession	getMetrics(String uuid)	Get Session Metrics
List<BasicApplicationInfo>	getPaths()	Get Available Applications
Permissions	getPermissions()	Get User Permissions
SwingSession	getSession(String id)	Get Session details
LogResponse	getSessionLogs(LogRequest request)	Request Session Log Content
Sessions	getSessions()	Get All Sessions
Map<String,Map<String,BigDecimal>>	getStats()	Get Aggregated Stats
String	getThreadDump(String instanceId, String timestamp)	Get Thread Dump
String	getVersion()	Webswing Server Version
void	ping()	Ping
void	requestThreadDump(String id)	Create Thread Dump
String	resolve(String type, String resolve)	Resolve Variables.
void	saveConfig(Map<String,Object> config)	Set Config
Map<String,String>	searchVariables(String type, String search)	Find Variables
void	shutdown(String id, String forceKill)	Request session shutdown
SwingSession	startRecording(String id)	Start Session Recording
void	toggleStatisticsLogging(String instanceId, Boolean enabled)	Set statistics logging value

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SwingAppRestService

public SwingAppRestService()

Method Detail

getInfo

public ApplicationInfo getInfo()
                        throws RestException

Description copied from interface: BasicApi

Get Path Info

Specified by:

getInfo in interface BasicApi

Throws:

RestException

getPaths

public List<BasicApplicationInfo> getPaths()
                                    throws RestException

Description copied from interface: BasicApi

Get Available Applications

Specified by:

getPaths in interface BasicApi

Throws:

RestException

getSessions

public Sessions getSessions()
                     throws RestException

Description copied from interface: BasicApi

Get All Sessions

Specified by:

getSessions in interface BasicApi

Throws:

RestException

activeSessionsCount

public Integer activeSessionsCount()
                            throws RestException

Description copied from interface: BasicApi

Get Number of Active Sessions

Specified by:

activeSessionsCount in interface BasicApi

Throws:

RestException

getPermissions

public Permissions getPermissions()
                           throws RestException

Description copied from interface: BasicApi

Get User Permissions

Specified by:

getPermissions in interface BasicApi

Throws:

RestException

getApps

public List<ApplicationInfoMsg> getApps()
                                 throws RestException

Description copied from interface: BasicApi

Get Applications

Specified by:

getApps in interface BasicApi

Throws:

RestException

getAdminConsoleUrl

public String getAdminConsoleUrl()
                          throws RestException

Description copied from interface: BasicApi

URL of admin console

Specified by:

getAdminConsoleUrl in interface BasicApi

Throws:

RestException

getVersion

public String getVersion()
                  throws RestException

Description copied from interface: BasicApi

Webswing Server Version

Specified by:

getVersion in interface BasicApi

Throws:

RestException

ping

public void ping()
          throws RestException

Description copied from interface: BasicApi

Ping

Specified by:

ping in interface BasicApi

Throws:

RestException

getStats

public Map<String,Map<String,BigDecimal>> getStats()
                                                        throws RestException

Description copied from interface: BasicApi

Get Aggregated Stats

Specified by:

getStats in interface BasicApi

Throws:

RestException

getConfig

public MetaObject getConfig()
                     throws RestException

Description copied from interface: ManageConfigurationApi

Get Config

Specified by:

getConfig in interface ManageConfigurationApi

Throws:

RestException

getMeta

public MetaObject getMeta(Map<String,Object> requestBody)
                   throws RestException

Description copied from interface: ManageConfigurationApi

Describe Configuration

Specified by:

getMeta in interface ManageConfigurationApi

Throws:

RestException

saveConfig

public void saveConfig(Map<String,Object> config)
                throws RestException

Description copied from interface: ManageConfigurationApi

Set Config

Specified by:

saveConfig in interface ManageConfigurationApi

Throws:

RestException

resolve

public String resolve(String type,
                      String resolve)
               throws RestException

Description copied from interface: ManageConfigurationApi

Resolve Variables.

Specified by:

resolve in interface ManageConfigurationApi

Throws:

RestException

searchVariables

public Map<String,String> searchVariables(String type,
                                                String search)
                                         throws RestException

Description copied from interface: ManageConfigurationApi

Find Variables

Specified by:

searchVariables in interface ManageConfigurationApi

Throws:

RestException

getSession

public SwingSession getSession(String id)
                        throws RestException

Description copied from interface: ManageSessionsApi

Get Session details

Specified by:

getSession in interface ManageSessionsApi

Throws:

RestException

getMetrics

public SwingSession getMetrics(String uuid)
                        throws RestException

Description copied from interface: ManageSessionsApi

Get Session Metrics

Specified by:

getMetrics in interface ManageSessionsApi

Throws:

RestException

startRecording

public SwingSession startRecording(String id)
                            throws RestException

Description copied from interface: ManageSessionsApi

Start Session Recording

Specified by:

startRecording in interface ManageSessionsApi

Throws:

RestException

getThreadDump

public String getThreadDump(String instanceId,
                            String timestamp)
                     throws RestException

Description copied from interface: ManageSessionsApi

Get Thread Dump

Specified by:

getThreadDump in interface ManageSessionsApi

Throws:

RestException

requestThreadDump

public void requestThreadDump(String id)
                       throws RestException

Description copied from interface: ManageSessionsApi

Create Thread Dump

Specified by:

requestThreadDump in interface ManageSessionsApi

Throws:

RestException

toggleStatisticsLogging

public void toggleStatisticsLogging(String instanceId,
                                    Boolean enabled)
                             throws RestException

Description copied from interface: ManageSessionsApi

Set statistics logging value

Specified by:

toggleStatisticsLogging in interface ManageSessionsApi

Throws:

RestException

shutdown

public void shutdown(String id,
                     String forceKill)
              throws RestException

Description copied from interface: ManageSessionsApi

Request session shutdown

Specified by:

shutdown in interface ManageSessionsApi

Throws:

RestException

getSessionLogs

public LogResponse getSessionLogs(LogRequest request)
                           throws RestException

Description copied from interface: ManageSessionsApi

Request Session Log Content

Specified by:

getSessionLogs in interface ManageSessionsApi

Throws:

RestException

getLogInstanceIds

public List<String> getLogInstanceIds()
                               throws RestException

Description copied from interface: ManageSessionsApi

Get session-logging Instances

Specified by:

getLogInstanceIds in interface ManageSessionsApi

Throws:

RestException

downloadSessionsLog

public File downloadSessionsLog()
                         throws RestException

Description copied from interface: ManageSessionsApi

Download Session Logs

Specified by:

downloadSessionsLog in interface ManageSessionsApi

Throws:

RestException

generateCsrfToken

public String generateCsrfToken()
                         throws RestException

Description copied from interface: ManageSessionsApi

CSRF Token

Specified by:

generateCsrfToken in interface ManageSessionsApi

Throws:

RestException

getManifest

public Manifest getManifest()
                     throws RestException

Description copied from interface: BasicApi

PWA manifest

Specified by:

getManifest in interface BasicApi

Throws:

RestException

getIcon

public File getIcon()
             throws RestException

Description copied from interface: BasicApi

Get Application Icon

Specified by:

getIcon in interface BasicApi

Throws:

RestException