Index (api-integrator-api 5.1 API)

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

A

APIIntegratorAPI - Interface in org.odpi.openmetadata.integrationservices.api.api: APIIntegratorAPI is the interface to validate that a connector is suitable to run in the API Integrator OMIS.
APIIntegratorAuditCode - Enum Class in org.odpi.openmetadata.integrationservices.api.ffdc: The APIIntegratorAuditCode is used to define the message content for the OMRS Audit Log.
APIIntegratorConnector - Class in org.odpi.openmetadata.integrationservices.api.connector: APIIntegratorConnector is the base class for an integration connector that is managed by the API Integrator OMIS.
APIIntegratorConnector() - Constructor for class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorConnector
APIIntegratorContext - Class in org.odpi.openmetadata.integrationservices.api.connector: APIIntegratorContext is the context for managing resources from a relational api server.
APIIntegratorContext(String, String, String, String, OpenIntegrationClient, GovernanceConfiguration, OpenMetadataClient, ActionControlInterface, APIManagerClient, ConnectionManagerClient, ValidValueManagement, DataManagerEventClient, boolean, PermittedSynchronization, String, String, String, AuditLog, int) - Constructor for class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Create a new client with no authentication embedded in the HTTP request.
APIIntegratorErrorCode - Enum Class in org.odpi.openmetadata.integrationservices.api.ffdc: The APIIntegratorErrorCode error code is used to define first failure data capture (FFDC) for errors that occur when working with the Integration Services.
APIIntegratorOMISConnector - Interface in org.odpi.openmetadata.integrationservices.api.connector: A marker interface to identify the OMIS that this connector works with.

C

clearReferenceValueTag(String, String) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Remove a reference value assignment relationship between an element and a valid value.
clearSchemaElementRelationship(String, String, String) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Remove a relationship between two schema elements.
clearSchemaTypes(String) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Remove the linked schema types from an API parameter.
clearValidValueMember(String, String) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Remove a membership relationship between a validValue and a validValueSet that it belongs to.
clearValidValues(String, String) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: 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.api.ffdc.APIIntegratorAuditCode: OMIS-API-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.api.ffdc.APIIntegratorAuditCode: OMIS-API-INTEGRATOR-0001 - The API integrator context manager is being initialized for calls to server {0} on platform {1}
createAPI(String, APIProperties) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Create a new metadata element to represent an API.
createAPIFromTemplate(String, String, TemplateProperties) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Create a new metadata element to represent an API using an existing metadata element as a template.
createAPIOperation(String, APIOperationProperties) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Create a new metadata element to represent an API operation.
createAPIOperationFromTemplate(String, String, TemplateProperties) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Create a new metadata element to represent an API operation using an existing metadata element as a template.
createAPIParameter(String, APIParameterProperties) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Create a new metadata element to represent a API parameter.
createAPIParameterFromTemplate(String, String, TemplateProperties) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Create a new metadata element to represent a API parameter using an existing metadata element as a template.
createAPIParameterList(String, APIParameterListType, APIParameterListProperties) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Create a new metadata element to represent an API Operation's Parameter list.
createAPIParameterListFromTemplate(String, String, APIParameterListType, TemplateProperties) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Create a new metadata element to represent an API Parameter List using an existing API Parameter List as a template.
createEndpoint(EndpointProperties) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Create a new metadata element to represent an endpoint
createEndpointFromTemplate(String, String, TemplateProperties) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: 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.api.connector.APIIntegratorContext: 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.
createLiteralSchemaType(LiteralSchemaTypeProperties) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: 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.api.connector.APIIntegratorContext: Create a new metadata element to represent a schema type.
createPrimitiveSchemaType(PrimitiveSchemaTypeProperties) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Create a new metadata element to represent a primitive schema type such as a string, integer or character.
createSchemaTypeChoice(SchemaTypeChoiceProperties, List<String>) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: 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.api.connector.APIIntegratorContext: 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.api.connector.APIIntegratorContext: Create a new metadata element to represent a schema type.
createValidValue(ValidValueProperties) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Create a new metadata element to represent a valid value.

F

findAPIOperations(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Retrieve the list of API operation metadata elements that contain the search string.
findAPIParameterLists(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Retrieve the list of API Parameter List metadata elements that contain the search string.
findAPIParameters(String, String, int, int) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Retrieve the list of API parameter metadata elements that contain the search string.
findAPIs(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Retrieve the list of API metadata elements that contain the search string.
findEndpoints(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Retrieve the list of endpoint metadata elements that contain the search string.
findSchemaType(String, String, int, int) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Retrieve the list of schema type metadata elements that contain the search string.
findValidValues(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Retrieve the list of metadata elements that contain the search string.
findValidValueSet(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: 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.api.connector.APIIntegratorContext: Retrieve the list of valid values.
getAPIByGUID(String) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Retrieve the API metadata element with the supplied unique identifier.
getAPIManagerName() - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Return the qualified name of the API manager that is supplied in the configuration document.
getAPIOperationByGUID(String) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Retrieve the API operation metadata element with the supplied unique identifier.
getAPIOperationsByName(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Retrieve the list of API operation metadata elements with a matching qualified or display name.
getAPIParameterByGUID(String) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Retrieve the API parameter metadata element with the supplied unique identifier.
getAPIParameterListByGUID(String) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Retrieve the API Parameter List metadata element with the supplied unique identifier.
getAPIParameterListsByName(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Retrieve the list of API Parameter List metadata elements with a matching qualified or display name.
getAPIParametersByName(String, String, int, int) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Retrieve the list of API parameter metadata elements with a matching qualified or display name.
getAPIsByName(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Retrieve the list of API metadata elements with a matching qualified or display name.
getAssigneesOfReferenceValue(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Return information about the person roles linked to a validValue.
getConsumersOfValidValue(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Return information about the consumers linked to a validValue.
getContext() - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorConnector: Return the context for this connector.
getEndpointByGUID(String) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Retrieve the endpoint metadata element with the supplied unique identifier.
getEndpointsByName(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Retrieve the list of endpoint metadata elements with a matching qualified or display name.
getMessageDefinition() - Method in enum class org.odpi.openmetadata.integrationservices.api.ffdc.APIIntegratorAuditCode: Retrieve a message definition object for logging.
getMessageDefinition() - Method in enum class org.odpi.openmetadata.integrationservices.api.ffdc.APIIntegratorErrorCode: Retrieve a message definition object for an exception.
getMessageDefinition(String...) - Method in enum class org.odpi.openmetadata.integrationservices.api.ffdc.APIIntegratorAuditCode: Retrieve a message definition object for logging.
getMessageDefinition(String...) - Method in enum class org.odpi.openmetadata.integrationservices.api.ffdc.APIIntegratorErrorCode: Retrieve a message definition object for an exception.
getMyAPIs(int, int) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Retrieve the list of apis created by this caller.
getNestedAPIParameters(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Retrieve the list of API parameters associated with a parameter list or nested underneath another parameter.
getOperationsForAPI(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Return the list of operations associated with an API.
getParameterListsForAPIOperation(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Return the list of API Parameter Lists associated with an API Operation.
getReferenceValues(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Return information about the valid values linked as reference value tags to an element.
getSchemaTypeByGUID(String) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Retrieve the schema type metadata element with the supplied unique identifier.
getSchemaTypeByName(String, String, int, int) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: 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.api.connector.APIIntegratorContext: 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.api.connector.APIIntegratorContext: Retrieve the header of the metadata element connected to a schema type.
getSetsForValidValue(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Page through the list of valid value sets that a valid value definition/set belongs to.
getValidValueByGUID(String) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Retrieve the metadata element with the supplied unique identifier.
getValidValuesByName(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Retrieve the list of metadata elements with a matching qualified or display name.
getValidValueSetByName(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: 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.api.connector.APIIntegratorContext: Page through the members of a valid value set.
getValidValuesForConsumer(String) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: 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.api.ffdc.APIIntegratorErrorCode: OMIS-API-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.api.ffdc.APIIntegratorAuditCode: OMIS-API-INTEGRATOR-0003 - Integration connector {0} has a null context
NULL_CONTEXT - Enum constant in enum class org.odpi.openmetadata.integrationservices.api.ffdc.APIIntegratorErrorCode: OMIS-API-INTEGRATOR-500-001 - Integration connector {0} has a null context

O

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

P

publishAPI(String) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Update the zones for the API asset so that it becomes visible to consumers.

R

registerListener(DataManagerEventListener) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Register a listener object that will be passed each of the events published by the Data Manager OMAS.
removeAPI(String, String) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Remove the metadata element representing an API.
removeAPIOperation(String, String) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Remove the metadata element representing an API operation.
removeAPIParameter(String) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Remove the metadata element representing a API parameter.
removeAPIParameterList(String, String) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Remove an API Parameter List and all of its parameters.
removeEndpoint(String) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Remove the metadata element representing an endpoint.
removeSchemaType(String) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Remove the metadata element representing a schema type.
removeValidValue(String) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Remove the metadata element representing a valid value.

S

setAPIManagerIsHome(boolean) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Set up the flag that controls the ownership of metadata created for this API manager.
setContext(APIIntegratorContext) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorConnector: Set up the context for this connector.
setupReferenceValueTag(String, ReferenceValueAssignmentProperties, String) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: 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.api.connector.APIIntegratorContext: Create a relationship between two schema elements.
setupSchemaType(String, String, String) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Connect a schema type to an API parameter.
setupValidValueMember(String, ValidValueMembershipProperties, String) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: 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.api.connector.APIIntegratorContext: 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

toString() - Method in enum class org.odpi.openmetadata.integrationservices.api.ffdc.APIIntegratorAuditCode: JSON-style toString
toString() - Method in enum class org.odpi.openmetadata.integrationservices.api.ffdc.APIIntegratorErrorCode: JSON-style toString

U

updateAPI(String, boolean, APIProperties) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Update the metadata element representing an API.
updateAPIOperation(String, boolean, APIOperationProperties) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Update the metadata element representing an API operation.
updateAPIParameter(String, boolean, APIParameterProperties) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Update the properties of the metadata element representing an API parameter.
updateAPIParameterList(String, boolean, APIParameterListProperties) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Update the metadata element representing an API Parameter List.
updateEndpoint(boolean, String, EndpointProperties) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Update the metadata element representing an endpoint.
updateSchemaType(String, boolean, SchemaTypeProperties) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Update the metadata element representing a schema type.
updateValidValue(String, boolean, ValidValueProperties) - Method in class org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext: Update the metadata element representing a valid value.

V

validateConnector(String, String) - Method in interface org.odpi.openmetadata.integrationservices.api.api.APIIntegratorAPI: Validate the connector and return its connector type.
valueOf(String) - Static method in enum class org.odpi.openmetadata.integrationservices.api.ffdc.APIIntegratorAuditCode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.odpi.openmetadata.integrationservices.api.ffdc.APIIntegratorErrorCode: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.odpi.openmetadata.integrationservices.api.ffdc.APIIntegratorAuditCode: 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.api.ffdc.APIIntegratorErrorCode: Returns an array containing the constants of this enum class, in the order they are declared.

W

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

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