UIServerConfig (User Interface Administration Services API 1.2 API)

java.lang.Object
- org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIAdminServicesConfigHeader
- - org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig

All Implemented Interfaces:

Serializable
```
public class UIServerConfig
extends UIAdminServicesConfigHeader
```
org.odpi.openmetadata.userinterface.adminservices.configuration.properties.UIServerConfig provides the properties used to initialize a user interface open metadata and governance (OMAG) server. The UI server configuration has the following basic properties, plus configuration for the subsystems that should be activated in the UI 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.
- organizationName - descriptive name for the organization that owns the ui 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.
- localServerType - descriptive type name for the UI server. Again this is useful information for the administrator to understand the role of the server. The default value is "User Interface for the Open Metadata and Governance Server".
- localServerURL - network address of the UI 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:8443".
- localServerUserId - UserId to use for server initiated REST calls. The default is "UIServer".
- maxPageSize - the maximum page size that can be set on requests to the server. The default value is 1000.
- metadataServerEndpointConfig - the endpoint used to connect to the Metadata server.
- ViewServicesConfig - configuration of the view services
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String VERSION_ONE

Fields
Modifier and Type	Field and Description
`static String`	`VERSION_ONE`

Constructor Summary

Constructors
Constructor and Description

UIServerConfig()
Default constructor.

UIServerConfig(UIServerConfig template)
Copy/clone constructor.

Constructors
Constructor and Description
`UIServerConfig()` Default constructor.
`UIServerConfig(UIServerConfig 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<Connection>`	`getAuditLogConnections()` Return the Connection properties used to create an OCF Connector to the AuditLog.
`List<String>`	`getAuditTrail()` Return the list of audit log entries associated with this config file.
`String`	`getAuthenticationSource()` Return the authentication source.
`String`	`getDescription()` Server description
`String`	`getLocalServerId()` Return the service name (the UI calls the services views).
`String`	`getLocalServerName()` Return the name of the ui server.
`String`	`getLocalServerPassword()` Return the password that the ui 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 ui server.
`String`	`getLocalServerUserId()` Return the userId that the ui 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`	`getMetadataServerName()` get the metadata server
`String`	`getMetadataServerURL()` The metadata server url
`String`	`getOrganizationName()` Return the name of the organization that is running the server.
`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.
`String`	`getServiceName()`
`String`	`getVersionId()` Return the versionId of this document.
`List<ViewServiceConfig>`	`getViewServiceConfigs()` Return the configuration for the registered view services.
`int`	`hashCode()` Return a hash code based on the values of this object.
`void`	`setAuditLogConnections(List<Connection> auditLogConnections)` Set up the Connection properties used to create an OCF Connector to the AuditLog.
`void`	`setAuditTrail(List<String> auditTrail)` Set up the audit log messages.
`void`	`setAuthenticationSource(String authenticationSource)` Set up the authentication source.
`void`	`setDescription(String description)` Set up server description
`void`	`setLocalServerId(String uiServerId)` Set up a unique identifier for this server.
`void`	`setLocalServerName(String uiServerName)` Set up the name of the ui server.
`void`	`setLocalServerPassword(String uiServerPassword)` Set up the password that the ui 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 uiServerURL)` Set up the base URL for calling the ui server.
`void`	`setLocalServerUserId(String uiServerUserId)` Set up the userId that the ui 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`	`setMetadataServerName(String metadataServerName)` Set up the localServerName for the metadata server.
`void`	`setMetadataServerURL(String metadataServerURL)` 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`	`setOrganizationName(String organizationName)` Set up the name of the organization that is running the server.
`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`	`setServiceName(String serviceName)` Set up the service name (the UI calls the services views).
`void`	`setVersionId(String versionId)` Set up the versionId of this document.
`void`	`setViewServiceConfigs(List<ViewServiceConfig> viewServiceConfigs)` Set up the configuration for the registered view 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
- Constructor Detail
  - UIServerConfig
```
public UIServerConfig()
```
    Default constructor.
  - UIServerConfig
```
public UIServerConfig(UIServerConfig 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
  - getServiceName
```
public String getServiceName()
```
  - setServiceName
```
public void setServiceName(String serviceName)
```
    Set up the service name (the UI calls the services views).
    
    Parameters:
    
    serviceName - name of the service
  - getLocalServerId
```
public String getLocalServerId()
```
    Return the service name (the UI calls the services views).
    
    Returns:
    
    string name of the service
  - setLocalServerId
```
public void setLocalServerId(String uiServerId)
```
    Set up a unique identifier for this server.
    
    Parameters:
    
    uiServerId - string guid
  - getLocalServerName
```
public String getLocalServerName()
```
    Return the name of the ui server.
    
    Returns:
    
    String server name
  - setLocalServerName
```
public void setLocalServerName(String uiServerName)
```
    Set up the name of the ui server.
    
    Parameters:
    
    uiServerName - String ui server name
  - 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 ui server.
    
    Returns:
    
    String URL
  - setLocalServerURL
```
public void setLocalServerURL(String uiServerURL)
```
    Set up the base URL for calling the ui server.
    
    Parameters:
    
    uiServerURL - String URL
  - getLocalServerUserId
```
public String getLocalServerUserId()
```
    Return the userId that the ui server should use when processing events and there is no external user driving the operation.
    
    Returns:
    
    user id
  - setLocalServerUserId
```
public void setLocalServerUserId(String uiServerUserId)
```
    Set up the userId that the ui server should use when processing events and there is no external user driving the operation.
    
    Parameters:
    
    uiServerUserId - string user id
  - getLocalServerPassword
```
public String getLocalServerPassword()
```
    Return the password that the ui server should use on outbound REST calls (this is the password for the localServerUserId). Using userIds and passwords for server authentication is not suitable for production environments.
    
    Returns:
    
    password in clear
  - setLocalServerPassword
```
public void setLocalServerPassword(String uiServerPassword)
```
    Set up the password that the ui server should use on outbound REST calls (this is the password for the localServerUserId). Using userIds and passwords for server authentication is not suitable for production environments.
    
    Parameters:
    
    uiServerPassword - 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
  - getMetadataServerName
```
public String getMetadataServerName()
```
    get the metadata server
    
    Returns:
    
    metadata server name
  - setMetadataServerName
```
public void setMetadataServerName(String metadataServerName)
```
    Set up the localServerName for the metadata server.
    
    Parameters:
    
    metadataServerName - metadata server name
  - getMetadataServerURL
```
public String getMetadataServerURL()
```
    The metadata server url
    
    Returns:
    
    metadata server URL
  - setMetadataServerURL
```
public void setMetadataServerURL(String metadataServerURL)
```
    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:
    
    metadataServerURL - connection bean
  - 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
  - getAuthenticationSource
```
public String getAuthenticationSource()
```
    Return the authentication source. The valid values are
    - db - to use the h2 database
    - ldap - to use LDAP
    Any configuration information associated with the specified authentication source should be supplied in UserStoreConfig.
    Returns:
    
    String the name of the authentication source
  - setAuthenticationSource
```
public void setAuthenticationSource(String authenticationSource)
```
    Set up the authentication source. The valid values are
    - db - to use the h2 database
    - ldap - to use LDAP
    Any configuration information associated with the specified authentication source should be supplied in UserStoreConfig.
    Parameters:
    
    authenticationSource - the name of the authentication source
  - getDescription
```
public String getDescription()
```
    Server description
    
    Returns:
    
    server description
  - setDescription
```
public void setDescription(String description)
```
    Set up server description
    
    Parameters:
    
    description - String description
  - getAuditLogConnections
```
public List<Connection> getAuditLogConnections()
```
    Return the Connection properties used to create an OCF Connector to the AuditLog.
    
    Returns:
    
    Connection object
  - setAuditLogConnections
```
public void setAuditLogConnections(List<Connection> auditLogConnections)
```
    Set up the Connection properties used to create an OCF Connector to the AuditLog.
    
    Parameters:
    
    auditLogConnections - list of Connection objects
  - getViewServiceConfigs
```
public List<ViewServiceConfig> getViewServiceConfigs()
```
    Return the configuration for the registered view services.
    
    Returns:
    
    array of configuration properties one for each view service.
  - setViewServiceConfigs
```
public void setViewServiceConfigs(List<ViewServiceConfig> viewServiceConfigs)
```
    Set up the configuration for the registered view services.
    
    Parameters:
    
    viewServiceConfigs - array of configuration properties one for each view service
  - 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 UIServerConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VERSION_ONE

Constructor Detail

UIServerConfig

UIServerConfig

Method Detail

getVersionId

setVersionId

getServiceName

setServiceName

getLocalServerId

setLocalServerId

getLocalServerName

setLocalServerName

getOrganizationName

setOrganizationName

getLocalServerURL

setLocalServerURL

getLocalServerUserId

setLocalServerUserId

getLocalServerPassword

setLocalServerPassword

getMaxPageSize

setMaxPageSize

getServerSecurityConnection

setServerSecurityConnection

getMetadataServerName

setMetadataServerName

getMetadataServerURL

setMetadataServerURL

getLocalServerType

setLocalServerType

getAuthenticationSource

setAuthenticationSource

getDescription

setDescription

getAuditLogConnections

setAuditLogConnections

getViewServiceConfigs

setViewServiceConfigs

getAuditTrail

setAuditTrail

toString

equals

hashCode