Package org.odpi.openmetadata.adapters.connectors.integration.basicfiles.ffdc

Enum Class BasicFilesIntegrationConnectorsAuditCode

java.lang.Object
java.lang.Enum<BasicFilesIntegrationConnectorsAuditCode>
org.odpi.openmetadata.adapters.connectors.integration.basicfiles.ffdc.BasicFilesIntegrationConnectorsAuditCode
All Implemented Interfaces:
Serializable, Comparable<BasicFilesIntegrationConnectorsAuditCode>, Constable, AuditLogMessageSet
public enum BasicFilesIntegrationConnectorsAuditCode extends Enum<BasicFilesIntegrationConnectorsAuditCode> implements AuditLogMessageSet
The BasicFilesIntegrationConnectorsAuditCode is used to define the message content for the OMRS Audit Log. The 5 fields in the enum are:
  • Log Message Identifier - to uniquely identify the message
  • Severity - is this an event, decision, action, error or exception
  • Log Message Text - includes placeholder to allow additional values to be captured
  • Additional Information - further parameters and data relating to the audit message (optional)
  • SystemAction - describes the result of the situation
  • UserAction - describes how a user should correct the situation

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    BAD_CONFIGURATION
    The {0} integration connector encountered an {1} exception when opening directory {2} sourced from {3} during the {4} method.
    BAD_FILE_ELEMENT
    BASIC-FILES-INTEGRATION-CONNECTORS-0013 - The {0} integration connector retrieved an incomplete DataFile asset: {1}
    BAD_FOLDER_ELEMENT
    BASIC-FILES-INTEGRATION-CONNECTORS-0003 - The {0} integration connector retrieved an incomplete FileFolder asset for directory {1}: {2}
    CONNECTOR_CONFIGURATION
    BASIC-FILES-INTEGRATION-CONNECTORS-0001 - The {0} integration connector has been initialized with directoryToMonitor={1}, allowCatalogDelete={2}, waitForDirectory={3}, fileTemplateQualifiedName={4}, directoryTemplateQualifiedName={5}, toDoTemplateQualifiedName={6} and incidentReportTemplateQualifiedName={7}
    CONNECTOR_STOPPING
    BASIC-FILES-INTEGRATION-CONNECTORS-0009 - The {0} integration connector has stopped its file monitoring and is shutting down
    DATA_FILE_ARCHIVED
    BASIC-FILES-INTEGRATION-CONNECTORS-0020 - The {0} integration connector has archived the DataFile {1} ({2}) because the real-world file is no longer stored in the directory
    DATA_FILE_CREATED
    BASIC-FILES-INTEGRATION-CONNECTORS-0016 - The {0} integration connector created the DataFile {1} ({2}) for a new real-world file
    DATA_FILE_CREATED_FROM_TEMPLATE
    BASIC-FILES-INTEGRATION-CONNECTORS-0017 - The {0} integration connector created the DataFile {1} ({2}) for a new real-world file using template {3} ({4})
    DATA_FILE_DELETED
    The {0} integration connector has deleted the DataFile {1} ({2}) because the real-world file is no longer stored in the directory
    DATA_FILE_UPDATED
    BASIC-FILES-INTEGRATION-CONNECTORS-0018 - The {0} integration connector has updated the DataFile {1} ({2}) because the real-world file changed
    DATA_FOLDER_UPDATED
    BASIC-FILES-INTEGRATION-CONNECTORS-0010 - The {0} integration connector has updated the last updated time in the DataFolder {1} to {2}
    DATA_FOLDER_UPDATED_FOR_FILE
    BASIC-FILES-INTEGRATION-CONNECTORS-0011 - The {0} integration connector has updated the last updated time in the DataFolder {1} to {2} because of changes to file {3}
    DIRECTORY_MONITORING_STARTING
    BASIC-FILES-INTEGRATION-CONNECTORS-0005 - The {0} integration connector is initiating the monitoring of file directory {1}
    DIRECTORY_MONITORING_STOPPING
    BASIC-FILES-INTEGRATION-CONNECTORS-0007 - The {0} integration connector is stopping the monitoring of file directory {1}
    FILES_LOCATION_NOT_FOUND
     
    MISSING_TEMPLATE
    BASIC-FILES-INTEGRATION-CONNECTORS-0015 - The {0} integration connector is unable to retrieve the DataFile template with qualified name: {1}
    UNEXPECTED_EXC_DATA_FILE_UPDATE
    BASIC-FILES-INTEGRATION-CONNECTORS-0014 - An unexpected {0} exception was returned to the {1} integration connector when it tried to update the DataFile in the metadata repositories for file {2}.
    UNEXPECTED_EXC_FOLDER_UPDATE
    BASIC-FILES-INTEGRATION-CONNECTORS-0012 - An unexpected {0} exception was returned to the {1} integration connector when it tried to update the DataFolder {2} in the metadata repositories for directory {3}.
    UNEXPECTED_EXC_MONITOR_START
    BASIC-FILES-INTEGRATION-CONNECTORS-0006
    UNEXPECTED_EXC_MONITOR_STOP
    BASIC-FILES-INTEGRATION-CONNECTORS-0008 - An unexpected {0} exception was returned to the {1} integration connector by the Apache Commons FileAlterationMonitor for directory {2} while it stopping the monitoring service.
    UNEXPECTED_EXC_RETRIEVING_CATALOG_TARGETS
    BASIC-FILES-INTEGRATION-CONNECTORS-0022 - An unexpected {0} exception was returned to the {1} integration connector by the Files Integrator OMIS {2} method when trying to retrieve the catalog targets for connector {3}.
    UNEXPECTED_EXC_RETRIEVING_FOLDER_BY_GUID
    BASIC-FILES-INTEGRATION-CONNECTORS-0021 - An unexpected {0} exception was returned to the {1} integration connector by the Files Integrator OMIS {2} method when trying to retrieve the FileFolder asset {3}.
    UNEXPECTED_EXC_RETRIEVING_FOLDER_BY_PATH_NAME
    BASIC-FILES-INTEGRATION-CONNECTORS-0004 - An unexpected {0} exception was returned to the {1} integration connector by the Files Integrator OMIS {2} method when trying to retrieve the FileFolder asset for directory {3} (absolute path {4}).
    UNEXPECTED_EXCEPTION
    BASIC-FILES-INTEGRATION-CONNECTORS-0023 - The {0} connector received an unexpected {1} exception during method {2}; the error message was: {3}

  • Method Summary

    Modifier and Type
    Method
    Description
    AuditLogMessageDefinition
    getMessageDefinition()
    Retrieve a message definition object for logging.
    AuditLogMessageDefinition
    getMessageDefinition(String... params)
    Retrieve a message definition object for logging.
    String
    toString()
    JSON-style toString
    static BasicFilesIntegrationConnectorsAuditCode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static BasicFilesIntegrationConnectorsAuditCode[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • CONNECTOR_CONFIGURATION

      public static final BasicFilesIntegrationConnectorsAuditCode CONNECTOR_CONFIGURATION
      BASIC-FILES-INTEGRATION-CONNECTORS-0001 - The {0} integration connector has been initialized with directoryToMonitor={1}, allowCatalogDelete={2}, waitForDirectory={3}, fileTemplateQualifiedName={4}, directoryTemplateQualifiedName={5}, toDoTemplateQualifiedName={6} and incidentReportTemplateQualifiedName={7}

    • BAD_CONFIGURATION

      public static final BasicFilesIntegrationConnectorsAuditCode BAD_CONFIGURATION
      The {0} integration connector encountered an {1} exception when opening directory {2} sourced from {3} during the {4} method. The exception message included was {5}

    • BAD_FOLDER_ELEMENT

      public static final BasicFilesIntegrationConnectorsAuditCode BAD_FOLDER_ELEMENT
      BASIC-FILES-INTEGRATION-CONNECTORS-0003 - The {0} integration connector retrieved an incomplete FileFolder asset for directory {1}: {2}

    • UNEXPECTED_EXC_RETRIEVING_FOLDER_BY_PATH_NAME

      public static final BasicFilesIntegrationConnectorsAuditCode UNEXPECTED_EXC_RETRIEVING_FOLDER_BY_PATH_NAME
      BASIC-FILES-INTEGRATION-CONNECTORS-0004 - An unexpected {0} exception was returned to the {1} integration connector by the Files Integrator OMIS {2} method when trying to retrieve the FileFolder asset for directory {3} (absolute path {4}). The error message was {5}

    • DIRECTORY_MONITORING_STARTING

      public static final BasicFilesIntegrationConnectorsAuditCode DIRECTORY_MONITORING_STARTING
      BASIC-FILES-INTEGRATION-CONNECTORS-0005 - The {0} integration connector is initiating the monitoring of file directory {1}

    • UNEXPECTED_EXC_MONITOR_START

      public static final BasicFilesIntegrationConnectorsAuditCode UNEXPECTED_EXC_MONITOR_START
      BASIC-FILES-INTEGRATION-CONNECTORS-0006

    • DIRECTORY_MONITORING_STOPPING

      public static final BasicFilesIntegrationConnectorsAuditCode DIRECTORY_MONITORING_STOPPING
      BASIC-FILES-INTEGRATION-CONNECTORS-0007 - The {0} integration connector is stopping the monitoring of file directory {1}

    • UNEXPECTED_EXC_MONITOR_STOP

      public static final BasicFilesIntegrationConnectorsAuditCode UNEXPECTED_EXC_MONITOR_STOP
      BASIC-FILES-INTEGRATION-CONNECTORS-0008 - An unexpected {0} exception was returned to the {1} integration connector by the Apache Commons FileAlterationMonitor for directory {2} while it stopping the monitoring service. The error message was {3}

    • CONNECTOR_STOPPING

      public static final BasicFilesIntegrationConnectorsAuditCode CONNECTOR_STOPPING
      BASIC-FILES-INTEGRATION-CONNECTORS-0009 - The {0} integration connector has stopped its file monitoring and is shutting down

    • DATA_FOLDER_UPDATED

      public static final BasicFilesIntegrationConnectorsAuditCode DATA_FOLDER_UPDATED
      BASIC-FILES-INTEGRATION-CONNECTORS-0010 - The {0} integration connector has updated the last updated time in the DataFolder {1} to {2}

    • DATA_FOLDER_UPDATED_FOR_FILE

      public static final BasicFilesIntegrationConnectorsAuditCode DATA_FOLDER_UPDATED_FOR_FILE
      BASIC-FILES-INTEGRATION-CONNECTORS-0011 - The {0} integration connector has updated the last updated time in the DataFolder {1} to {2} because of changes to file {3}

    • UNEXPECTED_EXC_FOLDER_UPDATE

      public static final BasicFilesIntegrationConnectorsAuditCode UNEXPECTED_EXC_FOLDER_UPDATE
      BASIC-FILES-INTEGRATION-CONNECTORS-0012 - An unexpected {0} exception was returned to the {1} integration connector when it tried to update the DataFolder {2} in the metadata repositories for directory {3}. The error message was {4}

    • BAD_FILE_ELEMENT

      public static final BasicFilesIntegrationConnectorsAuditCode BAD_FILE_ELEMENT
      BASIC-FILES-INTEGRATION-CONNECTORS-0013 - The {0} integration connector retrieved an incomplete DataFile asset: {1}

    • UNEXPECTED_EXC_DATA_FILE_UPDATE

      public static final BasicFilesIntegrationConnectorsAuditCode UNEXPECTED_EXC_DATA_FILE_UPDATE
      BASIC-FILES-INTEGRATION-CONNECTORS-0014 - An unexpected {0} exception was returned to the {1} integration connector when it tried to update the DataFile in the metadata repositories for file {2}. The error message was {3}

    • MISSING_TEMPLATE

      public static final BasicFilesIntegrationConnectorsAuditCode MISSING_TEMPLATE
      BASIC-FILES-INTEGRATION-CONNECTORS-0015 - The {0} integration connector is unable to retrieve the DataFile template with qualified name: {1}

    • DATA_FILE_CREATED

      public static final BasicFilesIntegrationConnectorsAuditCode DATA_FILE_CREATED
      BASIC-FILES-INTEGRATION-CONNECTORS-0016 - The {0} integration connector created the DataFile {1} ({2}) for a new real-world file

    • DATA_FILE_CREATED_FROM_TEMPLATE

      public static final BasicFilesIntegrationConnectorsAuditCode DATA_FILE_CREATED_FROM_TEMPLATE
      BASIC-FILES-INTEGRATION-CONNECTORS-0017 - The {0} integration connector created the DataFile {1} ({2}) for a new real-world file using template {3} ({4})

    • DATA_FILE_UPDATED

      public static final BasicFilesIntegrationConnectorsAuditCode DATA_FILE_UPDATED
      BASIC-FILES-INTEGRATION-CONNECTORS-0018 - The {0} integration connector has updated the DataFile {1} ({2}) because the real-world file changed

    • DATA_FILE_DELETED

      public static final BasicFilesIntegrationConnectorsAuditCode DATA_FILE_DELETED
      The {0} integration connector has deleted the DataFile {1} ({2}) because the real-world file is no longer stored in the directory

    • DATA_FILE_ARCHIVED

      public static final BasicFilesIntegrationConnectorsAuditCode DATA_FILE_ARCHIVED
      BASIC-FILES-INTEGRATION-CONNECTORS-0020 - The {0} integration connector has archived the DataFile {1} ({2}) because the real-world file is no longer stored in the directory

    • UNEXPECTED_EXC_RETRIEVING_FOLDER_BY_GUID

      public static final BasicFilesIntegrationConnectorsAuditCode UNEXPECTED_EXC_RETRIEVING_FOLDER_BY_GUID
      BASIC-FILES-INTEGRATION-CONNECTORS-0021 - An unexpected {0} exception was returned to the {1} integration connector by the Files Integrator OMIS {2} method when trying to retrieve the FileFolder asset {3}. The error message was {4}

    • UNEXPECTED_EXC_RETRIEVING_CATALOG_TARGETS

      public static final BasicFilesIntegrationConnectorsAuditCode UNEXPECTED_EXC_RETRIEVING_CATALOG_TARGETS
      BASIC-FILES-INTEGRATION-CONNECTORS-0022 - An unexpected {0} exception was returned to the {1} integration connector by the Files Integrator OMIS {2} method when trying to retrieve the catalog targets for connector {3}. The error message was {4}

    • FILES_LOCATION_NOT_FOUND

      public static final BasicFilesIntegrationConnectorsAuditCode FILES_LOCATION_NOT_FOUND

    • UNEXPECTED_EXCEPTION

      public static final BasicFilesIntegrationConnectorsAuditCode UNEXPECTED_EXCEPTION
      BASIC-FILES-INTEGRATION-CONNECTORS-0023 - The {0} connector received an unexpected {1} exception during method {2}; the error message was: {3}

  • Method Details

    • values

      public static BasicFilesIntegrationConnectorsAuditCode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static BasicFilesIntegrationConnectorsAuditCode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getMessageDefinition

      public AuditLogMessageDefinition getMessageDefinition()
      Retrieve a message definition object for logging. This method is used when there are no message inserts.
      Specified by:
      getMessageDefinition in interface AuditLogMessageSet
      Returns:
      message definition object.

    • getMessageDefinition

      public AuditLogMessageDefinition getMessageDefinition(String... params)
      Retrieve a message definition object for logging. This method is used when there are values to be inserted into the message.
      Specified by:
      getMessageDefinition in interface AuditLogMessageSet
      Parameters:
      params - array of parameters (all strings). They are inserted into the message according to the numbering in the message text.
      Returns:
      message definition object.

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class Enum<BasicFilesIntegrationConnectorsAuditCode>
      Returns:
      string of property names and values for this enum