Class AssetManagerClientBase

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addServerPurpose​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, boolean infrastructureManagerIsHome, java.lang.String itAssetGUID, java.lang.String classificationName, java.util.Date effectiveFrom, java.util.Date effectiveTo, java.util.Map<java.lang.String,​java.lang.Object> classificationProperties)
      Add a Server Purpose classification to an IT asset.
      void clearDeployment​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String itAssetGUID, java.lang.String destinationGUID, java.util.Date effectiveTime)
      Remove a deployment relationship.
      void clearServerPurpose​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String assetTypeName, java.lang.String assetGUID, java.lang.String classificationName, java.util.Date effectiveTime)
      Remove a server purpose classification.
      void deployITAsset​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, boolean infrastructureManagerIsHome, java.lang.String itAssetGUID, java.lang.String destinationGUID, DeploymentProperties deploymentProperties)
      Create a relationship that represents the deployment of an IT infrastructure asset to a specific deployment destination (another asset).
      java.util.List<DeploymentElement> getDeployedITAssets​(java.lang.String userId, java.lang.String destinationGUID, java.util.Date effectiveTime, int startFrom, int pageSize)
      Return the list of assets deployed on a particular destination.
      java.util.List<DeploymentElement> getDeploymentDestinations​(java.lang.String userId, java.lang.String itAssetGUID, java.util.Date effectiveTime, int startFrom, int pageSize)
      Return the list of destinations that a particular IT infrastructure asset is deployed to.
      void updateITAssetDeployment​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String deploymentGUID, boolean isMergeUpdate, DeploymentProperties deploymentProperties)
      Update a deployment relationship.
      void updateServerPurpose​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String assetTypeName, java.lang.String assetGUID, java.lang.String classificationName, java.util.Date effectiveFrom, java.util.Date effectiveTo, boolean isMergeUpdate, java.util.Map<java.lang.String,​java.lang.Object> classificationProperties)
      Update the properties of a classification for an asset.
      • Methods inherited from class java.lang.Object

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

      • addServerPurpose

        public void addServerPurpose​(java.lang.String userId,
                                     java.lang.String infrastructureManagerGUID,
                                     java.lang.String infrastructureManagerName,
                                     boolean infrastructureManagerIsHome,
                                     java.lang.String itAssetGUID,
                                     java.lang.String classificationName,
                                     java.util.Date effectiveFrom,
                                     java.util.Date effectiveTo,
                                     java.util.Map<java.lang.String,​java.lang.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​(java.lang.String userId,
                                        java.lang.String infrastructureManagerGUID,
                                        java.lang.String infrastructureManagerName,
                                        java.lang.String assetTypeName,
                                        java.lang.String assetGUID,
                                        java.lang.String classificationName,
                                        java.util.Date effectiveFrom,
                                        java.util.Date effectiveTo,
                                        boolean isMergeUpdate,
                                        java.util.Map<java.lang.String,​java.lang.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​(java.lang.String userId,
                                       java.lang.String infrastructureManagerGUID,
                                       java.lang.String infrastructureManagerName,
                                       java.lang.String assetTypeName,
                                       java.lang.String assetGUID,
                                       java.lang.String classificationName,
                                       java.util.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​(java.lang.String userId,
                                  java.lang.String infrastructureManagerGUID,
                                  java.lang.String infrastructureManagerName,
                                  boolean infrastructureManagerIsHome,
                                  java.lang.String itAssetGUID,
                                  java.lang.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​(java.lang.String userId,
                                            java.lang.String infrastructureManagerGUID,
                                            java.lang.String infrastructureManagerName,
                                            java.lang.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​(java.lang.String userId,
                                    java.lang.String infrastructureManagerGUID,
                                    java.lang.String infrastructureManagerName,
                                    java.lang.String itAssetGUID,
                                    java.lang.String destinationGUID,
                                    java.util.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)