Interface EndpointUriFactory

All Superinterfaces:
CamelContextAware, HasCamelContext
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.
Since:
3.6

  • 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.

    • endpointIdentityPropertyNames

      default Set<String> endpointIdentityPropertyNames()
      Returns the names of the endpoint identity properties.

      Endpoint identity properties are query parameters that form part of the endpoint's destination identity (e.g., bucket name, database name, topic). Most components encode the destination in the URI context path, but some use query parameters instead. This metadata allows tooling to include these parameters when building canonical URIs for endpoint matching.

      Since:
      4.21

    • multiValuePrefixes

      Map<String,String> multiValuePrefixes()
      Returns the prefixes (option name = prefix) of the multi-valued properties this endpoint supports.

    • isLenientProperties

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