Package org.odpi.openmetadata.accessservices.itinfrastructure.api

Interface EndpointManagerInterface

public interface EndpointManagerInterface
EndpointManagerInterface provides methods to define endpoints. Endpoints describe the network information needed to access the infrastructure.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    createEndpoint(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String infrastructureGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.connections.EndpointProperties endpointProperties)
    Create a new metadata element to represent the endpoint.
    String
    createEndpointFromTemplate(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String infrastructureGUID, String networkAddress, String templateGUID, TemplateProperties templateProperties)
    Create a new metadata element to represent an endpoint using an existing metadata element as a template.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.EndpointElement>
    findEndpoints(String userId, String searchString, int startFrom, int pageSize)
    Retrieve the list of endpoint metadata elements that contain the search string.
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.EndpointElement
    getEndpointByGUID(String userId, String endpointGUID)
    Retrieve the endpoint metadata element with the supplied unique identifier.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.EndpointElement>
    getEndpointsByName(String userId, String name, int startFrom, int pageSize)
    Retrieve the list of endpoint metadata elements with a matching qualified or display name.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.EndpointElement>
    getEndpointsByNetworkAddress(String userId, String networkAddress, int startFrom, int pageSize)
    Retrieve the list of endpoint metadata elements with a matching networkAddress.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.EndpointElement>
    getEndpointsForInfrastructure(String userId, String infrastructureGUID, int startFrom, int pageSize)
    Retrieve the list of endpoint metadata elements that are attached to a specific infrastructure element.
    void
    removeEndpoint(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String endpointGUID)
    Remove the metadata element representing an endpoint.
    void
    updateEndpoint(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean isMergeUpdate, String endpointGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.connections.EndpointProperties endpointProperties)
    Update the metadata element representing an endpoint.

  • Method Details

    • createEndpoint

      String createEndpoint(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String infrastructureGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.connections.EndpointProperties endpointProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new metadata element to represent the endpoint.
      Parameters:
      userId - calling user
      infrastructureManagerGUID - unique identifier of software server capability representing the caller
      infrastructureManagerName - unique name of software server capability representing the caller
      infrastructureGUID - unique identifier of the infrastructure to connect it to (optional)
      endpointProperties - properties to store
      Returns:
      unique identifier of the new metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • createEndpointFromTemplate

      String createEndpointFromTemplate(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String infrastructureGUID, String networkAddress, String templateGUID, TemplateProperties templateProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new metadata element to represent an endpoint using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new endpoint.
      Parameters:
      userId - calling user
      infrastructureManagerGUID - unique identifier of software server capability representing the caller
      infrastructureManagerName - unique name of software server capability representing the caller
      infrastructureGUID - unique identifier of the infrastructure to connect it to (optional)
      networkAddress - location of the endpoint
      templateGUID - unique identifier of the metadata element to copy
      templateProperties - descriptive properties that override the template
      Returns:
      unique identifier of the new metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateEndpoint

      void updateEndpoint(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean isMergeUpdate, String endpointGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.connections.EndpointProperties endpointProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the metadata element representing an endpoint.
      Parameters:
      userId - calling user
      infrastructureManagerGUID - unique identifier of software server capability representing the caller
      infrastructureManagerName - unique name of software server capability representing the caller
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      endpointGUID - unique identifier of the metadata element to update
      endpointProperties - new properties for this element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • removeEndpoint

      void removeEndpoint(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String endpointGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the metadata element representing an endpoint. This will delete the endpoint and all categories and terms.
      Parameters:
      userId - calling user
      infrastructureManagerGUID - unique identifier of software server capability representing the caller
      infrastructureManagerName - unique name of software server capability representing the caller
      endpointGUID - unique identifier of the metadata element to remove
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • findEndpoints

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.EndpointElement> findEndpoints(String userId, String searchString, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of endpoint metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      userId - calling user
      searchString - string to find in the properties
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getEndpointsByName

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.EndpointElement> getEndpointsByName(String userId, String name, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of endpoint metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      userId - calling user
      name - name to search for
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getEndpointsByNetworkAddress

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.EndpointElement> getEndpointsByNetworkAddress(String userId, String networkAddress, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of endpoint metadata elements with a matching networkAddress. There are no wildcards supported on this request.
      Parameters:
      userId - calling user
      networkAddress - networkAddress to search for
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getEndpointsForInfrastructure

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.EndpointElement> getEndpointsForInfrastructure(String userId, String infrastructureGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of endpoint metadata elements that are attached to a specific infrastructure element.
      Parameters:
      userId - calling user
      infrastructureGUID - element to search for
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getEndpointByGUID

      org.odpi.openmetadata.frameworks.openmetadata.metadataelements.EndpointElement getEndpointByGUID(String userId, String endpointGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the endpoint metadata element with the supplied unique identifier.
      Parameters:
      userId - calling user
      endpointGUID - unique identifier of the requested metadata element
      Returns:
      matching metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)