Package org.odpi.openmetadata.platformservices.server

Class OMAGServerPlatformOperationalServices

java.lang.Object

org.odpi.openmetadata.platformservices.server.OMAGServerPlatformOperationalServices

public class OMAGServerPlatformOperationalServices
extends Object

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

Constructor Summary

Constructors

Constructor	Description
OMAGServerPlatformOperationalServices()

Method Summary

Modifier and Type	Method	Description
VoidResponse	shutdownAllServers(String userId)	Temporarily deactivate any open metadata and governance services for all running servers.
VoidResponse	shutdownAndUnregisterAllServers(String userId)	Terminate any running open metadata and governance services, remove the server from any open metadata cohorts and delete the server's configuration.
VoidResponse	shutdownPlatform(String userId)	Terminate this platform.

Methods inherited from class java.lang.Object

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

Constructor Details

OMAGServerPlatformOperationalServices

public OMAGServerPlatformOperationalServices()

Method Details

shutdownAllServers

public VoidResponse shutdownAllServers(String userId)

Temporarily deactivate any open metadata and governance services for all running servers.

Parameters:

userId - user that is issuing the request

Returns:

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

shutdownAndUnregisterAllServers

public VoidResponse shutdownAndUnregisterAllServers(String userId)

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

Returns:

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

shutdownPlatform

public VoidResponse shutdownPlatform(String userId)

Terminate this platform.

Parameters:

userId - user that is issuing the request

Returns:

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