Class ServerManagerClient

    • Constructor Summary

      Constructors 
      Constructor Description
      ServerManagerClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot)
      Create a new client with no authentication embedded in the HTTP request.
      ServerManagerClient​(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.
      ServerManagerClient​(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.
      ServerManagerClient​(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.
      ServerManagerClient​(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 createSoftwareServer​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, boolean infrastructureManagerIsHome, SoftwareServerProperties softwareServerProperties)
      Create a new metadata element to represent a software server.
      java.lang.String createSoftwareServerFromTemplate​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, boolean infrastructureManagerIsHome, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a software server using an existing metadata element as a template.
      java.util.List<SoftwareServerElement> findSoftwareServers​(java.lang.String userId, java.lang.String searchString, java.util.Date effectiveTime, int startFrom, int pageSize)
      Retrieve the list of software server metadata elements that contain the search string.
      SoftwareServerElement getSoftwareServerByGUID​(java.lang.String userId, java.lang.String guid)
      Retrieve the softwareServer metadata element with the supplied unique identifier.
      java.util.List<SoftwareServerElement> getSoftwareServersByName​(java.lang.String userId, java.lang.String name, java.util.Date effectiveTime, int startFrom, int pageSize)
      Retrieve the list of softwareServer metadata elements with a matching qualified or display name.
      java.util.List<SoftwareServerElement> getSoftwareServersForInfrastructureManager​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.util.Date effectiveTime, int startFrom, int pageSize)
      Retrieve the list of software servers created by this caller.
      void publishSoftwareServer​(java.lang.String userId, java.lang.String softwareServerGUID)
      Update the zones for the software server asset so that it becomes visible to consumers.
      void removeSoftwareServer​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String softwareServerGUID)
      Remove the metadata element representing a software server.
      void updateSoftwareServer​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String softwareServerGUID, boolean isMergeUpdate, SoftwareServerProperties softwareServerProperties)
      Update the metadata element representing a software server.
      void withdrawSoftwareServer​(java.lang.String userId, java.lang.String softwareServerGUID)
      Update the zones for the software server 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
    • Constructor Detail

      • ServerManagerClient

        public ServerManagerClient​(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.
      • ServerManagerClient

        public ServerManagerClient​(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.
      • ServerManagerClient

        public ServerManagerClient​(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.
      • ServerManagerClient

        public ServerManagerClient​(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.
      • ServerManagerClient

        public ServerManagerClient​(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.