de.w3is.jdial

Class DialClientConnection

java.lang.Object

de.w3is.jdial.DialClientConnection

public class DialClientConnection
extends Object

A connection for interacting with a dial server.

Author:

Simon Weis

Method Summary

Modifier and Type	Method and Description
Optional<Application>	getApplication(String applicationName) Returns an Application instance if the app is supported.
void	hideApplication(Application application) Hide an application
Optional<URL>	startApplication(Application application) Start an application
Optional<URL>	startApplication(Application application, DialContent dialContent) Starts an application and provide additional data to send to the server
Optional<URL>	startApplication(String applicationName) Start an application by name
Optional<URL>	startApplication(String applicationName, DialContent dialContent) Start an application by name and provide additional data to send to the server
void	stopApplication(Application application) Stop an application that is not in the stopped state and supports stopping
void	stopApplication(URL instanceUrl) Stop an application
boolean	supportsApplication(String applicationName) Tests if the server supports the application.

Methods inherited from class java.lang.Object

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

Method Detail

supportsApplication

public boolean supportsApplication(String applicationName)

Tests if the server supports the application.

Parameters:

applicationName - The name of the application.

Returns:

True if the server supports the application.

getApplication

public Optional<Application> getApplication(String applicationName)

Returns an Application instance if the app is supported.

Parameters:

applicationName - The name of the application

Returns:

An instance of the Application

startApplication

public Optional<URL> startApplication(Application application)
                               throws DialClientException

Start an application

Parameters:

application - An application instance

Returns:

An url to the started instance if the server provides one

Throws:

DialClientException - In case of an network or protocol error

startApplication

public Optional<URL> startApplication(Application application,
                                      DialContent dialContent)
                               throws DialClientException

Starts an application and provide additional data to send to the server

Parameters:

application - The application to start

dialContent - The additional data to send

Returns:

An url to the started instance if the server provides one

Throws:

DialClientException - In case of an network or protocol error

startApplication

public Optional<URL> startApplication(String applicationName)
                               throws DialClientException

Start an application by name

Parameters:

applicationName - The name of the application

Returns:

An url to the started instance if the server provides one

Throws:

DialClientException - In case of an network or protocol error

startApplication

public Optional<URL> startApplication(String applicationName,
                                      DialContent dialContent)
                               throws DialClientException

Start an application by name and provide additional data to send to the server

Parameters:

applicationName - The name of the application

Returns:

An url to the started instance if the server provides one

Throws:

DialClientException - In case of an network or protocol error

stopApplication

public void stopApplication(URL instanceUrl)
                     throws DialClientException

Stop an application

Parameters:

instanceUrl - An url to the app instance

Throws:

DialClientException - In case of an network or protocol error

stopApplication

public void stopApplication(Application application)
                     throws DialClientException

Stop an application that is not in the stopped state and supports stopping

Parameters:

application - The application to stop

Throws:

DialClientException - In case of an network or protocol error or when the application does not support stopping

hideApplication

public void hideApplication(Application application)
                     throws DialClientException

Hide an application

Parameters:

application - An application instance

Throws:

DialClientException - In case of an network or protocol error