Package org.apache.camel.spi
Interface EndpointUriFactory
-
- All Superinterfaces:
CamelContextAware
public interface EndpointUriFactory extends CamelContextAware
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default String
buildUri(String scheme, Map<String,Object> properties)
Assembles an endpoint uri for the given component name with the given parameters.String
buildUri(String scheme, Map<String,Object> properties, boolean encode)
Assembles an endpoint uri for the given component name with the given parameters.boolean
isEnabled(String scheme)
Checks whether this factory supports the given component nameboolean
isLenientProperties()
Whether the endpoint is lenient or not.Set<String>
multiValuePrefixes()
Returns the prefixes of the multi-valued properties this endpoint supports.Set<String>
propertyNames()
Returns all the names this endpoint supports.Set<String>
secretPropertyNames()
Returns the names of the secret properties this endpoint supports.-
Methods inherited from interface org.apache.camel.CamelContextAware
getCamelContext, setCamelContext
-
-
-
-
Method Detail
-
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 nameproperties
- 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 nameproperties
- endpoint optionsencode
- whether to URL encode the returned uri or not- Returns:
- the constructed endpoint uri
- Throws:
URISyntaxException
-
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:
Endpoint.isLenientProperties()
-
-