Class EngineServiceConfig
- java.lang.Object
-
- org.odpi.openmetadata.adminservices.configuration.properties.AdminServicesConfigHeader
-
- org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerClientConfig
-
- org.odpi.openmetadata.adminservices.configuration.properties.EngineServiceConfig
-
- All Implemented Interfaces:
java.io.Serializable
public class EngineServiceConfig extends OMAGServerClientConfig
EngineServiceConfig provides the properties to configure a single engine service in an engine hosting server. The engine service runs one or more engines of a specific type. The configuration for each of these engines is extracted from the partner OMAS using the engine name as the qualified name.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description EngineServiceConfig()
Default constructorEngineServiceConfig(EngineServiceConfig template)
Copy/clone constructorEngineServiceConfig(EngineServiceRegistrationEntry 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.java.util.List<EngineConfig>
getEngines()
Return the list of unique names (qualifiedName) for the governance engines that will run in this server.java.lang.String
getEngineServiceAdminClass()
Return the Java class name of the admin-services interface for this engine service.java.lang.String
getEngineServiceDescription()
Return the short description of the engine service.ComponentDevelopmentStatus
getEngineServiceDevelopmentStatus()
Return the development status of the service.java.lang.String
getEngineServiceFullName()
Return the full name of the engine service.int
getEngineServiceId()
Return the code number (ordinal) for this engine service.java.lang.String
getEngineServiceName()
Return the name of the engine service.ServiceOperationalStatus
getEngineServiceOperationalStatus()
Return the status of this engine service.java.util.Map<java.lang.String,java.lang.Object>
getEngineServiceOptions()
Return the options for this engine service.java.lang.String
getEngineServicePartnerOMAS()
Return the full name of the Open Metadata Access Service (OMAS) that this engine service is partnered with.java.lang.String
getEngineServiceURLMarker()
Return the string that appears in the REST API URL that identifies the owning service.java.lang.String
getEngineServiceWiki()
Return the wiki page link for the engine service.int
hashCode()
Return a hash code based on the values of this object.void
setEngines(java.util.List<EngineConfig> engines)
Set up the list of unique names (qualifiedName) for the governance engines that will run in this server.void
setEngineServiceAdminClass(java.lang.String engineServiceAdminClass)
Set up the Java class name of the admin services interface for this engine service.void
setEngineServiceDescription(java.lang.String engineServiceDescription)
Set up the short description of the engine service.void
setEngineServiceDevelopmentStatus(ComponentDevelopmentStatus engineServiceDevelopmentStatus)
Set up the development status of the service.void
setEngineServiceFullName(java.lang.String engineServiceFullName)
Set up the full name of the engine service.void
setEngineServiceId(int engineServiceId)
Set up the code number (ordinal) for this engine service.void
setEngineServiceName(java.lang.String engineServiceName)
Set up the name of the engine service.void
setEngineServiceOperationalStatus(ServiceOperationalStatus engineServiceOperationalStatus)
Set up the status of the engine service.void
setEngineServiceOptions(java.util.Map<java.lang.String,java.lang.Object> engineServiceOptions)
Set up the options for this engine service.void
setEngineServicePartnerOMAS(java.lang.String engineServicePartnerOMAS)
Set up the full name of the Open Metadata Access Service (OMAS) that this engine service is partnered with.void
setEngineServiceURLMarker(java.lang.String engineServiceURLMarker)
Set up the string that appears in the REST API URL that identifies the owning service.void
setEngineServiceWiki(java.lang.String engineServiceWiki)
Set up the wiki page link for the engine 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
-
EngineServiceConfig
public EngineServiceConfig()
Default constructor
-
EngineServiceConfig
public EngineServiceConfig(EngineServiceConfig template)
Copy/clone constructor- Parameters:
template
- object to copy
-
EngineServiceConfig
public EngineServiceConfig(EngineServiceRegistrationEntry template)
Copy/clone constructor- Parameters:
template
- object to copy
-
-
Method Detail
-
getEngineServiceId
public int getEngineServiceId()
Return the code number (ordinal) for this engine service.- Returns:
- int ordinal
-
setEngineServiceId
public void setEngineServiceId(int engineServiceId)
Set up the code number (ordinal) for this engine service.- Parameters:
engineServiceId
- int ordinal
-
getEngineServiceDevelopmentStatus
public ComponentDevelopmentStatus getEngineServiceDevelopmentStatus()
Return the development status of the service.- Returns:
- enum describing the status
-
setEngineServiceDevelopmentStatus
public void setEngineServiceDevelopmentStatus(ComponentDevelopmentStatus engineServiceDevelopmentStatus)
Set up the development status of the service.- Parameters:
engineServiceDevelopmentStatus
- enum describing the status
-
getEngineServiceAdminClass
public java.lang.String getEngineServiceAdminClass()
Return the Java class name of the admin-services interface for this engine service.- Returns:
- String class name implementing the EngineServiceAdmin interface.
-
setEngineServiceAdminClass
public void setEngineServiceAdminClass(java.lang.String engineServiceAdminClass)
Set up the Java class name of the admin services interface for this engine service.- Parameters:
engineServiceAdminClass
- String class name implementing the EngineServiceAdmin interface.
-
getEngineServiceName
public java.lang.String getEngineServiceName()
Return the name of the engine service.- Returns:
- String name
-
setEngineServiceFullName
public void setEngineServiceFullName(java.lang.String engineServiceFullName)
Set up the full name of the engine service.- Parameters:
engineServiceFullName
- String name
-
setEngineServiceName
public void setEngineServiceName(java.lang.String engineServiceName)
Set up the name of the engine service.- Parameters:
engineServiceName
- String name
-
getEngineServiceFullName
public java.lang.String getEngineServiceFullName()
Return the full name of the engine service.- Returns:
- String name
-
getEngineServiceURLMarker
public java.lang.String getEngineServiceURLMarker()
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
-
setEngineServiceURLMarker
public void setEngineServiceURLMarker(java.lang.String engineServiceURLMarker)
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:
engineServiceURLMarker
- url fragment
-
getEngineServiceDescription
public java.lang.String getEngineServiceDescription()
Return the short description of the engine service. The default value is in English but this can be changed.- Returns:
- String description
-
setEngineServiceDescription
public void setEngineServiceDescription(java.lang.String engineServiceDescription)
Set up the short description of the engine service.- Parameters:
engineServiceDescription
- String description
-
getEngineServiceWiki
public java.lang.String getEngineServiceWiki()
Return the wiki page link for the engine service.- Returns:
- String url
-
setEngineServiceWiki
public void setEngineServiceWiki(java.lang.String engineServiceWiki)
Set up the wiki page link for the engine service.- Parameters:
engineServiceWiki
- String url
-
getEngineServicePartnerOMAS
public java.lang.String getEngineServicePartnerOMAS()
Return the full name of the Open Metadata Access Service (OMAS) that this engine service is partnered with.- Returns:
- Full name of OMAS
-
setEngineServicePartnerOMAS
public void setEngineServicePartnerOMAS(java.lang.String engineServicePartnerOMAS)
Set up the full name of the Open Metadata Access Service (OMAS) that this engine service is partnered with.- Parameters:
engineServicePartnerOMAS
- Full name of OMAS
-
getEngineServiceOperationalStatus
public ServiceOperationalStatus getEngineServiceOperationalStatus()
Return the status of this engine service.- Returns:
- ServiceOperationalStatus enum
-
setEngineServiceOperationalStatus
public void setEngineServiceOperationalStatus(ServiceOperationalStatus engineServiceOperationalStatus)
Set up the status of the engine service.- Parameters:
engineServiceOperationalStatus
- ServiceOperationalStatus enum
-
getEngineServiceOptions
public java.util.Map<java.lang.String,java.lang.Object> getEngineServiceOptions()
Return the options for this engine service. These are properties that are specific to the engine service.- Returns:
- Map from String to String
-
setEngineServiceOptions
public void setEngineServiceOptions(java.util.Map<java.lang.String,java.lang.Object> engineServiceOptions)
Set up the options for this engine service. These are properties that are specific to the engine service.- Parameters:
engineServiceOptions
- Map from String to String
-
getEngines
public java.util.List<EngineConfig> getEngines()
Return the list of unique names (qualifiedName) for the governance engines that will run in this server.- Returns:
- list of qualified names and userIds
-
setEngines
public void setEngines(java.util.List<EngineConfig> engines)
Set up the list of unique names (qualifiedName) for the governance engines that will run in this server.- Parameters:
engines
- list of qualified names and userIds
-
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
-
-