Package org.odpi.openmetadata.adminservices.client

Class OMAGServerOperationsClient

java.lang.Object

org.odpi.openmetadata.adminservices.client.OMAGServerOperationsClient

public class OMAGServerOperationsClient
extends Object

OMAGServerOperationsClient provides services to start and stop an OMAG Server.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
OMAGServerOperationsClient(String adminUserId, String serverName, String serverPlatformRootURL)	Create a new client with no authentication embedded in the HTTP request.
OMAGServerOperationsClient(String adminUserId, String serverName, String serverPlatformRootURL, String connectionUserId, String connectionPassword)	Create a new client that passes a connection userId and password in each HTTP request.

Method Summary

Modifier and Type	Method	Description
String	activateWithStoredConfig()	Activate the Open Metadata and Governance (OMAG) server using the configuration document stored for this server.
String	activateWithSuppliedConfig(OMAGServerConfig configuration)	Activate the open metadata and governance services using the supplied configuration document.
void	addOpenMetadataArchive(Connection connection)	Add a new open metadata archive to running repository.
void	addOpenMetadataArchiveFile(String fileName)	Add a new open metadata archive to running repository.
void	deactivatePermanently()	Permanently deactivate any open metadata and governance services and unregister from any cohorts.
void	deactivateTemporarily()	Temporarily deactivate any open metadata and governance services.
OMAGServerConfig	getActiveConfiguration()	Return the configuration used for the current active instance of the server.
ServerServicesStatus	getServerStatus()	Return the status of a running server (use platform services to find out if the server is running).

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

Constructor Detail

OMAGServerOperationsClient

public OMAGServerOperationsClient(String adminUserId,
                                  String serverName,
                                  String serverPlatformRootURL)
                           throws OMAGInvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

adminUserId - administrator's (end user's) userId to associate with calls.

serverName - name of the server to connect to

serverPlatformRootURL - the network address of the server running the admin services

Throws:

OMAGInvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

OMAGServerOperationsClient

public OMAGServerOperationsClient(String adminUserId,
                                  String serverName,
                                  String serverPlatformRootURL,
                                  String connectionUserId,
                                  String connectionPassword)
                           throws OMAGInvalidParameterException

Create a new client that passes a connection userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is passed as the admin userId.

Parameters:

adminUserId - administrator's (end user's) userId to associate with calls.

serverName - name of the server to connect to

serverPlatformRootURL - the network address of the server running the admin services

connectionUserId - caller's system userId embedded in all HTTP requests

connectionPassword - caller's system password embedded in all HTTP requests

Throws:

OMAGInvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Detail

activateWithStoredConfig

public String activateWithStoredConfig()
                                throws OMAGNotAuthorizedException,
                                       OMAGInvalidParameterException,
                                       OMAGConfigurationErrorException

Activate the Open Metadata and Governance (OMAG) server using the configuration document stored for this server.

Returns:

success message

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

activateWithSuppliedConfig

public String activateWithSuppliedConfig(OMAGServerConfig configuration)
                                  throws OMAGNotAuthorizedException,
                                         OMAGInvalidParameterException,
                                         OMAGConfigurationErrorException

Activate the open metadata and governance services using the supplied configuration document.

Parameters:

configuration - properties used to initialize the services

Returns:

success message

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

deactivateTemporarily

public void deactivateTemporarily()
                           throws OMAGNotAuthorizedException,
                                  OMAGInvalidParameterException,
                                  OMAGConfigurationErrorException

Temporarily deactivate any open metadata and governance services.

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

deactivatePermanently

public void deactivatePermanently()
                           throws OMAGNotAuthorizedException,
                                  OMAGInvalidParameterException,
                                  OMAGConfigurationErrorException

Permanently deactivate any open metadata and governance services and unregister from any cohorts.

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

getActiveConfiguration

public OMAGServerConfig getActiveConfiguration()
                                        throws OMAGNotAuthorizedException,
                                               OMAGInvalidParameterException,
                                               OMAGConfigurationErrorException

Return the configuration used for the current active instance of the server. Null is returned if the server instance is not running.

Returns:

configuration properties used to initialize the server or null if not running

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

getServerStatus

public ServerServicesStatus getServerStatus()
                                     throws OMAGNotAuthorizedException,
                                            OMAGInvalidParameterException,
                                            OMAGConfigurationErrorException

Return the status of a running server (use platform services to find out if the server is running).

Returns:

status of the server

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

addOpenMetadataArchiveFile

public void addOpenMetadataArchiveFile(String fileName)
                                throws OMAGNotAuthorizedException,
                                       OMAGInvalidParameterException,
                                       OMAGConfigurationErrorException

Add a new open metadata archive to running repository.

Parameters:

fileName - name of the open metadata archive file.

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

addOpenMetadataArchive

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

Add a new open metadata archive to running repository.

Parameters:

connection - connection for the open metadata archive.

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.