Class DisplayIntegrator

  • All Implemented Interfaces:
    DisplayIntegratorAPI

    public class DisplayIntegrator
    extends java.lang.Object
    implements DisplayIntegratorAPI
    DisplayIntegrator is the client library for the Display Integrator OMIS's REST API.
    • Constructor Summary

      Constructors 
      Constructor Description
      DisplayIntegrator​(java.lang.String serverName, java.lang.String serverPlatformRootURL)
      Create a new client with no authentication embedded in the HTTP request.
      DisplayIntegrator​(java.lang.String serverName, java.lang.String serverPlatformRootURL, java.lang.String userId, java.lang.String password)
      Create a new client that passes userId and password in each HTTP request.
      DisplayIntegrator​(java.lang.String serverName, java.lang.String serverPlatformRootURL, java.lang.String userId, java.lang.String password, AuditLog auditLog)
      Create a new client that passes userId and password in each HTTP request.
      DisplayIntegrator​(java.lang.String serverName, java.lang.String serverPlatformRootURL, AuditLog auditLog)
      Create a new client with no authentication embedded in the HTTP request.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ConnectorReport validateConnector​(java.lang.String userId, java.lang.String connectorProviderClassName)
      Validate the connector and return its connector type.
      • Methods inherited from class java.lang.Object

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

      • DisplayIntegrator

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

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

        public DisplayIntegrator​(java.lang.String serverName,
                                 java.lang.String serverPlatformRootURL,
                                 java.lang.String userId,
                                 java.lang.String password,
                                 AuditLog auditLog)
                          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
        serverPlatformRootURL - 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
        auditLog - logging destination
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • DisplayIntegrator

        public DisplayIntegrator​(java.lang.String serverName,
                                 java.lang.String serverPlatformRootURL,
                                 java.lang.String userId,
                                 java.lang.String password)
                          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
        serverPlatformRootURL - 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
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.