org.odpi.openmetadata.adminservices.configuration.properties

Class IntegrationConnectorConfig

java.lang.Object

org.odpi.openmetadata.adminservices.configuration.properties.AdminServicesConfigHeader

org.odpi.openmetadata.adminservices.configuration.properties.IntegrationConnectorConfig

All Implemented Interfaces:

Serializable

public class IntegrationConnectorConfig
extends AdminServicesConfigHeader

IntegrationConnectorConfig provides the configuration properties used to create and manage an integration connector that exchanges metadata with a third party technology. The integration connectors can:

• Listen on a blocking call for the third party technology to send a notification.
• Register with an external notification service that sends notifications on its own thread.
• Register a listener with the OMAS client to act on notifications from the OMAS's Out Topic.
• Poll the third party technology each time that the refresh() method is called.

The configuration properties defines the connector to create and how it should be operated.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IntegrationConnectorConfig() Default constructor does nothing.
IntegrationConnectorConfig(IntegrationConnectorConfig template) Copy/clone constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Validate that an object is equal depending on their stored values.
Connection	getConnection() Set up the connection for the integration connector.
String	getConnectorId() Return the unique identifier of this connector.
String	getConnectorName() Return the name of the connector.
String	getConnectorUserId() Return the user id for the connector - if this is null, the integration daemon's userId is used on requests to the Open Metadata Access Service (OMAS).
String	getMetadataSourceQualifiedName() Return the qualified name of the metadata source for this integration connector.
long	getRefreshTimeInterval() Return the number of minutes between each call to the connector to refresh the metadata.
boolean	getUsesBlockingCalls() Return if the connector should be started in its own thread to allow it is block on a listening call.
int	hashCode() Return a hash code based on the values of this object.
void	setConnection(Connection connection) Set up the connection for the integration connector.
void	setConnectorId(String connectorId) Set up the unique identifier of this connector.
void	setConnectorName(String connectorName) Set up the name of the connector.
void	setConnectorUserId(String connectorUserId) Set up the user id for the connector - if this is null, the integration daemon's userId is used on requests to the Open Metadata Access Service (OMAS).
void	setMetadataSourceQualifiedName(String metadataSourceQualifiedName) Set up the qualified name of the metadata source for this integration connector.
void	setRefreshTimeInterval(long refreshTimeInterval) Set up the number of minutes between each call to the connector to refresh the metadata.
void	setUsesBlockingCalls(boolean usesBlockingCalls) Set up if the connector should be started in its own thread to allow it is block on a listening call.
String	toString() Standard toString method.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IntegrationConnectorConfig

public IntegrationConnectorConfig()

Default constructor does nothing.

IntegrationConnectorConfig

public IntegrationConnectorConfig(IntegrationConnectorConfig template)

Copy/clone constructor

Parameters:

template - object to copy

Method Detail

getConnectorId

public String getConnectorId()

Return the unique identifier of this connector.

Returns:

string guid

setConnectorId

public void setConnectorId(String connectorId)

Set up the unique identifier of this connector.

Parameters:

connectorId - string guid

getConnectorName

public String getConnectorName()

Return the name of the connector. This name is used for routing refresh calls to the connector as well as being used for diagnostics. Ideally it should be unique amongst the connectors for the integration service.

Returns:

String name

setConnectorName

public void setConnectorName(String connectorName)

Set up the name of the connector. This name is used for routing refresh calls to the connector as well as being used for diagnostics. Ideally it should be unique amongst the connectors for the integration service.

Parameters:

connectorName - String

getConnectorUserId

public String getConnectorUserId()

Return the user id for the connector - if this is null, the integration daemon's userId is used on requests to the Open Metadata Access Service (OMAS).

Returns:

string name

setConnectorUserId

public void setConnectorUserId(String connectorUserId)

Set up the user id for the connector - if this is null, the integration daemon's userId is used on requests to the Open Metadata Access Service (OMAS).

Parameters:

connectorUserId - string name

getConnection

public Connection getConnection()

Set up the connection for the integration connector.

Returns:

Connection object

setConnection

public void setConnection(Connection connection)

Set up the connection for the integration connector.

Parameters:

connection - Connection object

getMetadataSourceQualifiedName

public String getMetadataSourceQualifiedName()

Return the qualified name of the metadata source for this integration connector. This is the qualified name of an appropriate software server capability stored in open metadata. This software server capability is accessed via the partner OMAS.

Returns:

string name

setMetadataSourceQualifiedName

public void setMetadataSourceQualifiedName(String metadataSourceQualifiedName)

Set up the qualified name of the metadata source for this integration connector. This is the qualified name of an appropriate software server capability stored in open metadata. This software server capability is accessed via the partner OMAS.

Parameters:

metadataSourceQualifiedName - string name

getRefreshTimeInterval

public long getRefreshTimeInterval()

Return the number of minutes between each call to the connector to refresh the metadata. Zero means that refresh is only called at server start up and whenever the refresh REST API request is made to the integration daemon. If the refresh time interval is greater than 0 then additional calls to refresh are added spaced out by the refresh time interval.

Returns:

minute count

setRefreshTimeInterval

public void setRefreshTimeInterval(long refreshTimeInterval)

Set up the number of minutes between each call to the connector to refresh the metadata. Zero means that refresh is only called at server start up and whenever the refresh REST API request is made to the integration daemon. If the refresh time interval is greater than 0 then additional calls to refresh are added spaced out by the refresh time interval.

Parameters:

refreshTimeInterval - minute count

getUsesBlockingCalls

public boolean getUsesBlockingCalls()

Return if the connector should be started in its own thread to allow it is block on a listening call.

Returns:

boolean flag

setUsesBlockingCalls

public void setUsesBlockingCalls(boolean usesBlockingCalls)

Set up if the connector should be started in its own thread to allow it is block on a listening call.

Parameters:

usesBlockingCalls - boolean flag

toString

public String toString()

Standard toString method.

Overrides:

toString in class Object

Returns:

JSON style description of variables.

equals

public boolean equals(Object objectToCompare)

Validate that an object is equal depending on their stored values.

Overrides:

equals in class Object

Parameters:

objectToCompare - object

Returns:

boolean result

hashCode

public int hashCode()

Return a hash code based on the values of this object.

Overrides:

hashCode in class Object

Returns:

in hash code