Class ITInfrastructureClientBase

java.lang.Object
org.odpi.openmetadata.accessservices.itinfrastructure.client.ITInfrastructureClientBase
All Implemented Interfaces:
DeploymentManagementInterface, ServerPurposeManagerInterface
Direct Known Subclasses:
CapabilityManagerClient, DataAssetManagerClient, HostManagerClient, PlatformManagerClient, ProcessManagerClient, ServerManagerClient

public abstract class ITInfrastructureClientBase extends Object implements ServerPurposeManagerInterface, DeploymentManagementInterface
ITInfrastructureClientBase supports the APIs to maintain assets and their related objects. It is called from the specific clients that manage the specializations of asset.
  • Method Details

    • addServerPurpose

      public void addServerPurpose(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String itAssetGUID, String classificationName, Date effectiveFrom, Date effectiveTo, Map<String,Object> classificationProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Add a Server Purpose classification to an IT asset.
      Specified by:
      addServerPurpose in interface ServerPurposeManagerInterface
      Parameters:
      userId - calling user
      infrastructureManagerGUID - unique identifier of software server capability representing the infrastructure manager
      infrastructureManagerName - unique name of software server capability representing the infrastructure manager
      infrastructureManagerIsHome - ensure that only the infrastructure manager can update this asset
      itAssetGUID - unique identifier of the asset
      classificationName - name of the classification type
      effectiveFrom - when should relationship be effective - null means immediately
      effectiveTo - when should relationship no longer be effective - null means never
      classificationProperties - properties
      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)
    • updateServerPurpose

      public void updateServerPurpose(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String assetTypeName, String assetGUID, String classificationName, Date effectiveFrom, Date effectiveTo, boolean isMergeUpdate, Map<String,Object> classificationProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Update the properties of a classification for an asset.
      Specified by:
      updateServerPurpose in interface ServerPurposeManagerInterface
      Parameters:
      userId - calling user
      infrastructureManagerGUID - unique identifier of software server capability representing the infrastructure manager
      infrastructureManagerName - unique name of software server capability representing the infrastructure manager
      assetTypeName - name of type for the asset
      assetGUID - unique identifier of the asset
      classificationName - name of the classification type
      effectiveFrom - when should relationship be effective - null means immediately
      effectiveTo - when should relationship no longer be effective - null means never
      isMergeUpdate - should the supplied properties be merged with existing properties (true) by replacing just the properties with matching names, or should the entire properties of the instance be replaced?
      classificationProperties - properties
      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)
    • clearServerPurpose

      public void clearServerPurpose(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String assetTypeName, String assetGUID, String classificationName, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove a server purpose classification.
      Specified by:
      clearServerPurpose in interface ServerPurposeManagerInterface
      Parameters:
      userId - calling user
      infrastructureManagerGUID - unique identifier of software server capability representing the infrastructure manager
      infrastructureManagerName - unique name of software server capability representing the infrastructure manager
      assetTypeName - name of type for the asset
      assetGUID - unique identifier of the asset
      classificationName - name of the classification type
      effectiveTime - effective time of the classification 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)
    • deployITAsset

      public void deployITAsset(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String itAssetGUID, String destinationGUID, DeploymentProperties deploymentProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Create a relationship that represents the deployment of an IT infrastructure asset to a specific deployment destination (another asset).
      Specified by:
      deployITAsset in interface DeploymentManagementInterface
      Parameters:
      userId - calling user
      infrastructureManagerGUID - unique identifier of software server capability representing the infrastructure manager
      infrastructureManagerName - unique name of software server capability representing the infrastructure manager
      infrastructureManagerIsHome - should the relationship be marked as owned by the infrastructure manager so others can not update?
      itAssetGUID - unique identifier of the IT infrastructure asset
      destinationGUID - unique identifier of the destination where the asset is being deployed to
      deploymentProperties - relationship properties
      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)
    • updateITAssetDeployment

      public void updateITAssetDeployment(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String deploymentGUID, boolean isMergeUpdate, DeploymentProperties deploymentProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Update a deployment relationship.
      Specified by:
      updateITAssetDeployment in interface DeploymentManagementInterface
      Parameters:
      userId - calling user
      infrastructureManagerGUID - unique identifier of software server capability representing the infrastructure manager
      infrastructureManagerName - unique name of software server capability representing the infrastructure manager
      deploymentGUID - unique identifier of the relationship
      isMergeUpdate - should the supplied properties be merged with existing properties (true) by replacing just the properties with matching names, or should the entire properties of the instance be replaced?
      deploymentProperties - properties for the relationship
      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)
    • clearDeployment

      public void clearDeployment(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String itAssetGUID, String destinationGUID, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove a deployment relationship.
      Specified by:
      clearDeployment in interface DeploymentManagementInterface
      Parameters:
      userId - calling user
      infrastructureManagerGUID - unique identifier of software server capability representing the infrastructure manager
      infrastructureManagerName - unique name of software server capability representing the infrastructure manager
      itAssetGUID - unique identifier of the IT infrastructure asset
      destinationGUID - unique identifier of the destination where the asset is being deployed to
      effectiveTime - time when the deployment is effective
      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)
    • getDeployedITAssets

      public List<DeploymentElement> getDeployedITAssets(String userId, String destinationGUID, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Return the list of assets deployed on a particular destination.
      Specified by:
      getDeployedITAssets in interface DeploymentManagementInterface
      Parameters:
      userId - calling user
      destinationGUID - unique identifier of the destination asset to query
      effectiveTime - effective time for the query
      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)
    • getDeploymentDestinations

      public List<DeploymentElement> getDeploymentDestinations(String userId, String itAssetGUID, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Return the list of destinations that a particular IT infrastructure asset is deployed to.
      Specified by:
      getDeploymentDestinations in interface DeploymentManagementInterface
      Parameters:
      userId - calling user
      itAssetGUID - unique identifier of the IT infrastructure asset to query
      effectiveTime - effective time for the query
      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)