Package com.xebialabs.deployit.service.externalproperties

Interface ExternalValueProvider

public interface ExternalValueProvider
Interface for resolving external values for BaseConfigurationItems
See Also:
  • BaseConfigurationItem.get$externalProperties()

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isProviderAvailable(com.xebialabs.deployit.plugin.api.udm.ExternalProperty externalProperty)
    Can this provider resolve a value (e.g.
    Object
    resolve(com.xebialabs.deployit.plugin.api.udm.ExternalProperty externalProperty, boolean password)
    Resolve a value for an ExternalProperty
    boolean
    supports(com.xebialabs.deployit.plugin.api.udm.ExternalProperty externalProperty)
    Can this provider provide a value for the property?

  • Method Details

    • isProviderAvailable

      boolean isProviderAvailable(com.xebialabs.deployit.plugin.api.udm.ExternalProperty externalProperty)
      Can this provider resolve a value (e.g. is it currently available)

    • supports

      boolean supports(com.xebialabs.deployit.plugin.api.udm.ExternalProperty externalProperty)
      Can this provider provide a value for the property?

    • resolve

      Object resolve(com.xebialabs.deployit.plugin.api.udm.ExternalProperty externalProperty, boolean password) throws IllegalExternalPropertyReferenceException
      Resolve a value for an ExternalProperty
      Parameters:
      externalProperty - The external property to resolve
      password - Whether the property will be used for a password property.
      Returns:
      The value found. Can return null if non value was found.
      Throws:
      IllegalExternalPropertyReferenceException - when the provider refuses to provide a value for this call, e.g. when a secret is resolved for a non password field.