OMAGServerConfig (Administration Services API 0.1 API)

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

All Implemented Interfaces:

Serializable
```
public class OMAGServerConfig
extends Object
implements Serializable
```
OMAGServerConfig provides the properties used to initialize an open metadata and governance (OMAG) server. The OMAG server configuration has the following properties:
- localServerName - meaningful name for the server for use in messages and UIs. Ideally this value is unique to aid administrators in understanding the behavior of the local server/repository in the open metadata cluster. The default value is "Default Server".
- localServerType - descriptive type name for the local server. Again this is useful information for the administrator to understand which vendor implementation, or version of the vendor implementation, is in operation. 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 server (typically URL and port number).
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`OMAGServerConfig()` Default constructor used to set all properties to their default value.
`OMAGServerConfig(OMAGServerConfig template)` Copy/clone constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<AccessServiceConfig>`	`getAccessServicesConfig()` Return the configuration for the registered Open Metadata Access Services (OMAS).
`EventBusConfig`	`getEventBusConfig()` Set up the information used to create connections to an event bus.
`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.
`void`	`setAccessServicesConfig(List<AccessServiceConfig> accessServicesConfig)` Set up the configuration for the registered Open Metadata Access Services (OMAS).
`void`	`setEventBusConfig(EventBusConfig eventBusConfig)` Set up the information used to create connections to an event bus.
`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.

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

- Constructor Detail
  - OMAGServerConfig
```
public OMAGServerConfig()
```
    Default constructor used to set all properties to their default value. This means the server can connect to the cluster (assuming the default topic name is used by the cluster) and replicate metadata, but it will not be remotely callable through an OMRS connector.
  - OMAGServerConfig
```
public OMAGServerConfig(OMAGServerConfig template)
```
    Copy/clone constructor.
- Method Detail
  - 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

Class OMAGServerConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OMAGServerConfig

OMAGServerConfig

Method Detail

getLocalServerName

setLocalServerName

getLocalServerType

setLocalServerType

getOrganizationName

setOrganizationName

getLocalServerURL

setLocalServerURL

getLocalServerUserId

setLocalServerUserId

getMaxPageSize

setMaxPageSize

getEventBusConfig

setEventBusConfig

getAccessServicesConfig

setAccessServicesConfig

getRepositoryServicesConfig

setRepositoryServicesConfig