org.odpi.openmetadata.viewservices.serverauthor.server.spring

Class OperationalServicesViewResource

java.lang.Object

org.odpi.openmetadata.viewservices.serverauthor.server.spring.OperationalServicesViewResource

@RestController
 @RequestMapping(value="/servers/{serverName}/open-metadata/view-services/server-author/users/{userId}/servers/{serverToBeConfiguredName}")
public class OperationalServicesViewResource
extends Object

OperationalServicesResource provides the REST API for controlling the start up, management and shutdown of services in the OMAG Server.

Constructor Summary

Constructors

Constructor and Description
OperationalServicesViewResource()

Method Summary

Modifier and Type	Method and Description
ServerAuthorConfigurationResponse	activateWithStoredConfig(String userId, String serverName, String destinationPlatformName, String serverToBeConfiguredName) Activate the Open Metadata and Governance (OMAG) server using the configuration document stored for this server.
SuccessMessageResponse	deactivatePermanently(String userId, String serverName, String destinationPlatformName, String serverToBeConfiguredName) Permanently deactivate any open metadata and governance services and unregister from any cohorts.
ServerAuthorConfigurationResponse	deactivateTemporarily(String userId, String serverName, String destinationPlatformName, String serverToBeConfiguredName) Temporarily deactivate any open metadata and governance services.
ServerAuthorConfigurationResponse	getActiveConfiguration(String userId, String serverName, String destinationPlatformName, String serverToBeConfiguredName) Return the configuration used for the current active instance of the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

OperationalServicesViewResource

public OperationalServicesViewResource()

Method Detail

activateWithStoredConfig

@PostMapping(path="/instance")
public ServerAuthorConfigurationResponse activateWithStoredConfig(@PathVariable
                                                                                                 String userId,
                                                                                                 @PathVariable
                                                                                                 String serverName,
                                                                                                 @PathVariable
                                                                                                 String destinationPlatformName,
                                                                                                 @PathVariable
                                                                                                 String serverToBeConfiguredName)

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

Parameters:

userId - user that is issuing the request

serverName - local server name

destinationPlatformName - Name of the platform where the server lives

serverToBeConfiguredName - name of the server to be configured.

Returns:

the current stored configuration 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

@DeleteMapping(path="/instance")
public ServerAuthorConfigurationResponse deactivateTemporarily(@PathVariable
                                                                                                String userId,
                                                                                                @PathVariable
                                                                                                String serverName,
                                                                                                @PathVariable
                                                                                                String destinationPlatformName,
                                                                                                @PathVariable
                                                                                                String serverToBeConfiguredName)

Temporarily deactivate any open metadata and governance services.

Parameters:

userId - user that is issuing the request

serverName - local server name

destinationPlatformName - Name of the platform where the server lives

serverToBeConfiguredName - name of the server to be configured.

Returns:

the current stored configuration or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException the serverName is invalid.

deactivatePermanently

@DeleteMapping(path="")
public SuccessMessageResponse deactivatePermanently(@PathVariable
                                                                            String userId,
                                                                            @PathVariable
                                                                            String serverName,
                                                                            @PathVariable
                                                                            String destinationPlatformName,
                                                                            @PathVariable
                                                                            String serverToBeConfiguredName)

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

Parameters:

userId - user that is issuing the request

serverName - local server name

destinationPlatformName - Name of the platform where the server lives

serverToBeConfiguredName - name of the server to be configured.

Returns:

the current stored configuration or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException the serverName is invalid.

getActiveConfiguration

@GetMapping(path="/instance/configuration")
public ServerAuthorConfigurationResponse getActiveConfiguration(@PathVariable
                                                                                                            String userId,
                                                                                                            @PathVariable
                                                                                                            String serverName,
                                                                                                            @PathVariable
                                                                                                            String destinationPlatformName,
                                                                                                            @PathVariable
                                                                                                            String serverToBeConfiguredName)

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

Parameters:

userId - user that is issuing the request

serverName - local server name

destinationPlatformName - Name of the platform where the server lives

serverToBeConfiguredName - name of the server to be configured.

Returns:

configuration properties used to initialize the server or null if not running 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.