@Deprecated public interface ComponentConfiguration
UriEndpointComponent
implementations created for Endpoints annotated with UriEndpoint
and the
associated annotations then all the parameter values can be introspected and the parameter values are converted to their
correct type.
Other implementations keep all the types as String and there is no validation until you try to create
an Endpoint from the values.Modifier and Type | Method and Description |
---|---|
List<String> |
completeEndpointPath(String completionText)
Deprecated.
A helper method for tools such as CLIs, IDEs or web tools that provides a completion list for Endpoint Paths
rather like bash tab completion or Karaf attribute or option completion handlers.
|
void |
configureEndpoint(Endpoint endpoint)
Deprecated.
Applies the current set of parameters to the given endpoint instance.
|
Endpoint |
createEndpoint()
Deprecated.
Converts the configuration into a URI and then looks up the endpoint in the
CamelContext
which typically results in a new Endpoint instance being created. |
String |
createParameterJsonSchema()
Deprecated.
Creates a JSON schema representation of the
configuration parameters for this endpoint and the types and validation rules.
|
String |
getBaseUri()
Deprecated.
Returns the base URI without any query parameters added
|
Object |
getEndpointParameter(Endpoint endpoint,
String name)
Deprecated.
Gets the named URI parameter value on the given endpoint
|
Object |
getParameter(String name)
Deprecated.
Returns the parameter value for the given name
|
ParameterConfiguration |
getParameterConfiguration(String name)
Deprecated.
Returns the URI query parameter configuration for the given parameter name or null if it does not exist
|
SortedMap<String,ParameterConfiguration> |
getParameterConfigurationMap()
Deprecated.
Returns the sorted map of all the parameter names to their
ParameterConfiguration objects |
Map<String,Object> |
getParameters()
Deprecated.
Returns the current parameters of the configuration (usually encoded as ?foo=bar&whatnot=something URI query parameters)
|
String |
getUriString()
Deprecated.
Returns the URI string (without schema) with query parameters for the current
configuration which can then be used to create an
Endpoint |
void |
setBaseUri(String baseUri)
Deprecated.
Sets the base URI without any query parameters added
|
void |
setEndpointParameter(Endpoint endpoint,
String name,
Object value)
Deprecated.
Sets the named URI query parameter value on the given endpoint
|
void |
setParameter(String name,
Object value)
Deprecated.
Sets the parameter value of the given name
|
void |
setParameters(Map<String,Object> propertyValues)
Deprecated.
Sets the parameter values of this configuration
|
void |
setUriString(String newValue)
Deprecated.
Sets the URI string (without schema but with optional query parameters)
which will update the
getBaseUri() and the getParameters() values |
String getBaseUri()
void setBaseUri(String baseUri)
Map<String,Object> getParameters()
void setParameters(Map<String,Object> propertyValues)
Object getParameter(String name)
name
- the name of the URI query parameter to getvoid setParameter(String name, Object value)
name
- the name of the URI query parametervalue
- the new value of the parameterString getUriString()
Endpoint
void setUriString(String newValue) throws URISyntaxException
getBaseUri()
and the getParameters()
valuesnewValue
- the new URI string with query argumentsURISyntaxException
ParameterConfiguration getParameterConfiguration(String name)
SortedMap<String,ParameterConfiguration> getParameterConfigurationMap()
ParameterConfiguration
objectsEndpoint createEndpoint() throws Exception
CamelContext
which typically results in a new Endpoint
instance being created.Exception
void configureEndpoint(Endpoint endpoint)
endpoint
- the endpoint instanceObject getEndpointParameter(Endpoint endpoint, String name) throws RuntimeCamelException
endpoint
- the endpoint instancename
- the name of the URI query parameterRuntimeCamelException
- if the parameter name does not exist on the endpointvoid setEndpointParameter(Endpoint endpoint, String name, Object value) throws RuntimeCamelException
endpoint
- the endpoint instancename
- the name of the URI query parametervalue
- the new value of the URI query parameterRuntimeCamelException
List<String> completeEndpointPath(String completionText)
completionText
- the prefix text used to complete on (usually a matching bit of text)String createParameterJsonSchema()
Apache Camel