DVB GEM Companion Framework
A C D E G I L N O P R S U W 

A

AppToAppInfo - Interface in org.dvb.gem.companion
Describes CompanionService's endpoint.

C

close() - Method in interface org.dvb.gem.websocket.WebSocket
Sends closings handshage and close the connection.
CompanionService - Interface in org.dvb.gem.companion
The interface is an abstract representation of UPnP Application.
connect() - Method in class org.dvb.gem.websocket.WebSocketClient
Connects to a WebSocket server available under URI passed in WebSocketClient.WebSocketClient(URI)
CSSService - Class in org.dvb.gem.companion.css
Represents CSS functionalities.
CSSService() - Constructor for class org.dvb.gem.companion.css.CSSService
 

D

DELETE(String) - Method in interface org.dvb.gem.companion.rest.RESTService
Realizes DELETE HTTP request.

E

enterPrivateMode() - Method in class org.dvb.gem.companion.ServiceManager
Enters into the private mode by pausing all running CompanionService.

G

GET(String) - Method in interface org.dvb.gem.companion.rest.RESTService
Realizes GET HTTP request.
getAppToAppInfos() - Method in interface org.dvb.gem.companion.CompanionService
Gets an arrays of AppToAppInfo associated with the service.
getConnection() - Method in class org.dvb.gem.websocket.WebSocketClient
Returns the client endpoint for the connection.
getConnectionAddress() - Method in interface org.dvb.gem.companion.AppToAppInfo
Gets a valid connection address for the protocol type.
getConnections() - Method in class org.dvb.gem.websocket.WebSocketServer
Returns an array of WebSocket currently connected clients.
getFriendlyName() - Method in interface org.dvb.gem.companion.CompanionService
Gets the name of the service supplied by the service vendor.
getInstance() - Static method in class org.dvb.gem.companion.ServiceManager
Returns the instance of SecurityManager.
getMatchingProtocolName() - Method in interface org.dvb.gem.companion.AppToAppInfo
Gets protocol name defined as "ApplicationIdentification".GEM.DVB.org_v1, where "ApplicationIdentification" is free text to be supplied by the application vendor.
getProtocol() - Method in interface org.dvb.gem.companion.AppToAppInfo
Gets protocol type (for example "REST", "Websocket").
getServices() - Method in class org.dvb.gem.companion.ServiceManager
Retrieves a list of started CompanionService.

I

isInPrivateMode() - Method in class org.dvb.gem.companion.ServiceManager
Checks if the ServiceManager is currently in the Private Mode.
isOpen() - Method in interface org.dvb.gem.websocket.WebSocket
Returns true if the websocket is open.
isProtocolRequired() - Method in interface org.dvb.gem.companion.AppToAppInfo
Determines if the protocol is required.

L

leavePrivateMode() - Method in class org.dvb.gem.companion.ServiceManager
Leaves from the Private Mode by resuming all paused CompanionService.

N

notifyAll(String) - Method in class org.dvb.gem.websocket.WebSocketServer
Sends a message to all connected clients.

O

onWebsocketClose(WebSocket) - Method in interface org.dvb.gem.websocket.WebSocketListener
Called after the call of WebSocket.close() or when the other endpoint of the connection is closed.
onWebsocketMessage(WebSocket, String) - Method in interface org.dvb.gem.websocket.WebSocketListener
Called when a full message has been received.
onWebsocketOpen(WebSocket) - Method in interface org.dvb.gem.websocket.WebSocketListener
Called after successful handshake.
org.dvb.gem.companion - package org.dvb.gem.companion
 
org.dvb.gem.companion.css - package org.dvb.gem.companion.css
 
org.dvb.gem.companion.rest - package org.dvb.gem.companion.rest
 
org.dvb.gem.companion.websocket - package org.dvb.gem.companion.websocket
 
org.dvb.gem.websocket - package org.dvb.gem.websocket
 

P

pause() - Method in interface org.dvb.gem.companion.CompanionService
Pauses the service.
POST(String, String) - Method in interface org.dvb.gem.companion.rest.RESTService
Realizes POST HTTP request.
PUT(String, String) - Method in interface org.dvb.gem.companion.rest.RESTService
Realizes PUT HTTP request.

R

registerService(CompanionService) - Method in class org.dvb.gem.companion.ServiceManager
Registers a CompanionService.
RESTService - Interface in org.dvb.gem.companion.rest
Represents Companion Service based on REST protocol.
resume() - Method in interface org.dvb.gem.companion.CompanionService
Resumes the service from paused state.

S

send(String) - Method in interface org.dvb.gem.websocket.WebSocket
Sends a text message to the other end of websocket connection.
ServiceManager - Class in org.dvb.gem.companion
Manages states of CompanionService.
ServiceManager() - Constructor for class org.dvb.gem.companion.ServiceManager
 
start() - Method in interface org.dvb.gem.companion.CompanionService
Starts the service.
start() - Method in class org.dvb.gem.websocket.WebSocketServer
Starts the server, binds to the chosen TCP port number and listens for WebSocket connection requests.
startService(CompanionService) - Method in class org.dvb.gem.companion.ServiceManager
stop() - Method in interface org.dvb.gem.companion.CompanionService
Stops the service.
stop() - Method in class org.dvb.gem.websocket.WebSocketServer
Stops the servers, closes all connected clients, frees used TCP port.
stopService(CompanionService) - Method in class org.dvb.gem.companion.ServiceManager

U

unregisterService(CompanionService) - Method in class org.dvb.gem.companion.ServiceManager
Unregisters a CompanionService.

W

WebSocket - Interface in org.dvb.gem.websocket
Represents end point of websocket connection.
WebSocketClient - Class in org.dvb.gem.websocket
Represents a client functionality of WebSocket.
WebSocketClient(URI) - Constructor for class org.dvb.gem.websocket.WebSocketClient
Creates WebSocketClient with the server endpoint.
WebSocketListener - Interface in org.dvb.gem.websocket
Methods called by WebSocket.
WebSocketServer - Class in org.dvb.gem.websocket
Represent a server functionality of WebSocket.
WebSocketServer(int) - Constructor for class org.dvb.gem.websocket.WebSocketServer
Creates a WebSocketServer instance working on the specific TCP port.
WebSocketService - Interface in org.dvb.gem.companion.websocket
Represent CompanionService based on WebSocket protocol.
A C D E G I L N O P R S U W 
DVB GEM Companion Framework