Interface EndpointManagerInterface

  • All Known Implementing Classes:
    EndpointManagerClient

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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String createEndpoint​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String infrastructureGUID, EndpointProperties endpointProperties)
      Create a new metadata element to represent the endpoint.
      java.lang.String createEndpointFromTemplate​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String infrastructureGUID, java.lang.String networkAddress, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent an endpoint using an existing metadata element as a template.
      java.util.List<EndpointElement> findEndpoints​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of endpoint metadata elements that contain the search string.
      EndpointElement getEndpointByGUID​(java.lang.String userId, java.lang.String endpointGUID)
      Retrieve the endpoint metadata element with the supplied unique identifier.
      java.util.List<EndpointElement> getEndpointsByName​(java.lang.String userId, 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<EndpointElement> getEndpointsByNetworkAddress​(java.lang.String userId, java.lang.String networkAddress, int startFrom, int pageSize)
      Retrieve the list of endpoint metadata elements with a matching networkAddress.
      java.util.List<EndpointElement> getEndpointsForInfrastructure​(java.lang.String userId, java.lang.String infrastructureGUID, int startFrom, int pageSize)
      Retrieve the list of endpoint metadata elements that are attached to a specific infrastructure element.
      void removeEndpoint​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String endpointGUID)
      Remove the metadata element representing an endpoint.
      void updateEndpoint​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, boolean isMergeUpdate, java.lang.String endpointGUID, EndpointProperties endpointProperties)
      Update the metadata element representing an endpoint.
    • Method Detail

      • createEndpoint

        java.lang.String createEndpoint​(java.lang.String userId,
                                        java.lang.String infrastructureManagerGUID,
                                        java.lang.String infrastructureManagerName,
                                        java.lang.String infrastructureGUID,
                                        EndpointProperties endpointProperties)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        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:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • createEndpointFromTemplate

        java.lang.String createEndpointFromTemplate​(java.lang.String userId,
                                                    java.lang.String infrastructureManagerGUID,
                                                    java.lang.String infrastructureManagerName,
                                                    java.lang.String infrastructureGUID,
                                                    java.lang.String networkAddress,
                                                    java.lang.String templateGUID,
                                                    TemplateProperties templateProperties)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    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:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • updateEndpoint

        void updateEndpoint​(java.lang.String userId,
                            java.lang.String infrastructureManagerGUID,
                            java.lang.String infrastructureManagerName,
                            boolean isMergeUpdate,
                            java.lang.String endpointGUID,
                            EndpointProperties endpointProperties)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            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:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • removeEndpoint

        void removeEndpoint​(java.lang.String userId,
                            java.lang.String infrastructureManagerGUID,
                            java.lang.String infrastructureManagerName,
                            java.lang.String endpointGUID)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            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:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • getEndpointsByNetworkAddress

        java.util.List<EndpointElement> getEndpointsByNetworkAddress​(java.lang.String userId,
                                                                     java.lang.String networkAddress,
                                                                     int startFrom,
                                                                     int pageSize)
                                                              throws InvalidParameterException,
                                                                     UserNotAuthorizedException,
                                                                     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:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)