Class CapabilityManagerClient

    • Constructor Summary

      Constructors 
      Constructor Description
      CapabilityManagerClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot)
      Create a new client with no authentication embedded in the HTTP request.
      CapabilityManagerClient​(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.
      CapabilityManagerClient​(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.
      CapabilityManagerClient​(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.
      CapabilityManagerClient​(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 Deprecated Methods 
      Modifier and Type Method Description
      java.lang.String createServerAssetUse​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, boolean infrastructureManagerIsHome, java.lang.String capabilityGUID, java.lang.String assetGUID, ServerAssetUseProperties properties)
      Create a new metadata relationship to represent the use of an asset by a software server capability.
      java.lang.String createSoftwareCapability​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, boolean infrastructureManagerIsHome, java.lang.String classificationName, SoftwareCapabilityProperties capabilityProperties)
      Create a new metadata element to represent a software server capability.
      java.lang.String createSoftwareCapabilityFromTemplate​(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 capability using an existing metadata element as a template.
      java.lang.String createSoftwareServerCapability​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, boolean infrastructureManagerIsHome, java.lang.String classificationName, SoftwareServerCapabilityProperties capabilityProperties)
      Deprecated.
      java.lang.String createSoftwareServerCapabilityFromTemplate​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, boolean infrastructureManagerIsHome, java.lang.String templateGUID, TemplateProperties templateProperties)
      Deprecated.
      void deployCapability​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, boolean infrastructureManagerIsHome, java.lang.String capabilityGUID, java.lang.String infrastructureAssetGUID, CapabilityDeploymentProperties deploymentProperties)
      Link a software capability to a software server.
      java.util.List<SoftwareCapabilityElement> findSoftwareCapabilities​(java.lang.String userId, java.lang.String searchString, java.util.Date effectiveTime, int startFrom, int pageSize)
      Retrieve the list of software capability metadata elements that contain the search string.
      java.util.List<SoftwareServerCapabilityElement> findSoftwareServerCapabilities​(java.lang.String userId, java.lang.String searchString, java.util.Date effectiveTime, int startFrom, int pageSize)
      Deprecated.
      java.util.List<ServerAssetUseElement> getCapabilityUsesForAsset​(java.lang.String userId, java.lang.String assetGUID, ServerAssetUseType useType, java.util.Date effectiveTime, int startFrom, int pageSize)
      Return the list of software server capabilities that make use of a specific asset.
      java.util.List<SoftwareCapabilityElement> getDeployedSoftwareCapabilities​(java.lang.String userId, java.lang.String itAssetGUID, java.util.Date effectiveTime, int startFrom, int pageSize)
      Retrieve the software capabilities that are deployed to an IT asset.
      ServerAssetUseElement getServerAssetUseByGUID​(java.lang.String userId, java.lang.String guid)
      Retrieve the server asset use type relationship with the supplied unique identifier.
      java.util.List<ServerAssetUseElement> getServerAssetUsesForCapability​(java.lang.String userId, java.lang.String capabilityGUID, ServerAssetUseType useType, java.util.Date effectiveTime, int startFrom, int pageSize)
      Return the list of server asset use relationships associated with a software server capability.
      java.util.List<ServerAssetUseElement> getServerAssetUsesForElements​(java.lang.String userId, java.lang.String capabilityGUID, java.lang.String assetGUID, java.util.Date effectiveTime, int startFrom, int pageSize)
      Retrieve the list of relationships between a specific software server capability and a specific asset.
      java.util.List<SoftwareCapabilityElement> getSoftwareCapabilitiesByName​(java.lang.String userId, java.lang.String name, java.util.Date effectiveTime, int startFrom, int pageSize)
      Retrieve the list of software capability metadata elements with a matching qualified or display name.
      java.util.List<SoftwareCapabilityElement> getSoftwareCapabilitiesForInfrastructureManager​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.util.Date effectiveTime, int startFrom, int pageSize)
      Retrieve the list of capabilities created by this caller.
      SoftwareCapabilityElement getSoftwareCapabilityByGUID​(java.lang.String userId, java.lang.String guid)
      Retrieve the software capability metadata element with the supplied unique identifier.
      java.util.List<RelatedAssetElement> getSoftwareCapabilityDeployments​(java.lang.String userId, java.lang.String guid, java.util.Date effectiveTime, int startFrom, int pageSize)
      Retrieve the IT asset metadata elements where the software with the supplied unique identifier is deployed.
      java.util.List<SoftwareServerCapabilityElement> getSoftwareServerCapabilitiesByName​(java.lang.String userId, java.lang.String name, java.util.Date effectiveTime, int startFrom, int pageSize)
      Deprecated.
      SoftwareServerCapabilityElement getSoftwareServerCapabilityByGUID​(java.lang.String userId, java.lang.String guid)
      Deprecated.
      void removeCapabilityDeployment​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String itAssetGUID, java.lang.String capabilityGUID, java.util.Date effectiveTime)
      Remove the link between a software server capability and a software server.
      void removeServerAssetUse​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String serverAssetUseGUID)
      Remove the metadata relationship to represent the use of an asset by a software server capability.
      void removeSoftwareCapability​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String capabilityGUID)
      Remove the metadata element representing a software capability.
      void removeSoftwareServerCapability​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String capabilityGUID)
      Deprecated.
      void updateCapabilityDeployment​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String deploymentGUID, boolean isMergeUpdate, CapabilityDeploymentProperties deploymentProperties)
      Update the properties of a server capability's deployment.
      void updateServerAssetUse​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String serverAssetUseGUID, boolean isMergeUpdate, ServerAssetUseProperties properties)
      Update the metadata relationship to represent the use of an asset by a software server capability.
      void updateSoftwareCapability​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String capabilityGUID, boolean isMergeUpdate, SoftwareCapabilityProperties capabilityProperties)
      Update the metadata element representing a software capability.
      void updateSoftwareServerCapability​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String capabilityGUID, boolean isMergeUpdate, SoftwareServerCapabilityProperties capabilityProperties)
      Deprecated.
      • Methods inherited from class java.lang.Object

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

      • CapabilityManagerClient

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

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

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

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

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