Package org.odpi.openmetadata.adminservices.server

Class OMAGServerAdminForAccessServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.adminservices.server.OMAGServerAdminForAccessServices
public class OMAGServerAdminForAccessServices extends TokenController
OMAGServerAdminForAccessServices provides the server-side support for the services that add access services configuration to an OMAG Server.

  • Constructor Details

    • OMAGServerAdminForAccessServices

      public OMAGServerAdminForAccessServices()
      Default constructor

  • Method Details

    • getConfiguredAccessServices

      public RegisteredOMAGServicesResponse getConfiguredAccessServices(String serverName)
      Return the list of access services that are configured for this server.
      Parameters:
      serverName - name of server
      Returns:
      list of access service descriptions

    • getAccessServicesConfiguration

      public AccessServicesResponse getAccessServicesConfiguration(String serverName)
      Return the list of access services that are configured for this server.
      Parameters:
      serverName - name of server
      Returns:
      list of access service configurations

    • configureAccessService

      public VoidResponse configureAccessService(String serverName, String serviceURLMarker, Map<String,Object> accessServiceOptions)
      Enable a single access service. If the enterprise repository services are not set up, they are enabled If openMetadataOutTopic is null, a default connection for this topic is created. It can be removed using clearOpenMetadataOutTopic.
      Parameters:
      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 UserNotAuthorizedException the supplied user is not authorized to issue this command or OMAGConfigurationErrorException the event bus has not been configured or InvalidParameterException invalid serverName parameter.

    • configureAllAccessServices

      public VoidResponse configureAllAccessServices(String serverName, Map<String,Object> accessServiceOptions)
      Enable all access services that are registered with this server platform. The configuration properties for each access service can be changed from their default using setAccessServicesConfig operation.
      Parameters:
      serverName - local server name.
      accessServiceOptions - property name/value pairs used to configure the access services
      Returns:
      void response or UserNotAuthorizedException the supplied user is not authorized to issue this command or OMAGConfigurationErrorException the event bus has not been configured or InvalidParameterException invalid serverName parameter.

    • configureAccessServiceNoTopics

      public VoidResponse configureAccessServiceNoTopics(String serverName, String serviceURLMarker, Map<String,Object> accessServiceOptions)
      Enable a single access service. This version of the call does not set up the InTopic nor the OutTopic.
      Parameters:
      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 UserNotAuthorizedException the supplied user is not authorized to issue this command or OMAGConfigurationErrorException the event bus has not been configured or InvalidParameterException invalid serverName parameter.

    • configureAllAccessServicesNoTopics

      public VoidResponse configureAllAccessServicesNoTopics(String serverName, Map<String,Object> accessServiceOptions)
      Enable all access services that are registered with this server platform. The configuration properties for each access service can be changed from their default using setAccessServicesConfig operation. This version of the call does not set up the InTopic nor the OutTopic.
      Parameters:
      serverName - local server name.
      accessServiceOptions - property name/value pairs used to configure the access services
      Returns:
      void response or UserNotAuthorizedException the supplied user is not authorized to issue this command or OMAGConfigurationErrorException the event bus has not been configured or InvalidParameterException invalid serverName parameter.

    • clearAllAccessServices

      public VoidResponse clearAllAccessServices(String serverName)
      Disable the access services. This removes all configuration for the access services and disables the enterprise repository services.
      Parameters:
      serverName - local server name.
      Returns:
      void response or UserNotAuthorizedException the supplied user is not authorized to issue this command or InvalidParameterException invalid serverName parameter.

    • getAccessServiceConfig

      public AccessServiceConfigResponse getAccessServiceConfig(String serverName, String serviceURLMarker)
      Retrieve the config for an access service.
      Parameters:
      serverName - local server name.
      serviceURLMarker - access service name used in URL
      Returns:
      void response or UserNotAuthorizedException the supplied user is not authorized to issue this command or InvalidParameterException invalid serverName parameter.

    • clearAccessService

      public VoidResponse clearAccessService(String serverName, String serviceURLMarker)
      Remove an access service. This removes all configuration for the access service.
      Parameters:
      serverName - local server name.
      serviceURLMarker - access service name used in URL
      Returns:
      void response or UserNotAuthorizedException the supplied user is not authorized to issue this command or InvalidParameterException invalid serverName parameter.

    • getAccessServiceTopicNames

      public StringMapResponse getAccessServiceTopicNames(String serverName, String serviceURLMarker)
      Retrieve the topic names for this access service
      Parameters:
      serverName - local server name.
      serviceURLMarker - string indicating which access service it requested
      Returns:
      map of topic names or UserNotAuthorizedException the supplied user is not authorized to issue this command or InvalidParameterException invalid serverName or accessServicesConfig parameter.

    • getAllAccessServiceTopicNames

      public StringMapResponse getAllAccessServiceTopicNames(String serverName)
      Retrieve the topic names for all configured access services
      Parameters:
      serverName - local server name.
      Returns:
      map of topic names or UserNotAuthorizedException the supplied user is not authorized to issue this command or InvalidParameterException invalid serverName or accessServicesConfig parameter.

    • overrideAccessServiceOutTopicName

      public VoidResponse overrideAccessServiceOutTopicName(String serverName, String serviceURLMarker, String topicName)
      Update the out topic name for a specific access service.
      Parameters:
      serverName - local server name.
      serviceURLMarker - string indicating which access service it requested
      topicName - string for new topic name
      Returns:
      map of topic names or UserNotAuthorizedException the supplied user is not authorized to issue this command or InvalidParameterException invalid serverName or accessServicesConfig parameter.

    • setAccessServicesConfig

      public VoidResponse setAccessServicesConfig(String serverName, List<AccessServiceConfig> accessServicesConfig)
      Set up the configuration for all the open metadata access services (OMASs). This overrides the current values.
      Parameters:
      serverName - local server name.
      accessServicesConfig - list of configuration properties for each access service.
      Returns:
      void response or UserNotAuthorizedException the supplied user is not authorized to issue this command or InvalidParameterException invalid serverName or accessServicesConfig parameter.

    • addRemoteEnterpriseTopic

      public VoidResponse addRemoteEnterpriseTopic(String serverName, Map<String,Object> configurationProperties)
      Set up the default remote enterprise topic. This allows a remote process to monitor enterprise topic events.
      Parameters:
      serverName - local server name.
      configurationProperties - additional properties for the cohort
      Returns:
      void response or UserNotAuthorizedException the supplied user is not authorized to issue this command or InvalidParameterException invalid serverName parameter.

    • setEnterpriseAccessConfig

      public VoidResponse setEnterpriseAccessConfig(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:
      serverName - local server name
      enterpriseAccessConfig - enterprise repository services configuration properties.
      Returns:
      void response or UserNotAuthorizedException the supplied user is not authorized to issue this command or InvalidParameterException invalid serverName or enterpriseAccessConfig parameter.