Class IntegrationServiceConfig
- java.lang.Object
-
- org.odpi.openmetadata.adminservices.configuration.properties.AdminServicesConfigHeader
-
- org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerClientConfig
-
- org.odpi.openmetadata.adminservices.configuration.properties.IntegrationServiceConfig
-
- All Implemented Interfaces:
java.io.Serializable
public class IntegrationServiceConfig extends OMAGServerClientConfig
IntegrationServiceConfig provides the configuration for a single Open Metadata Integration Service (OMIS). It extends OMAGServerClientConfig which defines the platform url root and name of the server that hosts the access service used by the integration service.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description IntegrationServiceConfig()
Default constructor for use with Jackson librariesIntegrationServiceConfig(IntegrationServiceConfig 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.PermittedSynchronization
getDefaultPermittedSynchronization()
Return the default value for permitted synchronization that should be set up for the integration connectors as they are configured.java.util.List<IntegrationConnectorConfig>
getIntegrationConnectorConfigs()
Return the OCF Connection for the topic used to pass requests to this integration service.java.lang.String
getIntegrationServiceContextManagerClass()
Return the Java class name of the admin-services interface for this integration service.java.lang.String
getIntegrationServiceDescription()
Return the short description of the integration service.ComponentDevelopmentStatus
getIntegrationServiceDevelopmentStatus()
Return the development status of the service.java.lang.String
getIntegrationServiceFullName()
Return the full name of the integration service.int
getIntegrationServiceId()
Return the code number (ordinal) for this integration service.java.lang.String
getIntegrationServiceName()
Return the name of the integration service.ServiceOperationalStatus
getIntegrationServiceOperationalStatus()
Return the status of this integration service.java.util.Map<java.lang.String,java.lang.Object>
getIntegrationServiceOptions()
Return the options for this integration service.java.lang.String
getIntegrationServicePartnerOMAS()
Return the full name of the Open Metadata Access Service (OMAS) that this integration service is partnered with.java.lang.String
getIntegrationServiceURLMarker()
Return the string that appears in the REST API URL that identifies the owning service.java.lang.String
getIntegrationServiceWiki()
Return the wiki page link for the integration service.int
hashCode()
Return a hash code based on the values of this object.void
setDefaultPermittedSynchronization(PermittedSynchronization defaultPermittedSynchronization)
Set up the default value for permitted synchronization that should be set up for the integration connectors as they are configured.void
setIntegrationConnectorConfigs(java.util.List<IntegrationConnectorConfig> integrationConnectorConfigs)
Set up the OCF Connection for the topic used to pass requests to this integration service.void
setIntegrationServiceContextManagerClass(java.lang.String integrationServiceContextManagerClass)
Set up the Java class name of the admin services interface for this integration service.void
setIntegrationServiceDescription(java.lang.String integrationServiceDescription)
Set up the short description of the integration service.void
setIntegrationServiceDevelopmentStatus(ComponentDevelopmentStatus integrationServiceDevelopmentStatus)
Set up the development status of the service.void
setIntegrationServiceFullName(java.lang.String integrationServiceFullName)
Set up the full name of the integration service.void
setIntegrationServiceId(int integrationServiceId)
Set up the code number (ordinal) for this integration service.void
setIntegrationServiceName(java.lang.String integrationServiceName)
Set up the name of the integration service.void
setIntegrationServiceOperationalStatus(ServiceOperationalStatus integrationServiceOperationalStatus)
Set up the status of the integration service.void
setIntegrationServiceOptions(java.util.Map<java.lang.String,java.lang.Object> integrationServiceOptions)
Set up the options for this integration service.void
setIntegrationServicePartnerOMAS(java.lang.String integrationServicePartnerOMAS)
Set up the full name of the Open Metadata Access Service (OMAS) that this integration service is partnered with.void
setIntegrationServiceURLMarker(java.lang.String integrationServiceURLMarker)
Set up the string that appears in the REST API URL that identifies the owning service.void
setIntegrationServiceWiki(java.lang.String integrationServiceWiki)
Set up the wiki page link for the integration service.java.lang.String
toString()
Standard toString method.-
Methods inherited from class org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerClientConfig
getOMAGServerName, getOMAGServerPlatformRootURL, setOMAGServerName, setOMAGServerPlatformRootURL
-
-
-
-
Constructor Detail
-
IntegrationServiceConfig
public IntegrationServiceConfig()
Default constructor for use with Jackson libraries
-
IntegrationServiceConfig
public IntegrationServiceConfig(IntegrationServiceConfig template)
Copy/clone constructor- Parameters:
template
- object to copy
-
-
Method Detail
-
getIntegrationServiceId
public int getIntegrationServiceId()
Return the code number (ordinal) for this integration service.- Returns:
- int ordinal
-
setIntegrationServiceId
public void setIntegrationServiceId(int integrationServiceId)
Set up the code number (ordinal) for this integration service.- Parameters:
integrationServiceId
- int ordinal
-
getIntegrationServiceDevelopmentStatus
public ComponentDevelopmentStatus getIntegrationServiceDevelopmentStatus()
Return the development status of the service.- Returns:
- enum describing the status
-
setIntegrationServiceDevelopmentStatus
public void setIntegrationServiceDevelopmentStatus(ComponentDevelopmentStatus integrationServiceDevelopmentStatus)
Set up the development status of the service.- Parameters:
integrationServiceDevelopmentStatus
- enum describing the status
-
getIntegrationServiceContextManagerClass
public java.lang.String getIntegrationServiceContextManagerClass()
Return the Java class name of the admin-services interface for this integration service.- Returns:
- String class name implementing the IntegrationServiceAdmin interface.
-
setIntegrationServiceContextManagerClass
public void setIntegrationServiceContextManagerClass(java.lang.String integrationServiceContextManagerClass)
Set up the Java class name of the admin services interface for this integration service.- Parameters:
integrationServiceContextManagerClass
- String class name implementing the IntegrationServiceAdmin interface.
-
getIntegrationServiceName
public java.lang.String getIntegrationServiceName()
Return the name of the integration service.- Returns:
- String name
-
setIntegrationServiceFullName
public void setIntegrationServiceFullName(java.lang.String integrationServiceFullName)
Set up the full name of the integration service.- Parameters:
integrationServiceFullName
- String name
-
setIntegrationServiceName
public void setIntegrationServiceName(java.lang.String integrationServiceName)
Set up the name of the integration service.- Parameters:
integrationServiceName
- String name
-
getIntegrationServiceFullName
public java.lang.String getIntegrationServiceFullName()
Return the full name of the integration service.- Returns:
- String name
-
getIntegrationServiceURLMarker
public java.lang.String getIntegrationServiceURLMarker()
Return the string that appears in the REST API URL that identifies the owning service. Null means no REST APIs supported by this service.- Returns:
- String default name
-
setIntegrationServiceURLMarker
public void setIntegrationServiceURLMarker(java.lang.String integrationServiceURLMarker)
Set up the string that appears in the REST API URL that identifies the owning service. Null means no REST APIs supported by this service.- Parameters:
integrationServiceURLMarker
- url fragment
-
getIntegrationServiceDescription
public java.lang.String getIntegrationServiceDescription()
Return the short description of the integration service. The default value is in English but this can be changed.- Returns:
- String description
-
setIntegrationServiceDescription
public void setIntegrationServiceDescription(java.lang.String integrationServiceDescription)
Set up the short description of the integration service.- Parameters:
integrationServiceDescription
- String description
-
getIntegrationServiceWiki
public java.lang.String getIntegrationServiceWiki()
Return the wiki page link for the integration service.- Returns:
- String url
-
setIntegrationServiceWiki
public void setIntegrationServiceWiki(java.lang.String integrationServiceWiki)
Set up the wiki page link for the integration service.- Parameters:
integrationServiceWiki
- String url
-
getIntegrationServicePartnerOMAS
public java.lang.String getIntegrationServicePartnerOMAS()
Return the full name of the Open Metadata Access Service (OMAS) that this integration service is partnered with.- Returns:
- Full name of OMAS
-
setIntegrationServicePartnerOMAS
public void setIntegrationServicePartnerOMAS(java.lang.String integrationServicePartnerOMAS)
Set up the full name of the Open Metadata Access Service (OMAS) that this integration service is partnered with.- Parameters:
integrationServicePartnerOMAS
- Full name of OMAS
-
getDefaultPermittedSynchronization
public PermittedSynchronization getDefaultPermittedSynchronization()
Return the default value for permitted synchronization that should be set up for the integration connectors as they are configured.- Returns:
- enum default
-
setDefaultPermittedSynchronization
public void setDefaultPermittedSynchronization(PermittedSynchronization defaultPermittedSynchronization)
Set up the default value for permitted synchronization that should be set up for the integration connectors as they are configured.- Parameters:
defaultPermittedSynchronization
- enum default
-
getIntegrationServiceOperationalStatus
public ServiceOperationalStatus getIntegrationServiceOperationalStatus()
Return the status of this integration service.- Returns:
- ServiceOperationalStatus enum
-
setIntegrationServiceOperationalStatus
public void setIntegrationServiceOperationalStatus(ServiceOperationalStatus integrationServiceOperationalStatus)
Set up the status of the integration service.- Parameters:
integrationServiceOperationalStatus
- ServiceOperationalStatus enum
-
getIntegrationConnectorConfigs
public java.util.List<IntegrationConnectorConfig> getIntegrationConnectorConfigs()
Return the OCF Connection for the topic used to pass requests to this integration service. The default values are constructed from the integration service name. If this value is set to null then the integration service ignores incoming events.- Returns:
- list of connector configurations
-
setIntegrationConnectorConfigs
public void setIntegrationConnectorConfigs(java.util.List<IntegrationConnectorConfig> integrationConnectorConfigs)
Set up the OCF Connection for the topic used to pass requests to this integration service. The default values are constructed from the integration service name. If this value is set to null then the integration service ignores incoming events.- Parameters:
integrationConnectorConfigs
- Connection properties
-
getIntegrationServiceOptions
public java.util.Map<java.lang.String,java.lang.Object> getIntegrationServiceOptions()
Return the options for this integration service. These are properties that are specific to the integration service.- Returns:
- Map from String to String
-
setIntegrationServiceOptions
public void setIntegrationServiceOptions(java.util.Map<java.lang.String,java.lang.Object> integrationServiceOptions)
Set up the options for this integration service. These are properties that are specific to the integration service.- Parameters:
integrationServiceOptions
- Map from String to String
-
toString
public java.lang.String toString()
Standard toString method.- Overrides:
toString
in classOMAGServerClientConfig
- 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 classOMAGServerClientConfig
- Parameters:
objectToCompare
- object- Returns:
- boolean result
-
hashCode
public int hashCode()
Return a hash code based on the values of this object.- Overrides:
hashCode
in classOMAGServerClientConfig
- Returns:
- in hash code
-
-