Package org.odpi.openmetadata.reports.messages

Enum Class MessageSetCategory

java.lang.Object
java.lang.Enum<MessageSetCategory>
org.odpi.openmetadata.reports.messages.MessageSetCategory
All Implemented Interfaces:
Serializable, Comparable<MessageSetCategory>, Constable
public enum MessageSetCategory extends Enum<MessageSetCategory>
MessageSetCategory organises the message sets into the directories of the documentation. Each category matches a part of the Egeria source tree so that a message set's documentation page sits in the same relative place as the module that defines it. The categories are tested in order and the first one whose source path prefix matches is used, so more specific prefixes must appear before more general ones.

  • Enum Constant Details

    • FRAMEWORKS

      public static final MessageSetCategory FRAMEWORKS
      Message sets defined by the Open Metadata and Governance (OMAG) frameworks.

    • COMMON_SERVICES

      public static final MessageSetCategory COMMON_SERVICES
      Message sets defined by the common services that are shared by the other Egeria services.

    • ACCESS_SERVICES

      public static final MessageSetCategory ACCESS_SERVICES
      Message sets defined by the Open Metadata Access Services (OMASs).

    • GENERIC_VIEW_SERVICES

      public static final MessageSetCategory GENERIC_VIEW_SERVICES
      Message sets defined by the generic Open Metadata View Services (OMVSs).

    • VIEW_SERVICES

      public static final MessageSetCategory VIEW_SERVICES
      Message sets defined by the Open Metadata View Services (OMVSs).

    • ENGINE_SERVICES

      public static final MessageSetCategory ENGINE_SERVICES
      Message sets defined by the Open Metadata Engine Services (OMESs).

    • GOVERNANCE_SERVER_SERVICES

      public static final MessageSetCategory GOVERNANCE_SERVER_SERVICES
      Message sets defined by the governance servers that host connectors and governance services.

    • REPOSITORY_SERVICES

      public static final MessageSetCategory REPOSITORY_SERVICES
      Message sets defined by the Open Metadata Repository Services (OMRS).

    • ADMIN_SERVICES

      public static final MessageSetCategory ADMIN_SERVICES
      Message sets defined by the administration services.

    • SERVER_OPERATIONS

      public static final MessageSetCategory SERVER_OPERATIONS
      Message sets defined by the server operations services.

    • USER_SECURITY

      public static final MessageSetCategory USER_SECURITY
      Message sets defined by the user security services.

    • DATA_MANAGER_CONNECTORS

      public static final MessageSetCategory DATA_MANAGER_CONNECTORS
      Message sets defined by the connectors that catalog and survey data managers.

    • DATA_STORE_CONNECTORS

      public static final MessageSetCategory DATA_STORE_CONNECTORS
      Message sets defined by the connectors that access the contents of data stores.

    • INTEGRATION_CONNECTORS

      public static final MessageSetCategory INTEGRATION_CONNECTORS
      Message sets defined by the integration connectors.

    • SYSTEM_CONNECTORS

      public static final MessageSetCategory SYSTEM_CONNECTORS
      Message sets defined by the connectors that call third party systems.

    • REPOSITORY_SERVICES_CONNECTORS

      public static final MessageSetCategory REPOSITORY_SERVICES_CONNECTORS
      Message sets defined by the connectors used by the repository services.

    • EVENT_BUS_CONNECTORS

      public static final MessageSetCategory EVENT_BUS_CONNECTORS
      Message sets defined by the event bus connectors.

    • GOVERNANCE_ACTION_CONNECTORS

      public static final MessageSetCategory GOVERNANCE_ACTION_CONNECTORS
      Message sets defined by the governance action connectors.

    • FILE_SURVEY_CONNECTORS

      public static final MessageSetCategory FILE_SURVEY_CONNECTORS
      Message sets defined by the survey action connectors that analyse files.

    • NANNY_CONNECTORS

      public static final MessageSetCategory NANNY_CONNECTORS
      Message sets defined by the connectors that capture observability data about the open metadata ecosystem.

    • LOVELACE_INSIGHTS

      public static final MessageSetCategory LOVELACE_INSIGHTS
      Message sets defined by the connectors that generate insight reports.

    • REPORT_GENERATING_CONNECTORS

      public static final MessageSetCategory REPORT_GENERATING_CONNECTORS
      Message sets defined by the connectors that generate documents from open metadata.

    • SECRETS_STORE_CONNECTORS

      public static final MessageSetCategory SECRETS_STORE_CONNECTORS
      Message sets defined by the connectors that retrieve secrets.

    • METADATA_SECURITY_CONNECTORS

      public static final MessageSetCategory METADATA_SECURITY_CONNECTORS
      Message sets defined by the connectors that enforce the metadata security rules.

    • CONFIGURATION_STORE_CONNECTORS

      public static final MessageSetCategory CONFIGURATION_STORE_CONNECTORS
      Message sets defined by the connectors that store the server configuration documents.

    • REST_CLIENT_CONNECTORS

      public static final MessageSetCategory REST_CLIENT_CONNECTORS
      Message sets defined by the connectors that issue REST API calls.

    • OTHER_CONNECTORS

      public static final MessageSetCategory OTHER_CONNECTORS
      Message sets defined by the remaining connectors.

    • CONFORMANCE_SUITE

      public static final MessageSetCategory CONFORMANCE_SUITE
      Message sets defined by the conformance suite.

    • SAMPLES

      public static final MessageSetCategory SAMPLES
      Message sets defined by the samples.

    • OTHER

      public static final MessageSetCategory OTHER
      Message sets that do not match any of the other categories.

  • Method Details

    • values

      public static MessageSetCategory[] 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 MessageSetCategory 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

    • getSourcePathPrefix

      public String getSourcePathPrefix()
      Return the start of the path (relative to the repository root) of the modules in this category.
      Returns:
      path prefix

    • getDirectoryName

      public String getDirectoryName()
      Return the location of the documentation, relative to the root of the documentation directory.
      Returns:
      directory name, which may include a "/" to create a nested directory

    • getDisplayName

      public String getDisplayName()
      Return the name of the category used in the documentation.
      Returns:
      display name

    • getDescription

      public String getDescription()
      Return the explanation of the category used in the documentation.
      Returns:
      description

    • getCategory

      public static MessageSetCategory getCategory(String sourcePath)
      Return the category that the supplied source file belongs to. The categories are tested in declaration order and the first matching prefix wins, so the more specific categories are declared first.
      Parameters:
      sourcePath - path of the message set's source file, relative to the repository root
      Returns:
      matching category - OTHER if nothing else matches

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Enum<MessageSetCategory>
      Returns:
      print out of variables in a JSON-style