OMAGServerConfig (Administration Services API 1.0 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 "http://localhost:8080".
- 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

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 (OMAS).
`List<String>`	`getAuditTrail()` Return the list of audit log entries associated with this config file.
`DiscoveryEngineConfig`	`getDiscoveryEngineConfig()` Return the configuration for a discovery engine.
`EventBusConfig`	`getEventBusConfig()` Set up the information used to create connections to an event bus.
`String`	`getLocalServerId()` Return an unique identifier for this server.
`String`	`getLocalServerName()` Return the name of the local server.
`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.
`String`	`getOrganizationName()` Return the name of the organization that is running the server.
`RepositoryServicesConfig`	`getRepositoryServicesConfig()` Return the Open Metadata Repository Services (OMRS) config.
`SecuritySyncConfig`	`getSecuritySyncConfig()` Return the configuration for the security synchronization services.
`StewardshipServicesConfig`	`getStewardshipServicesConfig()` Return the configuration for the stewardship services in a server.
`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 (OMAS).
`void`	`setAuditTrail(List<String> auditTrail)` Set up the audit log messages.
`void`	`setDiscoveryEngineConfig(DiscoveryEngineConfig discoveryEngineConfig)` Set up the configuration for a discovery engine.
`void`	`setEventBusConfig(EventBusConfig eventBusConfig)` Set up the information used to create connections to an event bus.
`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`	`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`	`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`	`setSecuritySyncConfig(SecuritySyncConfig securitySyncConfig)` Set up the configuration for the security synchronization services.
`void`	`setStewardshipServicesConfig(StewardshipServicesConfig stewardshipServicesConfig)` Set up the configuration for the stewardship services in a server.
`String`	`toString()` Standard toString method.

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

- Constructor Detail
  - OMAGServerConfig
```
public OMAGServerConfig()
```
    Default constructor.
  - OMAGServerConfig
```
public OMAGServerConfig(OMAGServerConfig template)
```
    Copy/clone constructor.
- Method Detail
  - 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
  - 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
  - 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 (OMAS).
    
    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 (OMAS).
    
    Parameters:
    
    accessServicesConfig - array of configuration properties one for each OMAS
  - 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
  - getDiscoveryEngineConfig
```
public DiscoveryEngineConfig getDiscoveryEngineConfig()
```
    Return the configuration for a discovery engine.
    
    Returns:
    
    DiscoveryEngineConfig properties
  - setDiscoveryEngineConfig
```
public void setDiscoveryEngineConfig(DiscoveryEngineConfig discoveryEngineConfig)
```
    Set up the configuration for a discovery engine.
    
    Parameters:
    
    discoveryEngineConfig - DiscoveryEngineConfig properties
  - getStewardshipServicesConfig
```
public StewardshipServicesConfig getStewardshipServicesConfig()
```
    Return the configuration for the stewardship services in a server.
    
    Returns:
    
    StewardshipServicesConfig properties
  - setStewardshipServicesConfig
```
public void setStewardshipServicesConfig(StewardshipServicesConfig stewardshipServicesConfig)
```
    Set up the configuration for the stewardship services in a server.
    
    Parameters:
    
    stewardshipServicesConfig - 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
  - 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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OMAGServerConfig

OMAGServerConfig

Method Detail

getLocalServerId

setLocalServerId

getLocalServerName

setLocalServerName

getLocalServerType

setLocalServerType

getOrganizationName

setOrganizationName

getLocalServerURL

setLocalServerURL

getLocalServerUserId

setLocalServerUserId

getMaxPageSize

setMaxPageSize

getEventBusConfig

setEventBusConfig

getAccessServicesConfig

setAccessServicesConfig

getRepositoryServicesConfig

setRepositoryServicesConfig

getDiscoveryEngineConfig

setDiscoveryEngineConfig

getStewardshipServicesConfig

setStewardshipServicesConfig

getSecuritySyncConfig

setSecuritySyncConfig

getAuditTrail

setAuditTrail

toString

equals

hashCode