org.odpi.openmetadata.adminservices

Class OMAGServerOperationalServices

java.lang.Object

org.odpi.openmetadata.adminservices.OMAGServerOperationalServices

public class OMAGServerOperationalServices
extends Object

OMAGServerOperationalServices will provide support to start, manage and stop services in the OMAG Server.

Constructor Summary

Constructors

Constructor and Description
OMAGServerOperationalServices()

Method Summary

Modifier and Type	Method and Description
SuccessMessageResponse	activateWithStoredConfig(String userId, String serverName) Activate the open metadata and governance services using the stored configuration information.
SuccessMessageResponse	activateWithSuppliedConfig(String userId, String serverName, OMAGServerConfig configuration) Activate the open metadata and governance services using the supplied configuration document.
VoidResponse	addOpenMetadataArchiveFile(String userId, String serverName, String fileName) Add a new open metadata archive to running repository.
VoidResponse	deactivatePermanently(String userId, String serverName) Terminate any running open metadata and governance services, remove the server from any open metadata cohorts and delete the server's configuration.
VoidResponse	deactivateTemporarily(String userId, String serverName) Temporarily deactivate any open metadata and governance services.
OMAGServerConfigResponse	getActiveConfiguration(String userId, String serverName) Return the complete set of configuration properties in use by the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

OMAGServerOperationalServices

public OMAGServerOperationalServices()

Method Detail

activateWithStoredConfig

public SuccessMessageResponse activateWithStoredConfig(String userId,
                                                       String serverName)

Activate the open metadata and governance services using the stored configuration information.

Parameters:

userId - user that is issuing the request

serverName - local server name

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException the server name is invalid or OMAGConfigurationErrorException there is a problem using the supplied configuration.

activateWithSuppliedConfig

public SuccessMessageResponse activateWithSuppliedConfig(String userId,
                                                         String serverName,
                                                         OMAGServerConfig configuration)

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

Parameters:

userId - user that is issuing the request

configuration - properties used to initialize the services

serverName - local server name

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException the server name is invalid or OMAGConfigurationErrorException there is a problem using the supplied configuration.

deactivateTemporarily

public VoidResponse deactivateTemporarily(String userId,
                                          String serverName)

Temporarily deactivate any open metadata and governance services.

Parameters:

userId - user that is issuing the request

serverName - local server name

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException the serverName is invalid.

deactivatePermanently

public VoidResponse deactivatePermanently(String userId,
                                          String serverName)

Terminate any running open metadata and governance services, remove the server from any open metadata cohorts and delete the server's configuration.

Parameters:

userId - user that is issuing the request

serverName - local server name

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException the serverName is invalid.

getActiveConfiguration

public OMAGServerConfigResponse getActiveConfiguration(String userId,
                                                       String serverName)

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

Parameters:

userId - user that is issuing the request

serverName - local server name

Returns:

OMAGServerConfig properties or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName parameter.

addOpenMetadataArchiveFile

public VoidResponse addOpenMetadataArchiveFile(String userId,
                                               String serverName,
                                               String fileName)

Add a new open metadata archive to running repository.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

fileName - name of the open metadata archive file.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or fileName parameter.