ConnectionEvent (Etherios Cloud Connector for Java ME)

java.lang.Object
- com.etherios.connector.core.events.Event
- - com.etherios.connector.core.events.ConnectionEvent

Direct Known Subclasses:

ConnectionEvent.ConnectedEvent, ConnectionEvent.ConnectionErrorEvent, ConnectionEvent.DisconnectedEvent, ConnectionEvent.StartingConnectionEvent
```
public abstract class ConnectionEvent
extends Event
```
Basic Connection Event class containing common information and functionality for the different connection event types.

See Also:

EventsListener

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ConnectionEvent.ConnectedEvent` Specific connection event indicating connection has been established.
`static class`	`ConnectionEvent.ConnectionErrorEvent` Specific connection event indicating a connection error.
`static class`	`ConnectionEvent.DisconnectedEvent` Specific connection event indicating connection has been disconnected.
`static class`	`ConnectionEvent.StartingConnectionEvent` Specific connection event indicating connection has been started.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CONNECTION_CONNECTED` Cloud Connector connection has established event.
`static int`	`CONNECTION_DISCONNECTED` Cloud Connector disconnected event.
`static int`	`CONNECTION_ERROR` Event indicating that there was an error with Device Cloud connection.
`static int`	`CONNECTION_STARTING` Cloud Connector connection is starting event.
`static int`	`ERROR_BAD_VERSION` Error: Cloud Connector version is bad.
`static int`	`ERROR_BAD_VERSION_COM` Error: Cloud Connector communication version is bad.
`static int`	`ERROR_CANNOT_RESOLVE_HOST` Error: Device Cloud host could not be resolved.
`static int`	`ERROR_CONNECTION_LOST` Error: Connection with Device Cloud lost.
`static int`	`ERROR_DESCRIPTOR_ERROR` Error: Device descriptor could not be generated.
`static int`	`ERROR_DEVICE_ID_NOT_RECEIVED` Error: Device ID not received from provisioning.
`static int`	`ERROR_INTERNET_NOT_AVAILABLE` Error: Internet connectivity not available.
`static int`	`ERROR_INVALID_AUTHORIZATION_TYPE` Error: Invalid authorization type.
`static int`	`ERROR_INVALID_BASIC_PASSWORD` Error: Invalid Basic authentication password.
`static int`	`ERROR_INVALID_DEVICE_TYPE` Error: Invalid Device type.
`static int`	`ERROR_INVALID_VENDOR_ID` Error: Vendor ID is not valid.
`static int`	`ERROR_NO_CONNECTION` Error: There is not an active Device Cloud connection.
`static int`	`ERROR_NO_ERROR` Error: Unknown.
`static int`	`ERROR_SECURITY_FAILURE` Error: There was a security failure trying to connect.
`static int`	`ERROR_SERVER_OVERLOAD` Error: Cloud connector server is overloaded.
`static int`	`ERROR_SERVER_UNAVAILABLE` Error: Device Cloud server is unavailable.
`static int`	`ERROR_UNABLE_TO_CONNECT` Error: Unable to connect to Device Cloud.
`static int`	`ERROR_WRONG_ID` Error: Device ID is wrong.

Fields inherited from class com.etherios.connector.core.events.Event
SEVERITY_DEBUG, SEVERITY_ERROR, SEVERITY_INFO, TAG_DEBUG, TAG_ERROR, TAG_INFO, TYPE_CONNECTION, TYPE_DATA_POINT, TYPE_DATA_PUSH, TYPE_DEVICE_REQUEST, TYPE_FILE_SYSTEM, TYPE_FIRMWARE, TYPE_RCI

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getConnectionEventType()` Retrieves the connection event type.
`java.lang.String`	`getEventTypeTag()` Retrieves the event type tag to be logged.
`static ConnectionEvent`	`newConnectedEvent()` Creates a new connected event.
`static ConnectionEvent`	`newConnectionErrorEvent(int errorType)` Creates a new connection error event.
`static ConnectionEvent`	`newDisconnectedEvent()` Creates a new disconnected event.
`static ConnectionEvent`	`newStartingConnectionEvent()` Creates a new starting connection event.
`java.lang.String`	`toString()`

Methods inherited from class com.etherios.connector.core.events.Event
getEventLogString, getEventSeverity, getEventType, setSeverity

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

- Field Detail
  - CONNECTION_CONNECTED
```
public static final int CONNECTION_CONNECTED
```
    Cloud Connector connection has established event.
    
    See Also:
    
    Constant Field Values
  - CONNECTION_DISCONNECTED
```
public static final int CONNECTION_DISCONNECTED
```
    Cloud Connector disconnected event.
    
    See Also:
    
    Constant Field Values
  - CONNECTION_ERROR
```
public static final int CONNECTION_ERROR
```
    Event indicating that there was an error with Device Cloud connection.
    
    See Also:
    
    Constant Field Values
  - CONNECTION_STARTING
```
public static final int CONNECTION_STARTING
```
    Cloud Connector connection is starting event.
    
    See Also:
    
    Constant Field Values
  - ERROR_BAD_VERSION
```
public static final int ERROR_BAD_VERSION
```
    Error: Cloud Connector version is bad.
    
    See Also:
    
    Constant Field Values
  - ERROR_BAD_VERSION_COM
```
public static final int ERROR_BAD_VERSION_COM
```
    Error: Cloud Connector communication version is bad.
    
    See Also:
    
    Constant Field Values
  - ERROR_CANNOT_RESOLVE_HOST
```
public static final int ERROR_CANNOT_RESOLVE_HOST
```
    Error: Device Cloud host could not be resolved.
    
    See Also:
    
    Constant Field Values
  - ERROR_CONNECTION_LOST
```
public static final int ERROR_CONNECTION_LOST
```
    Error: Connection with Device Cloud lost.
    
    See Also:
    
    Constant Field Values
  - ERROR_DESCRIPTOR_ERROR
```
public static final int ERROR_DESCRIPTOR_ERROR
```
    Error: Device descriptor could not be generated.
    
    See Also:
    
    Constant Field Values
  - ERROR_DEVICE_ID_NOT_RECEIVED
```
public static final int ERROR_DEVICE_ID_NOT_RECEIVED
```
    Error: Device ID not received from provisioning.
    
    See Also:
    
    Constant Field Values
  - ERROR_INTERNET_NOT_AVAILABLE
```
public static final int ERROR_INTERNET_NOT_AVAILABLE
```
    Error: Internet connectivity not available.
    
    See Also:
    
    Constant Field Values
  - ERROR_INVALID_AUTHORIZATION_TYPE
```
public static final int ERROR_INVALID_AUTHORIZATION_TYPE
```
    Error: Invalid authorization type.
    
    See Also:
    
    Constant Field Values
  - ERROR_INVALID_BASIC_PASSWORD
```
public static final int ERROR_INVALID_BASIC_PASSWORD
```
    Error: Invalid Basic authentication password.
    
    See Also:
    
    Constant Field Values
  - ERROR_INVALID_DEVICE_TYPE
```
public static final int ERROR_INVALID_DEVICE_TYPE
```
    Error: Invalid Device type.
    
    See Also:
    
    Constant Field Values
  - ERROR_INVALID_VENDOR_ID
```
public static final int ERROR_INVALID_VENDOR_ID
```
    Error: Vendor ID is not valid.
    
    See Also:
    
    Constant Field Values
  - ERROR_NO_CONNECTION
```
public static final int ERROR_NO_CONNECTION
```
    Error: There is not an active Device Cloud connection.
    
    See Also:
    
    Constant Field Values
  - ERROR_NO_ERROR
```
public static final int ERROR_NO_ERROR
```
    Error: Unknown.
    
    See Also:
    
    Constant Field Values
  - ERROR_SECURITY_FAILURE
```
public static final int ERROR_SECURITY_FAILURE
```
    Error: There was a security failure trying to connect.
    
    See Also:
    
    Constant Field Values
  - ERROR_SERVER_OVERLOAD
```
public static final int ERROR_SERVER_OVERLOAD
```
    Error: Cloud connector server is overloaded.
    
    See Also:
    
    Constant Field Values
  - ERROR_SERVER_UNAVAILABLE
```
public static final int ERROR_SERVER_UNAVAILABLE
```
    Error: Device Cloud server is unavailable.
    
    See Also:
    
    Constant Field Values
  - ERROR_UNABLE_TO_CONNECT
```
public static final int ERROR_UNABLE_TO_CONNECT
```
    Error: Unable to connect to Device Cloud.
    
    See Also:
    
    Constant Field Values
  - ERROR_WRONG_ID
```
public static final int ERROR_WRONG_ID
```
    Error: Device ID is wrong.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getConnectionEventType
```
public int getConnectionEventType()
```
    Retrieves the connection event type.
    
    Returns:
    
    Connection event type.
    
    See Also:
    
    CONNECTION_STARTING, CONNECTION_CONNECTED, CONNECTION_DISCONNECTED, CONNECTION_ERROR
  - getEventTypeTag
```
public java.lang.String getEventTypeTag()
```
    Description copied from class: Event
    
    Retrieves the event type tag to be logged.
    
    Specified by:
    
    getEventTypeTag in class Event
    
    Returns:
    
    The event type tag to be logged.
  - newConnectedEvent
```
public static ConnectionEvent newConnectedEvent()
```
    Creates a new connected event.
    
    Returns:
    
    Connected event.
  - newConnectionErrorEvent
```
public static ConnectionEvent newConnectionErrorEvent(int errorType)
```
    Creates a new connection error event.
    
    Parameters:
    
    errorType - Connection error type.
    
    Returns:
    
    Connection error event.
  - newDisconnectedEvent
```
public static ConnectionEvent newDisconnectedEvent()
```
    Creates a new disconnected event.
    
    Returns:
    
    Disconnected event.
  - newStartingConnectionEvent
```
public static ConnectionEvent newStartingConnectionEvent()
```
    Creates a new starting connection event.
    
    Returns:
    
    Starting connection event.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class Event

Class ConnectionEvent

Nested Class Summary

Field Summary

Fields inherited from class com.etherios.connector.core.events.Event

Method Summary

Methods inherited from class com.etherios.connector.core.events.Event

Methods inherited from class java.lang.Object

Field Detail

CONNECTION_CONNECTED

CONNECTION_DISCONNECTED

CONNECTION_ERROR

CONNECTION_STARTING

ERROR_BAD_VERSION

ERROR_BAD_VERSION_COM

ERROR_CANNOT_RESOLVE_HOST

ERROR_CONNECTION_LOST

ERROR_DESCRIPTOR_ERROR

ERROR_DEVICE_ID_NOT_RECEIVED

ERROR_INTERNET_NOT_AVAILABLE

ERROR_INVALID_AUTHORIZATION_TYPE

ERROR_INVALID_BASIC_PASSWORD

ERROR_INVALID_DEVICE_TYPE

ERROR_INVALID_VENDOR_ID

ERROR_NO_CONNECTION

ERROR_NO_ERROR

ERROR_SECURITY_FAILURE

ERROR_SERVER_OVERLOAD

ERROR_SERVER_UNAVAILABLE

ERROR_UNABLE_TO_CONNECT

ERROR_WRONG_ID

Method Detail

getConnectionEventType

getEventTypeTag

newConnectedEvent

newConnectionErrorEvent

newDisconnectedEvent

newStartingConnectionEvent

toString