Interface BasicApi
-
- All Known Implementing Classes:
GlobalRestService,SwingAppRestService
@Path("/") public interface BasicApiWebswing REST APIThe public REST API provided by Webswing Server
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description IntegeractiveSessionsCount()Get Number of Active SessionsStringgetAdminConsoleUrl()URL of admin consoleList<ApplicationInfoMsg>getApps()Get ApplicationsFilegetIcon()Get Application IconApplicationInfogetInfo()Get Path InfoManifestgetManifest()PWA manifestList<BasicApplicationInfo>getPaths()Get Available ApplicationsPermissionsgetPermissions()Get User PermissionsSessionsgetSessions()Get All SessionsMap<String,Map<String,BigDecimal>>getStats()Get Aggregated StatsStringgetVersion()Webswing Server Versionvoidping()Ping
-
-
-
Method Detail
-
activeSessionsCount
@GET @Path("/rest/activeSessionsCount") @Produces("text/plain") Integer activeSessionsCount() throws RestExceptionGet Number of Active Sessions- Throws:
RestException
-
getAdminConsoleUrl
@GET @Path("/rest/adminConsoleUrl") @Produces("text/plain") String getAdminConsoleUrl() throws RestExceptionURL of admin console- Throws:
RestException
-
getApps
@GET @Path("/apps") @Produces("application/json") List<ApplicationInfoMsg> getApps() throws RestExceptionGet Applications- Throws:
RestException
-
getIcon
@GET @Path("/appicon") @Produces("image/png") File getIcon() throws RestExceptionGet Application Icon- Throws:
RestException
-
getInfo
@GET @Path("/rest/info") @Produces("application/json") ApplicationInfo getInfo() throws RestExceptionGet Path Info- Throws:
RestException
-
getManifest
@GET @Path("/manifest.json") @Produces("application/json") Manifest getManifest() throws RestExceptionPWA manifest- Throws:
RestException
-
getPaths
@GET @Path("/rest/paths") @Produces("application/json") List<BasicApplicationInfo> getPaths() throws RestExceptionGet Available Applications- Throws:
RestException
-
getPermissions
@GET @Path("/rest/permissions") @Produces("application/json") Permissions getPermissions() throws RestExceptionGet User Permissions- Throws:
RestException
-
getSessions
@GET @Path("/rest/sessions") @Produces("application/json") Sessions getSessions() throws RestExceptionGet All Sessions- Throws:
RestException
-
getStats
@GET @Path("/rest/stats") @Produces("application/json") Map<String,Map<String,BigDecimal>> getStats() throws RestExceptionGet Aggregated Stats- Throws:
RestException
-
getVersion
@GET @Path("/rest/version") @Produces("text/plain") String getVersion() throws RestExceptionWebswing Server Version- Throws:
RestException
-
ping
@GET @Path("/rest/ping") void ping() throws RestExceptionPing- Throws:
RestException
-
-