Package com.xebialabs.deployit.core.api

Interface PlaceholderService

@Path("/placeholder") @Produces({"application/xml","application/json"}) @Consumes({"application/xml","application/json"}) public interface PlaceholderService
Information about placeholders

  • Method Summary

    Modifier and Type
    Method
    Description
    List<ai.digital.deploy.sql.model.DefinedPlaceholderView>
    definedPlaceholders(String key, String applicationId, String applicationName, com.xebialabs.deployit.engine.api.dto.Paging paging, com.xebialabs.deployit.engine.api.dto.Ordering order)
    Find all defined placeholders, optionally filtered by (exact) key, (part of) the application ID and (part of) the application name.
    List<ai.digital.deploy.sql.model.DictionaryWithValueView>
    definedPlaceholdersByDictionary(String key, String value, String dictionaryId, String dictionaryName, com.xebialabs.deployit.engine.api.dto.Paging paging, com.xebialabs.deployit.engine.api.dto.Ordering order)
    Find placeholders, optionally filtered by (exact) key, or (part of) the value, dictionary ID and/or dictionary name Returns whether it is encrypted; if it isn't and the user has read access, provides its value; and tells which dictionary defines its value
    List<ai.digital.deploy.sql.model.DefinedPlaceholderReference>
    definedPlaceholdersByEnvironment(String key, String environmentId, String environmentName, com.xebialabs.deployit.engine.api.dto.Paging paging, com.xebialabs.deployit.engine.api.dto.Ordering order)
    Find placeholders, optionally filtered by (exact) key, or (part of) the environment name or ID
    List<String>
    definedPlaceholdersNames(String key, com.xebialabs.deployit.engine.api.dto.Paging paging, com.xebialabs.deployit.engine.api.dto.Ordering order)
    Find placeholders by (part of their) key.
    List<ai.digital.deploy.sql.model.ResolvedPlaceholderView>
    findArchivedPlaceholdersForEnvironment(String environmentId, String key, String value, String deployedName, String dictionaryName, String hostName, String taskId, com.xebialabs.deployit.engine.api.dto.Paging paging, com.xebialabs.deployit.engine.api.dto.Ordering order)
    Gets historic resolved placeholder values on an environment, optionally restricted to finding those used in a specific deployment task, optionally filtered by (parts of) the key name, the placeholder value, and/or deployed application name, dictionary name, and/or host name that the value is restricted to.
    List<ai.digital.deploy.sql.model.ResolvedPlaceholderView>
    findPlaceholdersForEnvironment(String environmentId, String key, String value, String deployedName, String dictionaryName, String hostName, com.xebialabs.deployit.engine.api.dto.Paging paging, com.xebialabs.deployit.engine.api.dto.Ordering order)
    Gets resolved placeholder values, as far as the user has read permissions on them, on an environment, optionally filtered by (parts of) the key name, the placeholder value, and/or deployed application name, dictionary name, and/or host name that the value is restricted to.
    List<ai.digital.deploy.sql.model.ResolvedPlaceholderView>
    findPlaceholdersForHost(String hostId, String key, String value, String deployedName, String dictionaryName, String environmentName, com.xebialabs.deployit.engine.api.dto.Paging paging, com.xebialabs.deployit.engine.api.dto.Ordering order)
    Gets resolved placeholder values for placeholders that have been restricted to a host, optionally filtered by (parts of) the key name, the placeholder value, and/or deployed application name, dictionary name, and/or host name that the value is restricted to.

  • Method Details

    • definedPlaceholders

      @GET @Path("defined") List<ai.digital.deploy.sql.model.DefinedPlaceholderView> definedPlaceholders(@QueryParam("key") String key, @QueryParam("idPattern") String applicationId, @QueryParam("namePattern") String applicationName, @BeanParam com.xebialabs.deployit.engine.api.dto.Paging paging, @QueryParam("order") com.xebialabs.deployit.engine.api.dto.Ordering order)
      Find all defined placeholders, optionally filtered by (exact) key, (part of) the application ID and (part of) the application name.
      Parameters:
      key - (Optional) the exact key to look for
      applicationId - (Optional) (part of) the application ID to filter on
      applicationName - (Optional) (part of) the application name to filter on
      paging - Which page and how many results per page to retrieve
      order - Which ordering to use when listing results
      Returns:
      a list of objects

    • definedPlaceholdersByDictionary

      @GET @Path("defined/by-dictionary") List<ai.digital.deploy.sql.model.DictionaryWithValueView> definedPlaceholdersByDictionary(@QueryParam("key") String key, @QueryParam("value") String value, @QueryParam("idPattern") String dictionaryId, @QueryParam("namePattern") String dictionaryName, @BeanParam com.xebialabs.deployit.engine.api.dto.Paging paging, @QueryParam("order") com.xebialabs.deployit.engine.api.dto.Ordering order)
      Find placeholders, optionally filtered by (exact) key, or (part of) the value, dictionary ID and/or dictionary name Returns whether it is encrypted; if it isn't and the user has read access, provides its value; and tells which dictionary defines its value
      Parameters:
      key - (Optional) The exact placeholder key to look for
      value - (Optional) (Part of) the placeholder value to look for
      dictionaryId - (Optional) (Part of) the dictionary ID to look for
      dictionaryName - (Optional) (Part of) the dictionary name to look for
      paging - Which page and how many results per page to retrieve
      order - Which ordering to use when listing results
      Returns:
      a list of objects

    • definedPlaceholdersByEnvironment

      @GET @Path("defined/by-environment") List<ai.digital.deploy.sql.model.DefinedPlaceholderReference> definedPlaceholdersByEnvironment(@QueryParam("key") String key, @QueryParam("idPattern") String environmentId, @QueryParam("namePattern") String environmentName, @BeanParam com.xebialabs.deployit.engine.api.dto.Paging paging, @QueryParam("order") com.xebialabs.deployit.engine.api.dto.Ordering order)
      Find placeholders, optionally filtered by (exact) key, or (part of) the environment name or ID
      Parameters:
      key - (Optional) The exact placeholder key to look for
      environmentId - (Optional) (Part of) the dictionary ID to look for
      environmentName - (Optional) (Part of) the dictionary name to look for
      paging - Which page and how many results per page to retrieve
      order - Which ordering to use when listing results
      Returns:
      A list of objects

    • definedPlaceholdersNames

      @GET @Path("defined/names") List<String> definedPlaceholdersNames(@QueryParam("namePattern") String key, @BeanParam com.xebialabs.deployit.engine.api.dto.Paging paging, @QueryParam("order") com.xebialabs.deployit.engine.api.dto.Ordering order)
      Find placeholders by (part of their) key.
      Parameters:
      key - the key name pattern to match against
      paging - Which page and how many results per page to retrieve
      order - Which ordering to use when listing results
      Returns:
      a list of placeholder key names

    • findPlaceholdersForEnvironment

      @GET @Path("environment/{ID:.+}") List<ai.digital.deploy.sql.model.ResolvedPlaceholderView> findPlaceholdersForEnvironment(@PathParam("ID") String environmentId, @QueryParam("key") String key, @QueryParam("value") String value, @QueryParam("deployedName") String deployedName, @QueryParam("dictionaryName") String dictionaryName, @QueryParam("hostName") String hostName, @BeanParam com.xebialabs.deployit.engine.api.dto.Paging paging, @QueryParam("order") com.xebialabs.deployit.engine.api.dto.Ordering order)
      Gets resolved placeholder values, as far as the user has read permissions on them, on an environment, optionally filtered by (parts of) the key name, the placeholder value, and/or deployed application name, dictionary name, and/or host name that the value is restricted to.

      Returns information about the placeholder key, value (if readable), whether it is an encrypted entry, and restrictions

      Parameters:
      environmentId - The environment to query the resolved placeholder values against
      key - (Optional) (part of) placeholder key to look for
      value - (Optional) (part of) the placeholder value to look for
      deployedName - (Optional) (part of) the deployed application name that the placeholder should be restricted to
      dictionaryName - (Optional) (part of) the dictionary name that defines the placeholder
      hostName - (Optional) (part of) the host name that the placeholder is restricted to
      paging - Which page and how many results per page to retrieve
      order - Which ordering to use when listing results
      Returns:
      a list of objects

    • findPlaceholdersForHost

      @GET @Path("host/{ID:.+}") List<ai.digital.deploy.sql.model.ResolvedPlaceholderView> findPlaceholdersForHost(@PathParam("ID") String hostId, @QueryParam("key") String key, @QueryParam("value") String value, @QueryParam("deployedName") String deployedName, @QueryParam("dictionaryName") String dictionaryName, @QueryParam("hostName") String environmentName, @BeanParam com.xebialabs.deployit.engine.api.dto.Paging paging, @QueryParam("order") com.xebialabs.deployit.engine.api.dto.Ordering order)
      Gets resolved placeholder values for placeholders that have been restricted to a host, optionally filtered by (parts of) the key name, the placeholder value, and/or deployed application name, dictionary name, and/or host name that the value is restricted to.

      Returns information about the placeholder key, value (if readable), whether it is an encrypted entry, and restrictions

      Parameters:
      hostId - the host ID to query resolved placeholders against
      key - (Optional) (part of) placeholder key to look for
      value - (Optional) (part of) the placeholder value to look for
      deployedName - (Optional) (part of) the deployed application name that the placeholder should be restricted to
      dictionaryName - (Optional) (part of) the dictionary name that defines the placeholder
      environmentName - (Optional) (part of) the environment name that the placeholder is restricted to
      paging - Which page and how many results per page to retrieve
      order - Which ordering to use when listing results
      Returns:
      a list of objects

    • findArchivedPlaceholdersForEnvironment

      @GET @Path("archived/environment/{ID:.+}") List<ai.digital.deploy.sql.model.ResolvedPlaceholderView> findArchivedPlaceholdersForEnvironment(@PathParam("ID") String environmentId, @QueryParam("key") String key, @QueryParam("value") String value, @QueryParam("deployedName") String deployedName, @QueryParam("dictionaryName") String dictionaryName, @QueryParam("hostName") String hostName, @QueryParam("taskId") String taskId, @BeanParam com.xebialabs.deployit.engine.api.dto.Paging paging, @QueryParam("order") com.xebialabs.deployit.engine.api.dto.Ordering order)
      Gets historic resolved placeholder values on an environment, optionally restricted to finding those used in a specific deployment task, optionally filtered by (parts of) the key name, the placeholder value, and/or deployed application name, dictionary name, and/or host name that the value is restricted to.

      Returns information about the placeholder key, value (if readable), whether it is an encrypted entry, and restrictions

      Parameters:
      environmentId - The environment to query the resolved placeholder values against
      key - (Optional) (part of) placeholder key to look for
      value - (Optional) (part of) the placeholder value to look for
      deployedName - (Optional) (part of) the deployed application name that the placeholder should be restricted to
      dictionaryName - (Optional) (part of) the dictionary name that defines the placeholder
      hostName - (Optional) (part of) the host name that the placeholder is restricted to
      taskId - (Optional) The task ID for which to find used placeholders
      paging - Which page and how many results per page to retrieve
      order - Which ordering to use when listing results
      Returns:
      a list of objects