Connection (safeguardjava 2.10.0 API)

java.lang.Object
- microsoft.aspnet.signalr.client.Connection

All Implemented Interfaces:

ConnectionBase

Direct Known Subclasses:

HubConnection
```
public class Connection
extends Object
implements ConnectionBase
```
Represents a basic SingalR connection

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.google.gson.Gson`	`mGson`
`protected com.google.gson.JsonParser`	`mJsonParser`
`protected ConnectionState`	`mState`
`static Version`	`PROTOCOL_VERSION`

Constructor Summary

Constructors
Constructor and Description
`Connection(String url)` Initializes the connection with an URL
`Connection(String url, Logger logger)` Initializes the connection with an URL and a logger
`Connection(String url, String queryString)` Initializes the connection with an URL and a query string
`Connection(String url, String queryString, Logger logger)` Initializes the connection with an URL, a query string and a Logger

Method Summary

All Methods Instance Methods Concrete 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
`protected String`	`getSourceNameForLog()`
`ConnectionState`	`getState()` Returns the connection state
`String`	`getUrl()` Returns the URL used by the connection
`protected void`	`log(String message, LogLevel level)`
`protected void`	`log(Throwable error)`
`protected void`	`onClosed()` Triggers the Closed event
`protected void`	`onConnected()` Triggers the Connected event
`void`	`onError(Throwable error, boolean mustCleanCurrentConnection)` Triggers the Error event
`void`	`onReceived(com.google.gson.JsonElement message)`
`protected void`	`onReconnected()` Triggers the Reconnected event
`protected void`	`onReconnecting()` Triggers the Reconnecting event
`void`	`prepareRequest(Request request)` Prepares a request that is going to be sent to the server
`protected com.google.gson.JsonElement`	`processMessage(com.google.gson.JsonElement message)` Processes a received message
`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(Object object)` Sends a serialized object
`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(boolean ignoreSsl)` Starts the connection using the best available transport
`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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PROTOCOL_VERSION
```
public static final Version PROTOCOL_VERSION
```
  - mState
```
protected ConnectionState mState
```
  - mJsonParser
```
protected com.google.gson.JsonParser mJsonParser
```
  - mGson
```
protected com.google.gson.Gson mGson
```
- Constructor Detail
  - Connection
```
public Connection(String url)
```
    Initializes the connection with an URL
    
    Parameters:
    
    url - The connection URL
  - Connection
```
public Connection(String url,
                  String queryString)
```
    Initializes the connection with an URL and a query string
    
    Parameters:
    
    url - The connection URL
    
    queryString - The connection query string
  - Connection
```
public Connection(String url,
                  Logger logger)
```
    Initializes the connection with an URL and a logger
    
    Parameters:
    
    url - The connection URL
    
    logger - The connection logger
  - Connection
```
public Connection(String url,
                  String queryString,
                  Logger logger)
```
    Initializes the connection with an URL, a query string and a Logger
    
    Parameters:
    
    url - The connection URL
    
    queryString - The connection query string
    
    logger - The connection logger
- Method Detail
  - getLogger
```
public Logger getLogger()
```
    Description copied from interface: ConnectionBase
    
    Returns the Logger used by the connection
    
    Specified by:
    
    getLogger in interface ConnectionBase
    
    Returns:
    
    Logger Logger
  - getState
```
public ConnectionState getState()
```
    Description copied from interface: ConnectionBase
    
    Returns the connection state
    
    Specified by:
    
    getState in interface ConnectionBase
    
    Returns:
    
    ConnectionState State
  - getUrl
```
public String getUrl()
```
    Description copied from interface: ConnectionBase
    
    Returns the URL used by the connection
    
    Specified by:
    
    getUrl in interface ConnectionBase
    
    Returns:
    
    Url
  - getConnectionToken
```
public String getConnectionToken()
```
    Description copied from interface: ConnectionBase
    
    Returns the connection token
    
    Specified by:
    
    getConnectionToken in interface ConnectionBase
    
    Returns:
    
    String Connection token
  - getConnectionId
```
public String getConnectionId()
```
    Description copied from interface: ConnectionBase
    
    Returns the connection Id
    
    Specified by:
    
    getConnectionId in interface ConnectionBase
    
    Returns:
    
    String Connection Id
  - getQueryString
```
public String getQueryString()
```
    Description copied from interface: ConnectionBase
    
    Returns the query string used by the connection
    
    Specified by:
    
    getQueryString in interface ConnectionBase
    
    Returns:
    
    String QueryString
  - getMessageId
```
public String getMessageId()
```
    Description copied from interface: ConnectionBase
    
    Returns the current message Id
    
    Specified by:
    
    getMessageId in interface ConnectionBase
    
    Returns:
    
    String Message Id
  - setMessageId
```
public void setMessageId(String messageId)
```
    Description copied from interface: ConnectionBase
    
    Sets the message id the connection should use
    
    Specified by:
    
    setMessageId in interface ConnectionBase
    
    Parameters:
    
    messageId - Message Id
  - getGroupsToken
```
public String getGroupsToken()
```
    Description copied from interface: ConnectionBase
    
    Returns the connection groups token
    
    Specified by:
    
    getGroupsToken in interface ConnectionBase
    
    Returns:
    
    String Groups Token
  - setGroupsToken
```
public void setGroupsToken(String groupsToken)
```
    Description copied from interface: ConnectionBase
    
    Sets the groups token the connection should use
    
    Specified by:
    
    setGroupsToken in interface ConnectionBase
    
    Parameters:
    
    groupsToken - Group Token
  - getHeaders
```
public Map<String,String> getHeaders()
```
    Description copied from interface: ConnectionBase
    
    Returns the connection headers
    
    Specified by:
    
    getHeaders in interface ConnectionBase
    
    Returns:
    
    Map Headers
  - reconnecting
```
public void reconnecting(Runnable handler)
```
    Description copied from interface: ConnectionBase
    
    Sets the handler for the "Reconnecting" event
    
    Specified by:
    
    reconnecting in interface ConnectionBase
    
    Parameters:
    
    handler - Handler
  - reconnected
```
public void reconnected(Runnable handler)
```
    Description copied from interface: ConnectionBase
    
    Sets the handler for the "Reconnected" event
    
    Specified by:
    
    reconnected in interface ConnectionBase
    
    Parameters:
    
    handler - Handler
  - connected
```
public void connected(Runnable handler)
```
    Description copied from interface: ConnectionBase
    
    Sets the handler for the "Connected" event
    
    Specified by:
    
    connected in interface ConnectionBase
    
    Parameters:
    
    handler - Handler
  - error
```
public void error(ErrorCallback handler)
```
    Description copied from interface: ConnectionBase
    
    Sets the handler for the "Error" event
    
    Specified by:
    
    error in interface ConnectionBase
    
    Parameters:
    
    handler - Error Handler
  - received
```
public void received(MessageReceivedHandler handler)
```
    Description copied from interface: ConnectionBase
    
    Sets the handler for the "Received" event
    
    Specified by:
    
    received in interface ConnectionBase
    
    Parameters:
    
    handler - Message received handler
  - connectionSlow
```
public void connectionSlow(Runnable handler)
```
    Description copied from interface: ConnectionBase
    
    Sets the handler for the "ConnectionSlow" event
    
    Specified by:
    
    connectionSlow in interface ConnectionBase
    
    Parameters:
    
    handler - Handler
  - closed
```
public void closed(Runnable handler)
```
    Description copied from interface: ConnectionBase
    
    Sets the handler for the "Closed" event
    
    Specified by:
    
    closed in interface ConnectionBase
    
    Parameters:
    
    handler - Handler
  - stateChanged
```
public void stateChanged(StateChangedCallback handler)
```
    Description copied from interface: ConnectionBase
    
    Sets the handler for the "StateChanged" event
    
    Specified by:
    
    stateChanged in interface ConnectionBase
    
    Parameters:
    
    handler - State change handler
  - setClientCertificate
```
public void setClientCertificate(String clientCertificatePath,
                                 char[] clientCertificatePassword,
                                 String clientCertificateAlias)
```
    Description copied from interface: ConnectionBase
    
    Set the client certificate information
    
    Specified by:
    
    setClientCertificate in interface ConnectionBase
    
    Parameters:
    
    clientCertificatePath - client certificate path
    
    clientCertificatePassword - client certificate password
    
    clientCertificateAlias - client certificate alias
  - start
```
public SignalRFuture<Void> start(boolean ignoreSsl)
```
    Starts the connection using the best available transport
    
    Parameters:
    
    ignoreSsl - Ignore SSL certificate verification
    
    Returns:
    
    A Future for the operation
  - send
```
public SignalRFuture<Void> send(Object object)
```
    Sends a serialized object
    
    Parameters:
    
    object - The object to send. If the object is a JsonElement, its string representation is sent. Otherwise, the object is serialized to Json.
    
    Returns:
    
    A Future for the operation
  - send
```
public SignalRFuture<Void> send(String data)
```
    Description copied from interface: ConnectionBase
    
    Sends data using the connection
    
    Specified by:
    
    send in interface ConnectionBase
    
    Parameters:
    
    data - Data to send
    
    Returns:
    
    Future for the operation
  - start
```
public SignalRFuture<Void> start(ClientTransport transport)
```
    Description copied from interface: ConnectionBase
    
    Starts the connection
    
    Specified by:
    
    start in interface ConnectionBase
    
    Parameters:
    
    transport - Transport to be used by the connection
    
    Returns:
    
    Future for the operation
  - getCredentials
```
public Credentials getCredentials()
```
    Description copied from interface: ConnectionBase
    
    Returns the credentials used by the connection
    
    Specified by:
    
    getCredentials in interface ConnectionBase
    
    Returns:
    
    Credentials
  - setCredentials
```
public void setCredentials(Credentials credentials)
```
    Description copied from interface: ConnectionBase
    
    Sets the credentials the connection should use
    
    Specified by:
    
    setCredentials in interface ConnectionBase
    
    Parameters:
    
    credentials - Credentials
  - prepareRequest
```
public void prepareRequest(Request request)
```
    Description copied from interface: ConnectionBase
    
    Prepares a request that is going to be sent to the server
    
    Specified by:
    
    prepareRequest in interface ConnectionBase
    
    Parameters:
    
    request - The request to prepare
  - getConnectionData
```
public String getConnectionData()
```
    Description copied from interface: ConnectionBase
    
    Returns the data used by the connection
    
    Specified by:
    
    getConnectionData in interface ConnectionBase
    
    Returns:
    
    String Connection Data
  - stop
```
public void stop()
```
    Description copied from interface: ConnectionBase
    
    Aborts the connection and closes it
    
    Specified by:
    
    stop in interface ConnectionBase
  - disconnect
```
public void disconnect()
```
    Description copied from interface: ConnectionBase
    
    Closes the connection
    
    Specified by:
    
    disconnect in interface ConnectionBase
  - getGson
```
public com.google.gson.Gson getGson()
```
    Description copied from interface: ConnectionBase
    
    Returns the Gson instance used by the connection
    
    Specified by:
    
    getGson in interface ConnectionBase
    
    Returns:
    
    Gson instance
  - setGson
```
public void setGson(com.google.gson.Gson gson)
```
    Description copied from interface: ConnectionBase
    
    Sets the Gson instance used by the connection
    
    Specified by:
    
    setGson in interface ConnectionBase
    
    Parameters:
    
    gson - Gson instance
  - getJsonParser
```
public com.google.gson.JsonParser getJsonParser()
```
    Description copied from interface: ConnectionBase
    
    Returns the JsonParser used by the connection
    
    Specified by:
    
    getJsonParser in interface ConnectionBase
    
    Returns:
    
    JsonParser Json parser
  - onReconnecting
```
protected void onReconnecting()
```
    Triggers the Reconnecting event
  - onReconnected
```
protected void onReconnected()
```
    Triggers the Reconnected event
  - onConnected
```
protected void onConnected()
```
    Triggers the Connected event
  - processMessage
```
protected com.google.gson.JsonElement processMessage(com.google.gson.JsonElement message)
                                              throws Exception
```
    Processes a received message
    
    Parameters:
    
    message - The message to process
    
    Returns:
    
    The processed message
    
    Throws:
    
    Exception - An exception could be thrown if there an error while processing the message
  - onError
```
public void onError(Throwable error,
                    boolean mustCleanCurrentConnection)
```
    Description copied from interface: ConnectionBase
    
    Triggers the Error event
    
    Specified by:
    
    onError in interface ConnectionBase
    
    Parameters:
    
    error - The error that triggered the event
    
    mustCleanCurrentConnection - True if the connection must be cleaned
  - onClosed
```
protected void onClosed()
```
    Triggers the Closed event
  - log
```
protected void log(String message,
                   LogLevel level)
```
  - log
```
protected void log(Throwable error)
```
  - getSourceNameForLog
```
protected String getSourceNameForLog()
```
  - onReceived
```
public void onReceived(com.google.gson.JsonElement message)
```
    Specified by:
    
    onReceived in interface ConnectionBase

Class Connection

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROTOCOL_VERSION

mState

mJsonParser

mGson

Constructor Detail

Connection

Connection

Connection

Connection

Method Detail

getLogger

getState

getUrl

getConnectionToken

getConnectionId

getQueryString

getMessageId

setMessageId

getGroupsToken

setGroupsToken

getHeaders

reconnecting

reconnected

connected

error

received

connectionSlow

closed

stateChanged

setClientCertificate

start

send

send

start

getCredentials

setCredentials

prepareRequest

getConnectionData

stop

disconnect

getGson

setGson

getJsonParser

onReconnecting

onReconnected

onConnected

processMessage

onError

onClosed

log

log

getSourceNameForLog

onReceived