Interface SoftwareServerManagerInterface

  • All Known Implementing Classes:
    ServerManagerClient

    public interface SoftwareServerManagerInterface
    SoftwareServerManagerInterface defines the client side interface for the IT Infrastructure OMAS that is relevant for softwareServer assets. It provides the ability to define and maintain the metadata about a software server and the capabilities deployed on it.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String createSoftwareServer​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, boolean infrastructureManagerIsHome, SoftwareServerProperties softwareServerProperties)
      Create a new metadata element to represent a software server.
      java.lang.String createSoftwareServerFromTemplate​(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 server using an existing metadata element as a template.
      java.util.List<SoftwareServerElement> findSoftwareServers​(java.lang.String userId, java.lang.String searchString, java.util.Date effectiveTime, int startFrom, int pageSize)
      Retrieve the list of software server metadata elements that contain the search string.
      SoftwareServerElement getSoftwareServerByGUID​(java.lang.String userId, java.lang.String guid)
      Retrieve the softwareServer metadata element with the supplied unique identifier.
      java.util.List<SoftwareServerElement> getSoftwareServersByName​(java.lang.String userId, java.lang.String name, java.util.Date effectiveTime, int startFrom, int pageSize)
      Retrieve the list of softwareServer metadata elements with a matching qualified or display name.
      java.util.List<SoftwareServerElement> getSoftwareServersForInfrastructureManager​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.util.Date effectiveTime, int startFrom, int pageSize)
      Retrieve the list of software servers created by this caller.
      void publishSoftwareServer​(java.lang.String userId, java.lang.String softwareServerGUID)
      Update the zones for the software server asset so that it becomes visible to consumers.
      void removeSoftwareServer​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String softwareServerGUID)
      Remove the metadata element representing a software server.
      void updateSoftwareServer​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String softwareServerGUID, boolean isMergeUpdate, SoftwareServerProperties softwareServerProperties)
      Update the metadata element representing a software server.
      void withdrawSoftwareServer​(java.lang.String userId, java.lang.String softwareServerGUID)
      Update the zones for the software server asset so that it is no longer visible to consumers.
    • Method Detail

      • createSoftwareServer

        java.lang.String createSoftwareServer​(java.lang.String userId,
                                              java.lang.String infrastructureManagerGUID,
                                              java.lang.String infrastructureManagerName,
                                              boolean infrastructureManagerIsHome,
                                              SoftwareServerProperties softwareServerProperties)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException
        Create a new metadata element to represent a software server.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        infrastructureManagerIsHome - should the softwareServer be marked as owned by the infrastructure manager so others can not update?
        softwareServerProperties - 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)
      • createSoftwareServerFromTemplate

        java.lang.String createSoftwareServerFromTemplate​(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 software server using an existing metadata element as a template.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        infrastructureManagerIsHome - should the softwareServer 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)
      • updateSoftwareServer

        void updateSoftwareServer​(java.lang.String userId,
                                  java.lang.String infrastructureManagerGUID,
                                  java.lang.String infrastructureManagerName,
                                  java.lang.String softwareServerGUID,
                                  boolean isMergeUpdate,
                                  SoftwareServerProperties softwareServerProperties)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
        Update the metadata element representing a software server.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        softwareServerGUID - unique identifier of the metadata element to update
        isMergeUpdate - are unspecified properties unchanged (true) or removed?
        softwareServerProperties - 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)
      • publishSoftwareServer

        void publishSoftwareServer​(java.lang.String userId,
                                   java.lang.String softwareServerGUID)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException
        Update the zones for the software server 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
        softwareServerGUID - 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)
      • withdrawSoftwareServer

        void withdrawSoftwareServer​(java.lang.String userId,
                                    java.lang.String softwareServerGUID)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException
        Update the zones for the software server 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 softwareServer is first created).
        Parameters:
        userId - calling user
        softwareServerGUID - 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)
      • removeSoftwareServer

        void removeSoftwareServer​(java.lang.String userId,
                                  java.lang.String infrastructureManagerGUID,
                                  java.lang.String infrastructureManagerName,
                                  java.lang.String softwareServerGUID)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
        Remove the metadata element representing a software server.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        softwareServerGUID - 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)
      • findSoftwareServers

        java.util.List<SoftwareServerElement> findSoftwareServers​(java.lang.String userId,
                                                                  java.lang.String searchString,
                                                                  java.util.Date effectiveTime,
                                                                  int startFrom,
                                                                  int pageSize)
                                                           throws InvalidParameterException,
                                                                  UserNotAuthorizedException,
                                                                  PropertyServerException
        Retrieve the list of software server 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 - time that the element is effective
        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)
      • getSoftwareServersByName

        java.util.List<SoftwareServerElement> getSoftwareServersByName​(java.lang.String userId,
                                                                       java.lang.String name,
                                                                       java.util.Date effectiveTime,
                                                                       int startFrom,
                                                                       int pageSize)
                                                                throws InvalidParameterException,
                                                                       UserNotAuthorizedException,
                                                                       PropertyServerException
        Retrieve the list of softwareServer 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 - time that the element is effective
        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)
      • getSoftwareServersForInfrastructureManager

        java.util.List<SoftwareServerElement> getSoftwareServersForInfrastructureManager​(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 software servers created by this caller.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        effectiveTime - time that the element is effective
        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)