Package org.odpi.openmetadata.accessservices.itinfrastructure.client

Class EndpointManagerClient

java.lang.Object
org.odpi.openmetadata.accessservices.itinfrastructure.client.EndpointManagerClient
All Implemented Interfaces:
org.odpi.openmetadata.accessservices.itinfrastructure.api.EndpointManagerInterface
public class EndpointManagerClient extends Object implements org.odpi.openmetadata.accessservices.itinfrastructure.api.EndpointManagerInterface
EndpointManagerClient supports the APIs to maintain connections and their related objects.

  • Constructor Summary

    Constructors
    Constructor
    Description
    EndpointManagerClient(String serverName, String serverPlatformURLRoot)
    Create a new client with no authentication embedded in the HTTP request.
    EndpointManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password)
    Create a new client that passes userId and password in each HTTP request.
    EndpointManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Create a new client that passes userId and password in each HTTP request.
    EndpointManagerClient(String serverName, String serverPlatformURLRoot, ITInfrastructureRESTClient restClient, int maxPageSize)
    Create a new client that is going to be used in an OMAG Server.
    EndpointManagerClient(String serverName, String serverPlatformURLRoot, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Create a new client with no authentication embedded in the HTTP request.

  • 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 an endpoint
    String
    createEndpointFromTemplate(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String infrastructureGUID, String networkAddress, String templateGUID, org.odpi.openmetadata.accessservices.itinfrastructure.properties.TemplateProperties templateProperties)
    Create a new metadata element to represent a 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 a 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 a endpoint.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • EndpointManagerClient

      public EndpointManagerClient(String serverName, String serverPlatformURLRoot, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client with no authentication embedded in the HTTP request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      auditLog - logging destination
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • EndpointManagerClient

      public EndpointManagerClient(String serverName, String serverPlatformURLRoot) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client with no authentication embedded in the HTTP request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • EndpointManagerClient

      public EndpointManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      userId - caller's userId embedded in all HTTP requests
      password - caller's userId embedded in all HTTP requests
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • EndpointManagerClient

      public EndpointManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      userId - caller's userId embedded in all HTTP requests
      password - caller's userId embedded in all HTTP requests
      auditLog - logging destination
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • EndpointManagerClient

      public EndpointManagerClient(String serverName, String serverPlatformURLRoot, ITInfrastructureRESTClient restClient, int maxPageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client that is going to be used in an OMAG Server.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      restClient - client that issues the REST API calls
      maxPageSize - maximum number of results supported by this server
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

  • Method Details

    • createEndpoint

      public 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 an endpoint
      Specified by:
      createEndpoint in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.EndpointManagerInterface
      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 about the endpoint to store
      Returns:
      unique identifier of the new endpoint
      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

      public String createEndpointFromTemplate(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String infrastructureGUID, String networkAddress, String templateGUID, org.odpi.openmetadata.accessservices.itinfrastructure.properties.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 a endpoint using an existing metadata element as a template.
      Specified by:
      createEndpointFromTemplate in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.EndpointManagerInterface
      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 endpoint
      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

      public 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 a endpoint. It is possible to use the subtype property classes or set up specialized properties in extended properties.
      Specified by:
      updateEndpoint in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.EndpointManagerInterface
      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 update
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      endpointProperties - new properties for the 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)

    • removeEndpoint

      public 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 a endpoint.
      Specified by:
      removeEndpoint in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.EndpointManagerInterface
      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

      public 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.
      Specified by:
      findEndpoints in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.EndpointManagerInterface
      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

      public 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.
      Specified by:
      getEndpointsByName in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.EndpointManagerInterface
      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

      public 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.
      Specified by:
      getEndpointsByNetworkAddress in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.EndpointManagerInterface
      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

      public 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.
      Specified by:
      getEndpointsForInfrastructure in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.EndpointManagerInterface
      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

      public 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.
      Specified by:
      getEndpointByGUID in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.EndpointManagerInterface
      Parameters:
      userId - calling user
      endpointGUID - unique identifier of the requested metadata element
      Returns:
      requested 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)