Interface AssetConsumerLoggingInterface

  • All Known Implementing Classes:
    AssetConsumer

    public interface AssetConsumerLoggingInterface
    AssetConsumerLoggingInterface supports the ability to add log messages to the local server's audit log about an asset.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addLogMessageToAsset​(java.lang.String userId, java.lang.String assetGUID, java.lang.String connectorInstanceId, java.lang.String connectionName, java.lang.String connectorType, java.lang.String contextId, java.lang.String message)
      Creates an Audit log record about the asset.
    • Method Detail

      • addLogMessageToAsset

        void addLogMessageToAsset​(java.lang.String userId,
                                  java.lang.String assetGUID,
                                  java.lang.String connectorInstanceId,
                                  java.lang.String connectionName,
                                  java.lang.String connectorType,
                                  java.lang.String contextId,
                                  java.lang.String message)
                           throws InvalidParameterException,
                                  PropertyServerException,
                                  UserNotAuthorizedException
        Creates an Audit log record about the asset. This log record is stored in the local server's Audit Log.
        Parameters:
        userId - userId of user making request.
        assetGUID - unique id for the asset.
        connectorInstanceId - (optional) id of connector in use (if any).
        connectionName - (optional) name of the connection (extracted from the connector).
        connectorType - (optional) type of connector in use (if any).
        contextId - (optional) function name, or processId of the activity that the caller is performing.
        message - log record content.
        Throws:
        InvalidParameterException - one of the parameters is null or invalid.
        PropertyServerException - There is a problem adding the asset properties to the property server.
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.