Interface OperatingPlatformManagerInterface


  • public interface OperatingPlatformManagerInterface
    OperatingPlatformManagerInterface provides methods to define operating platforms. OperatingPlatforms describe the operating system and hardware characteristics of a host.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void clearOperatingPlatformFromHost​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String hostGUID)
      Remove any link from an operating platform to the requested host.
      java.lang.String createOperatingPlatform​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, OperatingPlatformProperties operatingPlatformProperties)
      Create a new metadata element to represent the operating platform.
      java.lang.String createOperatingPlatformFromTemplate​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a operating platform using an existing metadata element as a template.
      java.util.List<OperatingPlatformElement> findOperatingPlatforms​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of operating platform metadata elements that contain the search string.
      OperatingPlatformElement getOperatingPlatformByGUID​(java.lang.String userId, java.lang.String operatingPlatformGUID)
      Retrieve the operating platform metadata element with the supplied unique identifier.
      java.util.List<OperatingPlatformElement> getOperatingPlatformsByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of operating platform metadata elements with a matching qualified or display name.
      void linkOperatingPlatformToHost​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String operatingPlatformGUID, java.lang.String hostGUID)
      Set up the link between the operating platform and a host.
      void removeOperatingPlatform​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String operatingPlatformGUID)
      Remove the metadata element representing a operating platform.
      void updateOperatingPlatform​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, boolean isMergeUpdate, java.lang.String operatingPlatformGUID, OperatingPlatformProperties operatingPlatformProperties)
      Update the metadata element representing a operating platform.
    • Method Detail

      • createOperatingPlatform

        java.lang.String createOperatingPlatform​(java.lang.String userId,
                                                 java.lang.String infrastructureManagerGUID,
                                                 java.lang.String infrastructureManagerName,
                                                 OperatingPlatformProperties operatingPlatformProperties)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException
        Create a new metadata element to represent the operating platform.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        operatingPlatformProperties - properties to store
        Returns:
        unique identifier of the new metadata element
        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)
      • createOperatingPlatformFromTemplate

        java.lang.String createOperatingPlatformFromTemplate​(java.lang.String userId,
                                                             java.lang.String infrastructureManagerGUID,
                                                             java.lang.String infrastructureManagerName,
                                                             java.lang.String templateGUID,
                                                             TemplateProperties templateProperties)
                                                      throws InvalidParameterException,
                                                             UserNotAuthorizedException,
                                                             PropertyServerException
        Create a new metadata element to represent a operating platform using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new operating platform.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        templateGUID - unique identifier of the metadata element to copy
        templateProperties - descriptive properties that override the template
        Returns:
        unique identifier of the new metadata element
        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)
      • updateOperatingPlatform

        void updateOperatingPlatform​(java.lang.String userId,
                                     java.lang.String infrastructureManagerGUID,
                                     java.lang.String infrastructureManagerName,
                                     boolean isMergeUpdate,
                                     java.lang.String operatingPlatformGUID,
                                     OperatingPlatformProperties operatingPlatformProperties)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException
        Update the metadata element representing a operating platform.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
        operatingPlatformGUID - unique identifier of the metadata element to update
        operatingPlatformProperties - new properties for this element
        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)
      • removeOperatingPlatform

        void removeOperatingPlatform​(java.lang.String userId,
                                     java.lang.String infrastructureManagerGUID,
                                     java.lang.String infrastructureManagerName,
                                     java.lang.String operatingPlatformGUID)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException
        Remove the metadata element representing a operating platform. This will delete the operating platform and all categories and terms.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        operatingPlatformGUID - unique identifier of the metadata element 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)
      • linkOperatingPlatformToHost

        void linkOperatingPlatformToHost​(java.lang.String userId,
                                         java.lang.String infrastructureManagerGUID,
                                         java.lang.String infrastructureManagerName,
                                         java.lang.String operatingPlatformGUID,
                                         java.lang.String hostGUID)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException
        Set up the link between the operating platform and a host. If the host is already linked to a different operating platform, the existing link is deleted.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        operatingPlatformGUID - unique identifier of the operating platform metadata element
        hostGUID - unique identifier of the host
        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)
      • clearOperatingPlatformFromHost

        void clearOperatingPlatformFromHost​(java.lang.String userId,
                                            java.lang.String infrastructureManagerGUID,
                                            java.lang.String infrastructureManagerName,
                                            java.lang.String hostGUID)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException
        Remove any link from an operating platform to the requested host. This is useful if the host is being decommissioned or undergoing an extensive reinstall.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        hostGUID - unique identifier of the host
        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)