Class OMAGServerPlatformConfigurationClient


  • public class OMAGServerPlatformConfigurationClient
    extends java.lang.Object
    OMAGServerPlatformConfigurationClient provides services to configure an OMAG Server Platform. There are two aspects to this. Firstly setting up the connector for the configuration document store. Then secondly, configuring the platform security connector.
    • Field Detail

      • adminUserId

        protected java.lang.String adminUserId
      • serverPlatformRootURL

        protected java.lang.String serverPlatformRootURL
    • Constructor Detail

      • OMAGServerPlatformConfigurationClient

        public OMAGServerPlatformConfigurationClient​(java.lang.String adminUserId,
                                                     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.
        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.
      • OMAGServerPlatformConfigurationClient

        public OMAGServerPlatformConfigurationClient​(java.lang.String adminUserId,
                                                     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.
        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

      • setConfigurationStoreConnection

        public void setConfigurationStoreConnection​(Connection connection)
                                             throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                    org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                    org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Override the default implementation or configuration of the configuration document store.
        Parameters:
        connection - connection object that defines the configuration document store
        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.
      • clearConfigurationStoreConnection

        public void clearConfigurationStoreConnection()
                                               throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Clear the connection object for the configuration store which means the platform uses the default store.
        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.
      • getConfigurationStoreConnection

        public Connection getConfigurationStoreConnection()
                                                   throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                          org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                          org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Return the connection object for the configuration store. Null is returned if the server is using the default store with the default configuration.
        Returns:
        Platform security connection
        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.
      • setPlatformSecurityConnection

        public void setPlatformSecurityConnection​(Connection connection)
                                           throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                  org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                  org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Set up a platform security connector. This connector provides additional authorization checks on API requests to the platform.
        Parameters:
        connection - connection object that defines the platform security connector
        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.
      • clearPlatformSecurityConnection

        public void clearPlatformSecurityConnection()
                                             throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                    org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                    org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Clear the connection object for platform security. This means there is no platform security set up and there will be no authorization checks within the platform. All security will have to come from the surrounding deployment environment. This is the default state.
        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.
      • getPlatformSecurityConnection

        public Connection getPlatformSecurityConnection()
                                                 throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Return the connection object for platform security connector. Null is returned if no platform security has been set up.
        Returns:
        Platform security connection
        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.
      • getAllServerConfigurations

        public java.util.Set<OMAGServerConfig> getAllServerConfigurations()
                                                                   throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                                          org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException,
                                                                          org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException
        Return all the OMAG Server configurations that are stored on this platform
        Returns:
        the OMAG Server configurations that are stored on this platform
        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.