org.odpi.openmetadata.adminservices.configuration.properties

Class EngineConfig

java.lang.Object

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

org.odpi.openmetadata.adminservices.configuration.properties.EngineConfig

All Implemented Interfaces:

Serializable

public class EngineConfig
extends AdminServicesConfigHeader

EngineConfig provides the properties to configure a single governance engine in an service (in an engine hosting server). 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 and Description
EngineConfig() Default constructor
EngineConfig(EngineConfig 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.
String	getEngineId() Return the unique identifier for this engine.
String	getEngineQualifiedName() Return the name of the engine.
String	getEngineUserId() Return the userId that the engine should use when calling the metadata server.
int	hashCode() Return a hash code based on the values of this object.
void	setEngineId(String engineId) Set up the unique identifier for this engine.
void	setEngineQualifiedName(String engineQualifiedName) Set up the name of the engine service.
void	setEngineUserId(String engineUserId) Set up the userId that the engine should use when calling the metadata server.
String	toString() Standard toString method.

Methods inherited from class java.lang.Object

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

Constructor Detail

EngineConfig

public EngineConfig()

Default constructor

EngineConfig

public EngineConfig(EngineConfig template)

Copy/clone constructor

Parameters:

template - object to copy

Method Detail

getEngineId

public String getEngineId()

Return the unique identifier for this engine. It is used when registering a listener with the one of the OutTopics of the metadata services access services.

Returns:

String identifier

setEngineId

public void setEngineId(String engineId)

Set up the unique identifier for this engine. It is used when registering a listener with the one of the OutTopics of the metadata services access services.

Parameters:

engineId - String identifier

getEngineQualifiedName

public String getEngineQualifiedName()

Return the name of the engine. This is the qualified name of the SoftwareServerCapability entity in the metadata repository that represents the engine.

Returns:

String name

setEngineQualifiedName

public void setEngineQualifiedName(String engineQualifiedName)

Set up the name of the engine service. This is the qualified name of the SoftwareServerCapability entity in the metadata repository that represents the engine.

Parameters:

engineQualifiedName - String name

getEngineUserId

public String getEngineUserId()

Return the userId that the engine should use when calling the metadata server. (Null means use the Engine Host's userId.)

Returns:

string userId

setEngineUserId

public void setEngineUserId(String engineUserId)

Set up the userId that the engine should use when calling the metadata server. (Null means use the Engine Host's userId.)

Parameters:

engineUserId - string userId

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