org.odpi.openmetadata.adminservices.client

Class OMAGServerConfigurationClient

java.lang.Object

org.odpi.openmetadata.adminservices.client.OMAGServerConfigurationClient

Direct Known Subclasses:

DiscoveryServerConfigurationClient, MetadataAccessPointConfigurationClient, RepositoryProxyConfigurationClient, StewardshipServerConfigurationClient

public abstract class OMAGServerConfigurationClient
extends Object

OMAGServerConfigurationClient provides services to configure an OMAG Server. It is abstract because it is extended by the concrete types of server.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	adminUserId
protected InvalidParameterHandler	invalidParameterHandler
protected NullRequestBody	nullRequestBody
protected org.odpi.openmetadata.adminservices.client.AdminServicesRESTClient	restClient
protected String	serverName
protected String	serverPlatformRootURL

Method Summary

Modifier and Type	Method and Description
void	addAuditLogDestination(Connection connection) Add an audit log destination that is defined by the supplied connection object.
void	addConsoleAuditLogDestination(List<String> supportedSeverities) Set up the console audit log for the server.
void	addEventTopicAuditLogDestination(List<String> supportedSeverities) Add an audit log destination that sends each log record as an event on the supplied event topic.
void	addFileAuditLogDestination(List<String> supportedSeverities) Add an audit log destination that creates log records as JSON files in a shared directory.
void	addSLF4JAuditLogDestination(List<String> supportedSeverities) Add an audit log destination that creates slf4j records.
void	clearAuditLogDestinations() Clears all audit log destinations for this server.
void	clearServerSecurityConnection() Clear the connection object for the server security connection which means the server does no authorization checks when a request is made to this server.
void	deployOMAGServerConfig(String destinationPlatformURLRoot) Push the configuration for the server to another OMAG Server Platform.
OMAGServerConfig	getOMAGServerConfig() Return the complete set of configuration properties in use by the server.
ServerTypeClassificationSummary	getServerClassification() Return the derived server type that is classified based on the configuration values.
Connection	getServerSecurityConnection() Return the connection object for the server security connector.
void	setDefaultAuditLog() Set up the default audit log for the server.
void	setEventBus(String connectorProvider, String topicURLRoot, Map<String,Object> configurationProperties) Set up the default event bus for embedding in event-driven connector.
void	setMaxPageSize(int maxPageSize) Set an upper limit in the page size that can be requested on a REST call to the server.
void	setOMAGServerConfig(OMAGServerConfig serverConfig) Set up the configuration properties for an OMAG Server in a single command.
void	setOrganizationName(String organizationName) Set up the name of the organization that is running this server.
void	setServerPassword(String serverPassword) Set up the password to use in the header of HTTP requests with the server's userId.
void	setServerSecurityConnection(Connection connection) Override the default server security connector.
void	setServerType(String serverType) Set up the descriptive type of the server.
void	setServerURLRoot(String serverURLRoot) Set up the root URL for this server that is used to construct full URL paths to calls for this server's REST interfaces.
void	setServerUserId(String serverUserId) Set up the user id to use when there is no external user driving the work (for example when processing events from another server).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

adminUserId

protected String adminUserId

serverName

protected String serverName

serverPlatformRootURL

protected String serverPlatformRootURL

invalidParameterHandler

protected InvalidParameterHandler invalidParameterHandler

restClient

protected org.odpi.openmetadata.adminservices.client.AdminServicesRESTClient restClient

nullRequestBody

protected NullRequestBody nullRequestBody

Method Detail

getServerClassification

public ServerTypeClassificationSummary getServerClassification()
                                                        throws OMAGNotAuthorizedException,
                                                               OMAGInvalidParameterException,
                                                               OMAGConfigurationErrorException

Return the derived server type that is classified based on the configuration values.

Returns:

server classification description

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setServerURLRoot

public void setServerURLRoot(String serverURLRoot)
                      throws OMAGNotAuthorizedException,
                             OMAGInvalidParameterException,
                             OMAGConfigurationErrorException

Set up the root URL for this server that is used to construct full URL paths to calls for this server's REST interfaces. Typically this is the URL root of the OMAG Server Platform Where the server is deployed to. However it may be a DNS name - particularly if the server is deployed to multiple platforms for high availability (HA). The default value is "https://localhost:9443".

Parameters:

serverURLRoot - String url.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setEventBus

public void setEventBus(String connectorProvider,
                        String topicURLRoot,
                        Map<String,Object> configurationProperties)
                 throws OMAGNotAuthorizedException,
                        OMAGInvalidParameterException,
                        OMAGConfigurationErrorException

Set up the default event bus for embedding in event-driven connector. The resulting connector will be used in the OMRS Topic Connector for each cohort, the in and out topics for each Access Service and the local repositories event mapper.

Parameters:

connectorProvider - connector provider for the event bus (if it is null then Kafka is assumed).

topicURLRoot - the common root of the topics used by the open metadata server.

configurationProperties - property name/value pairs used to configure the connection to the event bus connector

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setServerType

public void setServerType(String serverType)
                   throws OMAGNotAuthorizedException,
                          OMAGInvalidParameterException,
                          OMAGConfigurationErrorException

Set up the descriptive type of the server. This value is added to distributed events to make it easier to understand the source of events. The default value is derived from the type of server that is being configured. If this method is called, it overrides the default value.

Parameters:

serverType - short description for the type of server.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setOrganizationName

public void setOrganizationName(String organizationName)
                         throws OMAGNotAuthorizedException,
                                OMAGInvalidParameterException,
                                OMAGConfigurationErrorException

Set up the name of the organization that is running this server. This value is added to distributed events to make it easier to understand the source of events. The default value is null.

Parameters:

organizationName - String name of the organization.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setServerUserId

public void setServerUserId(String serverUserId)
                     throws OMAGNotAuthorizedException,
                            OMAGInvalidParameterException,
                            OMAGConfigurationErrorException

Set up the user id to use when there is no external user driving the work (for example when processing events from another server). It is also used in the header of HTTP requests if the password is also set.

Parameters:

serverUserId - String user that the server will use on connections and requests not associated with an end user.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setServerPassword

public void setServerPassword(String serverPassword)
                       throws OMAGNotAuthorizedException,
                              OMAGInvalidParameterException,
                              OMAGConfigurationErrorException

Set up the password to use in the header of HTTP requests with the server's userId.

Parameters:

serverPassword - String password that the server will use on connections.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setMaxPageSize

public void setMaxPageSize(int maxPageSize)
                    throws OMAGNotAuthorizedException,
                           OMAGInvalidParameterException,
                           OMAGConfigurationErrorException

Set an upper limit in the page size that can be requested on a REST call to the server. The default value is 1000. The value is validated server side.

Parameters:

maxPageSize - max number of elements that can be returned on a request.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setDefaultAuditLog

public void setDefaultAuditLog()
                        throws OMAGNotAuthorizedException,
                               OMAGInvalidParameterException,
                               OMAGConfigurationErrorException

Set up the default audit log for the server. This adds the console audit log destination.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

addConsoleAuditLogDestination

public void addConsoleAuditLogDestination(List<String> supportedSeverities)
                                   throws OMAGNotAuthorizedException,
                                          OMAGInvalidParameterException,
                                          OMAGConfigurationErrorException

Set up the console audit log for the server. This writes selected parts of the audit log record to stdout.

Parameters:

supportedSeverities - list of severities that should be logged to this destination (empty list means all)

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

addSLF4JAuditLogDestination

public void addSLF4JAuditLogDestination(List<String> supportedSeverities)
                                 throws OMAGNotAuthorizedException,
                                        OMAGInvalidParameterException,
                                        OMAGConfigurationErrorException

Add an audit log destination that creates slf4j records.

Parameters:

supportedSeverities - list of severities that should be logged to this destination (empty list means all)

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

addFileAuditLogDestination

public void addFileAuditLogDestination(List<String> supportedSeverities)
                                throws OMAGNotAuthorizedException,
                                       OMAGInvalidParameterException,
                                       OMAGConfigurationErrorException

Add an audit log destination that creates log records as JSON files in a shared directory.

Parameters:

supportedSeverities - list of severities that should be logged to this destination (empty list means all)

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

addEventTopicAuditLogDestination

public void addEventTopicAuditLogDestination(List<String> supportedSeverities)
                                      throws OMAGNotAuthorizedException,
                                             OMAGInvalidParameterException,
                                             OMAGConfigurationErrorException

Add an audit log destination that sends each log record as an event on the supplied event topic.

Parameters:

supportedSeverities - list of severities that should be logged to this destination (empty list means all)

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

addAuditLogDestination

public void addAuditLogDestination(Connection connection)
                            throws OMAGNotAuthorizedException,
                                   OMAGInvalidParameterException,
                                   OMAGConfigurationErrorException

Add an audit log destination that is defined by the supplied connection object.

Parameters:

connection - connection object that defines the audit log destination

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

clearAuditLogDestinations

public void clearAuditLogDestinations()
                               throws OMAGNotAuthorizedException,
                                      OMAGInvalidParameterException,
                                      OMAGConfigurationErrorException

Clears all audit log destinations for this server.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setServerSecurityConnection

public void setServerSecurityConnection(Connection connection)
                                 throws OMAGNotAuthorizedException,
                                        OMAGInvalidParameterException,
                                        OMAGConfigurationErrorException

Override the default server security connector.

Parameters:

connection - connection object that defines the server security connector

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

clearServerSecurityConnection

public void clearServerSecurityConnection()
                                   throws OMAGNotAuthorizedException,
                                          OMAGInvalidParameterException,
                                          OMAGConfigurationErrorException

Clear the connection object for the server security connection which means the server does no authorization checks when a request is made to this server.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

getServerSecurityConnection

public Connection getServerSecurityConnection()
                                       throws OMAGNotAuthorizedException,
                                              OMAGInvalidParameterException,
                                              OMAGConfigurationErrorException

Return the connection object for the server security connector. Null is returned if the server does not have a server security connection.

Returns:

server security connection

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setOMAGServerConfig

public void setOMAGServerConfig(OMAGServerConfig serverConfig)
                         throws OMAGNotAuthorizedException,
                                OMAGConfigurationErrorException,
                                OMAGInvalidParameterException

Set up the configuration properties for an OMAG Server in a single command.

Parameters:

serverConfig - configuration for the server

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

deployOMAGServerConfig

public void deployOMAGServerConfig(String destinationPlatformURLRoot)
                            throws OMAGNotAuthorizedException,
                                   OMAGConfigurationErrorException,
                                   OMAGInvalidParameterException

Push the configuration for the server to another OMAG Server Platform.

Parameters:

destinationPlatformURLRoot - location of the platform where the config is to be deployed to

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

getOMAGServerConfig

public OMAGServerConfig getOMAGServerConfig()
                                     throws OMAGNotAuthorizedException,
                                            OMAGInvalidParameterException,
                                            OMAGConfigurationErrorException

Return the complete set of configuration properties in use by the server.

Returns:

OMAGServerConfig properties

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.