Package com.xebialabs.deployit.core.api

Interface HostService

  • @Path("/host")
@Produces("application/json")
public interface HostService
    Retrieves information about Hosts: which DeployedApplications have deployeds on this host, and which environments does this host take part in? The user must have READ access to the specified host.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.Integer countEnvironmentsByHost​(java.lang.String hostId, java.lang.String environmentName)
      Count the number of environments that the user has READ access to and the specified host is part of, optionally filtered by (part of) the environment name
      java.util.List<com.xebialabs.deployit.engine.api.dto.ConfigurationItemId> findDeployedApplications​(java.lang.String hostId, java.lang.String deployedAppName, com.xebialabs.deployit.engine.api.dto.Paging paging, com.xebialabs.deployit.engine.api.dto.Ordering order)
      Find deployedApplications that have deployeds on the specified host.
      java.util.List<com.xebialabs.deployit.engine.api.dto.DeploymentInfo> getEnvironmentsByHost​(java.lang.String hostId, java.lang.String environmentName, com.xebialabs.deployit.engine.api.dto.Paging paging, com.xebialabs.deployit.engine.api.dto.Ordering order)
      Gets all environments that the specified host is part of, including when and by whom this environment was last deployed to.

    • Method Detail

      • findDeployedApplications

        @GET
@Path("deployed-applications/{ID:.+}")
java.util.List<com.xebialabs.deployit.engine.api.dto.ConfigurationItemId> findDeployedApplications​(@PathParam("ID")
                                                                                                   java.lang.String hostId,
                                                                                                   @QueryParam("deployedAppName")
                                                                                                   java.lang.String deployedAppName,
                                                                                                   @BeanParam
                                                                                                   com.xebialabs.deployit.engine.api.dto.Paging paging,
                                                                                                   @QueryParam("order")
                                                                                                   com.xebialabs.deployit.engine.api.dto.Ordering order)
        Find deployedApplications that have deployeds on the specified host.
        Parameters:
        hostId - the host ID
        deployedAppName - (Optional) (Part of) the deployedApplication's to look for
        paging - How many results to display per page, and which page to retrieve
        order - How to order the search results.
        Returns:
        A list of {@see com.xebialabs.deployit.engine.api.dto.ConfigurationItemId} objects corresponding to the deployedApplications

      • getEnvironmentsByHost

        @GET
@Path("{id:.+}/environments")
java.util.List<com.xebialabs.deployit.engine.api.dto.DeploymentInfo> getEnvironmentsByHost​(@PathParam("id")
                                                                                           java.lang.String hostId,
                                                                                           @QueryParam("name")
                                                                                           java.lang.String environmentName,
                                                                                           @BeanParam
                                                                                           com.xebialabs.deployit.engine.api.dto.Paging paging,
                                                                                           @QueryParam("order")
                                                                                           com.xebialabs.deployit.engine.api.dto.Ordering order)
        Gets all environments that the specified host is part of, including when and by whom this environment was last deployed to. Lists only environments that the user has READ permission for.
        Parameters:
        hostId - The host ID to query for
        environmentName - (Optional) (part of) the name of the environment(s) to look for
        paging - How many results to display per page, and which page to retrieve
        order - How to order the search results.
        Returns:
        a list of {@see com.xebialabs.deployit.engine.api.dto.DeploymentInfo} objects

      • countEnvironmentsByHost

        @GET
@Path("{id:.+}/environments/count")
java.lang.Integer countEnvironmentsByHost​(@PathParam("id")
                                          java.lang.String hostId,
                                          @QueryParam("name")
                                          java.lang.String environmentName)
        Count the number of environments that the user has READ access to and the specified host is part of, optionally filtered by (part of) the environment name
        Parameters:
        hostId - The host ID to query
        environmentName - (Optional) (part of) the environment name(s) to look for.
        Returns:
        The number of environments that this host is part of