Class OMAGServerAdminForViewServices


  • public class OMAGServerAdminForViewServices
    extends java.lang.Object
    OMAGServerAdminForViewServices provides the server-side support for the services that add view services configuration to an OMAG Server.
    • Constructor Detail

      • OMAGServerAdminForViewServices

        public OMAGServerAdminForViewServices()
        Default constructor
    • Method Detail

      • getConfiguredViewServices

        public RegisteredOMAGServicesResponse getConfiguredViewServices​(java.lang.String userId,
                                                                        java.lang.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​(java.lang.String userId,
                                                                 java.lang.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​(java.lang.String userId,
                                                              java.lang.String serverName,
                                                              java.lang.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​(java.lang.String userId,
                                                 java.lang.String serverName,
                                                 java.lang.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​(java.lang.String userId,
                                                     java.lang.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​(java.lang.String userId,
                                             java.lang.String serverName,
                                             java.lang.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​(java.lang.String userId,
                                                 java.lang.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​(java.lang.String userId,
                                                  java.lang.String serverName,
                                                  java.util.List<ViewServiceConfig> viewServicesConfig)
        Set up the configuration for all 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.