org.odpi.openmetadata.adminservices

Class OMAGServerAdminForViewServices

java.lang.Object

org.odpi.openmetadata.adminservices.OMAGServerAdminForViewServices

public class OMAGServerAdminForViewServices
extends Object

OMAGServerAdminForViewServices provides the server-side support for the services that add view services configuration to an OMAG Server.

Constructor Summary

Constructors

Constructor and Description
OMAGServerAdminForViewServices() Default constructor

Method Summary

Modifier and Type	Method and Description
VoidResponse	clearAllViewServices(String userId, String serverName) Disable the view services.
VoidResponse	clearViewService(String userId, String serverName, String serviceURLMarker) Remove a view service.
VoidResponse	configureAllViewServices(String userId, String serverName, ViewServiceConfig requestedViewServiceConfig) Enable all view services that are registered with this server platform.
VoidResponse	configureViewService(String userId, String serverName, String serviceURLMarker, ViewServiceConfig requestedViewServiceConfig) Configure a single view service.
RegisteredOMAGServicesResponse	getConfiguredViewServices(String userId, String serverName) Return the list of view services that are configured for this server.
ViewServiceConfigResponse	getViewServiceConfig(String userId, String serverName, String serviceURLMarker) Return the configuration of a single view service
ViewServicesResponse	getViewServicesConfiguration(String userId, String serverName) Return the view services configuration for this server.
VoidResponse	setViewServicesConfig(String userId, String serverName, List<ViewServiceConfig> viewServicesConfig) Set up the configuration for all of the open metadata view services (OMASs).

Methods inherited from class java.lang.Object

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

Constructor Detail

OMAGServerAdminForViewServices

public OMAGServerAdminForViewServices()

Default constructor

Method Detail

getConfiguredViewServices

public RegisteredOMAGServicesResponse getConfiguredViewServices(String userId,
                                                                String serverName)

Return the list of view services that are configured for this server.

Parameters:

userId - calling user

serverName - name of server

Returns:

list of view service descriptions

getViewServicesConfiguration

public ViewServicesResponse getViewServicesConfiguration(String userId,
                                                         String serverName)

Return the view services configuration for this server.

Parameters:

userId - calling user

serverName - name of server

Returns:

view services response

getViewServiceConfig

public ViewServiceConfigResponse getViewServiceConfig(String userId,
                                                      String serverName,
                                                      String serviceURLMarker)

Return the configuration of a single view service

Parameters:

userId - calling user

serverName - name of server

serviceURLMarker - server URL marker identifying the view service

Returns:

view services response

configureViewService

public VoidResponse configureViewService(String userId,
                                         String serverName,
                                         String serviceURLMarker,
                                         ViewServiceConfig requestedViewServiceConfig)

Configure a single view service.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

serviceURLMarker - view service name used in URL

requestedViewServiceConfig - view service config

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException the event bus has not been configured or OMAGInvalidParameterException invalid serverName parameter.

configureAllViewServices

public VoidResponse configureAllViewServices(String userId,
                                             String serverName,
                                             ViewServiceConfig requestedViewServiceConfig)

Enable all view services that are registered with this server platform. The configuration properties for each view service can be changed from their default using setViewServicesConfig operation.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

requestedViewServiceConfig - requested View Service Config containing the OMAGServerName and OMAGServerRootPlatformURL

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException the event bus has not been configured or OMAGInvalidParameterException invalid serverName parameter.

clearViewService

public VoidResponse clearViewService(String userId,
                                     String serverName,
                                     String serviceURLMarker)

Remove a view service. This removes all configuration for the view service.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

serviceURLMarker - view service name used in URL

Returns:

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

clearAllViewServices

public VoidResponse clearAllViewServices(String userId,
                                         String serverName)

Disable the view services. This removes all configuration for the view services and disables the enterprise repository 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 invalid serverName parameter.

setViewServicesConfig

public VoidResponse setViewServicesConfig(String userId,
                                          String serverName,
                                          List<ViewServiceConfig> viewServicesConfig)

Set up the configuration for all of the open metadata view services (OMASs). This overrides the current values.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

viewServicesConfig - list of configuration properties for each view service.

Returns:

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