IntegrationServiceConfig (Administration Services API 2.4 API)

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:

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 and Description
`IntegrationServiceConfig()` Default constructor for use with Jackson libraries
`IntegrationServiceConfig(IntegrationServiceConfig template)` Copy/clone constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object objectToCompare)` Validate that an object is equal depending on their stored values.
`List<IntegrationConnectorConfig>`	`getIntegrationConnectorConfigs()` Return the OCF Connection for the topic used to pass requests to this integration service.
`String`	`getIntegrationServiceContextManagerClass()` Return the Java class name of the admin-services interface for this integration service.
`String`	`getIntegrationServiceDescription()` Return the short description of the integration service.
`String`	`getIntegrationServiceFullName()` Return the full name of the integration service.
`int`	`getIntegrationServiceId()` Return the code number (ordinal) for this integration service.
`String`	`getIntegrationServiceName()` Return the name of the integration service.
`ServiceOperationalStatus`	`getIntegrationServiceOperationalStatus()` Return the status of this integration service.
`Map<String,Object>`	`getIntegrationServiceOptions()` Return the options for this integration service.
`String`	`getIntegrationServicePartnerOMAS()` Return the full name of the Open Metadata Access Service (OMAS) that this integration service is partnered with.
`String`	`getIntegrationServiceURLMarker()` Return the string that appears in the REST API URL that identifies the owning service.
`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`	`setIntegrationConnectorConfigs(List<IntegrationConnectorConfig> integrationConnectorConfigs)` Set up the OCF Connection for the topic used to pass requests to this integration service.
`void`	`setIntegrationServiceContextManagerClass(String integrationServiceContextManagerClass)` Set up the Java class name of the admin services interface for this integration service.
`void`	`setIntegrationServiceDescription(String integrationServiceDescription)` Set up the short description of the integration service.
`void`	`setIntegrationServiceFullName(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(String integrationServiceName)` Set up the name of the integration service.
`void`	`setIntegrationServiceOperationalStatus(ServiceOperationalStatus integrationServiceOperationalStatus)` Set up the status of the integration service.
`void`	`setIntegrationServiceOptions(Map<String,Object> integrationServiceOptions)` Set up the options for this integration service.
`void`	`setIntegrationServicePartnerOMAS(String integrationServicePartnerOMAS)` Set up the full name of the Open Metadata Access Service (OMAS) that this integration service is partnered with.
`void`	`setIntegrationServiceURLMarker(String integrationServiceURLMarker)` Set up the string that appears in the REST API URL that identifies the owning service.
`void`	`setIntegrationServiceWiki(String integrationServiceWiki)` Set up the wiki page link for the integration service.
`String`	`toString()` Standard toString method.

Methods inherited from class org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerClientConfig
getOMAGServerName, getOMAGServerPlatformRootURL, setOMAGServerName, setOMAGServerPlatformRootURL

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 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
  - getIntegrationServiceContextManagerClass
```
public 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(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 String getIntegrationServiceName()
```
    Return the name of the integration service.
    
    Returns:
    
    String name
  - setIntegrationServiceFullName
```
public void setIntegrationServiceFullName(String integrationServiceFullName)
```
    Set up the full name of the integration service.
    
    Parameters:
    
    integrationServiceFullName - String name
  - setIntegrationServiceName
```
public void setIntegrationServiceName(String integrationServiceName)
```
    Set up the name of the integration service.
    
    Parameters:
    
    integrationServiceName - String name
  - getIntegrationServiceFullName
```
public String getIntegrationServiceFullName()
```
    Return the full name of the integration service.
    
    Returns:
    
    String name
  - getIntegrationServiceURLMarker
```
public 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(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 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(String integrationServiceDescription)
```
    Set up the short description of the integration service.
    
    Parameters:
    
    integrationServiceDescription - String description
  - getIntegrationServiceWiki
```
public String getIntegrationServiceWiki()
```
    Return the wiki page link for the integration service. The default value points to a page on the Atlas confluence wiki.
    
    Returns:
    
    String url
  - setIntegrationServiceWiki
```
public void setIntegrationServiceWiki(String integrationServiceWiki)
```
    Set up the wiki page link for the integration service.
    
    Parameters:
    
    integrationServiceWiki - String url
  - getIntegrationServicePartnerOMAS
```
public 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(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
  - 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 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(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 Map<String,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(Map<String,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 String toString()
```
    Standard toString method.
    
    Overrides:
    
    toString in class OMAGServerClientConfig
    
    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 OMAGServerClientConfig
    
    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 OMAGServerClientConfig
    
    Returns:
    
    in hash code

Class IntegrationServiceConfig

Constructor Summary

Method Summary

Methods inherited from class org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerClientConfig

Methods inherited from class java.lang.Object

Constructor Detail

IntegrationServiceConfig

IntegrationServiceConfig

Method Detail

getIntegrationServiceId

setIntegrationServiceId

getIntegrationServiceContextManagerClass

setIntegrationServiceContextManagerClass

getIntegrationServiceName

setIntegrationServiceFullName

setIntegrationServiceName

getIntegrationServiceFullName

getIntegrationServiceURLMarker

setIntegrationServiceURLMarker

getIntegrationServiceDescription

setIntegrationServiceDescription

getIntegrationServiceWiki

setIntegrationServiceWiki

getIntegrationServicePartnerOMAS

setIntegrationServicePartnerOMAS

getIntegrationServiceOperationalStatus

setIntegrationServiceOperationalStatus

getIntegrationConnectorConfigs

setIntegrationConnectorConfigs

getIntegrationServiceOptions

setIntegrationServiceOptions

toString

equals

hashCode