ConnectionBase (safeguardjava 2.10.0 API)

All Known Implementing Classes:

Connection, HubConnection
```
public interface ConnectionBase
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`closed(Runnable handler)` Sets the handler for the "Closed" event
`void`	`connected(Runnable handler)` Sets the handler for the "Connected" event
`void`	`connectionSlow(Runnable handler)` Sets the handler for the "ConnectionSlow" event
`void`	`disconnect()` Closes the connection
`void`	`error(ErrorCallback handler)` Sets the handler for the "Error" event
`String`	`getConnectionData()` Returns the data used by the connection
`String`	`getConnectionId()` Returns the connection Id
`String`	`getConnectionToken()` Returns the connection token
`Credentials`	`getCredentials()` Returns the credentials used by the connection
`String`	`getGroupsToken()` Returns the connection groups token
`com.google.gson.Gson`	`getGson()` Returns the Gson instance used by the connection
`Map<String,String>`	`getHeaders()` Returns the connection headers
`com.google.gson.JsonParser`	`getJsonParser()` Returns the JsonParser used by the connection
`Logger`	`getLogger()` Returns the Logger used by the connection
`String`	`getMessageId()` Returns the current message Id
`String`	`getQueryString()` Returns the query string used by the connection
`ConnectionState`	`getState()` Returns the connection state
`String`	`getUrl()` Returns the URL used by the connection
`void`	`onError(Throwable error, boolean mustCleanCurrentConnection)` Triggers the Error event
`void`	`onReceived(com.google.gson.JsonElement message)`
`void`	`prepareRequest(Request request)` Prepares a request that is going to be sent to the server
`void`	`received(MessageReceivedHandler handler)` Sets the handler for the "Received" event
`void`	`reconnected(Runnable handler)` Sets the handler for the "Reconnected" event
`void`	`reconnecting(Runnable handler)` Sets the handler for the "Reconnecting" event
`SignalRFuture<Void>`	`send(String data)` Sends data using the connection
`void`	`setClientCertificate(String clientCertificatePath, char[] clientCertificatePassword, String clientCertificateAlias)` Set the client certificate information
`void`	`setCredentials(Credentials credentials)` Sets the credentials the connection should use
`void`	`setGroupsToken(String groupsToken)` Sets the groups token the connection should use
`void`	`setGson(com.google.gson.Gson gson)` Sets the Gson instance used by the connection
`void`	`setMessageId(String messageId)` Sets the message id the connection should use
`SignalRFuture<Void>`	`start(ClientTransport transport)` Starts the connection
`void`	`stateChanged(StateChangedCallback handler)` Sets the handler for the "StateChanged" event
`void`	`stop()` Aborts the connection and closes it

- Method Detail
  - getUrl
```
String getUrl()
```
    Returns the URL used by the connection
    
    Returns:
    
    Url
  - getCredentials
```
Credentials getCredentials()
```
    Returns the credentials used by the connection
    
    Returns:
    
    Credentials
  - setCredentials
```
void setCredentials(Credentials credentials)
```
    Sets the credentials the connection should use
    
    Parameters:
    
    credentials - Credentials
  - setMessageId
```
void setMessageId(String messageId)
```
    Sets the message id the connection should use
    
    Parameters:
    
    messageId - Message Id
  - setGroupsToken
```
void setGroupsToken(String groupsToken)
```
    Sets the groups token the connection should use
    
    Parameters:
    
    groupsToken - Group Token
  - reconnecting
```
void reconnecting(Runnable handler)
```
    Sets the handler for the "Reconnecting" event
    
    Parameters:
    
    handler - Handler
  - reconnected
```
void reconnected(Runnable handler)
```
    Sets the handler for the "Reconnected" event
    
    Parameters:
    
    handler - Handler
  - connected
```
void connected(Runnable handler)
```
    Sets the handler for the "Connected" event
    
    Parameters:
    
    handler - Handler
  - error
```
void error(ErrorCallback handler)
```
    Sets the handler for the "Error" event
    
    Parameters:
    
    handler - Error Handler
  - stateChanged
```
void stateChanged(StateChangedCallback handler)
```
    Sets the handler for the "StateChanged" event
    
    Parameters:
    
    handler - State change handler
  - onError
```
void onError(Throwable error,
             boolean mustCleanCurrentConnection)
```
    Triggers the Error event
    
    Parameters:
    
    error - The error that triggered the event
    
    mustCleanCurrentConnection - True if the connection must be cleaned
  - received
```
void received(MessageReceivedHandler handler)
```
    Sets the handler for the "Received" event
    
    Parameters:
    
    handler - Message received handler
  - onReceived
```
void onReceived(com.google.gson.JsonElement message)
```
  - connectionSlow
```
void connectionSlow(Runnable handler)
```
    Sets the handler for the "ConnectionSlow" event
    
    Parameters:
    
    handler - Handler
  - closed
```
void closed(Runnable handler)
```
    Sets the handler for the "Closed" event
    
    Parameters:
    
    handler - Handler
  - getConnectionToken
```
String getConnectionToken()
```
    Returns the connection token
    
    Returns:
    
    String Connection token
  - getConnectionId
```
String getConnectionId()
```
    Returns the connection Id
    
    Returns:
    
    String Connection Id
  - getQueryString
```
String getQueryString()
```
    Returns the query string used by the connection
    
    Returns:
    
    String QueryString
  - getMessageId
```
String getMessageId()
```
    Returns the current message Id
    
    Returns:
    
    String Message Id
  - getGroupsToken
```
String getGroupsToken()
```
    Returns the connection groups token
    
    Returns:
    
    String Groups Token
  - getConnectionData
```
String getConnectionData()
```
    Returns the data used by the connection
    
    Returns:
    
    String Connection Data
  - getState
```
ConnectionState getState()
```
    Returns the connection state
    
    Returns:
    
    ConnectionState State
  - start
```
SignalRFuture<Void> start(ClientTransport transport)
```
    Starts the connection
    
    Parameters:
    
    transport - Transport to be used by the connection
    
    Returns:
    
    Future for the operation
  - stop
```
void stop()
```
    Aborts the connection and closes it
  - disconnect
```
void disconnect()
```
    Closes the connection
  - send
```
SignalRFuture<Void> send(String data)
```
    Sends data using the connection
    
    Parameters:
    
    data - Data to send
    
    Returns:
    
    Future for the operation
  - prepareRequest
```
void prepareRequest(Request request)
```
    Prepares a request that is going to be sent to the server
    
    Parameters:
    
    request - The request to prepare
  - getHeaders
```
Map<String,String> getHeaders()
```
    Returns the connection headers
    
    Returns:
    
    Map Headers
  - getGson
```
com.google.gson.Gson getGson()
```
    Returns the Gson instance used by the connection
    
    Returns:
    
    Gson instance
  - setGson
```
void setGson(com.google.gson.Gson gson)
```
    Sets the Gson instance used by the connection
    
    Parameters:
    
    gson - Gson instance
  - getJsonParser
```
com.google.gson.JsonParser getJsonParser()
```
    Returns the JsonParser used by the connection
    
    Returns:
    
    JsonParser Json parser
  - getLogger
```
Logger getLogger()
```
    Returns the Logger used by the connection
    
    Returns:
    
    Logger Logger
  - setClientCertificate
```
void setClientCertificate(String clientCertificatePath,
                          char[] clientCertificatePassword,
                          String clientCertificateAlias)
```
    Set the client certificate information
    
    Parameters:
    
    clientCertificatePath - client certificate path
    
    clientCertificatePassword - client certificate password
    
    clientCertificateAlias - client certificate alias

Interface ConnectionBase

Method Summary

Method Detail

getUrl

getCredentials

setCredentials

setMessageId

setGroupsToken

reconnecting

reconnected

connected

error

stateChanged

onError

received

onReceived

connectionSlow

closed

getConnectionToken

getConnectionId

getQueryString

getMessageId

getGroupsToken

getConnectionData

getState

start

stop

disconnect

send

prepareRequest

getHeaders

getGson

setGson

getJsonParser

getLogger

setClientCertificate