Index (topic-integrator-api 5.2 API)

C F G I N O P R S T U V W
All Classes and Interfaces|All Packages

C

clearAssetConnection(String, String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Remove a relationship between an asset and its connection.
clearConnectorType(String, String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Remove a relationship between a connection and a connector type.
clearEmbeddedConnection(String, String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Remove a relationship between a virtual connection and an embedded connection.
clearEndpoint(String, String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Remove a relationship between a connection and an endpoint.
clearReferenceValueTag(String, String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Remove a reference value assignment relationship between an element and a valid value.
clearSchemaElementRelationship(String, String, String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Remove a relationship between two schema elements.
clearSchemaTypes(String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Remove the linked schema types from a schema attribute.
clearValidValueMember(String, String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Remove a membership relationship between a validValue and a validValueSet that it belongs to.
clearValidValues(String, String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Remove a valid value assignment relationship between an element and a valid value.
CONNECTOR_CONTEXT_INITIALIZING - Enum constant in enum class org.odpi.openmetadata.integrationservices.topic.ffdc.TopicIntegratorAuditCode: OMIS-TOPIC-INTEGRATOR-0002 - Creating context for integration connector {0} ({1}) connecting to third party technology {2} with permitted synchronization of {3} and service options of {4}
CONTEXT_INITIALIZING - Enum constant in enum class org.odpi.openmetadata.integrationservices.topic.ffdc.TopicIntegratorAuditCode: OMIS-TOPIC-INTEGRATOR-0001 - The topic integrator context manager is being initialized for calls to server {0} on platform {1}
createConnection(ConnectionProperties) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Create a new metadata element to represent a connection.
createConnectionFromTemplate(String, TemplateProperties) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Create a new metadata element to represent a connection using an existing metadata element as a template.
createEndpoint(EndpointProperties) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Create a new metadata element to represent an endpoint
createEndpointFromTemplate(String, String, TemplateProperties) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Create a new metadata element to represent a endpoint using an existing metadata element as a template.
createEnumSchemaType(EnumSchemaTypeProperties, String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Create a new metadata element to represent a schema type that has a fixed set of values that are described by a valid value set.
createEventType(String, EventTypeProperties) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Create a new metadata element to represent a event type.
createEventTypeFromTemplate(String, String, TemplateProperties) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Create a new metadata element to represent an event type using an existing metadata element as a template.
createLiteralSchemaType(LiteralSchemaTypeProperties) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Create a new metadata element to represent a schema type that has a fixed value.
createMapSchemaType(MapSchemaTypeProperties, String, String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Create a new metadata element to represent a schema type.
createPrimitiveSchemaType(PrimitiveSchemaTypeProperties) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Create a new metadata element to represent a primitive schema type such as a string, integer or character.
createSchemaAttribute(String, SchemaAttributeProperties) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Create a new metadata element to represent a schema attribute.
createSchemaAttributeFromTemplate(String, String, TemplateProperties) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Create a new metadata element to represent a schema attribute using an existing metadata element as a template.
createSchemaTypeChoice(SchemaTypeChoiceProperties, List<String>) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Create a new metadata element to represent a list of possible schema types that can be used for the attached API parameter.
createSchemaTypeFromTemplate(String, TemplateProperties) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Create a new metadata element to represent a schema type using an existing metadata element as a template.
createStructSchemaType(StructSchemaTypeProperties) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Create a new metadata element to represent a schema type.
createTopic(TopicProperties) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Create a new metadata element to represent a topic.
createTopicFromTemplate(String, TemplateProperties) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Create a new metadata element to represent a topic using an existing metadata element as a template.
createValidValue(ValidValueProperties) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Create a new metadata element to represent a valid value.

F

findConnections(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the list of metadata elements that contain the search string.
findConnectorTypes(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the list of connector type metadata elements that contain the search string.
findEndpoints(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the list of endpoint metadata elements that contain the search string.
findEventTypes(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the list of event type metadata elements that contain the search string.
findSchemaAttributes(String, String, int, int) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the list of schema attribute metadata elements that contain the search string.
findSchemaType(String, String, int, int) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the list of schema type metadata elements that contain the search string.
findTopics(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the list of topic metadata elements that contain the search string.
findValidValues(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the list of metadata elements that contain the search string.
findValidValueSet(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the list of valid value set metadata elements that contain the search string.

G

getAllValidValues(int, int) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the list of valid values.
getAssigneesOfReferenceValue(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Return information about the person roles linked to a validValue.
getConnectionByGUID(String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the metadata element with the supplied unique identifier.
getConnectionsByName(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the list of metadata elements with a matching qualified or display name.
getConnectorTypeByGUID(String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the connector type metadata element with the supplied unique identifier.
getConnectorTypesByName(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the list of connector type metadata elements with a matching qualified or display name.
getConsumersOfValidValue(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Return information about the consumers linked to a validValue.
getContext() - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorConnector: Return the context for this connector.
getEndpointByGUID(String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the endpoint metadata element with the supplied unique identifier.
getEndpointsByName(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the list of endpoint metadata elements with a matching qualified or display name.
getEventBrokerGUID() - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Return the unique identifier of the event broker's entity that corresponds to the eventBrokerName.
getEventBrokerName() - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Return the qualified name of the event broker that is supplied in the configuration document.
getEventTypeByGUID(String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the event type metadata element with the supplied unique identifier.
getEventTypesByName(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the list of event type metadata elements with a matching qualified or display name.
getEventTypesForEventSet(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Return the list of event types associated with a topic.
getEventTypesForTopic(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Return the list of event types associated with a topic.
getMessageDefinition() - Method in enum class org.odpi.openmetadata.integrationservices.topic.ffdc.TopicIntegratorAuditCode: Retrieve a message definition object for logging.
getMessageDefinition() - Method in enum class org.odpi.openmetadata.integrationservices.topic.ffdc.TopicIntegratorErrorCode: Retrieve a message definition object for an exception.
getMessageDefinition(String...) - Method in enum class org.odpi.openmetadata.integrationservices.topic.ffdc.TopicIntegratorAuditCode: Retrieve a message definition object for logging.
getMessageDefinition(String...) - Method in enum class org.odpi.openmetadata.integrationservices.topic.ffdc.TopicIntegratorErrorCode: Retrieve a message definition object for an exception.
getMyTopics(int, int) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the list of topics created by this caller.
getNestedAttributes(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the list of schema attributes associated with a StructSchemaType or nested underneath a schema attribute.
getReferenceValues(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Return information about the valid values linked as reference value tags to an element.
getSchemaAttributeByGUID(String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the schema attribute metadata element with the supplied unique identifier.
getSchemaAttributesByName(String, String, int, int) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the list of schema attribute metadata elements with a matching qualified or display name.
getSchemaTypeByGUID(String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the schema type metadata element with the supplied unique identifier.
getSchemaTypeByName(String, String, int, int) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the list of schema type metadata elements with a matching qualified or display name.
getSchemaTypeForElement(String, String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Return the schema type associated with a specific open metadata element (data asset, process or port).
getSchemaTypeParent(String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the header of the metadata element connected to a schema type.
getSetsForValidValue(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Page through the list of valid value sets that a valid value definition/set belongs to.
getTopicByGUID(String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the topic metadata element with the supplied unique identifier.
getTopicsByName(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the list of topic metadata elements with a matching qualified or display name.
getValidValueByGUID(String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the metadata element with the supplied unique identifier.
getValidValuesByName(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the list of metadata elements with a matching qualified or display name.
getValidValueSetByName(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Retrieve the list of valid value set metadata elements with a matching qualified or display name.
getValidValueSetMembers(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Page through the members of a valid value set.
getValidValuesForConsumer(String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Return information about the valid value set linked to an element as its set of valid values.

I

INVALID_CONNECTOR - Enum constant in enum class org.odpi.openmetadata.integrationservices.topic.ffdc.TopicIntegratorErrorCode: OMIS-TOPIC-INTEGRATOR-400-001 - Integration connector {0} is not of the correct type to run in the {1} integration service.

N

NULL_CONTEXT - Enum constant in enum class org.odpi.openmetadata.integrationservices.topic.ffdc.TopicIntegratorAuditCode: OMIS-TOPIC-INTEGRATOR-0003 - Integration connector {0} has a null context
NULL_CONTEXT - Enum constant in enum class org.odpi.openmetadata.integrationservices.topic.ffdc.TopicIntegratorErrorCode: OMIS-TOPIC-INTEGRATOR-500-001 - Integration connector {0} has a null context

O

org.odpi.openmetadata.integrationservices.topic.api - package org.odpi.openmetadata.integrationservices.topic.api
org.odpi.openmetadata.integrationservices.topic.connector - package org.odpi.openmetadata.integrationservices.topic.connector: This package provides the interfaces and base classes to use when writing an integration connector for the Topic Integrator OMIS.
org.odpi.openmetadata.integrationservices.topic.ffdc - package org.odpi.openmetadata.integrationservices.topic.ffdc

P

publishTopic(String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Update the zones for the topic asset so that it becomes visible to consumers.

R

registerListener(DataManagerEventListener) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Register a listener object that will be passed each of the events published by the Data Manager OMAS.
removeConnection(String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Remove the metadata element representing a connection.
removeEndpoint(String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Remove the metadata element representing a endpoint.
removeEventType(String, String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Remove the metadata element representing an event type.
removeSchemaAttribute(String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Remove the metadata element representing a schema attribute.
removeSchemaType(String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Remove the metadata element representing a schema type.
removeTopic(String, String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Remove the metadata element representing a topic.
removeValidValue(String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Remove the metadata element representing a valid value.

S

setContext(TopicIntegratorContext) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorConnector: Set up the context for this connector.
setEventBrokerIsHome(boolean) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Set up the flag that controls the ownership of metadata created for this Event Broker.
setupAssetConnection(String, String, String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Create a relationship between an asset and its connection.
setupConnectorType(String, String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Create a relationship between a connection and a connector type.
setupEmbeddedConnection(String, int, String, Map<String, Object>, String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Create a relationship between a virtual connection and an embedded connection.
setupEndpoint(String, String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Create a relationship between a connection and an endpoint.
setupReferenceValueTag(String, ReferenceValueAssignmentProperties, String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Create a reference value assignment relationship between an element and a valid value to show that the valid value is a semiformal tag/classification.
setupSchemaElementRelationship(String, String, String, RelationshipProperties) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Create a relationship between two schema elements.
setupSchemaType(String, String, String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Connect a schema type to a schema attribute.
setupValidValueMember(String, ValidValueMembershipProperties, String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Create a membership relationship between a validValue and a validValueSet that it belongs to.
setupValidValues(String, ValidValueAssignmentProperties, String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Create a valid value assignment relationship between an element and a valid value (typically, a valid value set) to show that the valid value defines the values that can be stored in the data item that the element represents.

T

TopicIntegratorAPI - Interface in org.odpi.openmetadata.integrationservices.topic.api: TopicIntegratorAPI is the interface to validate that a connector is suitable to run in the Topic Integrator OMIS.
TopicIntegratorAuditCode - Enum Class in org.odpi.openmetadata.integrationservices.topic.ffdc: The TopicIntegratorAuditCode is used to define the message content for the OMRS Audit Log.
TopicIntegratorConnector - Class in org.odpi.openmetadata.integrationservices.topic.connector: TopicIntegratorConnector is the base class for an integration connector that is managed by the Topic Integrator OMIS.
TopicIntegratorConnector() - Constructor for class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorConnector
TopicIntegratorContext - Class in org.odpi.openmetadata.integrationservices.topic.connector: TopicIntegratorContext is the context for cataloging topics from an event broker server.
TopicIntegratorContext(String, String, String, String, OpenIntegrationClient, GovernanceConfiguration, OpenMetadataClient, ActionControlInterface, EventBrokerClient, ConnectionManagerClient, ValidValueManagement, DataManagerEventClient, boolean, PermittedSynchronization, String, String, String, AuditLog, int) - Constructor for class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Create a new client with no authentication embedded in the HTTP request.
TopicIntegratorErrorCode - Enum Class in org.odpi.openmetadata.integrationservices.topic.ffdc: The TopicIntegratorErrorCode error code is used to define first failure data capture (FFDC) for errors that occur when working with the Integration Services.
TopicIntegratorOMISConnector - Interface in org.odpi.openmetadata.integrationservices.topic.connector: A marker interface to identify the OMIS that this connector works with.
toString() - Method in enum class org.odpi.openmetadata.integrationservices.topic.ffdc.TopicIntegratorAuditCode: JSON-style toString
toString() - Method in enum class org.odpi.openmetadata.integrationservices.topic.ffdc.TopicIntegratorErrorCode: JSON-style toString

U

updateConnection(String, boolean, ConnectionProperties) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Update the metadata element representing a connection.
updateEndpoint(boolean, String, EndpointProperties) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Update the metadata element representing an endpoint.
updateEventType(String, boolean, EventTypeProperties) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Update the metadata element representing an event type.
updateSchemaAttribute(String, boolean, SchemaAttributeProperties) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Update the properties of the metadata element representing a schema attribute.
updateSchemaType(String, boolean, SchemaTypeProperties) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Update the metadata element representing a schema type.
updateTopic(String, boolean, TopicProperties) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Update the metadata element representing a topic.
updateValidValue(String, boolean, ValidValueProperties) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Update the metadata element representing a valid value.

V

validateConnector(String, String) - Method in interface org.odpi.openmetadata.integrationservices.topic.api.TopicIntegratorAPI: Validate the connector and return its connector type.
valueOf(String) - Static method in enum class org.odpi.openmetadata.integrationservices.topic.ffdc.TopicIntegratorAuditCode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.odpi.openmetadata.integrationservices.topic.ffdc.TopicIntegratorErrorCode: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.odpi.openmetadata.integrationservices.topic.ffdc.TopicIntegratorAuditCode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.odpi.openmetadata.integrationservices.topic.ffdc.TopicIntegratorErrorCode: Returns an array containing the constants of this enum class, in the order they are declared.

W

withdrawTopic(String) - Method in class org.odpi.openmetadata.integrationservices.topic.connector.TopicIntegratorContext: Update the zones for the topic asset so that it is no longer visible to consumers.

C F G I N O P R S T U V W
All Classes and Interfaces|All Packages