Class MetadataAccessStoreConfigurationClient


  • public class MetadataAccessStoreConfigurationClient
    extends MetadataAccessServerConfigurationClient
    MetadataAccessStoreConfigurationClient provides the configuration client for a MetadataAccessServer OMAG server. A metadata access server is a metadata access point with a native open metadata repository.
    • Constructor Detail

      • MetadataAccessStoreConfigurationClient

        public MetadataAccessStoreConfigurationClient​(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.
      • MetadataAccessStoreConfigurationClient

        public MetadataAccessStoreConfigurationClient​(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

      • setInMemLocalRepository

        public void setInMemLocalRepository()
                                     throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                            org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException,
                                            org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException
        Set up an in memory local repository. This repository uses hashmaps to store content. It is useful for demos, testing and POCs.
        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.
      • setGraphLocalRepository

        public void setGraphLocalRepository​(java.util.Map<java.lang.String,​java.lang.Object> storageProperties)
                                     throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                            org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException,
                                            org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException
        Set up a graph store as the local repository. This graph store uses JanusGraph. It is scalable with different back ends and can be run in a HA context with multiple versions of the same server deployed to the same repository.
        Parameters:
        storageProperties - properties used to configure the back end storage for the graph
        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.
      • setReadOnlyLocalRepository

        public void setReadOnlyLocalRepository()
                                        throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                               org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException,
                                               org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException
        Set up an read only local repository. This repository manages metadata in memory but does not support the ability to store new metadata. This means it can safely be used to host read only content from an open metadata archive within a production cohort.
        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.
      • setPluginRepositoryConnection

        public void setPluginRepositoryConnection​(org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
                                           throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                  org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                  org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Provide the connection to the local repository connector that maps the OMRS RepositoryConnector API to the third party persistence API. The persistence layer is only called through the open metadata APIs.
        Parameters:
        connection - connection to the OMRS repository 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.
      • setPluginRepositoryConnection

        public void setPluginRepositoryConnection​(java.lang.String connectorProvider,
                                                  java.util.Map<java.lang.String,​java.lang.Object> additionalProperties)
                                           throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                  org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                  org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Provide the connection to the local repository connector that maps the OMRS RepositoryConnector API to the third party persistence API. The persistence layer is only called through the open metadata APIs.
        Parameters:
        connectorProvider - connector provider class name to the OMRS repository connector.
        additionalProperties - additional parameters to pass to the repository 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.