Class APIIntegratorContext


  • public class APIIntegratorContext
    extends java.lang.Object
    APIIntegratorContext is the context for managing resources from a relational api server.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void clearSchemaTypes​(java.lang.String apiParameterGUID)
      Remove the linked schema types from a API parameter.
      java.lang.String createAPI​(java.lang.String endpointGUID, APIProperties apiProperties)
      Create a new metadata element to represent an API.
      java.lang.String createAPIFromTemplate​(java.lang.String endpointGUID, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent an API using an existing metadata element as a template.
      java.lang.String createAPIOperation​(java.lang.String apiGUID, APIOperationProperties apiOperationProperties)
      Create a new metadata element to represent an API operation.
      java.lang.String createAPIOperationFromTemplate​(java.lang.String templateGUID, java.lang.String apiGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent an API operation using an existing metadata element as a template.
      java.lang.String createAPIParameter​(java.lang.String schemaElementGUID, APIParameterProperties apiParameterProperties)
      Create a new metadata element to represent a API parameter.
      java.lang.String createAPIParameterFromTemplate​(java.lang.String schemaElementGUID, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a API parameter using an existing metadata element as a template.
      java.lang.String createAPIParameterList​(java.lang.String apiOperationGUID, APIParameterListType parameterListType, APIParameterListProperties properties)
      Create a new metadata element to represent an API Operation's Parameter list.
      java.lang.String createAPIParameterListFromTemplate​(java.lang.String templateGUID, java.lang.String apiOperationGUID, APIParameterListType parameterListType, TemplateProperties templateProperties)
      Create a new metadata element to represent a an API Parameter List using an existing API Parameter List 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 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 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 API parameter.
      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.util.List<APIOperationElement> findAPIOperations​(java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of API operation metadata elements that contain the search string.
      java.util.List<APIParameterListElement> findAPIParameterLists​(java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of API Parameter List metadata elements that contain the search string.
      java.util.List<APIParameterElement> findAPIParameters​(java.lang.String searchString, java.lang.String typeName, int startFrom, int pageSize)
      Retrieve the list of API parameter metadata elements that contain the search string.
      java.util.List<APIElement> findAPIs​(java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of API 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<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<ValidValueSetElement> findValidValueSet​(java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of valid value set metadata elements that contain the search string.
      APIElement getAPIByGUID​(java.lang.String guid)
      Retrieve the API metadata element with the supplied unique identifier.
      java.lang.String getAPIManagerName()
      Return the qualified name of the API manager that is supplied in the configuration document.
      APIOperationElement getAPIOperationByGUID​(java.lang.String guid)
      Retrieve the API operation metadata element with the supplied unique identifier.
      java.util.List<APIOperationElement> getAPIOperationsByName​(java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of API operation metadata elements with a matching qualified or display name.
      APIParameterElement getAPIParameterByGUID​(java.lang.String apiParameterGUID)
      Retrieve the API parameter metadata element with the supplied unique identifier.
      APIParameterListElement getAPIParameterListByGUID​(java.lang.String guid)
      Retrieve the API Parameter List metadata element with the supplied unique identifier.
      java.util.List<APIParameterListElement> getAPIParameterListsByName​(java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of API Parameter List metadata elements with a matching qualified or display name.
      java.util.List<APIParameterElement> getAPIParametersByName​(java.lang.String name, java.lang.String typeName, int startFrom, int pageSize)
      Retrieve the list of API parameter metadata elements with a matching qualified or display name.
      java.util.List<APIElement> getAPIsByName​(java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of API metadata elements with a matching qualified or display name.
      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.util.List<APIElement> getMyAPIs​(int startFrom, int pageSize)
      Retrieve the list of apis created by this caller.
      java.util.List<APIParameterElement> getNestedAPIParameters​(java.lang.String parentElementGUID, int startFrom, int pageSize)
      Retrieve the list of API parameters associated with a parameter list or nested underneath another parameter.
      java.util.List<APIOperationElement> getOperationsForAPI​(java.lang.String apiGUID, int startFrom, int pageSize)
      Return the list of operations associated with an API.
      java.util.List<APIParameterListElement> getParameterListsForAPIOperation​(java.lang.String apiOperationGUID, int startFrom, int pageSize)
      Return the list of API Parameter Lists associated with an API Operation.
      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<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.
      void publishAPI​(java.lang.String apiGUID)
      Update the zones for the API 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 removeAPI​(java.lang.String apiGUID, java.lang.String qualifiedName)
      Remove the metadata element representing an API.
      void removeAPIOperation​(java.lang.String apiOperationGUID, java.lang.String qualifiedName)
      Remove the metadata element representing an API operation.
      void removeAPIParameter​(java.lang.String apiParameterGUID)
      Remove the metadata element representing a API parameter.
      void removeAPIParameterList​(java.lang.String apiParameterListGUID, java.lang.String qualifiedName)
      Remove an API Parameter List and all of its parameters.
      void removeEndpoint​(java.lang.String endpointGUID)
      Remove the metadata element representing a endpoint.
      void removeSchemaType​(java.lang.String schemaTypeGUID)
      Remove the metadata element representing a schema type.
      void setAPIManagerIsHome​(boolean apiManagerIsHome)
      Set up the flag that controls the ownership of metadata created for this API manager.
      void setupSchemaType​(java.lang.String relationshipTypeName, java.lang.String apiParameterGUID, java.lang.String schemaTypeGUID)
      Connect a schema type to a API parameter.
      void updateAPI​(java.lang.String apiGUID, boolean isMergeUpdate, APIProperties apiProperties)
      Update the metadata element representing an API.
      void updateAPIOperation​(java.lang.String apiOperationGUID, boolean isMergeUpdate, APIOperationProperties apiOperationProperties)
      Update the metadata element representing an API operation.
      void updateAPIParameter​(java.lang.String apiParameterGUID, boolean isMergeUpdate, APIParameterProperties apiParameterProperties)
      Update the properties of the metadata element representing a API parameter.
      void updateAPIParameterList​(java.lang.String apiParameterListGUID, boolean isMergeUpdate, APIParameterListProperties properties)
      Update the metadata element representing an API Parameter List.
      void updateEndpoint​(boolean isMergeUpdate, java.lang.String endpointGUID, EndpointProperties endpointProperties)
      Update the metadata element representing a endpoint.
      void updateSchemaType​(java.lang.String schemaTypeGUID, boolean isMergeUpdate, SchemaTypeProperties schemaTypeProperties)
      Update the metadata element representing a schema type.
      void withdrawAPI​(java.lang.String apiGUID)
      Update the zones for the API 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