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


@RpcInterface(value="ucp.v30.requests.connection")
@UciService(value="ucp.v30.requests.connection")
public interface UcpConnectionRequests

This interface defines the UCP connection requests provided by the UCI server. This is a UCP addition to the standard UCI requests used for UCP connection handling.


Field Summary
static String SERVICE_NAME
          The UCI service name used for this interface
 
Method Summary
 boolean keepAlive()
          The keepAlive request is used to check if the server is still available, the connection has not been lost and tell the server that the client is still available.
 boolean login()
          The login request is sent by the client to connect to the UCP server.
 void logout()
          The client uses the logout request to indicate its intention to close the UCP connection.
 

Field Detail

SERVICE_NAME

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

See Also:
Constant Field Values
Method Detail

login

boolean login()
              throws UciIllegalAccessException,
                     UcpCommunicationException
The login request is sent by the client to connect to the UCP server. To stay connected to the server the client is required to send continuous keepAlive() requests!

Returns:
The return value of the message indicates if the login was successful.
Throws:
UciIllegalAccessException - if the request is not allowed to the user (UciIllegalAccessException).
UcpCommunicationException

logout

void logout()
            throws UcpCommunicationException
The client uses the logout request to indicate its intention to close the UCP connection. The response of the server is always true and may therefore be ignored.

Throws:
UcpCommunicationException

keepAlive

@RpcLogging(value=TRACE)
boolean keepAlive()
                  throws UcpCommunicationException
The keepAlive request is used to check if the server is still available, the connection has not been lost and tell the server that the client is still available.

Returns:
A return value of true denotes that the client connection to the server is still available and false tells the client that it is not logged in from the servers point of view. In the case of the false return value the client must login again and discard all information about states (call, fax, ...) it had previously received from the server.
Throws:
UcpCommunicationException


Copyright © 2012 STARFACE GmbH. All rights reserved.