Class TopicIntegratorContext


  • public class TopicIntegratorContext
    extends java.lang.Object
    TopicIntegratorContext is the context for cataloging topics from an event broker server.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void clearAssetConnection​(java.lang.String assetGUID, java.lang.String connectionGUID)
      Remove a relationship between an asset and its connection.
      void clearConnectorType​(java.lang.String connectionGUID, java.lang.String connectorTypeGUID)
      Remove a relationship between a connection and a connector type.
      void clearEmbeddedConnection​(java.lang.String connectionGUID, java.lang.String embeddedConnectionGUID)
      Remove a relationship between a virtual connection and an embedded connection.
      void clearEndpoint​(java.lang.String connectionGUID, java.lang.String endpointGUID)
      Remove a relationship between a connection and an endpoint.
      void clearReferenceValueTag​(java.lang.String elementGUID, java.lang.String validValueGUID)
      Remove a reference value assignment relationship between an element and a valid value.
      void clearSchemaTypes​(java.lang.String schemaAttributeGUID)
      Remove the linked schema types from a schema attribute.
      void clearValidValueMember​(java.lang.String validValueSetGUID, java.lang.String validValueMemberGUID)
      Remove a membership relationship between a validValue and a validValueSet that it belongs to.
      void clearValidValues​(java.lang.String elementGUID, java.lang.String validValueGUID)
      Remove a valid value assignment relationship between an element and a valid value.
      java.lang.String createConnection​(ConnectionProperties connectionProperties)
      Create a new metadata element to represent a connection.
      java.lang.String createConnectionFromTemplate​(java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a connection using an existing metadata element as a template.
      java.lang.String createEndpoint​(EndpointProperties endpointProperties)
      Create a new metadata element to represent an endpoint
      java.lang.String createEndpointFromTemplate​(java.lang.String networkAddress, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a endpoint using an existing metadata element as a template.
      java.lang.String createEnumSchemaType​(EnumSchemaTypeProperties schemaTypeProperties, java.lang.String validValuesSetGUID)
      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.
      java.lang.String createEventType​(java.lang.String topicGUID, EventTypeProperties properties)
      Create a new metadata element to represent a event type.
      java.lang.String createEventTypeFromTemplate​(java.lang.String templateGUID, java.lang.String topicGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent an event type using an existing metadata element as a template.
      java.lang.String createLiteralSchemaType​(LiteralSchemaTypeProperties schemaTypeProperties)
      Create a new metadata element to represent a schema type that has a fixed value.
      java.lang.String createMapSchemaType​(MapSchemaTypeProperties schemaTypeProperties, java.lang.String mapFromSchemaTypeGUID, java.lang.String mapToSchemaTypeGUID)
      Create a new metadata element to represent a schema type.
      java.lang.String createPrimitiveSchemaType​(PrimitiveSchemaTypeProperties schemaTypeProperties)
      Create a new metadata element to represent a primitive schema type such as a string, integer or character.
      java.lang.String createSchemaAttribute​(java.lang.String schemaElementGUID, SchemaAttributeProperties schemaAttributeProperties)
      Create a new metadata element to represent a schema attribute.
      java.lang.String createSchemaAttributeFromTemplate​(java.lang.String schemaElementGUID, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a schema attribute using an existing metadata element as a template.
      java.lang.String createSchemaTypeChoice​(SchemaTypeChoiceProperties schemaTypeProperties, java.util.List<java.lang.String> schemaTypeOptionGUIDs)
      Create a new metadata element to represent a list of possible schema types that can be used for the attached schema attribute.
      java.lang.String createSchemaTypeFromTemplate​(java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a schema type using an existing metadata element as a template.
      java.lang.String createStructSchemaType​(StructSchemaTypeProperties schemaTypeProperties)
      Create a new metadata element to represent a schema type.
      java.lang.String createTopic​(TopicProperties topicProperties)
      Create a new metadata element to represent a topic.
      java.lang.String createTopicFromTemplate​(java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a topic using an existing metadata element as a template.
      java.lang.String createValidValue​(ValidValueProperties validValueProperties)
      Create a new metadata element to represent a valid value.
      java.util.List<ConnectionElement> findConnections​(java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of metadata elements that contain the search string.
      java.util.List<ConnectorTypeElement> findConnectorTypes​(java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of connector type metadata elements that contain the search string.
      java.util.List<EndpointElement> findEndpoints​(java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of endpoint metadata elements that contain the search string.
      java.util.List<EventTypeElement> findEventTypes​(java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of event type metadata elements that contain the search string.
      java.util.List<SchemaAttributeElement> findSchemaAttributes​(java.lang.String searchString, java.lang.String typeName, int startFrom, int pageSize)
      Retrieve the list of schema attribute metadata elements that contain the search string.
      java.util.List<SchemaTypeElement> findSchemaType​(java.lang.String searchString, java.lang.String typeName, int startFrom, int pageSize)
      Retrieve the list of schema type metadata elements that contain the search string.
      java.util.List<TopicElement> findTopics​(java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of topic metadata elements that contain the search string.
      java.util.List<ValidValueElement> findValidValues​(java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of metadata elements that contain the search string.
      java.util.List<ValidValueSetElement> findValidValueSet​(java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of valid value set metadata elements that contain the search string.
      java.util.List<ValidValueElement> getAllValidValues​(int startFrom, int pageSize)
      Retrieve the list of valid values.
      java.util.List<RelatedElement> getAssigneesOfReferenceValue​(java.lang.String validValueGUID, int startFrom, int pageSize)
      Return information about the person roles linked to a validValue.
      ConnectionElement getConnectionByGUID​(java.lang.String connectionGUID)
      Retrieve the metadata element with the supplied unique identifier.
      java.util.List<ConnectionElement> getConnectionsByName​(java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of metadata elements with a matching qualified or display name.
      ConnectorTypeElement getConnectorTypeByGUID​(java.lang.String connectorTypeGUID)
      Retrieve the connector type metadata element with the supplied unique identifier.
      java.util.List<ConnectorTypeElement> getConnectorTypesByName​(java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of connector type metadata elements with a matching qualified or display name.
      java.util.List<RelatedElement> getConsumersOfValidValue​(java.lang.String validValueGUID, int startFrom, int pageSize)
      Return information about the consumers linked to a validValue.
      EndpointElement getEndpointByGUID​(java.lang.String endpointGUID)
      Retrieve the endpoint metadata element with the supplied unique identifier.
      java.util.List<EndpointElement> getEndpointsByName​(java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of endpoint metadata elements with a matching qualified or display name.
      java.lang.String getEventBrokerName()
      Return the qualified name of the event broker that is supplied in the configuration document.
      EventTypeElement getEventTypeByGUID​(java.lang.String guid)
      Retrieve the event type metadata element with the supplied unique identifier.
      java.util.List<EventTypeElement> getEventTypesByName​(java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of event type metadata elements with a matching qualified or display name.
      java.util.List<EventTypeElement> getEventTypesForEventSet​(java.lang.String eventSetGUID, int startFrom, int pageSize)
      Return the list of event types associated with a topic.
      java.util.List<EventTypeElement> getEventTypesForTopic​(java.lang.String topicGUID, int startFrom, int pageSize)
      Return the list of event types associated with a topic.
      java.util.List<TopicElement> getMyTopics​(int startFrom, int pageSize)
      Retrieve the list of topics created by this caller.
      java.util.List<SchemaAttributeElement> getNestedAttributes​(java.lang.String parentSchemaElementGUID, int startFrom, int pageSize)
      Retrieve the list of schema attributes associated with a StructSchemaType or nested underneath a schema attribute.
      java.util.List<ValidValueElement> getReferenceValues​(java.lang.String elementGUID, int startFrom, int pageSize)
      Return information about the valid values linked as reference value tags to an element.
      SchemaAttributeElement getSchemaAttributeByGUID​(java.lang.String schemaAttributeGUID)
      Retrieve the schema attribute metadata element with the supplied unique identifier.
      java.util.List<SchemaAttributeElement> getSchemaAttributesByName​(java.lang.String name, java.lang.String typeName, int startFrom, int pageSize)
      Retrieve the list of schema attribute metadata elements with a matching qualified or display name.
      SchemaTypeElement getSchemaTypeByGUID​(java.lang.String schemaTypeGUID)
      Retrieve the schema type metadata element with the supplied unique identifier.
      java.util.List<SchemaTypeElement> getSchemaTypeByName​(java.lang.String name, java.lang.String typeName, int startFrom, int pageSize)
      Retrieve the list of schema type metadata elements with a matching qualified or display name.
      SchemaTypeElement getSchemaTypeForElement​(java.lang.String parentElementGUID, java.lang.String parentElementTypeName)
      Return the schema type associated with a specific open metadata element (data asset, process or port).
      ElementHeader getSchemaTypeParent​(java.lang.String schemaTypeGUID)
      Retrieve the header of the metadata element connected to a schema type.
      java.util.List<ValidValueElement> getSetsForValidValue​(java.lang.String validValueGUID, int startFrom, int pageSize)
      Page through the list of valid value sets that a valid value definition/set belongs to.
      TopicElement getTopicByGUID​(java.lang.String guid)
      Retrieve the topic metadata element with the supplied unique identifier.
      java.util.List<TopicElement> getTopicsByName​(java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of topic metadata elements with a matching qualified or display name.
      ValidValueElement getValidValueByGUID​(java.lang.String validValueGUID)
      Retrieve the metadata element with the supplied unique identifier.
      java.util.List<ValidValueElement> getValidValuesByName​(java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of metadata elements with a matching qualified or display name.
      java.util.List<ValidValueSetElement> getValidValueSetByName​(java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of valid value set metadata elements with a matching qualified or display name.
      java.util.List<ValidValueElement> getValidValueSetMembers​(java.lang.String validValueSetGUID, int startFrom, int pageSize)
      Page through the members of a valid value set.
      ValidValueElement getValidValuesForConsumer​(java.lang.String elementGUID)
      Return information about the valid value set linked to an element as its set of valid values.
      void publishTopic​(java.lang.String topicGUID)
      Update the zones for the topic asset so that it becomes visible to consumers.
      void registerListener​(DataManagerEventListener listener)
      Register a listener object that will be passed each of the events published by the Data Manager OMAS.
      void removeConnection​(java.lang.String connectionGUID)
      Remove the metadata element representing a connection.
      void removeEndpoint​(java.lang.String endpointGUID)
      Remove the metadata element representing a endpoint.
      void removeEventType​(java.lang.String eventTypeGUID, java.lang.String qualifiedName)
      Remove the metadata element representing an event type.
      void removeSchemaAttribute​(java.lang.String schemaAttributeGUID)
      Remove the metadata element representing a schema attribute.
      void removeSchemaType​(java.lang.String schemaTypeGUID)
      Remove the metadata element representing a schema type.
      void removeTopic​(java.lang.String topicGUID, java.lang.String qualifiedName)
      Remove the metadata element representing a topic.
      void removeValidValue​(java.lang.String validValueGUID)
      Remove the metadata element representing a valid value.
      void setEventBrokerIsHome​(boolean eventBrokerIsHome)
      Set up the flag that controls the ownership of metadata created for this Event Broker.
      void setupAssetConnection​(java.lang.String assetGUID, java.lang.String assetSummary, java.lang.String connectionGUID)
      Create a relationship between an asset and its connection.
      void setupConnectorType​(java.lang.String connectionGUID, java.lang.String connectorTypeGUID)
      Create a relationship between a connection and a connector type.
      void setupEmbeddedConnection​(java.lang.String connectionGUID, int position, java.lang.String displayName, java.util.Map<java.lang.String,​java.lang.Object> arguments, java.lang.String embeddedConnectionGUID)
      Create a relationship between a virtual connection and an embedded connection.
      void setupEndpoint​(java.lang.String connectionGUID, java.lang.String endpointGUID)
      Create a relationship between a connection and an endpoint.
      void setupReferenceValueTag​(java.lang.String elementGUID, ReferenceValueAssignmentProperties properties, java.lang.String validValueGUID)
      Create a reference value assignment relationship between an element and a valid value to show that the valid value is a semiformal tag/classification.
      void setupSchemaType​(java.lang.String relationshipTypeName, java.lang.String schemaAttributeGUID, java.lang.String schemaTypeGUID)
      Connect a schema type to a schema attribute.
      void setupValidValueMember​(java.lang.String validValueSetGUID, ValidValueMembershipProperties properties, java.lang.String validValueMemberGUID)
      Create a membership relationship between a validValue and a validValueSet that it belongs to.
      void setupValidValues​(java.lang.String elementGUID, ValidValueAssignmentProperties properties, java.lang.String validValueGUID)
      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.
      void updateConnection​(java.lang.String connectionGUID, boolean isMergeUpdate, ConnectionProperties connectionProperties)
      Update the metadata element representing a connection.
      void updateEndpoint​(boolean isMergeUpdate, java.lang.String endpointGUID, EndpointProperties endpointProperties)
      Update the metadata element representing an endpoint.
      void updateEventType​(java.lang.String eventTypeGUID, boolean isMergeUpdate, EventTypeProperties properties)
      Update the metadata element representing an event type.
      void updateSchemaAttribute​(java.lang.String schemaAttributeGUID, boolean isMergeUpdate, SchemaAttributeProperties schemaAttributeProperties)
      Update the properties of the metadata element representing a schema attribute.
      void updateSchemaType​(java.lang.String schemaTypeGUID, boolean isMergeUpdate, SchemaTypeProperties schemaTypeProperties)
      Update the metadata element representing a schema type.
      void updateTopic​(java.lang.String topicGUID, boolean isMergeUpdate, TopicProperties topicProperties)
      Update the metadata element representing a topic.
      void updateValidValue​(java.lang.String validValueGUID, boolean isMergeUpdate, ValidValueProperties validValueProperties)
      Update the metadata element representing a valid value.
      void withdrawTopic​(java.lang.String topicGUID)
      Update the zones for the topic asset so that it is no longer visible to consumers.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait