Package org.apache.camel.spi

Interface EndpointUriFactory

All Superinterfaces:
CamelContextAware
public interface EndpointUriFactory extends CamelContextAware
Factory to create Endpoint URI string from a Map of parameters. Notice that this factory is only for creating an URL string and not Endpoint instances.

  • Method Details

    • isEnabled

      boolean isEnabled(String scheme)
      Checks whether this factory supports the given component name

    • buildUri

      default String buildUri(String scheme, Map<String,Object> properties) throws URISyntaxException
      Assembles an endpoint uri for the given component name with the given parameters.
      Parameters:
      scheme - the component name
      properties - endpoint options
      Returns:
      the constructed endpoint uri
      Throws:
      URISyntaxException

    • buildUri

      String buildUri(String scheme, Map<String,Object> properties, boolean encode) throws URISyntaxException
      Assembles an endpoint uri for the given component name with the given parameters.
      Parameters:
      scheme - the component name
      properties - endpoint options
      encode - whether to URL encode the returned uri or not
      Returns:
      the constructed endpoint uri
      Throws:
      URISyntaxException

    • propertyNames

      Set<String> propertyNames()
      Returns all the names this endpoint supports.

    • secretPropertyNames

      Set<String> secretPropertyNames()
      Returns the names of the secret properties this endpoint supports.

    • multiValuePrefixes

      Set<String> multiValuePrefixes()
      Returns the prefixes of the multi-valued properties this endpoint supports.

    • isLenientProperties

      boolean isLenientProperties()
      Whether the endpoint is lenient or not.
      See Also: