Class EndpointManagerClient

  • All Implemented Interfaces:
    EndpointManagerInterface

    public class EndpointManagerClient
    extends java.lang.Object
    implements EndpointManagerInterface
    EndpointManagerClient supports the APIs to maintain connections and their related objects.
    • Constructor Summary

      Constructors 
      Constructor Description
      EndpointManagerClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot)
      Create a new client with no authentication embedded in the HTTP request.
      EndpointManagerClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password)
      Create a new client that passes userId and password in each HTTP request.
      EndpointManagerClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password, AuditLog auditLog)
      Create a new client that passes userId and password in each HTTP request.
      EndpointManagerClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, ITInfrastructureRESTClient restClient, int maxPageSize)
      Create a new client that is going to be used in an OMAG Server.
      EndpointManagerClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, AuditLog auditLog)
      Create a new client with no authentication embedded in the HTTP request.
    • Method Summary

      All Methods Instance Methods Concrete 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 an 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 a 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 a 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 a endpoint.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • EndpointManagerClient

        public EndpointManagerClient​(java.lang.String serverName,
                                     java.lang.String serverPlatformURLRoot,
                                     AuditLog auditLog)
                              throws 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 servers
        auditLog - logging destination
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • EndpointManagerClient

        public EndpointManagerClient​(java.lang.String serverName,
                                     java.lang.String serverPlatformURLRoot)
                              throws 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 servers
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • EndpointManagerClient

        public EndpointManagerClient​(java.lang.String serverName,
                                     java.lang.String serverPlatformURLRoot,
                                     java.lang.String userId,
                                     java.lang.String password)
                              throws 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 servers
        userId - caller's userId embedded in all HTTP requests
        password - caller's userId embedded in all HTTP requests
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • EndpointManagerClient

        public EndpointManagerClient​(java.lang.String serverName,
                                     java.lang.String serverPlatformURLRoot,
                                     java.lang.String userId,
                                     java.lang.String password,
                                     AuditLog auditLog)
                              throws 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 servers
        userId - caller's userId embedded in all HTTP requests
        password - caller's userId embedded in all HTTP requests
        auditLog - logging destination
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • EndpointManagerClient

        public EndpointManagerClient​(java.lang.String serverName,
                                     java.lang.String serverPlatformURLRoot,
                                     ITInfrastructureRESTClient restClient,
                                     int maxPageSize)
                              throws 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 servers
        restClient - client that issues the REST API calls
        maxPageSize - maximum number of results supported by this server
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.