Interface SoftwareServerPlatformManagerInterface

  • All Known Implementing Classes:
    PlatformManagerClient

    public interface SoftwareServerPlatformManagerInterface
    SoftwareServerPlatformManagerInterface defines the client side interface for the IT Infrastructure OMAS that is relevant for software server platform assets. It provides the ability to define and maintain the metadata about a platform and relationships between platforms and hosts.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String createSoftwareServerPlatform​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, boolean infrastructureManagerIsHome, SoftwareServerPlatformProperties platformProperties)
      Create a new metadata element to represent a platform.
      java.lang.String createSoftwareServerPlatformFromTemplate​(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 platform using an existing metadata element as a template.
      java.util.List<SoftwareServerPlatformElement> findSoftwareServerPlatforms​(java.lang.String userId, java.lang.String searchString, java.util.Date effectiveTime, int startFrom, int pageSize)
      Retrieve the list of platform metadata elements that contain the search string.
      SoftwareServerPlatformElement getSoftwareServerPlatformByGUID​(java.lang.String userId, java.lang.String guid)
      Retrieve the platform metadata element with the supplied unique identifier.
      java.util.List<SoftwareServerPlatformElement> getSoftwareServerPlatformsByName​(java.lang.String userId, java.lang.String name, java.util.Date effectiveTime, int startFrom, int pageSize)
      Retrieve the list of platform metadata elements with a matching qualified or display name.
      java.util.List<SoftwareServerPlatformElement> getSoftwareServerPlatformsForInfrastructureManager​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.util.Date effectiveTime, int startFrom, int pageSize)
      Retrieve the list of platforms created by this caller.
      void publishSoftwareServerPlatform​(java.lang.String userId, java.lang.String platformGUID)
      Update the zones for the platform asset so that it becomes visible to consumers.
      void removeSoftwareServerPlatform​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String platformGUID)
      Remove the metadata element representing a platform.
      void updateSoftwareServerPlatform​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String platformGUID, boolean isMergeUpdate, SoftwareServerPlatformProperties platformProperties)
      Update the metadata element representing a platform.
      void withdrawSoftwareServerPlatform​(java.lang.String userId, java.lang.String platformGUID)
      Update the zones for the platform asset so that it is no longer visible to consumers.
    • Method Detail

      • createSoftwareServerPlatform

        java.lang.String createSoftwareServerPlatform​(java.lang.String userId,
                                                      java.lang.String infrastructureManagerGUID,
                                                      java.lang.String infrastructureManagerName,
                                                      boolean infrastructureManagerIsHome,
                                                      SoftwareServerPlatformProperties platformProperties)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException
        Create a new metadata element to represent a platform.
        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 platform be marked as owned by the infrastructure manager so others can not update?
        platformProperties - 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)
      • createSoftwareServerPlatformFromTemplate

        java.lang.String createSoftwareServerPlatformFromTemplate​(java.lang.String userId,
                                                                  java.lang.String infrastructureManagerGUID,
                                                                  java.lang.String infrastructureManagerName,
                                                                  boolean infrastructureManagerIsHome,
                                                                  java.lang.String templateGUID,
                                                                  TemplateProperties templateProperties)
                                                           throws InvalidParameterException,
                                                                  UserNotAuthorizedException,
                                                                  PropertyServerException
        Create a new metadata element to represent a platform using an existing metadata element as a template.
        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 platform be marked as owned by the infrastructure manager so others can not update?
        templateGUID - unique identifier of the metadata element to copy
        templateProperties - 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)
      • updateSoftwareServerPlatform

        void updateSoftwareServerPlatform​(java.lang.String userId,
                                          java.lang.String infrastructureManagerGUID,
                                          java.lang.String infrastructureManagerName,
                                          java.lang.String platformGUID,
                                          boolean isMergeUpdate,
                                          SoftwareServerPlatformProperties platformProperties)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException
        Update the metadata element representing a platform.
        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
        platformGUID - unique identifier of the metadata element to update
        isMergeUpdate - are unspecified properties unchanged (true) or removed?
        platformProperties - 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)
      • publishSoftwareServerPlatform

        void publishSoftwareServerPlatform​(java.lang.String userId,
                                           java.lang.String platformGUID)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
        Update the zones for the platform asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the IT Infrastructure OMAS).
        Parameters:
        userId - calling user
        platformGUID - unique identifier of the metadata element to publish
        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)
      • withdrawSoftwareServerPlatform

        void withdrawSoftwareServerPlatform​(java.lang.String userId,
                                            java.lang.String platformGUID)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException
        Update the zones for the platform asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the IT Infrastructure OMAS. This is the setting when the platform is first created).
        Parameters:
        userId - calling user
        platformGUID - unique identifier of the metadata element to withdraw
        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)
      • removeSoftwareServerPlatform

        void removeSoftwareServerPlatform​(java.lang.String userId,
                                          java.lang.String infrastructureManagerGUID,
                                          java.lang.String infrastructureManagerName,
                                          java.lang.String platformGUID)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException
        Remove the metadata element representing a platform.
        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
        platformGUID - 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)
      • findSoftwareServerPlatforms

        java.util.List<SoftwareServerPlatformElement> findSoftwareServerPlatforms​(java.lang.String userId,
                                                                                  java.lang.String searchString,
                                                                                  java.util.Date effectiveTime,
                                                                                  int startFrom,
                                                                                  int pageSize)
                                                                           throws InvalidParameterException,
                                                                                  UserNotAuthorizedException,
                                                                                  PropertyServerException
        Retrieve the list of platform metadata elements that contain the search string. The search string is treated as a regular expression.
        Parameters:
        userId - calling user
        searchString - string to find in the properties
        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)
      • getSoftwareServerPlatformsByName

        java.util.List<SoftwareServerPlatformElement> getSoftwareServerPlatformsByName​(java.lang.String userId,
                                                                                       java.lang.String name,
                                                                                       java.util.Date effectiveTime,
                                                                                       int startFrom,
                                                                                       int pageSize)
                                                                                throws InvalidParameterException,
                                                                                       UserNotAuthorizedException,
                                                                                       PropertyServerException
        Retrieve the list of platform metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
        Parameters:
        userId - calling user
        name - name to search for
        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)
      • getSoftwareServerPlatformsForInfrastructureManager

        java.util.List<SoftwareServerPlatformElement> getSoftwareServerPlatformsForInfrastructureManager​(java.lang.String userId,
                                                                                                         java.lang.String infrastructureManagerGUID,
                                                                                                         java.lang.String infrastructureManagerName,
                                                                                                         java.util.Date effectiveTime,
                                                                                                         int startFrom,
                                                                                                         int pageSize)
                                                                                                  throws InvalidParameterException,
                                                                                                         UserNotAuthorizedException,
                                                                                                         PropertyServerException
        Retrieve the list of platforms created by this caller.
        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
        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)