Class EnterpriseRepositoryServicesClient

  • All Implemented Interfaces:
    AuditLoggingComponent

    public class EnterpriseRepositoryServicesClient
    extends MetadataCollectionServicesClient
    EnterpriseRepositoryServicesClient provides a client interface for calling the enterprise repository services in a remote server.
    • Constructor Detail

      • EnterpriseRepositoryServicesClient

        public EnterpriseRepositoryServicesClient​(java.lang.String serverName,
                                                  java.lang.String restURLRoot)
                                           throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Create a new client with no authentication embedded in the HTTP request.
        Parameters:
        serverName - name of the server to connect to
        restURLRoot - the network address of the server running the repository services. This is of the form serverURLroot + "/servers/" + serverName.
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - bad input parameters
      • EnterpriseRepositoryServicesClient

        public EnterpriseRepositoryServicesClient​(java.lang.String repositoryName,
                                                  java.lang.String restURLRoot,
                                                  java.lang.String userId,
                                                  java.lang.String password)
                                           throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
        Parameters:
        repositoryName - name of the server to connect to
        restURLRoot - the network address of the server running the repository services. This is of the form serverURLroot + "/servers/" + serverName.
        userId - caller's userId embedded in all HTTP requests
        password - caller's userId embedded in all HTTP requests
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - bad input parameters
      • EnterpriseRepositoryServicesClient

        public EnterpriseRepositoryServicesClient​(java.lang.String repositoryName,
                                                  java.lang.String restURLRoot,
                                                  int maxPageSize,
                                                  java.lang.String callerId)
                                           throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Create a new client with no authentication embedded in the HTTP request.
        Parameters:
        repositoryName - name of the server to connect to
        restURLRoot - the network address of the server running the repository services. This is of the form serverURLroot + "/servers/" + serverName.
        maxPageSize - pre-initialized parameter limit
        callerId - unique identifier of the caller
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - bad input parameters
      • EnterpriseRepositoryServicesClient

        public EnterpriseRepositoryServicesClient​(java.lang.String repositoryName,
                                                  java.lang.String restURLRoot,
                                                  java.lang.String userId,
                                                  java.lang.String password,
                                                  int maxPageSize,
                                                  java.lang.String callerId)
                                           throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
        Parameters:
        repositoryName - name of the server to connect to
        restURLRoot - the network address of the server running the repository services. This is of the form serverURLroot + "/servers/" + serverName.
        userId - caller's userId embedded in all HTTP requests
        password - caller's userId embedded in all HTTP requests
        maxPageSize - pre-initialized parameter limit
        callerId - unique identifier of the caller
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - bad input parameters
    • Method Detail

      • registerListener

        public void registerListener​(java.lang.String userId,
                                     OMRSTopicRepositoryEventListener listener)
                              throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException,
                                     ConnectionCheckedException,
                                     ConnectorCheckedException,
                                     org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException,
                                     org.odpi.openmetadata.repositoryservices.ffdc.exception.UserNotAuthorizedException
        Register a listener object that will be passed each of the events published by the Asset Manager OMAS.
        Parameters:
        userId - calling user
        listener - listener object
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - one of the parameters is null or invalid.
        ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.
        ConnectorCheckedException - there are errors in the initialization of the connector.
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - there is a problem retrieving information from the property server(s).
        org.odpi.openmetadata.repositoryservices.ffdc.exception.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      • disconnectFromEnterpriseTopic

        public void disconnectFromEnterpriseTopic()
                                           throws ConnectorCheckedException
        Disconnect from the topic connector - events will no longer be passed to the registered listeners.
        Throws:
        ConnectorCheckedException - problem with the topic connector