org.odpi.openmetadata.adminservices

Class OMAGServerAdminForAccessServices

java.lang.Object

org.odpi.openmetadata.adminservices.OMAGServerAdminForAccessServices

public class OMAGServerAdminForAccessServices
extends Object

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

Constructor Summary

Constructors

Constructor and Description
OMAGServerAdminForAccessServices() Default constructor

Method Summary

Modifier and Type	Method and Description
VoidResponse	configureAccessService(String userId, String serverName, String serviceURLMarker, Map<String,Object> accessServiceOptions) Enable a single access service.
VoidResponse	disableAccessServices(String userId, String serverName) Disable the access services.
VoidResponse	enableAccessServices(String userId, String serverName, Map<String,Object> accessServiceOptions) Enable all access services that are installed into this server.
RegisteredOMAGServicesResponse	getConfiguredAccessServices(String userId, String serverName) Return the list of access services that are configured for this server.
VoidResponse	setAccessServicesConfig(String userId, String serverName, List<AccessServiceConfig> accessServicesConfig) Set up the configuration for all of the open metadata access services (OMASs).
VoidResponse	setEnterpriseAccessConfig(String userId, String serverName, EnterpriseAccessConfig enterpriseAccessConfig) Set up the configuration that controls the enterprise repository services.

Methods inherited from class java.lang.Object

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

Constructor Detail

OMAGServerAdminForAccessServices

public OMAGServerAdminForAccessServices()

Default constructor

Method Detail

getConfiguredAccessServices

public RegisteredOMAGServicesResponse getConfiguredAccessServices(String userId,
                                                                  String serverName)

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

Parameters:

userId - calling user

serverName - name of server

Returns:

list of access service descriptions

configureAccessService

public VoidResponse configureAccessService(String userId,
                                           String serverName,
                                           String serviceURLMarker,
                                           Map<String,Object> accessServiceOptions)

Enable a single access service.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

serviceURLMarker - access service name used in URL

accessServiceOptions - property name/value pairs used to configure the access services

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.

enableAccessServices

public VoidResponse enableAccessServices(String userId,
                                         String serverName,
                                         Map<String,Object> accessServiceOptions)

Enable all access services that are installed into this server. The configuration properties for each access service can be changed from their default using setAccessServicesConfig operation.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

accessServiceOptions - property name/value pairs used to configure the access services

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.

disableAccessServices

public VoidResponse disableAccessServices(String userId,
                                          String serverName)

Disable the access services. This removes all configuration for the access 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.

setAccessServicesConfig

public VoidResponse setAccessServicesConfig(String userId,
                                            String serverName,
                                            List<AccessServiceConfig> accessServicesConfig)

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

Parameters:

userId - user that is issuing the request.

serverName - local server name.

accessServicesConfig - list of configuration properties for each access service.

Returns:

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

setEnterpriseAccessConfig

public VoidResponse setEnterpriseAccessConfig(String userId,
                                              String serverName,
                                              EnterpriseAccessConfig enterpriseAccessConfig)

Set up the configuration that controls the enterprise repository services. These services are part of the Open Metadata Repository Services (OMRS). They provide federated queries and federated event notifications that cover metadata from the local repository plus any repositories connected via open metadata repository cohorts.

Parameters:

userId - user that is issuing the request

serverName - local server name

enterpriseAccessConfig - enterprise repository services configuration properties.

Returns:

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