OMAGServerConfig (Administration Services API 2.4 API)

java.lang.Object
- org.odpi.openmetadata.adminservices.configuration.properties.AdminServicesConfigHeader
- - org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig

All Implemented Interfaces:

Serializable
```
public class OMAGServerConfig
extends AdminServicesConfigHeader
```
OMAGServerConfig provides the properties used to initialize an open metadata and governance (OMAG) server. The OMAG server configuration has the following basic properties, plus configuration for the subsystems that should be activated in the OMAG Server:
- localServerId - Unique identifier for this server. By default, this is initialized to a randomly generated Universal Unique identifier (UUID).
- localServerName - meaningful name for the server for use in messages and UIs. Ideally this value is unique to aid administrators in understanding the source of messages and events from the server. This value is set to the server name assigned when the configuration is created.
- localServerType - descriptive type name for the server. Again this is useful information for the administrator to understand the role of the server. The default value is "Open Metadata and Governance Server".
- organizationName - descriptive name for the organization that owns the local server/repository. This is useful when the open metadata repository cluster consists of metadata servers from different organizations, or different departments of an enterprise. The default value is null.
- localServerURL - network address of the OMAG server platform where this server runs (typically host and port number but may also include the initial part of the URL before "open-metadata"). The default value is "https://localhost:9443".
- localServerUserId - UserId to use for server initiated REST calls. The default is "OMAGServer".
- maxPageSize - the maximum page size that can be set on requests to the server. The default value is 1000.
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static List<String> COMPATIBLE_VERSIONS

static String defaultLocalServerType

static String VERSION_ONE

static String VERSION_TWO

Fields
Modifier and Type	Field and Description
`static List<String>`	`COMPATIBLE_VERSIONS`
`static String`	`defaultLocalServerType`
`static String`	`VERSION_ONE`
`static String`	`VERSION_TWO`

Constructor Summary

Constructors
Constructor and Description

OMAGServerConfig()
Default constructor.

OMAGServerConfig(OMAGServerConfig template)
Copy/clone constructor.

Constructors
Constructor and Description
`OMAGServerConfig()` Default constructor.
`OMAGServerConfig(OMAGServerConfig 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<AccessServiceConfig>`	`getAccessServicesConfig()` Return the configuration for the registered Open Metadata Access Services (OMASs).
`List<String>`	`getAuditTrail()` Return the list of audit log entries associated with this config file.
`ConformanceSuiteConfig`	`getConformanceSuiteConfig()` Return the configuration for the open metadata conformance suite services.
`DataEngineProxyConfig`	`getDataEngineProxyConfig()` Return the configuration for the data engine proxy services.
`DataPlatformServicesConfig`	`getDataPlatformServicesConfig()` Return the configuration for the data platform services.
`DiscoveryEngineServicesConfig`	`getDiscoveryEngineServicesConfig()` Return the configuration for a discovery server.
`EventBusConfig`	`getEventBusConfig()` Set up the information used to create connections to an event bus.
`List<IntegrationServiceConfig>`	`getIntegrationServicesConfig()` Return the configuration for the registered Open Metadata Integration Services (OMISs).
`String`	`getLocalServerId()` Return an unique identifier for this server.
`String`	`getLocalServerName()` Return the name of the local server.
`String`	`getLocalServerPassword()` Return the password that the local server should use on outbound REST calls (this is the password for the localServerUserId).
`String`	`getLocalServerType()` Return the descriptive name for the server type.
`String`	`getLocalServerURL()` Return the base URL for calling the local server.
`String`	`getLocalServerUserId()` Return the userId that the local server should use when processing events and there is no external user driving the operation.
`int`	`getMaxPageSize()` Return the maximum page size supported by this server.
`OpenLineageServerConfig`	`getOpenLineageServerConfig()` Return the configuration for open lineage services.
`String`	`getOrganizationName()` Return the name of the organization that is running the server.
`RepositoryServicesConfig`	`getRepositoryServicesConfig()` Return the Open Metadata Repository Services (OMRS) config.
`SecurityOfficerConfig`	`getSecurityOfficerConfig()` Return the configuration for the security officer services.
`SecuritySyncConfig`	`getSecuritySyncConfig()` Return the configuration for the security synchronization services.
`Connection`	`getServerSecurityConnection()` Return the connection for the optional server security connector that validates calls to this server from admin to operations to metadata and governance services.
`StewardshipEngineServicesConfig`	`getStewardshipEngineServicesConfig()` Return the configuration for the stewardship services in a server.
`String`	`getVersionId()` Return the versionId of this document.
`List<ViewServiceConfig>`	`getViewServicesConfig()` Return the configuration for the registered Open Metadata View Services (OMVSs).
`VirtualizationConfig`	`getVirtualizationConfig()` Return the configuration for the virtualization services.
`int`	`hashCode()` Return a hash code based on the values of this object.
`void`	`setAccessServicesConfig(List<AccessServiceConfig> accessServicesConfig)` Set up the configuration for the registered Open Metadata Access Services (OMASs).
`void`	`setAuditTrail(List<String> auditTrail)` Set up the audit log messages.
`void`	`setConformanceSuiteConfig(ConformanceSuiteConfig conformanceSuiteConfig)` Set up the configuration for the open metadata conformance suite services.
`void`	`setDataEngineProxyConfig(DataEngineProxyConfig dataEngineProxyConfig)` Set up the configuration for the data engine proxy services.
`void`	`setDataPlatformServicesConfig(DataPlatformServicesConfig dataPlatformServicesConfig)` Set up the configuration for the data platform services.
`void`	`setDiscoveryEngineServicesConfig(DiscoveryEngineServicesConfig discoveryEngineServicesConfig)` Set up the configuration for a discovery server.
`void`	`setEventBusConfig(EventBusConfig eventBusConfig)` Set up the information used to create connections to an event bus.
`void`	`setIntegrationServicesConfig(List<IntegrationServiceConfig> integrationServicesConfig)` Set up the configuration for the registered Open Metadata Integration Services (OMISs).
`void`	`setLocalServerId(String localServerId)` Set up a unique identifier for this server.
`void`	`setLocalServerName(String localServerName)` Set up the name of the local server.
`void`	`setLocalServerPassword(String localServerPassword)` Set up the password that the local server should use on outbound REST calls (this is the password for the localServerUserId).
`void`	`setLocalServerType(String localServerType)` Set up the descriptive name for the server type.
`void`	`setLocalServerURL(String localServerURL)` Set up the base URL for calling the local server.
`void`	`setLocalServerUserId(String localServerUserId)` Set up the userId that the local server should use when processing events and there is no external user driving the operation.
`void`	`setMaxPageSize(int maxPageSize)` Set up the maximum page size supported by this server.
`void`	`setOpenLineageServerConfig(OpenLineageServerConfig openLineageServerConfig)` Set up the configuration for open lineage services.
`void`	`setOrganizationName(String organizationName)` Set up the name of the organization that is running the server.
`void`	`setRepositoryServicesConfig(RepositoryServicesConfig repositoryServicesConfig)` Set up the Open Metadata Repository Services (OMRS) config.
`void`	`setSecurityOfficerConfig(SecurityOfficerConfig securityOfficerConfig)` Set up the configuration for the security officer services.
`void`	`setSecuritySyncConfig(SecuritySyncConfig securitySyncConfig)` Set up the configuration for the security synchronization services.
`void`	`setServerSecurityConnection(Connection serverSecurityConnection)` Set up the connection for the optional server security connector that validates calls to this server from admin to operations to metadata and governance services.
`void`	`setStewardshipEngineServicesConfig(StewardshipEngineServicesConfig stewardshipEngineServicesConfig)` Set up the configuration for the stewardship services in a server.
`void`	`setVersionId(String versionId)` Set up the versionId of this document.
`void`	`setViewServicesConfig(List<ViewServiceConfig> viewServicesConfig)` Set up the configuration for the registered Open Metadata View Services (OMVSs).
`void`	`setVirtualizationConfig(VirtualizationConfig virtualizationConfig)` Set up the configuration for the virtualization services.
`String`	`toString()` Standard toString method.

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

- Field Detail
  - VERSION_ONE
```
public static final String VERSION_ONE
```
    See Also:
    
    Constant Field Values
  - VERSION_TWO
```
public static final String VERSION_TWO
```
    See Also:
    
    Constant Field Values
  - COMPATIBLE_VERSIONS
```
public static final List<String> COMPATIBLE_VERSIONS
```
  - defaultLocalServerType
```
public static final String defaultLocalServerType
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OMAGServerConfig
```
public OMAGServerConfig()
```
    Default constructor.
  - OMAGServerConfig
```
public OMAGServerConfig(OMAGServerConfig template)
```
    Copy/clone constructor.
    
    Parameters:
    
    template - object to copy
- Method Detail
  - getVersionId
```
public String getVersionId()
```
    Return the versionId of this document.
    
    Returns:
    
    string
  - setVersionId
```
public void setVersionId(String versionId)
```
    Set up the versionId of this document.
    
    Parameters:
    
    versionId - string
  - getLocalServerId
```
public String getLocalServerId()
```
    Return an unique identifier for this server.
    
    Returns:
    
    string guid
  - setLocalServerId
```
public void setLocalServerId(String localServerId)
```
    Set up a unique identifier for this server.
    
    Parameters:
    
    localServerId - string guid
  - getLocalServerName
```
public String getLocalServerName()
```
    Return the name of the local server.
    
    Returns:
    
    String server name
  - setLocalServerName
```
public void setLocalServerName(String localServerName)
```
    Set up the name of the local server.
    
    Parameters:
    
    localServerName - String local server name
  - getLocalServerType
```
public String getLocalServerType()
```
    Return the descriptive name for the server type.
    
    Returns:
    
    String server type
  - setLocalServerType
```
public void setLocalServerType(String localServerType)
```
    Set up the descriptive name for the server type.
    
    Parameters:
    
    localServerType - String server type
  - getOrganizationName
```
public String getOrganizationName()
```
    Return the name of the organization that is running the server.
    
    Returns:
    
    String organization name
  - setOrganizationName
```
public void setOrganizationName(String organizationName)
```
    Set up the name of the organization that is running the server.
    
    Parameters:
    
    organizationName - String organization name
  - getLocalServerURL
```
public String getLocalServerURL()
```
    Return the base URL for calling the local server.
    
    Returns:
    
    String URL
  - setLocalServerURL
```
public void setLocalServerURL(String localServerURL)
```
    Set up the base URL for calling the local server.
    
    Parameters:
    
    localServerURL - String URL
  - getLocalServerUserId
```
public String getLocalServerUserId()
```
    Return the userId that the local server should use when processing events and there is no external user driving the operation.
    
    Returns:
    
    user id
  - setLocalServerUserId
```
public void setLocalServerUserId(String localServerUserId)
```
    Set up the userId that the local server should use when processing events and there is no external user driving the operation.
    
    Parameters:
    
    localServerUserId - string user id
  - getLocalServerPassword
```
public String getLocalServerPassword()
```
    Return the password that the local server should use on outbound REST calls (this is the password for the localServerUserId). Using userId's and passwords for server authentication is not suitable for production environments.
    
    Returns:
    
    password in clear
  - setLocalServerPassword
```
public void setLocalServerPassword(String localServerPassword)
```
    Set up the password that the local server should use on outbound REST calls (this is the password for the localServerUserId). Using userId's and passwords for server authentication is not suitable for production environments.
    
    Parameters:
    
    localServerPassword - password in clear
  - getMaxPageSize
```
public int getMaxPageSize()
```
    Return the maximum page size supported by this server.
    
    Returns:
    
    int number of elements
  - setMaxPageSize
```
public void setMaxPageSize(int maxPageSize)
```
    Set up the maximum page size supported by this server.
    
    Parameters:
    
    maxPageSize - int number of elements
  - getServerSecurityConnection
```
public Connection getServerSecurityConnection()
```
    Return the connection for the optional server security connector that validates calls to this server from admin to operations to metadata and governance services.
    
    Returns:
    
    Connection bean.
  - setServerSecurityConnection
```
public void setServerSecurityConnection(Connection serverSecurityConnection)
```
    Set up the connection for the optional server security connector that validates calls to this server from admin to operations to metadata and governance services.
    
    Parameters:
    
    serverSecurityConnection - connection bean
  - getEventBusConfig
```
public EventBusConfig getEventBusConfig()
```
    Set up the information used to create connections to an event bus.
    
    Returns:
    
    EventBusConfig object
  - setEventBusConfig
```
public void setEventBusConfig(EventBusConfig eventBusConfig)
```
    Set up the information used to create connections to an event bus.
    
    Parameters:
    
    eventBusConfig - EventBusConfig object
  - getAccessServicesConfig
```
public List<AccessServiceConfig> getAccessServicesConfig()
```
    Return the configuration for the registered Open Metadata Access Services (OMASs).
    
    Returns:
    
    array of configuration properties, one for each OMAS
  - setAccessServicesConfig
```
public void setAccessServicesConfig(List<AccessServiceConfig> accessServicesConfig)
```
    Set up the configuration for the registered Open Metadata Access Services (OMASs).
    
    Parameters:
    
    accessServicesConfig - array of configuration properties, one for each OMAS
  - getIntegrationServicesConfig
```
public List<IntegrationServiceConfig> getIntegrationServicesConfig()
```
    Return the configuration for the registered Open Metadata Integration Services (OMISs).
    
    Returns:
    
    array of configuration properties, one for each OMIS
  - setIntegrationServicesConfig
```
public void setIntegrationServicesConfig(List<IntegrationServiceConfig> integrationServicesConfig)
```
    Set up the configuration for the registered Open Metadata Integration Services (OMISs).
    
    Parameters:
    
    integrationServicesConfig - array of configuration properties, one for each OMIS
  - getViewServicesConfig
```
public List<ViewServiceConfig> getViewServicesConfig()
```
    Return the configuration for the registered Open Metadata View Services (OMVSs).
    
    Returns:
    
    array of configuration properties, one for each OMVS
  - setViewServicesConfig
```
public void setViewServicesConfig(List<ViewServiceConfig> viewServicesConfig)
```
    Set up the configuration for the registered Open Metadata View Services (OMVSs).
    
    Parameters:
    
    viewServicesConfig - array of configuration properties, one for each OMVS
  - getRepositoryServicesConfig
```
public RepositoryServicesConfig getRepositoryServicesConfig()
```
    Return the Open Metadata Repository Services (OMRS) config.
    
    Returns:
    
    configuration properties that control OMRS
  - setRepositoryServicesConfig
```
public void setRepositoryServicesConfig(RepositoryServicesConfig repositoryServicesConfig)
```
    Set up the Open Metadata Repository Services (OMRS) config.
    
    Parameters:
    
    repositoryServicesConfig - configuration properties that control OMRS
  - getConformanceSuiteConfig
```
public ConformanceSuiteConfig getConformanceSuiteConfig()
```
    Return the configuration for the open metadata conformance suite services.
    
    Returns:
    
    configuration properties that control the operation of the open metadata test labs.
  - setConformanceSuiteConfig
```
public void setConformanceSuiteConfig(ConformanceSuiteConfig conformanceSuiteConfig)
```
    Set up the configuration for the open metadata conformance suite services.
    
    Parameters:
    
    conformanceSuiteConfig - configuration properties that control the operation of the open metadata test labs.
  - getDiscoveryEngineServicesConfig
```
public DiscoveryEngineServicesConfig getDiscoveryEngineServicesConfig()
```
    Return the configuration for a discovery server.
    
    Returns:
    
    DiscoveryServerConfig properties
  - setDiscoveryEngineServicesConfig
```
public void setDiscoveryEngineServicesConfig(DiscoveryEngineServicesConfig discoveryEngineServicesConfig)
```
    Set up the configuration for a discovery server.
    
    Parameters:
    
    discoveryEngineServicesConfig - DiscoveryServerConfig properties
  - getOpenLineageServerConfig
```
public OpenLineageServerConfig getOpenLineageServerConfig()
```
    Return the configuration for open lineage services.
    
    Returns:
    
    OpenLineageConfig properties
  - setOpenLineageServerConfig
```
public void setOpenLineageServerConfig(OpenLineageServerConfig openLineageServerConfig)
```
    Set up the configuration for open lineage services.
    
    Parameters:
    
    openLineageServerConfig - OpenLineageConfig properties
  - getStewardshipEngineServicesConfig
```
public StewardshipEngineServicesConfig getStewardshipEngineServicesConfig()
```
    Return the configuration for the stewardship services in a server.
    
    Returns:
    
    StewardshipServicesConfig properties
  - setStewardshipEngineServicesConfig
```
public void setStewardshipEngineServicesConfig(StewardshipEngineServicesConfig stewardshipEngineServicesConfig)
```
    Set up the configuration for the stewardship services in a server.
    
    Parameters:
    
    stewardshipEngineServicesConfig - StewardshipServicesConfig properties
  - getSecuritySyncConfig
```
public SecuritySyncConfig getSecuritySyncConfig()
```
    Return the configuration for the security synchronization services.
    
    Returns:
    
    SecuritySyncConfig properties
  - setSecuritySyncConfig
```
public void setSecuritySyncConfig(SecuritySyncConfig securitySyncConfig)
```
    Set up the configuration for the security synchronization services.
    
    Parameters:
    
    securitySyncConfig - SecuritySyncConfig properties
  - getSecurityOfficerConfig
```
public SecurityOfficerConfig getSecurityOfficerConfig()
```
    Return the configuration for the security officer services.
    
    Returns:
    
    SecurityOfficerConfig properties
  - setSecurityOfficerConfig
```
public void setSecurityOfficerConfig(SecurityOfficerConfig securityOfficerConfig)
```
    Set up the configuration for the security officer services.
    
    Parameters:
    
    securityOfficerConfig - SecurityOfficerConfig properties
  - getVirtualizationConfig
```
public VirtualizationConfig getVirtualizationConfig()
```
    Return the configuration for the virtualization services.
    
    Returns:
    
    VirtualizationConfig properties
  - setDataEngineProxyConfig
```
public void setDataEngineProxyConfig(DataEngineProxyConfig dataEngineProxyConfig)
```
    Set up the configuration for the data engine proxy services.
    
    Parameters:
    
    dataEngineProxyConfig - properties
  - getDataEngineProxyConfig
```
public DataEngineProxyConfig getDataEngineProxyConfig()
```
    Return the configuration for the data engine proxy services.
    
    Returns:
    
    DataEngineProxyConfig properties
  - setVirtualizationConfig
```
public void setVirtualizationConfig(VirtualizationConfig virtualizationConfig)
```
    Set up the configuration for the virtualization services.
    
    Parameters:
    
    virtualizationConfig - properties
  - getDataPlatformServicesConfig
```
public DataPlatformServicesConfig getDataPlatformServicesConfig()
```
    Return the configuration for the data platform services.
    
    Returns:
    
    DataEngineProxyConfig properties
  - setDataPlatformServicesConfig
```
public void setDataPlatformServicesConfig(DataPlatformServicesConfig dataPlatformServicesConfig)
```
    Set up the configuration for the data platform services.
    
    Parameters:
    
    dataPlatformServicesConfig - properties
  - getAuditTrail
```
public List<String> getAuditTrail()
```
    Return the list of audit log entries associated with this config file. The audit log simply keep track of the changed to the configuration.
    
    Returns:
    
    list of audit messages
  - setAuditTrail
```
public void setAuditTrail(List<String> auditTrail)
```
    Set up the audit log messages.
    
    Parameters:
    
    auditTrail - list of audit messages
  - 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

Class OMAGServerConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VERSION_ONE

VERSION_TWO

COMPATIBLE_VERSIONS

defaultLocalServerType

Constructor Detail

OMAGServerConfig

OMAGServerConfig

Method Detail

getVersionId

setVersionId

getLocalServerId

setLocalServerId

getLocalServerName

setLocalServerName

getLocalServerType

setLocalServerType

getOrganizationName

setOrganizationName

getLocalServerURL

setLocalServerURL

getLocalServerUserId

setLocalServerUserId

getLocalServerPassword

setLocalServerPassword

getMaxPageSize

setMaxPageSize

getServerSecurityConnection

setServerSecurityConnection

getEventBusConfig

setEventBusConfig

getAccessServicesConfig

setAccessServicesConfig

getIntegrationServicesConfig

setIntegrationServicesConfig

getViewServicesConfig

setViewServicesConfig

getRepositoryServicesConfig

setRepositoryServicesConfig

getConformanceSuiteConfig

setConformanceSuiteConfig

getDiscoveryEngineServicesConfig

setDiscoveryEngineServicesConfig

getOpenLineageServerConfig

setOpenLineageServerConfig

getStewardshipEngineServicesConfig

setStewardshipEngineServicesConfig

getSecuritySyncConfig

setSecuritySyncConfig

getSecurityOfficerConfig

setSecurityOfficerConfig

getVirtualizationConfig

setDataEngineProxyConfig

getDataEngineProxyConfig

setVirtualizationConfig

getDataPlatformServicesConfig

setDataPlatformServicesConfig

getAuditTrail

setAuditTrail

toString

equals

hashCode