Class IntegrationConnectorConfig
- java.lang.Object
-
- org.odpi.openmetadata.adminservices.configuration.properties.AdminServicesConfigHeader
-
- org.odpi.openmetadata.adminservices.configuration.properties.IntegrationConnectorConfig
-
- All Implemented Interfaces:
java.io.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.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description IntegrationConnectorConfig()
Default constructor does nothing.IntegrationConnectorConfig(IntegrationConnectorConfig template)
Copy/clone constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object objectToCompare)
Validate that an object is equal depending on their stored values.Connection
getConnection()
Set up the connection for the integration connector.java.lang.String
getConnectorId()
Return the unique identifier of this connector.java.lang.String
getConnectorName()
Return the name of the connector.java.lang.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).java.lang.String
getMetadataSourceQualifiedName()
Return the qualified name of the metadata source for this integration connector.PermittedSynchronization
getPermittedSynchronization()
Return the permitted direction of metadata flow (see the enum definition for more details).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(java.lang.String connectorId)
Set up the unique identifier of this connector.void
setConnectorName(java.lang.String connectorName)
Set up the name of the connector.void
setConnectorUserId(java.lang.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(java.lang.String metadataSourceQualifiedName)
Set up the qualified name of the metadata source for this integration connector.void
setPermittedSynchronization(PermittedSynchronization permittedSynchronization)
Set up the permitted direction of metadata flow (see the enum definition for more details).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.java.lang.String
toString()
Standard toString method.
-
-
-
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 java.lang.String getConnectorId()
Return the unique identifier of this connector.- Returns:
- string guid
-
setConnectorId
public void setConnectorId(java.lang.String connectorId)
Set up the unique identifier of this connector.- Parameters:
connectorId
- string guid
-
getConnectorName
public java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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
-
getPermittedSynchronization
public PermittedSynchronization getPermittedSynchronization()
Return the permitted direction of metadata flow (see the enum definition for more details). Any attempt by the connector to send/receive metadata in a direction that is not permitted results in a UserNotAuthorizedException.- Returns:
- enum
-
setPermittedSynchronization
public void setPermittedSynchronization(PermittedSynchronization permittedSynchronization)
Set up the permitted direction of metadata flow (see the enum definition for more details). Any attempt by the connector to send/receive metadata in a direction that is not permitted results in a UserNotAuthorizedException.- Parameters:
permittedSynchronization
- enum
-
toString
public java.lang.String toString()
Standard toString method.- Overrides:
toString
in classjava.lang.Object
- Returns:
- JSON style description of variables.
-
equals
public boolean equals(java.lang.Object objectToCompare)
Validate that an object is equal depending on their stored values.- Overrides:
equals
in classjava.lang.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 classjava.lang.Object
- Returns:
- in hash code
-
-