Package org.odpi.openmetadata.accessservices.itinfrastructure.api

Interface HostManagerInterface

All Known Implementing Classes:
HostManagerClient
public interface HostManagerInterface
HostManagerInterface defines the client side interface for the IT Infrastructure OMAS that is relevant for host assets. It provides the ability to define and maintain the metadata about a host and relationships between hosts.

  • Method Details

    • createHost

      String createHost(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, HostProperties hostProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Create a new metadata element to represent a host.
      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 host be marked as owned by the infrastructure manager so others can not update?
      hostProperties - 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)

    • createHostFromTemplate

      String createHostFromTemplate(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String templateGUID, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Create a new metadata element to represent a host 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 host 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)

    • updateHost

      void updateHost(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String hostGUID, boolean isMergeUpdate, HostProperties hostProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Update the metadata element representing a host.
      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
      hostGUID - unique identifier of the metadata element to update
      isMergeUpdate - are unspecified properties unchanged (true) or removed?
      hostProperties - 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)

    • setupClusterMember

      void setupClusterMember(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String hostGUID, String clusterMemberGUID, Date effectiveFrom, Date effectiveTo) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Create a relationship between a host and an cluster member host.
      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
      hostGUID - unique identifier of the host
      clusterMemberGUID - unique identifier of the cluster member host
      effectiveFrom - time when this hosting is effective - null means immediately
      effectiveTo - time when this hosting is no longer effective - null means forever
      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)

    • clearClusterMember

      void clearClusterMember(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String hostGUID, String clusterMemberGUID, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove a relationship between a host and an cluster member host.
      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
      hostGUID - unique identifier of the host
      clusterMemberGUID - unique identifier of the cluster member host
      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)

    • publishHost

      void publishHost(String userId, String hostGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Update the zones for the host 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
      hostGUID - 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)

    • withdrawHost

      void withdrawHost(String userId, String hostGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Update the zones for the host 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 host is first created).
      Parameters:
      userId - calling user
      hostGUID - 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)

    • removeHost

      void removeHost(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String hostGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove the metadata element representing a host.
      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
      hostGUID - 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)

    • findHosts

      List<HostElement> findHosts(String userId, String searchString, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Retrieve the list of host 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)

    • getHostsByName

      List<HostElement> getHostsByName(String userId, String name, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Retrieve the list of host 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)

    • getHostsForInfrastructureManager

      List<HostElement> getHostsForInfrastructureManager(String userId, String infrastructureManagerGUID, String infrastructureManagerName, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Retrieve the list of hosts 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)

    • getHostByGUID

      HostElement getHostByGUID(String userId, String guid) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Retrieve the host metadata element with the supplied unique identifier.
      Parameters:
      userId - calling user
      guid - unique identifier of the requested metadata element
      Returns:
      matching 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)

    • getClusterMembersForHost

      List<HostElement> getClusterMembersForHost(String userId, String hostGUID, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Return the list of cluster members associated with a host.
      Parameters:
      userId - calling user
      hostGUID - unique identifier of the host 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)