de.starface.integration.uci.java.v30.ucp.messages.requests
Interface UcpServiceRequests


@RpcInterface(value="ucp.v30.requests.service")
@UciService(value="ucp.v30.requests.service")
public interface UcpServiceRequests


Field Summary
static String SERVICE_NAME
          The UCI service name used for this interface
 
Method Summary
 List<String> getProvidedEvents()
          This request can be used to query the server for the service names of all supported events.
 List<String> getProvidedRequests()
          This request can be used to query the server for the service names of all supported requests.
 boolean providesEvents(String serviceName)
          This request can be used by the client to detect if events it wants to use are actually provided by the server.
 boolean providesRequests(String serviceName)
          This request can be used by the client to detect if another requests it wants to use are actually provided by the server.
 boolean subscribeEvents(String serviceName)
          The client logged in at the server may subscribe to events provided by the server.
 void unsubscribeEvents(String serviceName)
          The client logged in may also unsubscribe any events it has previously subscribed to.
 

Field Detail

SERVICE_NAME

static final String SERVICE_NAME
The UCI service name used for this interface

See Also:
Constant Field Values
Method Detail

subscribeEvents

boolean subscribeEvents(String serviceName)
                        throws UciException
The client logged in at the server may subscribe to events provided by the server. To do so it provides a service name depending on the events it wants to receive. The server will only send the events requested in this way. The client is not required to subscribe to any events but this method to get informed of server state is preferred over polling.

Parameters:
serviceName - a String denoting the service name of the events the client wants to receive
Returns:
true if the registration was successful or false if the requested events are not provided by the server
Throws:
UciException - if the request is placed while the UCI client is not connected ( UcpNotConnectedException).

unsubscribeEvents

void unsubscribeEvents(String serviceName)
                       throws UciException
The client logged in may also unsubscribe any events it has previously subscribed to. To do so it will send this request providing a service names to unsubscribe from.

Parameters:
serviceName - a String denoting the service name of the events to unsubscribe from
Throws:
UciException - if the request is placed while the UCI client is not connected ( UcpNotConnectedException).

providesEvents

boolean providesEvents(String serviceName)
                       throws UciException
This request can be used by the client to detect if events it wants to use are actually provided by the server. To do so it sends this request providing a service name of the events intended to be used.

Parameters:
serviceName - a String denoting the service name of the events to query for
Returns:
true if the given events are supported by the server or false if not supported.
Throws:
UciException - if the request is placed while the UCI client is not connected ( UcpNotConnectedException).

getProvidedEvents

List<String> getProvidedEvents()
                               throws UciException
This request can be used to query the server for the service names of all supported events.

Returns:
a List of String containing the service names of supported events
Throws:
UciException - if the request is placed while the UCI client is not connected ( UcpNotConnectedException).

providesRequests

boolean providesRequests(String serviceName)
                         throws UciException
This request can be used by the client to detect if another requests it wants to use are actually provided by the server. To do so it sends this request providing a service name of the requests intended to be used.

Parameters:
serviceName - a String denoting the service name of the requests to query for
Returns:
true if the given requests are supported by the server or false if not supported.
Throws:
UciException - if the request is placed while the UCI client is not connected ( UcpNotConnectedException).

getProvidedRequests

List<String> getProvidedRequests()
                                 throws UciException
This request can be used to query the server for the service names of all supported requests.

Returns:
a List of String containing the service names of supported requests
Throws:
UciException - if the request is placed while the UCI client is not connected ( UcpNotConnectedException).


Copyright © 2012 STARFACE GmbH. All rights reserved.