Class ConnectedAssetUniverse

  • All Implemented Interfaces:
    java.io.Serializable

    public class ConnectedAssetUniverse
    extends AssetUniverse
    ConnectedAssetUniverse is the OMAS client library implementation of the Open Connector Framework (OCF) AssetUniverse object. AssetUniverse provides read-only access to the properties known about an asset. ConnectedAssetUniverse configures AssetUniverse (and its dependent objects) with the information necessary to populate the AssetUniverse contents from the open metadata repositories. All of ConnectedAssetUniverse's work is done in the constructors. They extract basic information about the asset and push objects to the super class to retrieve the more detailed properties. These properties are only retrieved on demand.
    See Also:
    Serialized Form
    • Constructor Detail

      • ConnectedAssetUniverse

        public ConnectedAssetUniverse​(java.lang.String serviceName,
                                      java.lang.String remoteServerName,
                                      java.lang.String omasServerURL,
                                      java.lang.String userId,
                                      java.lang.String assetGUID)
                               throws InvalidParameterException,
                                      PropertyServerException,
                                      UserNotAuthorizedException
        Constructor used by Asset Consumer OMAS for getAssetProperties() with no authentication information being attached to the HTTP requests. The calling user of the specific request flows as a property in the URL.
        Parameters:
        serviceName - calling service
        remoteServerName - name of the server.
        omasServerURL - url used to call the server.
        userId - userId of user making request.
        assetGUID - unique id for asset.
        Throws:
        InvalidParameterException - one of the parameters is null or invalid.
        PropertyServerException - There is a problem retrieving the asset properties from the property server.
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      • ConnectedAssetUniverse

        public ConnectedAssetUniverse​(java.lang.String serviceName,
                                      java.lang.String remoteServerName,
                                      java.lang.String localServerUserId,
                                      java.lang.String localServerPassword,
                                      java.lang.String omasServerURL,
                                      java.lang.String userId,
                                      java.lang.String assetGUID)
                               throws InvalidParameterException,
                                      PropertyServerException,
                                      UserNotAuthorizedException
        Constructor used by Asset Consumer OMAS for getExtendedProperties() where a userId and password of the local calling server are embedded in the HTTP requests. The calling user of the specific request flows as a property in the URL.
        Parameters:
        serviceName - calling service
        remoteServerName - name of the server.
        localServerUserId - userId of the local server.
        localServerPassword - password of the local server.
        omasServerURL - url used to call the server.
        userId - userId of user making request.
        assetGUID - unique id for asset.
        Throws:
        InvalidParameterException - one of the parameters is null or invalid.
        PropertyServerException - There is a problem retrieving the asset properties from the property server.
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      • ConnectedAssetUniverse

        public ConnectedAssetUniverse​(java.lang.String serviceName,
                                      java.lang.String remoteServerName,
                                      java.lang.String omasServerURL,
                                      java.lang.String userId,
                                      java.lang.String assetGUID,
                                      OCFRESTClient restClient)
                               throws InvalidParameterException,
                                      PropertyServerException,
                                      UserNotAuthorizedException
        Constructor used by Connected Asset OMAS for related asset properties.
        Parameters:
        serviceName - calling service
        remoteServerName - name of the server.
        omasServerURL - url used to call the server.
        userId - userId of user making request.
        assetGUID - unique id for asset.
        restClient - client for calling rest APIs
        Throws:
        InvalidParameterException - one of the parameters is null or invalid.
        PropertyServerException - There is a problem retrieving the asset properties from the property server.
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      • ConnectedAssetUniverse

        public ConnectedAssetUniverse​(java.lang.String serviceName,
                                      java.lang.String remoteServerName,
                                      java.lang.String omasServerURL,
                                      java.lang.String userId,
                                      java.lang.String assetGUID,
                                      java.lang.String connectionGUID)
                               throws InvalidParameterException,
                                      PropertyServerException,
                                      UserNotAuthorizedException
        Constructor used by EgeriaConnectedAssetProperties.refresh() with no authentication information being attached to the HTTP requests. The calling user of the specific request flows as a property in the URL.
        Parameters:
        serviceName - calling service
        remoteServerName - name of the server.
        omasServerURL - url used to call the server.
        userId - userId of user making request.
        assetGUID - unique id for asset.
        connectionGUID - unique id for connection used to access asset.
        Throws:
        InvalidParameterException - one of the parameters is null or invalid.
        PropertyServerException - There is a problem retrieving the asset properties from the property server.
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      • ConnectedAssetUniverse

        public ConnectedAssetUniverse​(java.lang.String serviceName,
                                      java.lang.String remoteServerName,
                                      java.lang.String localServerUserId,
                                      java.lang.String localServerPassword,
                                      java.lang.String omasServerURL,
                                      java.lang.String userId,
                                      java.lang.String assetGUID,
                                      java.lang.String connectionGUID)
                               throws InvalidParameterException,
                                      PropertyServerException,
                                      UserNotAuthorizedException
        Constructor used by EgeriaConnectedAssetProperties.refresh() with no authentication information being attached to the HTTP requests. The calling user of the specific request flows as a property in the URL.
        Parameters:
        serviceName - calling service
        remoteServerName - name of the server.
        localServerUserId - userId of the local server.
        localServerPassword - password of the local server.
        omasServerURL - url used to call the server.
        userId - userId of user making request.
        assetGUID - unique id for asset.
        connectionGUID - unique id for connection used to access asset.
        Throws:
        InvalidParameterException - one of the parameters is null or invalid.
        PropertyServerException - There is a problem retrieving the asset properties from the property server.
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.