com.cisco.thunderhead.connector

Interface Connector

All Superinterfaces:

Plugin

All Known Subinterfaces:

ContextServiceClient, ManagementConnector

public interface Connector
extends Plugin

The interface for all Connectors. This interface requires all connectors to be initialized with a set of credentials. These credentials are later used to access oAuth-protected APIs.

Method Summary

Modifier and Type	Method and Description
void	addStateListener(ConnectorStateListener listener) Listen for state change events from the connector.
void	destroy() Destroys and cleanups connector threads and tokens.
String	getStatus() Returns a summary of the the current state of the connector.
String	getVersion() Gets version.
ApiException	handleException(Throwable t) Used by ConnectorProxyInvocationHandler in order to map exceptions thrown by connector implementation classes into exceptions as exposed by the published SDK.
void	init(String encryptedCredentials, ConnectorInfo connectorInfo) Initializes the connector with a set of credentials and configuration data.
void	init(String encryptedCredentials, ConnectorInfo connectorInfo, ConnectorConfiguration connectionConfig) Initializes the connector with a set of credentials, connector information and configuration data.
void	removeStateListener(ConnectorStateListener listener) Stop listening for state change events
void	updateAndReloadConfigAsync(String connectionDataString, ConnectorInfo connectorInfo, ConnectorConfiguration connectionConfig, ReloadListener reloadListener) Update and reload the configuration.
void	updateAndReloadConfigSync(String connectionDataString, ConnectorInfo connectorInfo, ConnectorConfiguration connectionConfig) Update and reload the configuration.

Method Detail

init

void init(String encryptedCredentials,
          ConnectorInfo connectorInfo)

Initializes the connector with a set of credentials and configuration data. ConnectorIsNotRegisteredExceptionRest is thrown in cases where the connector does not have credentials or cannot create access tokens. RestApiException is thrown for all other exceptions.

Parameters:

encryptedCredentials - the encrypted credentials

connectorInfo - the connector info

init

void init(String encryptedCredentials,
          ConnectorInfo connectorInfo,
          ConnectorConfiguration connectionConfig)

Initializes the connector with a set of credentials, connector information and configuration data. ConnectorIsNotRegisteredExceptionRest is thrown in cases where the connector does not have credentials or cannot create access tokens. RestApiException is thrown for all other exceptions.

Parameters:

encryptedCredentials - a JSON string containing connection data

connectorInfo - used to describe the state of the connector. This state will be used by the Atlas dashboard to display the state of this connector.

connectionConfig - configure how connections are made to the context service including retries and time outs

updateAndReloadConfigAsync

void updateAndReloadConfigAsync(String connectionDataString,
                                ConnectorInfo connectorInfo,
                                ConnectorConfiguration connectionConfig,
                                ReloadListener reloadListener)

Update and reload the configuration. The reload occurs asynchronously and will be swapped in once the new connector has been fully initialized (similar to a no downtime upgrade).

Parameters:

connectionDataString - connection data

connectorInfo - connector

connectionConfig - configuration parameters

reloadListener - listener that will receive a notification when the reload attempt completes (successfully or not). set to null if no callback is desired

updateAndReloadConfigSync

void updateAndReloadConfigSync(String connectionDataString,
                               ConnectorInfo connectorInfo,
                               ConnectorConfiguration connectionConfig)

Update and reload the configuration. The reload occurs synchronously. As such, this call could take a long time to return, and could timeout. The reload will be swapped in once the new connector has been fully initialized.

Parameters:

connectionDataString - connection data

connectorInfo - connector

connectionConfig - configuration parameters

destroy

void destroy()

Destroys and cleanups connector threads and tokens.

addStateListener

void addStateListener(ConnectorStateListener listener)

Listen for state change events from the connector.

Parameters:

listener - callback for state change events

See Also:

ConnectorState

removeStateListener

void removeStateListener(ConnectorStateListener listener)

Stop listening for state change events

Parameters:

listener - the listener to remove

getVersion

String getVersion()

Gets version.

Returns:

returns the version of the connector

handleException

ApiException handleException(Throwable t)

Used by ConnectorProxyInvocationHandler in order to map exceptions thrown by connector implementation classes into exceptions as exposed by the published SDK.

Parameters:

t - Exception thrown by the connector implementation

Returns:

Exception that should be visible to the client of the SDK

getStatus

String getStatus()

Returns a summary of the the current state of the connector.

Returns:

connector status summary