Class ConnectedAssetClientBase

    • Constructor Summary

      Constructors 
      Constructor Description
      ConnectedAssetClientBase​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String serviceURLMarker)
      Create a new client with no authentication embedded in the HTTP request.
      ConnectedAssetClientBase​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String serviceURLMarker, int maxPageSize, AuditLog auditLog)
      Create a new client with no authentication embedded in the HTTP request.
      ConnectedAssetClientBase​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String serviceURLMarker, java.lang.String userId, java.lang.String password)
      Create a new client that passes userId and password in each HTTP request.
      ConnectedAssetClientBase​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String serviceURLMarker, java.lang.String userId, java.lang.String password, AuditLog auditLog)
      Create a new client that passes userId and password in each HTTP request.
      ConnectedAssetClientBase​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String serviceURLMarker, 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
      protected java.lang.String getAssetForConnection​(OCFRESTClient restClient, java.lang.String serviceName, java.lang.String userId, java.lang.String connectionGUID)
      Returns the unique identifier for the asset connected to the requested connection.
      protected AssetUniverse getAssetProperties​(java.lang.String serviceName, java.lang.String userId, java.lang.String assetGUID)
      Returns a comprehensive collection of properties about the requested asset.
      protected Asset getAssetSummary​(java.lang.String userId, java.lang.String guid, java.lang.String methodName)
      Return the basic properties of an asset.
      protected Connection getConnectionByGUID​(OCFRESTClient restClient, java.lang.String serviceName, java.lang.String userId, java.lang.String guid)
      Returns the connection corresponding to the supplied connection GUID.
      protected Connection getConnectionByName​(OCFRESTClient restClient, java.lang.String serviceName, java.lang.String userId, java.lang.String name)
      Returns the connection object corresponding to the supplied connection name.
      protected Connection getConnectionForAsset​(OCFRESTClient restClient, java.lang.String serviceName, java.lang.String userId, java.lang.String assetGUID)
      Returns the connection corresponding to the supplied asset GUID.
      Connector getConnectorByConnection​(java.lang.String userId, Connection connection)
      Returns the connector corresponding to the supplied connection.
      Connector getConnectorByGUID​(java.lang.String userId, java.lang.String connectionGUID)
      Returns the connector corresponding to the supplied connection GUID.
      Connector getConnectorByName​(java.lang.String userId, java.lang.String connectionName)
      Returns the connector corresponding to the supplied connection name.
      Connector getConnectorForAsset​(java.lang.String userId, java.lang.String assetGUID)
      Returns the connector corresponding to the supplied asset GUID.
      protected Connector getConnectorForConnection​(OCFRESTClient restClient, java.lang.String serviceName, java.lang.String userId, Connection requestedConnection, java.lang.String methodName)
      Use the Open Connector Framework (OCF) to create a connector using the supplied connection.
      • Methods inherited from class java.lang.Object

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

      • serverName

        protected java.lang.String serverName
      • serverPlatformURLRoot

        protected java.lang.String serverPlatformURLRoot
    • Constructor Detail

      • ConnectedAssetClientBase

        public ConnectedAssetClientBase​(java.lang.String serverName,
                                        java.lang.String serverPlatformURLRoot,
                                        java.lang.String serviceURLMarker,
                                        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
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        serviceURLMarker - indicator of the OMAS that this client is supporting
        auditLog - destination for log messages
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • ConnectedAssetClientBase

        public ConnectedAssetClientBase​(java.lang.String serverName,
                                        java.lang.String serverPlatformURLRoot,
                                        java.lang.String serviceURLMarker,
                                        int maxPageSize,
                                        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
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        maxPageSize - maximum page size for this process
        serviceURLMarker - indicator of the OMAS that this client is supporting
        auditLog - destination for log messages
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • ConnectedAssetClientBase

        public ConnectedAssetClientBase​(java.lang.String serverName,
                                        java.lang.String serverPlatformURLRoot,
                                        java.lang.String serviceURLMarker)
                                 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
        serviceURLMarker - indicator of the OMAS that this client is supporting
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • ConnectedAssetClientBase

        public ConnectedAssetClientBase​(java.lang.String serverName,
                                        java.lang.String serverPlatformURLRoot,
                                        java.lang.String serviceURLMarker,
                                        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
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        serviceURLMarker - indicator of the OMAS that this client is supporting
        userId - caller's userId embedded in all HTTP requests
        password - caller's userId embedded in all HTTP requests
        auditLog - destination for log messages
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • ConnectedAssetClientBase

        public ConnectedAssetClientBase​(java.lang.String serverName,
                                        java.lang.String serverPlatformURLRoot,
                                        java.lang.String serviceURLMarker,
                                        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
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        serviceURLMarker - indicator of the OMAS that this client is supporting
        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.