Class ViewServerConfigurationClient


  • public class ViewServerConfigurationClient
    extends OMAGServerConfigurationClient
    ViewServerConfigurationClient provides the configuration services for view servers. This involves creating a list of view services config properties.
    • Constructor Detail

      • ViewServerConfigurationClient

        public ViewServerConfigurationClient​(java.lang.String adminUserId,
                                             java.lang.String serverName,
                                             java.lang.String serverPlatformRootURL)
                                      throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException
        Create a new client with no authentication embedded in the HTTP request.
        Parameters:
        adminUserId - administrator's (end user's) userId to associate with calls.
        serverName - name of the server to connect to
        serverPlatformRootURL - the network address of the server running the admin services
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • ViewServerConfigurationClient

        public ViewServerConfigurationClient​(java.lang.String adminUserId,
                                             java.lang.String serverName,
                                             java.lang.String serverPlatformRootURL,
                                             java.lang.String connectionUserId,
                                             java.lang.String connectionPassword)
                                      throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException
        Create a new client that passes a connection userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is passed as the admin userId.
        Parameters:
        adminUserId - administrator's (end user's) userId to associate with calls.
        serverName - name of the server to connect to
        serverPlatformRootURL - the network address of the server running the admin services
        connectionUserId - caller's system userId embedded in all HTTP requests
        connectionPassword - caller's system password embedded in all HTTP requests
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
    • Method Detail

      • getRegisteredViewServices

        public java.util.List<RegisteredOMAGService> getRegisteredViewServices()
                                                                        throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                                               org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                                               org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Return the list of view services for this server.
        Returns:
        list of view service descriptions
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • getConfiguredViewServices

        public java.util.List<RegisteredOMAGService> getConfiguredViewServices()
                                                                        throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                                               org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                                               org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Return the list of view services for this server.
        Returns:
        list of view service descriptions
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • getViewServicesConfiguration

        public java.util.List<ViewServiceConfig> getViewServicesConfiguration()
                                                                       throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                                              org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                                              org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Return the configuration for the view services in this server.
        Returns:
        list of view service configuration
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • configureViewService

        public void configureViewService​(java.lang.String serviceURLMarker,
                                         java.util.Map<java.lang.String,​java.lang.Object> viewServiceOptions)
                                  throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                         org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                         org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Enable a single view service.
        Parameters:
        serviceURLMarker - string indicating which view service it is configuring
        viewServiceOptions - property name/value pairs used to configure the view service
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • disableViewService

        public void disableViewService​(java.lang.String serviceURLMarker)
                                throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                       org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                       org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Disable a single view service.
        Parameters:
        serviceURLMarker - string indicating which view service it is configuring
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • configureAllViewService

        public void configureAllViewService​(java.lang.String partnerOMASServerURLRoot,
                                            java.lang.String partnerOMASServerName,
                                            java.util.Map<java.lang.String,​java.lang.Object> viewServiceOptions)
                                     throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                            org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                            org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Enable all registered view services with the same partner server and options.
        Parameters:
        partnerOMASServerURLRoot - URL root of the OMAG Server Platform where the access service used by this view service is running
        partnerOMASServerName - name of server where the access service used by this view service is running
        viewServiceOptions - property name/value pairs used to configure the view service
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • setViewServicesConfig

        public void setViewServicesConfig​(java.util.List<ViewServiceConfig> viewServicesConfig)
                                   throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                          org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                          org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Set up the configuration for all the open metadata view services (OMVSs). This overrides the current values.
        Parameters:
        viewServicesConfig - list of configuration properties for each view service.
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • clearAllViewServices

        public void clearAllViewServices()
                                  throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                         org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                         org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Disable the view services. This removes all configuration for the view server.
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.