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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.List<ai.digital.deploy.sql.model.DefinedPlaceholderView> definedPlaceholders​(java.lang.String key, java.lang.String applicationId, java.lang.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.
      java.util.List<ai.digital.deploy.sql.model.DictionaryWithValueView> definedPlaceholdersByDictionary​(java.lang.String key, java.lang.String value, java.lang.String dictionaryId, java.lang.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
      java.util.List<ai.digital.deploy.sql.model.DefinedPlaceholderReference> definedPlaceholdersByEnvironment​(java.lang.String key, java.lang.String environmentId, java.lang.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
      java.util.List<java.lang.String> definedPlaceholdersNames​(java.lang.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.
      java.util.List<ai.digital.deploy.sql.model.ResolvedPlaceholderView> findArchivedPlaceholdersForEnvironment​(java.lang.String environmentId, java.lang.String key, java.lang.String value, java.lang.String deployedName, java.lang.String dictionaryName, java.lang.String hostName, java.lang.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.
      java.util.List<ai.digital.deploy.sql.model.ResolvedPlaceholderView> findPlaceholdersForEnvironment​(java.lang.String environmentId, java.lang.String key, java.lang.String value, java.lang.String deployedName, java.lang.String dictionaryName, java.lang.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.
      java.util.List<ai.digital.deploy.sql.model.ResolvedPlaceholderView> findPlaceholdersForHost​(java.lang.String hostId, java.lang.String key, java.lang.String value, java.lang.String deployedName, java.lang.String dictionaryName, java.lang.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 Detail

      • definedPlaceholders

        @GET
@Path("defined")
java.util.List<ai.digital.deploy.sql.model.DefinedPlaceholderView> definedPlaceholders​(@QueryParam("key")
                                                                                       java.lang.String key,
                                                                                       @QueryParam("idPattern")
                                                                                       java.lang.String applicationId,
                                                                                       @QueryParam("namePattern")
                                                                                       java.lang.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 {@see com.xebialabs.deployit.core.api.dto.DefinedPlaceholderView} objects

      • definedPlaceholdersByDictionary

        @GET
@Path("defined/by-dictionary")
java.util.List<ai.digital.deploy.sql.model.DictionaryWithValueView> definedPlaceholdersByDictionary​(@QueryParam("key")
                                                                                                    java.lang.String key,
                                                                                                    @QueryParam("value")
                                                                                                    java.lang.String value,
                                                                                                    @QueryParam("idPattern")
                                                                                                    java.lang.String dictionaryId,
                                                                                                    @QueryParam("namePattern")
                                                                                                    java.lang.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 {@see com.xebialabs.deployit.core.api.dto.DictionaryWithValueView} objects

      • definedPlaceholdersByEnvironment

        @GET
@Path("defined/by-environment")
java.util.List<ai.digital.deploy.sql.model.DefinedPlaceholderReference> definedPlaceholdersByEnvironment​(@QueryParam("key")
                                                                                                         java.lang.String key,
                                                                                                         @QueryParam("idPattern")
                                                                                                         java.lang.String environmentId,
                                                                                                         @QueryParam("namePattern")
                                                                                                         java.lang.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 {@see com.xebialabs.deployit.core.api.dto.DefinedPlaceholderReference} objects

      • definedPlaceholdersNames

        @GET
@Path("defined/names")
java.util.List<java.lang.String> definedPlaceholdersNames​(@QueryParam("namePattern")
                                                          java.lang.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:.+}")
java.util.List<ai.digital.deploy.sql.model.ResolvedPlaceholderView> findPlaceholdersForEnvironment​(@PathParam("ID")
                                                                                                   java.lang.String environmentId,
                                                                                                   @QueryParam("key")
                                                                                                   java.lang.String key,
                                                                                                   @QueryParam("value")
                                                                                                   java.lang.String value,
                                                                                                   @QueryParam("deployedName")
                                                                                                   java.lang.String deployedName,
                                                                                                   @QueryParam("dictionaryName")
                                                                                                   java.lang.String dictionaryName,
                                                                                                   @QueryParam("hostName")
                                                                                                   java.lang.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 {@see com.xebialabs.deployit.core.api.dto.ResolvedPlaceholderView} objects

      • findPlaceholdersForHost

        @GET
@Path("host/{ID:.+}")
java.util.List<ai.digital.deploy.sql.model.ResolvedPlaceholderView> findPlaceholdersForHost​(@PathParam("ID")
                                                                                            java.lang.String hostId,
                                                                                            @QueryParam("key")
                                                                                            java.lang.String key,
                                                                                            @QueryParam("value")
                                                                                            java.lang.String value,
                                                                                            @QueryParam("deployedName")
                                                                                            java.lang.String deployedName,
                                                                                            @QueryParam("dictionaryName")
                                                                                            java.lang.String dictionaryName,
                                                                                            @QueryParam("hostName")
                                                                                            java.lang.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 {@see com.xebialabs.deployit.core.api.dto.ResolvedPlaceholderView} objects

      • findArchivedPlaceholdersForEnvironment

        @GET
@Path("archived/environment/{ID:.+}")
java.util.List<ai.digital.deploy.sql.model.ResolvedPlaceholderView> findArchivedPlaceholdersForEnvironment​(@PathParam("ID")
                                                                                                           java.lang.String environmentId,
                                                                                                           @QueryParam("key")
                                                                                                           java.lang.String key,
                                                                                                           @QueryParam("value")
                                                                                                           java.lang.String value,
                                                                                                           @QueryParam("deployedName")
                                                                                                           java.lang.String deployedName,
                                                                                                           @QueryParam("dictionaryName")
                                                                                                           java.lang.String dictionaryName,
                                                                                                           @QueryParam("hostName")
                                                                                                           java.lang.String hostName,
                                                                                                           @QueryParam("taskId")
                                                                                                           java.lang.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 {@see com.xebialabs.deployit.core.api.dto.ResolvedPlaceholderView} objects