Package org.odpi.openmetadata.adminservices.spring

Class OperationalServicesResource

java.lang.Object

org.odpi.openmetadata.adminservices.spring.OperationalServicesResource

@RestController
@RequestMapping("/open-metadata/admin-services/users/{userId}/servers/{serverName}")
public class OperationalServicesResource
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	Description
OperationalServicesResource()

Method Summary

Modifier and Type	Method	Description
SuccessMessageResponse	activateWithStoredConfig(String userId, String serverName)	Activate the Open Metadata and Governance (OMAG) server using the configuration document stored for this server.
SuccessMessageResponse	activateWithSuppliedConfig(String userId, String serverName, OMAGServerConfig configuration)	Activate the open metadata and governance services using the supplied configuration document.
VoidResponse	addOpenMetadataArchive(String userId, String serverName, Connection connection)	Add a new open metadata archive to running repository.
VoidResponse	addOpenMetadataArchiveFile(String userId, String serverName, String fileName)	Add a new open metadata archive to running repository.
VoidResponse	deactivatePermanently(String userId, String serverName)	Permanently deactivate any open metadata and governance services and unregister from any cohorts.
VoidResponse	deactivateTemporarily(String userId, String serverName)	Temporarily deactivate any open metadata and governance services.
OMAGServerConfigResponse	getActiveConfiguration(String userId, String serverName)	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

OperationalServicesResource

public OperationalServicesResource()

Method Detail

activateWithStoredConfig

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

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

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

@PostMapping(path="/instance/configuration")
public SuccessMessageResponse activateWithSuppliedConfig(@PathVariable
                                                         String userId,
                                                         @PathVariable
                                                         String serverName,
                                                         @RequestBody
                                                         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

@DeleteMapping(path="/instance")
public VoidResponse deactivateTemporarily(@PathVariable
                                          String userId,
                                          @PathVariable
                                          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

@DeleteMapping(path="")
public VoidResponse deactivatePermanently(@PathVariable
                                          String userId,
                                          @PathVariable
                                          String serverName)

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

Returns:

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

getActiveConfiguration

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

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

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.

addOpenMetadataArchiveFile

@PostMapping(path="/instance/open-metadata-archives/file")
public VoidResponse addOpenMetadataArchiveFile(@PathVariable
                                               String userId,
                                               @PathVariable
                                               String serverName,
                                               @RequestBody
                                               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.

addOpenMetadataArchive

@PostMapping(path="/instance/open-metadata-archives/connection")
public VoidResponse addOpenMetadataArchive(@PathVariable
                                           String userId,
                                           @PathVariable
                                           String serverName,
                                           @RequestBody
                                           Connection connection)

Add a new open metadata archive to running repository.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

connection - connection for the open metadata archive.

Returns:

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