Class DataManagerEventClient

  • All Implemented Interfaces:
    DataManagerEventInterface

    public class DataManagerEventClient
    extends java.lang.Object
    implements DataManagerEventInterface
    DataManagerEventClient provides the implementation to manage the interaction with the server to set up a listener to support the receipt of inbound events from the Data Manager OMAS Out Topic.
    • Constructor Summary

      Constructors 
      Constructor Description
      DataManagerEventClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String callerId)
      Create a new client with no authentication embedded in the HTTP request.
      DataManagerEventClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password, java.lang.String callerId)
      Create a new client that passes userId and password in each HTTP request.
      DataManagerEventClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, OCFRESTClient restClient, int maxPageSize, AuditLog auditLog, java.lang.String callerId)
      Create a new client that is to be used within an OMAG Server.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getConfigurationServerName()
      Return the name of the server where configuration is supposed to be stored.
      void registerListener​(java.lang.String userId, DataManagerEventListener listener)
      Register a listener object that will be passed each of the events published by the Data Manager OMAS.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • DataManagerEventClient

        public DataManagerEventClient​(java.lang.String serverName,
                                      java.lang.String serverPlatformURLRoot,
                                      java.lang.String callerId)
                               throws InvalidParameterException
        Create a new client with no authentication embedded in the HTTP request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        callerId - unique identifier of the caller
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • DataManagerEventClient

        public DataManagerEventClient​(java.lang.String serverName,
                                      java.lang.String serverPlatformURLRoot,
                                      java.lang.String userId,
                                      java.lang.String password,
                                      java.lang.String callerId)
                               throws 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:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        userId - caller's userId embedded in all HTTP requests
        password - caller's userId embedded in all HTTP requests
        callerId - unique identifier of the caller
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • DataManagerEventClient

        public DataManagerEventClient​(java.lang.String serverName,
                                      java.lang.String serverPlatformURLRoot,
                                      OCFRESTClient restClient,
                                      int maxPageSize,
                                      AuditLog auditLog,
                                      java.lang.String callerId)
                               throws InvalidParameterException
        Create a new client that is to be used within an OMAG Server.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        restClient - pre-initialized REST client
        maxPageSize - pre-initialized parameter limit
        auditLog - logging destination
        callerId - unique identifier of the caller
        Throws:
        InvalidParameterException - there is a problem with the information about the remote OMAS