All Classes and Interfaces
Class
Description
ArrayPropertyValue stores the values of an array within an entity or relationship properties.
AttributeCardinality is used on a association from one TypeDef to another.
The AttributeTypeDef class is used to identify the type of an attribute.
The AttributeTypeDefCategory defines the list of valid types of a attribute (property) for an open metadata instance.
AttributeTypeDefListResponse provides a simple bean for returning an array of AttributeTypeDefs
AttributeTypeDefResponse provides a response structure for an OMRS REST API call that returns
an AttributeTypeDef object.
Deprecated.
AuditLogReportResponse describes the response structure for an OMRS REST API that returns
an AuditLogReport object.
AuditLogSeveritiesResponse support an OMRS REST API response that returns a list of Audit log severity definition objects.
BooleanResponse is the response structure used on the OMRS REST API calls that return a boolean response.
The Classification class stores information about a classification assigned to an entity.
The ClassificationCondition class provides support for searching against a single classification, either based only
on its name or also combined with a set of property-based conditions.
ClassificationDef stores the properties for the definition of a type of classification.
Capture the differences between classification instances.
ClassificationEntityExtension is used to represent a single classification for an entity.
The ClassificationErrorException is thrown by an OMRS Connector when a classification for a specific entity
instance is either not defined for this type of entity or is not currently attached to the requested entity.
ClassificationListResponse support an OMRS REST API response that returns a list of Classification objects.
ClassificationOrigin describes the provenance of a classification attached to an entity.
ClassificationPropagationRule is part of a relationship definition (RelationshipDef).
ClassificationProxyRequest is used when working with classifications using an entity proxy.
ClassificationRequest carries the properties needed to create a classification.
ClassificationResponse describes the response structure for an OMRS REST API that returns
a Classification object.
ClassificationWithEntityRequest carries a classification that has changed along with its entity.
CohortConnectionStatus defines the status of the local server's connection to the metadata highway for
a specific cohort.
CohortDescription describes a single cohort.
CohortListResponse support an OMRS REST API response that returns a list of cohort description objects.
CohortMembership describes the structure of the cohort registry store.
CohortMembershipListResponse support an OMRS REST API response that returns a list of cohort member registration objects.
CohortListResponse support an OMRS REST API response that returns a list of cohort description objects.
CollectionDef supports the definition of a collection type.
This enum defines the list of open metadata collection types.
Future that represents a task that has already completed.
OMRSFuture which has a list of child futures.ConnectionResponse is the response structure used on REST API calls that return a
Connection object as a response.
Future that starts out as unfinished can can be delegated
to a different Future once processing takes place.
General class for capturing differences.
EntityConflictException provides a checked exception for reporting that an entity can not be added because
it conflicts with an entity already stored.
EntityCreateRequest carries the properties needed to create a new entity.
EntityDef describes a type of entity in the metadata collection.
EntityDetail stores all the type-specific properties for the entity.
Capture the differences between EntityDetail objects.
EntityDetailResponse describes the response structure for an OMRS REST API that returns
an EntityDetail object.
EntityFindRequest restricts a find request to entities with specific classifications.
EntityHistoricalFindRequest provides an extension to the search parameters to include the
point in time that the request should be based on.
EntityListResponse support an OMRS REST API response that returns a list of EntityDetail objects.
EntityNeighborhoodFindRequest adds the ability to restrict a neighborhood find request to only
traversing specific relationship types.
TypeLimitedHistoricalFindRequest provides an extension to the search parameters to include the
point in time that the request should be based on.
EntityNotDeletedException is thrown by an OMRS Connector when a request is made to purge or restore a specific
entity instance and the entity is not in DELETED status.
The EntityNotKnownException is thrown by an OMRS Connector when a specific entity instance is requested but this
entity is not known in the metadata collection.
EntityPropertyFindRequests restricts a find request to entities with specific classifications.
EntityPropertyHistoricalFindRequest provides an extension to the search parameters to include the
point in time that the request should be based on.
EntityProxy summarizes an entity instance.
Capture the differences between EntityProxy objects.
The EntityProxyOnlyException is thrown by an OMRS Connector when a specific entity instance is requested but this
only a proxy version of the entity is in the metadata collection.
EntitySummary provides the basic header attributes for an open metadata entity.
Capture the differences between EntitySummary objects.
EntitySummaryResponse describes the response structure for an OMRS REST API that returns an EntitySummary object.
The EnumDef describes an open metadata enumeration.
EnumElementDef describes a single valid value defined for an enum.
An EnumPropertyValue stores the value for an enum property.
ExternalStandardMapping defines a mapping of TypeDefs and TypeDefAttributes to an external standard.
FunctionNotSupportedException provides a checked exception for reporting that an OMRS repository connector
does not support the method called.
HistoryRequest carries the date/time for a historical query.
HistoryRequest carries the date/time for a historical query.
HistorySequencingOrder is used for retrieval of history against a metadata collection.
The HomeEntityException is thrown by an OMRS Connector when reference copy maintenance requests are issued on
a home entity instance in the metadata collection.
The HomeRelationshipException is thrown by an OMRS Connector when reference copy maintenance requests are issued on
a home relationship instance in the metadata collection.
An event that was received from a connector
The state of an event that was received from a connector
InstanceAuditHeader manages the attributes that are common to classifications,
entities and relationships.
InstanceElementHeader provides a common base for all instance information from the metadata collection.
InstanceFindRequest adds match properties to a find request.
InstanceGraph stores a subgraph of entities and relationships and provides methods to access its content.
InstanceGraphRequest is the request structure for an OMRS REST API call that
sends an instance graph object.
InstanceGraphResponse is the response structure for an OMRS REST API call that
returns an instance graph object.
InstanceHeader manages the attributes that are common to entities and relationship instances.
InstanceHistoricalFindRequest provides an extension to the search parameters to include the
point in time that the request should be based on.
The InstanceProperties class provides support for properties to be added to an entity,
classification or relationship instances.
Capture the differences between instance properties.
InstancePropertiesRequest carries the properties needed to update an entity, relationship or classification.
The InstancePropertyCategory defines the list of value types for the properties for open metadata.
InstancePropertyValue provides a common class for holding an instance type and value.
InstanceProvenanceType defines where the metadata comes from and, hence if it can be updated.
The InstanceStatus defines the status of an instance (classification, relationship or an entity) in the metadata collection.
InstanceType contains information from the instance's TypeDef that are useful for processing the instance.
Internal Asynchronous message processing context.
InvalidEntityException provides a checked exception for reporting that an entity can not be added because
its content is invalid.
The InvalidParameterException is thrown by an OMRS Connector when the parameters passed to a repository
connector, or its accompanying metadata collection, are not valid.
InvalidRelationshipException provides a checked exception for reporting that a relationship can not be added because
its content is invalid.
InvalidTypeDefException provides a checked exception for reporting that a typedef can not be added because
its content is invalid.
MapPropertyValue stores the values of a map within an entity, struct or relationship properties.
The MatchCriteria enum defines how the metadata instances in the metadata collection should be matched
against the properties supplied on the search request.
MemberRegistration is a POJO for storing the information about a metadata repository that is a member
of the open metadata repository cohort.
MetadataCollectionIdRequest is the request structure used on the OMRS REST API calls that use the home metadata collection id as
a validator/originator for the request.
MetadataCollectionIdResponse is the response structure used on the OMRS REST API calls that return a String response.
OMRSAPISearchRequest provides a common header for OMRS managed rest to the OMRS REST API.
OMRSAPIHistoricalFindRequest provides an extension to the search parameters to include the
point in time that the request should be based on.
OMRSAPIPagedFindRequest provides support for the paging parameters of a find request.
OMRSRESTAPIPagedResponse provides the base definition for a paged response.
OMRSAPIRequest provides a common header for complex OMRS request to the OMRS REST API.
OMRSAPIResponse provides a common header for OMRS managed rest to the OMRS REST API.
The OMRSAuditCode is used to define the message content for the OMRS Audit Log.
OMRSAuditingComponent provides identifying and background information about the components writing log records
to the OMRS Audit log.
OMRSAuditLog is a class for managing the audit logging of activity for the OMAG components.
OMRSAuditLogDestination provides information needed to log records to the configured audit log destinations
for a specific server instance.
OMRSAuditLogDestinationReport is a container for properties about the logging destinations
supported by this audit log.
OMRSAuditLogRecord provides a carrier for details about a single log record in the OMRS audit log.
OMRSAuditLogRecordOriginator describes the server that originated an audit log record.
OMRSAuditLogRecordSeverity defines the different levels of severity for log records stored in the OMRSAuditLogRecord.
OMRSAuditLogReport is a structure that describes the properties of the audit log running in a server.
OMRSAuditLogReportingComponent describes the component issuing the audit log record.
AuditLogReportSeverity provides information about the different types of severities defined for the audit log.
OMRSAuditLogStore is the specialized data API for an Audit Log destination connector.
OMRSAuditLogStoreConnectorBase is the base class for connectors that support the OMRSAuditLog.
The OMRSAuditLogStoreProviderBase provides a base class for the connector provider supporting OMRS
audit log stores.
OMRSAuditLogStoreReport is a bean to describe one of the audit log store connectors registered with a server.
OMRSCheckedExceptionBase provides a checked exception for reporting errors found when using the OMRS.
OMRSCohortRegistryStore is a connector to a repository that can store registration information for a cohort registry.
OMRSCohortRegistryStoreConnectorBase provides the base class for a cohort registry store.
The OMRSCohortRegistryStoreProviderBase provides a base class for the connector provider supporting OMRS
cluster registry stores.
OMRSConfigErrorException is used for all runtime exceptions generated by the Open Metadata Repository Services (OMRS)
components that indicate a configuration error.
OMRSConnectorErrorException is used for all runtime exceptions generated by the Open Metadata Repository Services (OMRS)
components that indicate a problem with one of its connectors.
OMRSDynamicTypeMetadataCollectionBase provides a base class for an open metadata repository that
has a dynamic type system.
The OMRSErrorCode is used to define first failure data capture (FFDC) for errors that occur within the OMRS
It is used in conjunction with all OMRS Exceptions, both Checked and Runtime (unchecked).
OMRSEvent defines the common content of a message that is sent through the OMRSTopicConnector to all metadata
repositories registered in the open metadata repository cohort.
OMRSEventBean provides a common root for all bean versions of the OMRSEvent.
OMRSEventCategory defines the different categories of events that pass through the OMRS Topic.
OMRSEventDirection defines the origin of an OMRSEvent.
OMRSEventErrorCode is a merging of the OMRSRegistryEventErrorCode, OMRSTypeDefEventErrorCode and
OMRSInstanceEventErrorCode that is used in OMRSEvent.
OMRSEventOriginator is part of an OMRSEvent's header.
OMRS message processing context.
OMRSEventProtocolVersion provides the identifier for the version number of the event payload.
OMRSEventV1 is the OMRSEvent payload for version 1 of the open metadata and governance message exchange.
OMRSEventV1ErrorSection describes the properties used to record errors detected by one of the members of the
open metadata repository cohort.
OMRSEventV1InstanceSection describes the properties specific to instance events
OMRSEventV1RegistrySection describes properties that are used exclusively for registry events.
OMRSEventV1TypeDefSection describes the properties specific to TypeDef related events
OMRSFixedTypeMetadataCollectionBase provides a base class for an open metadata repository that
has a fixed type system.
Future wrapper to prevent consumers from
directly accessing Futures created by other
consumers.
Implementation of
OMRSFutureOMRSInstanceEventErrorCode defines the list of error codes that are used to record errors in the metadata
instance replication process that is used by the repository connectors within the open metadata repository cluster.
OMRSInstanceEventProcessor is an interface implemented by a component that is able to process incoming
metadata instance events for an Open Metadata Repository.
OMRSInstanceEventProcessorClassificationExtension adds methods for classifications that include an entity proxy rather than an entity proxy.
OMRSInstanceEventProcessor is an interface implemented by a component that is able to process incoming
metadata instance events for an Open Metadata Repository.
OMRSInstanceEventType defines the different types of instance events in the open metadata repository services
protocol.
OMRSLogicErrorException is used for all runtime exceptions generated by the Open Metadata Repository Services (OMRS)
components that indicate a logic error.
OMRSMetadataInstanceStore is the common interface for working with the contents of a metadata repository.
OMRSMetadataInstanceStore is the common interface for working with the contents of a metadata repository.
OMRSRepositoryConnectors are used by OMRS to retrieve metadata from metadata repositories.
OMRSMetadataDefaultEventsSecurity provides a default instance events security filter that allows all events to
pass unchanged.
OMRSMetadataDefaultRepositorySecurity provides a default instance repository security support that allows all
actions.
OMRSRegistryEvent provides the conversion between the properties of a registry event and the serialized event body.
OMRSRegistryEventErrorCode defines the list of error codes that are used to record errors in the registration
process that is used by the cluster registries when managing the membership of the open metadata repository cluster.
OMRSRegistryEventProcessor is an interface implemented by a component that is able to process
registry events for an Open Metadata Repository's membership of an Open Metadata Repository Cohort.
OMRSRegistryEventProcessor is an interface implemented by a component that is able to process
registry events for an Open Metadata Repository's membership of an Open Metadata Repository Cohort.
OMRSRegistryEventType defines the different types of registry events in the open metadata repository services
protocol.
The OMRSRepositoryConnector defines the interface for an OMRS Repository Connector.
The OMRSRepositoryConnectorProviderBase provides a base class for the connector provider supporting OMRS Connectors.
OMRSRepositoryEventMapper is the interface to a connector that is converting events received from
a non-native local metadata repository into OMRS compliant repository events.
OMRSRepositoryEventMapperBase provides a base class for implementors of OMRSRepositoryEventMapper.
OMRSRepositoryEventMapperBase provides a base class for implementors of OMRSRepositoryEventMapper.
OMRSRepositoryEventMapperProviderBase provides a base class for the connector provider supporting
OMRSRepositoryEventMapper connectors.
OMRSRepositoryEventProcessor describes the interface of a component that can process both TypeDef and Instance
events from an open metadata repository.
OMRSRepositoryHelper provides methods to repository connectors and repository event mappers to help
them build valid type definitions (TypeDefs), entities and relationships.
OMRSRepositoryHelper provides methods to repository connectors and repository event mappers to help
them build valid type definitions (TypeDefs), entities and relationships.
OMRSRepositoryPropertiesUtilities implements the methods to add and remove values from InstanceProperties
objects as defined by the OMRSRepositoryPropertiesHelper interface.
OMRSRepositoryValidator provides methods to validate TypeDefs and Instances returned from
an open metadata repository.
OMRSRuntimeException is used for all runtime exceptions generated by the Open Metadata Repository Services (OMRS).
OMRSTopic defines the interface to the messaging Topic for OMRS Events.
OMRSTopicConnector provides the support for the registration of OMRSTopicListeners and the distribution of
OMRS events - both inbound and outbound.
OMRSTopicListener defines the interface that a listener must implement in order to receive events
from the OMRSTopicConnector.
OMRSTopicListenerBase provides a base class for a topic listener, so it only needs to
override the methods for the events it cares about.
OMRSTopicListenerWrapper is a class that wraps a real OMRSTopicListener when it registers with the
OMRSTopicConnector.
OMRSTopicProvider provides implementation of the connector provider for the OMRSTopicConnector.
OMRSTopicRepositoryEventListener defines the interface that a listener must implement in order to receive repository
events from the OMRSTopicConnector.
OMRSTypeDefEvent provides the wrapper for an event that relates to a type definition (TypeDef).
OMRSTypeDefEventErrorCode defines the list of error codes that are used to record errors in the TypeDef
synchronization process that is used by the repository connectors within the open metadata repository cluster.
OMRSTypeDefEventProcessor is an interface implemented by a component that is able to process incoming
TypeDef events for an Open Metadata Repository.
OMRSTypeDefEventProcessor is an interface implemented by a component that is able to process incoming
TypeDef events for an Open Metadata Repository.
OMRSTypeDefEventType defines the different types of TypeDef events in the open metadata repository services
protocol:
UNKNOWN_TYPEDEF_EVENT: the event is not recognized by this local server, probably because it is back-level
from other servers in the cluster.
OpenMetadataArchive defines the structure of the properties in an open metadata archive.
OpenMetadataArchiveBuilder defines the interface for an open metadata archive store connector that is able
to manage individual elements of the open metadata archive.
OpenMetadataArchiveCache is an optional interface for a builder that is accumulating the archive contents in memory.
OpenMetadataArchiveElementHeader provides a common base for the content of an open metadata archive.
OpenMetadataArchiveInstanceStore defines the contents of the InstanceStore in an open metadata archive.
OpenMetadataArchiveProperties defines the properties of an open metadata archive.
OpenMetadataArchiveStore is the interface for a connector to an open metadata archive.
OpenMetadataArchiveStoreConnector is the base class for connectors that support the OpenMetadataArchiveStore
The OpenMetadataArchiveProviderStoreBase provides a base class for the connector provider supporting OMRS
open metadata archive stores.
OpenMetadataArchiveType defines the origin of the open metadata archive.
OpenMetadataArchiveTypeStore defines the contents of the TypeStore in an open metadata archive.
OpenMetadataEventsSecurity defines the optional interface that an Open Metadata Server Security
Connector can implement to control whether an event is either sent or received from a cohort.
OpenMetadataRepositorySecurity defines security checks for accessing and maintaining open metadata types
and instances in the local repository.
OpenMetadataTopic defines the generic interface to an event bus topic for open metadata events.
OpenMetadataTopicConnector provides the support for the registration of listeners and the distribution of
incoming events to the registered listeners.
OpenMetadataTopicConnectorBase is a base class to topic connectors that only send
events on the embedded event bus connector
OpenMetadataTopicListener defines the interface that a listener must implement in order to receive events
from the open metadata topic.
OpenMetadataTopicListenerConnectorBase is a base class for a connector that is going to embed the OpenMetadataTopicConnector
and register a listener with it.
OMRSTopicProvider provides implementation of the connector provider for the OMRSTopicConnector.
OpenMetadataTopicConnectorBase is a base class to topic connectors that only send
events on the embedded event bus connector
The PagingErrorException is thrown by an OMRS Connector when the caller has passed invalid paging attributes
on a search call.
PatchErrorException provides a checked exception for reporting that a typedef can not be updated because there are
problems with the supplied TypeDefPatch.
PrimitiveDef supports the definition of a primitive type.
This enumeration defines the list of open metadata primitive types.
PrimitivePropertyValue stores a single primitive property.
PropertyComparisonOperator is used for search requests against a metadata collection.
The PropertyCondition class provides support for searching against a single property using a single comparison
mechanism, or for nesting further SearchProperties.
The PropertyErrorException is thrown by an OMRS Connector when the properties defined for a specific entity
or relationship instance do not match the TypeDefs for the metadata collection.
PropertyMatchFindRequest adds match properties and the match criteria to a find request.
PropertyMatchHistoricalFindRequest provides an extension to the search parameters to include the
point in time that the request should be based on.
ProxyClassificationRequest is used when working with classifications using an entity proxy.
RelatedEntitiesHistoricalFindRequest provides an extension to the search parameters to include the
point in time that the request should be based on.
Relationship is a POJO that manages the properties of an open metadata relationship.
RelationshipConflictException provides a checked exception for reporting that a relationship can not be added because
it conflicts with a relationship already stored.
RelationshipCreateRequest provides the bean to hold all the properties needed to create a new
relationship.
RelationshipDef describes the type of a relationship.
Capture the differences between relationship instances.
RelationshipCardinality is used in a RelationshipEndDef to indicate how many relationships of this type
can be connected to an entity instance.:
UNKNOWN: uninitialized cardinality
AT_MOST_ONE: means there can be zero or one instances of this relationship connected
to an instance of the EntityDef.
RelationshipEndDef describes the type of the entity and the attribute information for one end of a RelationshipDef.
RelationshipListResponse holds the response information for an OMRS REST API call that returns a list of
relationship objects or an exception.
RelationshipNotDeletedException is thrown by an OMRS Connector when a request is made to purge or restore a specific
relationship instance and the entity is not in DELETED status.
RelationshipNotKnownException provides a checked exception for reporting when a requested relationship
instance can not be found in the metadata collection.
RelationshipResponse describes the response to an OMRS REST API request that returns a relationship object.
RepositoryElementHeader provides a common base for all type and instance information from the metadata collection.
RepositoryErrorException provides a checked exception for reporting situations where the metadata
repository hosting a metadata collection is unable to perform a request.
RepositoryTimeoutException provides a checked exception for reporting situations where the metadata
repository hosting a metadata collection is unable to perform a request due to a timeout (for example, a query
that exceeds a maximum allowed response time threshold).
The SearchClassifications class provides support for searching against one or more classifications using a variety of
comparison mechanisms.
The SearchProperties class provides support for searching against one or more properties using a variety of
comparison mechanisms, including searching against the same property using different comparison mechanisms.
SequencingOrder is used for search requests against a metadata collection.
StatusNotSupportedException provides a checked exception for reporting that the metadata repository hosting
a metadata collection is not able to support the requested status.
StructPropertyValue supports the value part of property that is defined as a complex structure.
SubtypeLimitedFindRequest extends the type limited find request to allow the caller to request that only a restricted
list of subtypes of the overall type are included in the results.
The TypeDef is the base class for objects that store the properties of an open metadata type
definition (call ed a TypeDef).
TypeDefAttribute stores the properties used to describe a attribute within a Classification,
Entity or Relationship.
TypeDefAttributeStatus is an enum that describes the status of a specific typeDef attribute.
The TypeDefCategory defines the list of valid types of TypeDef for open metadata instances.
TypeDefChangeRequest carries details of the old and new TypeDef used to re-type an instance.
TypeDefConflictException provides a checked exception for reporting that a typedef can not be added because
it conflicts with a TypeDef already stored.
TypeDefDeleteRequest carries the TypeDef properties for deleting a TypeDef.
TypeDefElementHeader provides a common base for all typedef information.
TypeDefGalleryResponse contains details of the AttributeTypeDefs and full TypeDefs supported by a rep
TypeDefGalleryResponse provides the response structure for an OMRS REST API call that returns a TypeDefGallery.
TypeDefInUseException provides a checked exception for reporting that a typedef can not be deleted because there are
instances currently using it.
TypeDefKnownException provides a checked exception for reporting that a type definition (TypeDef) can not be added because
it is already known to the repository.
The TypeDefLink holds basic identifying information used to link one TypeDef to another.
TypeDefListResponse provides a simple bean for returning a list of TypeDefs (or information to create
a valid OMRS exception).
TypeDefNotKnownException provides a checked exception for reporting that a requested typedef can not be found.
TypeDefNotSupportedException provides a checked exception for reporting that a typedef can not be added because
the local repository can not support it.
TypeDefPatch describes a change (patch) to a typeDef's properties, options, external standards mappings or
list of valid instance statuses.
The TypeDefProperties class provides support for arbitrary properties that belong to a TypeDef object.
TypeDefReIdentifyRequest carries the TypeDef properties for changing the identity of a TypeDef.
TypeDefResponse provides the response structure for an OMRS API call that returns a TypeDef
TypeDefStatus is an enum that describes the status of a specific typeDef.
The TypeDefSummary holds basic identifying information for a specific TypeDef.
TypeDefValidationForRequest carries the TypeDef validation properties for destructive requests (such as delete).
The TypeErrorException is thrown by an OMRS Connector when the requested type for an instance is not represented by
a known TypeDef.
TypeLimitedFindRequest extends the paged find request to allow the caller to request results from only
one type of instance.
TypeLimitedHistoricalFindRequest provides an extension to the search parameters to include the
point in time that the request should be based on.
The UserNotAuthorizedException is thrown by an OMRS Connector when the supplied UserId is not permitted to
perform a specific operation on the metadata collection.
VoidResponse defines the response structure for an OMRS REST API call that has a void return with
checked exceptions