This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 44bd21982f93ce73d9bd669481e4806db6e1e98e
Author: Claus Ibsen <claus.ib...@gmail.com>
AuthorDate: Thu Aug 13 15:05:48 2020 +0200
CAMEL-15253: fixed uri syntax
---
.../apache/camel/catalog/components/oaipmh.json | 20 +++++++--------
.../camel/catalog/docs/oaipmh-component.adoc | 30 ++++++++++------------
.../org/apache/camel/oaipmh/component/oaipmh.json | 2 +-
.../src/main/docs/oaipmh-component.adoc | 2 +-
.../camel/oaipmh/component/OAIPMHEndpoint.java | 2 +-
.../src/generated/resources/metadata.json | 2 +-
.../builder/endpoint/StaticEndpointBuilders.java | 8 +++---
.../endpoint/dsl/OAIPMHEndpointBuilderFactory.java | 8 +++---
docs/components/modules/ROOT/nav.adoc | 2 +-
.../modules/ROOT/pages/oaipmh-component.adoc | 28 +++++++++-----------
10 files changed, 48 insertions(+), 56 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/oaipmh.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/oaipmh.json
index 0476813..70f1692 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/oaipmh.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/oaipmh.json
@@ -2,8 +2,8 @@
"component": {
"kind": "component",
"name": "oaipmh",
- "title": "OAIPMH",
- "description": "Represents a OAIPMH endpoint. Component for do OAI-PMH
request",
+ "title": "OAI-PMH",
+ "description": "Harvest metadata using OAI-PMH protocol",
"deprecated": false,
"firstVersion": "3.5.0",
"label": "endpoint,webservice,batch",
@@ -14,7 +14,7 @@
"version": "3.5.0-SNAPSHOT",
"scheme": "oaipmh",
"extendsScheme": "",
- "syntax": "oaipmh:name",
+ "syntax": "oaipmh:url",
"async": false,
"consumerOnly": false,
"producerOnly": false,
@@ -26,15 +26,12 @@
"basicPropertyBinding": { "kind": "property", "displayName": "Basic
Property Binding", "group": "advanced", "label": "advanced", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false,
"defaultValue": false, "description": "Whether the component should use basic
property binding (Camel 2.x) or the newer property binding with additional
capabilities" }
},
"properties": {
- "url": { "kind": "path", "displayName": "Url", "group": "advanced",
"label": "advanced", "required": true, "type": "string", "javaType":
"java.net.URI", "deprecated": false, "deprecationNote": "", "secret": false,
"description": "Base URL of the repository to which the request is made through
the OAI-PMH protocol." },
+ "url": { "kind": "path", "displayName": "Url", "group": "common", "label":
"", "required": true, "type": "string", "javaType": "java.net.URI",
"deprecated": false, "deprecationNote": "", "secret": false, "description":
"Base URL of the repository to which the request is made through the OAI-PMH
protocol" },
"endpointUrl": { "kind": "parameter", "displayName": "Endpoint Url",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "secret": false,
"description": "Base URL of the repository to which the request is made through
the OAI-PMH protocol. (Parameter)" },
"from": { "kind": "parameter", "displayName": "From", "group": "common",
"label": "", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "secret": false, "description":
"Specifies a lower bound for datestamp-based selective harvesting. UTC DateTime
value" },
- "identitier": { "kind": "parameter", "displayName": "Identitier", "group":
"common", "label": "", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "secret": false, "description":
"Identifier of the requested resources. Applicable only with certain verbs" },
- "ignoreSSLWarnings": { "kind": "parameter", "displayName": "Ignore
SSLWarnings", "group": "common", "label": "", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "secret": false,
"defaultValue": "false", "description": "Ignore SSL certificate warnings" },
+ "identifier": { "kind": "parameter", "displayName": "Identifier", "group":
"common", "label": "", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "secret": false, "description":
"Identifier of the requested resources. Applicable only with certain verbs" },
"metadataPrefix": { "kind": "parameter", "displayName": "Metadata Prefix",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "secret": false,
"defaultValue": "oai_dc", "description": "Specifies the metadataPrefix of the
format that should be included in the metadata part of the returned records." },
- "onlyFirst": { "kind": "parameter", "displayName": "Only First", "group":
"common", "label": "", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "secret": false, "defaultValue": "False",
"description": "Returns the response of a single request. Otherwise it will
make requests until there is no more data to return." },
- "set": { "kind": "parameter", "displayName": "Set", "group": "common",
"label": "", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "secret": false, "description":
"Specifies membership as a criteria for set-based selective harvesting." },
- "ssl": { "kind": "parameter", "displayName": "Ssl", "group": "common",
"label": "", "required": false, "type": "boolean", "javaType": "boolean",
"deprecated": false, "secret": false, "defaultValue": "false", "description":
"Causes the defined url to make an https request" },
+ "set": { "kind": "parameter", "displayName": "Set", "group": "common",
"label": "", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "secret": false, "description":
"Specifies membership as a criteria for set-based selective harvesting" },
"until": { "kind": "parameter", "displayName": "Until", "group": "common",
"label": "", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "secret": false, "description":
"Specifies an upper bound for datestamp-based selective harvesting. UTC
DateTime value." },
"verb": { "kind": "parameter", "displayName": "Verb", "group": "common",
"label": "", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "secret": false, "defaultValue":
"ListRecords", "description": "Request name supported by OAI-PMh protocol" },
"bridgeErrorHandler": { "kind": "parameter", "displayName": "Bridge Error
Handler", "group": "consumer", "label": "consumer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "secret": false,
"defaultValue": false, "description": "Allows for bridging the consumer to the
Camel routing Error Handler, which mean any exceptions occurred while the
consumer is trying to pickup incoming messages, or the likes, will now be
processed as a message and handled b [...]
@@ -43,6 +40,7 @@
"exchangePattern": { "kind": "parameter", "displayName": "Exchange
Pattern", "group": "consumer (advanced)", "label": "consumer,advanced",
"required": false, "type": "object", "javaType":
"org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut",
"InOptionalOut" ], "deprecated": false, "secret": false, "description": "Sets
the exchange pattern when the consumer creates an exchange." },
"pollStrategy": { "kind": "parameter", "displayName": "Poll Strategy",
"group": "consumer (advanced)", "label": "consumer,advanced", "required":
false, "type": "object", "javaType":
"org.apache.camel.spi.PollingConsumerPollStrategy", "deprecated": false,
"secret": false, "description": "A pluggable
org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your
custom implementation to control error handling usually occurred during the
poll operation before an Exchange h [...]
"lazyStartProducer": { "kind": "parameter", "displayName": "Lazy Start
Producer", "group": "producer", "label": "producer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "secret": false,
"defaultValue": false, "description": "Whether the producer should be started
lazy (on the first message). By starting lazy you can use this to allow
CamelContext and routes to startup in situations where a producer may otherwise
fail during starting and cause the [...]
+ "onlyFirst": { "kind": "parameter", "displayName": "Only First", "group":
"producer", "label": "producer", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
false, "description": "Returns the response of a single request. Otherwise it
will make requests until there is no more data to return." },
"basicPropertyBinding": { "kind": "parameter", "displayName": "Basic
Property Binding", "group": "advanced", "label": "advanced", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false,
"defaultValue": false, "description": "Whether the endpoint should use basic
property binding (Camel 2.x) or the newer property binding with additional
capabilities" },
"synchronous": { "kind": "parameter", "displayName": "Synchronous",
"group": "advanced", "label": "advanced", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "secret": false, "defaultValue":
"false", "description": "Sets whether synchronous processing should be strictly
used, or Camel is allowed to use asynchronous processing (if supported)." },
"backoffErrorThreshold": { "kind": "parameter", "displayName": "Backoff
Error Threshold", "group": "scheduler", "label": "consumer,scheduler",
"required": false, "type": "integer", "javaType": "int", "deprecated": false,
"secret": false, "description": "The number of subsequent error polls (failed
due some error) that should happen before the backoffMultipler should kick-in."
},
@@ -58,6 +56,8 @@
"schedulerProperties": { "kind": "parameter", "displayName": "Scheduler
Properties", "group": "scheduler", "label": "consumer,scheduler", "required":
false, "type": "object", "javaType": "java.util.Map<java.lang.String,
java.lang.Object>", "prefix": "scheduler.", "multiValue": true, "deprecated":
false, "secret": false, "description": "To configure additional properties when
using a custom scheduler or any of the Quartz, Spring based scheduler." },
"startScheduler": { "kind": "parameter", "displayName": "Start Scheduler",
"group": "scheduler", "label": "consumer,scheduler", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "secret": false,
"defaultValue": "true", "description": "Whether the scheduler should be auto
started." },
"timeUnit": { "kind": "parameter", "displayName": "Time Unit", "group":
"scheduler", "label": "consumer,scheduler", "required": false, "type":
"object", "javaType": "java.util.concurrent.TimeUnit", "enum": [ "NANOSECONDS",
"MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ],
"deprecated": false, "secret": false, "defaultValue": "MILLISECONDS",
"description": "Time unit for initialDelay and delay options." },
- "useFixedDelay": { "kind": "parameter", "displayName": "Use Fixed Delay",
"group": "scheduler", "label": "consumer,scheduler", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "secret": false,
"defaultValue": "true", "description": "Controls if fixed delay or fixed rate
is used. See ScheduledExecutorService in JDK for details." }
+ "useFixedDelay": { "kind": "parameter", "displayName": "Use Fixed Delay",
"group": "scheduler", "label": "consumer,scheduler", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "secret": false,
"defaultValue": "true", "description": "Controls if fixed delay or fixed rate
is used. See ScheduledExecutorService in JDK for details." },
+ "ignoreSSLWarnings": { "kind": "parameter", "displayName": "Ignore
SSLWarnings", "group": "security", "label": "security", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false,
"defaultValue": false, "description": "Ignore SSL certificate warnings" },
+ "ssl": { "kind": "parameter", "displayName": "Ssl", "group": "security",
"label": "security", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "secret": false, "defaultValue": false,
"description": "Causes the defined url to make an https request" }
}
}
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/oaipmh-component.adoc
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/oaipmh-component.adoc
index 9ec9c53..ef6cb5b 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/oaipmh-component.adoc
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/oaipmh-component.adoc
@@ -1,8 +1,8 @@
[[oaipmh-component]]
-= OAIPMH Component
-:docTitle: OAIPMH
+= OAI-PMH Component
+:docTitle: OAI-PMH
:artifactId: camel-oaipmh
-:description: Represents a OAIPMH endpoint. Component for do OAI-PMH request
+:description: Harvest metadata using OAI-PMH protocol
:since: 3.5
:supportLevel: Preview
:component-header: Both producer and consumer are supported
@@ -13,7 +13,7 @@
-The oaipmh component is used for harvest OAI-PMH data providers. It allows do
request to OAI-PMH endpoint using all verbs supported by the protocol.
+The oaipmh component is used for harvest OAI-PMH data providers. It allows do
request to OAI-PMH endpoint using all verbs supported by the protocol.
Maven users will need to add the following dependency to their `pom.xml`
for this component:
@@ -41,7 +41,7 @@ You can append query options to the URI in the following
format,
== Options
// component options: START
-The OAIPMH component supports 3 options, which are listed below.
+The OAI-PMH component supports 3 options, which are listed below.
@@ -57,10 +57,10 @@ The OAIPMH component supports 3 options, which are listed
below.
// endpoint options: START
-The OAIPMH endpoint is configured using URI syntax:
+The OAI-PMH endpoint is configured using URI syntax:
----
-oaipmh:name
+oaipmh:url
----
with the following path and query parameters:
@@ -71,7 +71,7 @@ with the following path and query parameters:
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
-| *url* | *Required* Base URL of the repository to which the request is made
through the OAI-PMH protocol. | | URI
+| *url* | *Required* Base URL of the repository to which the request is made
through the OAI-PMH protocol | | URI
|===
@@ -83,12 +83,9 @@ with the following path and query parameters:
| Name | Description | Default | Type
| *endpointUrl* (common) | Base URL of the repository to which the request is
made through the OAI-PMH protocol. (Parameter) | | String
| *from* (common) | Specifies a lower bound for datestamp-based selective
harvesting. UTC DateTime value | | String
-| *identitier* (common) | Identifier of the requested resources. Applicable
only with certain verbs | | String
-| *ignoreSSLWarnings* (common) | Ignore SSL certificate warnings | false |
boolean
+| *identifier* (common) | Identifier of the requested resources. Applicable
only with certain verbs | | String
| *metadataPrefix* (common) | Specifies the metadataPrefix of the format that
should be included in the metadata part of the returned records. | oai_dc |
String
-| *onlyFirst* (common) | Returns the response of a single request. Otherwise
it will make requests until there is no more data to return. | False | boolean
-| *set* (common) | Specifies membership as a criteria for set-based selective
harvesting. | | String
-| *ssl* (common) | Causes the defined url to make an https request | false |
boolean
+| *set* (common) | Specifies membership as a criteria for set-based selective
harvesting | | String
| *until* (common) | Specifies an upper bound for datestamp-based selective
harvesting. UTC DateTime value. | | String
| *verb* (common) | Request name supported by OAI-PMh protocol | ListRecords |
String
| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the
Camel routing Error Handler, which mean any exceptions occurred while the
consumer is trying to pickup incoming messages, or the likes, will now be
processed as a message and handled by the routing Error Handler. By default the
consumer will use the org.apache.camel.spi.ExceptionHandler to deal with
exceptions, that will be logged at WARN or ERROR level and ignored. | false |
boolean
@@ -97,6 +94,7 @@ with the following path and query parameters:
| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer
creates an exchange. The value can be one of: InOnly, InOut, InOptionalOut | |
ExchangePattern
| *pollStrategy* (consumer) | A pluggable
org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your
custom implementation to control error handling usually occurred during the
poll operation before an Exchange have been created and being routed in Camel.
| | PollingConsumerPollStrategy
| *lazyStartProducer* (producer) | Whether the producer should be started lazy
(on the first message). By starting lazy you can use this to allow CamelContext
and routes to startup in situations where a producer may otherwise fail during
starting and cause the route to fail being started. By deferring this startup
to be lazy then the startup failure can be handled during routing messages via
Camel's routing error handlers. Beware that when the first message is processed
then creating and [...]
+| *onlyFirst* (producer) | Returns the response of a single request. Otherwise
it will make requests until there is no more data to return. | false | boolean
| *basicPropertyBinding* (advanced) | Whether the endpoint should use basic
property binding (Camel 2.x) or the newer property binding with additional
capabilities | false | boolean
| *synchronous* (advanced) | Sets whether synchronous processing should be
strictly used, or Camel is allowed to use asynchronous processing (if
supported). | false | boolean
| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls
(failed due some error) that should happen before the backoffMultipler should
kick-in. | | int
@@ -113,6 +111,8 @@ with the following path and query parameters:
| *startScheduler* (scheduler) | Whether the scheduler should be auto started.
| true | boolean
| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. The
value can be one of: NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES,
HOURS, DAYS | MILLISECONDS | TimeUnit
| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used.
See ScheduledExecutorService in JDK for details. | true | boolean
+| *ignoreSSLWarnings* (security) | Ignore SSL certificate warnings | false |
boolean
+| *ssl* (security) | Causes the defined url to make an https request | false |
boolean
|===
// endpoint options: END
@@ -126,8 +126,6 @@ with the following path and query parameters:
|=======================================================================
|Name |Description
|`CamelOaimphResumptionToken` | This header is obtained when onlyFirst option
is enable. Return resumptiontoken of the request when data is still available.
-
-
|=======================================================================
== Usage
@@ -163,5 +161,3 @@ from("oaipmh:baseUrlRepository/oai/request")
---------------------------------------------------------
For more details about OAI-PMH see the documentation:
http://www.openarchives.org/pmh/
-
-
diff --git
a/components/camel-oaipmh/src/generated/resources/org/apache/camel/oaipmh/component/oaipmh.json
b/components/camel-oaipmh/src/generated/resources/org/apache/camel/oaipmh/component/oaipmh.json
index 1cd96d9..70f1692 100644
---
a/components/camel-oaipmh/src/generated/resources/org/apache/camel/oaipmh/component/oaipmh.json
+++
b/components/camel-oaipmh/src/generated/resources/org/apache/camel/oaipmh/component/oaipmh.json
@@ -14,7 +14,7 @@
"version": "3.5.0-SNAPSHOT",
"scheme": "oaipmh",
"extendsScheme": "",
- "syntax": "oaipmh:name",
+ "syntax": "oaipmh:url",
"async": false,
"consumerOnly": false,
"producerOnly": false,
diff --git a/components/camel-oaipmh/src/main/docs/oaipmh-component.adoc
b/components/camel-oaipmh/src/main/docs/oaipmh-component.adoc
index b0db216..ef6cb5b 100644
--- a/components/camel-oaipmh/src/main/docs/oaipmh-component.adoc
+++ b/components/camel-oaipmh/src/main/docs/oaipmh-component.adoc
@@ -60,7 +60,7 @@ The OAI-PMH component supports 3 options, which are listed
below.
The OAI-PMH endpoint is configured using URI syntax:
----
-oaipmh:name
+oaipmh:url
----
with the following path and query parameters:
diff --git
a/components/camel-oaipmh/src/main/java/org/apache/camel/oaipmh/component/OAIPMHEndpoint.java
b/components/camel-oaipmh/src/main/java/org/apache/camel/oaipmh/component/OAIPMHEndpoint.java
index 52ffa07..599250b 100644
---
a/components/camel-oaipmh/src/main/java/org/apache/camel/oaipmh/component/OAIPMHEndpoint.java
+++
b/components/camel-oaipmh/src/main/java/org/apache/camel/oaipmh/component/OAIPMHEndpoint.java
@@ -34,7 +34,7 @@ import org.joda.time.format.ISODateTimeFormat;
/**
* Harvest metadata using OAI-PMH protocol
*/
-@UriEndpoint(firstVersion = "3.5.0", scheme = "oaipmh", title = "OAI-PMH",
syntax = "oaipmh:name", category = {Category.ENDPOINT, Category.WEBSERVICE,
Category.BATCH})
+@UriEndpoint(firstVersion = "3.5.0", scheme = "oaipmh", title = "OAI-PMH",
syntax = "oaipmh:url", category = {Category.ENDPOINT, Category.WEBSERVICE,
Category.BATCH})
public class OAIPMHEndpoint extends DefaultPollingEndpoint {
@UriPath(description = "Base URL of the repository to which the request is
made through the OAI-PMH protocol")
diff --git a/core/camel-componentdsl/src/generated/resources/metadata.json
b/core/camel-componentdsl/src/generated/resources/metadata.json
index c197157..90ccf83 100644
--- a/core/camel-componentdsl/src/generated/resources/metadata.json
+++ b/core/camel-componentdsl/src/generated/resources/metadata.json
@@ -5207,7 +5207,7 @@
"version": "3.5.0-SNAPSHOT",
"scheme": "oaipmh",
"extendsScheme": "",
- "syntax": "oaipmh:name",
+ "syntax": "oaipmh:url",
"async": false,
"consumerOnly": false,
"producerOnly": false,
diff --git
a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
index af94fea..9f3a488 100644
---
a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
+++
b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
@@ -10828,13 +10828,13 @@ public class StaticEndpointBuilders {
* Since: 3.5
* Maven coordinates: org.apache.camel:camel-oaipmh
*
- * Syntax: <code>oaipmh:name</code>
+ * Syntax: <code>oaipmh:url</code>
*
* Path parameter: url (required)
* Base URL of the repository to which the request is made through the
* OAI-PMH protocol
*
- * @param path name
+ * @param path url
*/
public static
org.apache.camel.builder.endpoint.dsl.OAIPMHEndpointBuilderFactory.OAIPMHEndpointBuilder
oaipmh(
String path) {
@@ -10848,7 +10848,7 @@ public class StaticEndpointBuilders {
* Since: 3.5
* Maven coordinates: org.apache.camel:camel-oaipmh
*
- * Syntax: <code>oaipmh:name</code>
+ * Syntax: <code>oaipmh:url</code>
*
* Path parameter: url (required)
* Base URL of the repository to which the request is made through the
@@ -10856,7 +10856,7 @@ public class StaticEndpointBuilders {
*
* @param componentName to use a custom component name for the endpoint
* instead of the default name
- * @param path name
+ * @param path url
*/
public static
org.apache.camel.builder.endpoint.dsl.OAIPMHEndpointBuilderFactory.OAIPMHEndpointBuilder
oaipmh(
String componentName,
diff --git
a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/OAIPMHEndpointBuilderFactory.java
b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/OAIPMHEndpointBuilderFactory.java
index 87166e3..df02cf1 100644
---
a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/OAIPMHEndpointBuilderFactory.java
+++
b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/OAIPMHEndpointBuilderFactory.java
@@ -1281,13 +1281,13 @@ public interface OAIPMHEndpointBuilderFactory {
* Since: 3.5
* Maven coordinates: org.apache.camel:camel-oaipmh
*
- * Syntax: <code>oaipmh:name</code>
+ * Syntax: <code>oaipmh:url</code>
*
* Path parameter: url (required)
* Base URL of the repository to which the request is made through the
* OAI-PMH protocol
*
- * @param path name
+ * @param path url
*/
default OAIPMHEndpointBuilder oaipmh(String path) {
return OAIPMHEndpointBuilderFactory.endpointBuilder("oaipmh",
path);
@@ -1300,7 +1300,7 @@ public interface OAIPMHEndpointBuilderFactory {
* Since: 3.5
* Maven coordinates: org.apache.camel:camel-oaipmh
*
- * Syntax: <code>oaipmh:name</code>
+ * Syntax: <code>oaipmh:url</code>
*
* Path parameter: url (required)
* Base URL of the repository to which the request is made through the
@@ -1308,7 +1308,7 @@ public interface OAIPMHEndpointBuilderFactory {
*
* @param componentName to use a custom component name for the endpoint
* instead of the default name
- * @param path name
+ * @param path url
*/
default OAIPMHEndpointBuilder oaipmh(String componentName, String
path) {
return OAIPMHEndpointBuilderFactory.endpointBuilder(componentName,
path);
diff --git a/docs/components/modules/ROOT/nav.adoc
b/docs/components/modules/ROOT/nav.adoc
index 1078926..3e2325d 100644
--- a/docs/components/modules/ROOT/nav.adoc
+++ b/docs/components/modules/ROOT/nav.adoc
@@ -248,7 +248,7 @@
** xref:netty-http-component.adoc[Netty HTTP]
** xref:nitrite-component.adoc[Nitrite]
** xref:nsq-component.adoc[NSQ]
-** xref:oaipmh-component.adoc[OAIPMH]
+** xref:oaipmh-component.adoc[OAI-PMH]
** xref:olingo2-component.adoc[Olingo2]
** xref:olingo4-component.adoc[Olingo4]
** xref:milo-client-component.adoc[OPC UA Client]
diff --git a/docs/components/modules/ROOT/pages/oaipmh-component.adoc
b/docs/components/modules/ROOT/pages/oaipmh-component.adoc
index 407f533..f4ba124 100644
--- a/docs/components/modules/ROOT/pages/oaipmh-component.adoc
+++ b/docs/components/modules/ROOT/pages/oaipmh-component.adoc
@@ -1,10 +1,10 @@
[[oaipmh-component]]
-= OAIPMH Component
+= OAI-PMH Component
//THIS FILE IS COPIED: EDIT THE SOURCE FILE:
:page-source: components/camel-oaipmh/src/main/docs/oaipmh-component.adoc
-:docTitle: OAIPMH
+:docTitle: OAI-PMH
:artifactId: camel-oaipmh
-:description: Represents a OAIPMH endpoint. Component for do OAI-PMH request
+:description: Harvest metadata using OAI-PMH protocol
:since: 3.5
:supportLevel: Preview
:component-header: Both producer and consumer are supported
@@ -15,7 +15,7 @@
-The oaipmh component is used for harvest OAI-PMH data providers. It allows do
request to OAI-PMH endpoint using all verbs supported by the protocol.
+The oaipmh component is used for harvest OAI-PMH data providers. It allows do
request to OAI-PMH endpoint using all verbs supported by the protocol.
Maven users will need to add the following dependency to their `pom.xml`
for this component:
@@ -43,7 +43,7 @@ You can append query options to the URI in the following
format,
== Options
// component options: START
-The OAIPMH component supports 3 options, which are listed below.
+The OAI-PMH component supports 3 options, which are listed below.
@@ -59,7 +59,7 @@ The OAIPMH component supports 3 options, which are listed
below.
// endpoint options: START
-The OAIPMH endpoint is configured using URI syntax:
+The OAI-PMH endpoint is configured using URI syntax:
----
oaipmh:name
@@ -73,7 +73,7 @@ with the following path and query parameters:
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
-| *url* | *Required* Base URL of the repository to which the request is made
through the OAI-PMH protocol. | | URI
+| *url* | *Required* Base URL of the repository to which the request is made
through the OAI-PMH protocol | | URI
|===
@@ -85,12 +85,9 @@ with the following path and query parameters:
| Name | Description | Default | Type
| *endpointUrl* (common) | Base URL of the repository to which the request is
made through the OAI-PMH protocol. (Parameter) | | String
| *from* (common) | Specifies a lower bound for datestamp-based selective
harvesting. UTC DateTime value | | String
-| *identitier* (common) | Identifier of the requested resources. Applicable
only with certain verbs | | String
-| *ignoreSSLWarnings* (common) | Ignore SSL certificate warnings | false |
boolean
+| *identifier* (common) | Identifier of the requested resources. Applicable
only with certain verbs | | String
| *metadataPrefix* (common) | Specifies the metadataPrefix of the format that
should be included in the metadata part of the returned records. | oai_dc |
String
-| *onlyFirst* (common) | Returns the response of a single request. Otherwise
it will make requests until there is no more data to return. | False | boolean
-| *set* (common) | Specifies membership as a criteria for set-based selective
harvesting. | | String
-| *ssl* (common) | Causes the defined url to make an https request | false |
boolean
+| *set* (common) | Specifies membership as a criteria for set-based selective
harvesting | | String
| *until* (common) | Specifies an upper bound for datestamp-based selective
harvesting. UTC DateTime value. | | String
| *verb* (common) | Request name supported by OAI-PMh protocol | ListRecords |
String
| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the
Camel routing Error Handler, which mean any exceptions occurred while the
consumer is trying to pickup incoming messages, or the likes, will now be
processed as a message and handled by the routing Error Handler. By default the
consumer will use the org.apache.camel.spi.ExceptionHandler to deal with
exceptions, that will be logged at WARN or ERROR level and ignored. | false |
boolean
@@ -99,6 +96,7 @@ with the following path and query parameters:
| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer
creates an exchange. The value can be one of: InOnly, InOut, InOptionalOut | |
ExchangePattern
| *pollStrategy* (consumer) | A pluggable
org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your
custom implementation to control error handling usually occurred during the
poll operation before an Exchange have been created and being routed in Camel.
| | PollingConsumerPollStrategy
| *lazyStartProducer* (producer) | Whether the producer should be started lazy
(on the first message). By starting lazy you can use this to allow CamelContext
and routes to startup in situations where a producer may otherwise fail during
starting and cause the route to fail being started. By deferring this startup
to be lazy then the startup failure can be handled during routing messages via
Camel's routing error handlers. Beware that when the first message is processed
then creating and [...]
+| *onlyFirst* (producer) | Returns the response of a single request. Otherwise
it will make requests until there is no more data to return. | false | boolean
| *basicPropertyBinding* (advanced) | Whether the endpoint should use basic
property binding (Camel 2.x) or the newer property binding with additional
capabilities | false | boolean
| *synchronous* (advanced) | Sets whether synchronous processing should be
strictly used, or Camel is allowed to use asynchronous processing (if
supported). | false | boolean
| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls
(failed due some error) that should happen before the backoffMultipler should
kick-in. | | int
@@ -115,6 +113,8 @@ with the following path and query parameters:
| *startScheduler* (scheduler) | Whether the scheduler should be auto started.
| true | boolean
| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. The
value can be one of: NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES,
HOURS, DAYS | MILLISECONDS | TimeUnit
| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used.
See ScheduledExecutorService in JDK for details. | true | boolean
+| *ignoreSSLWarnings* (security) | Ignore SSL certificate warnings | false |
boolean
+| *ssl* (security) | Causes the defined url to make an https request | false |
boolean
|===
// endpoint options: END
@@ -128,8 +128,6 @@ with the following path and query parameters:
|=======================================================================
|Name |Description
|`CamelOaimphResumptionToken` | This header is obtained when onlyFirst option
is enable. Return resumptiontoken of the request when data is still available.
-
-
|=======================================================================
== Usage
@@ -165,5 +163,3 @@ from("oaipmh:baseUrlRepository/oai/request")
---------------------------------------------------------
For more details about OAI-PMH see the documentation:
http://www.openarchives.org/pmh/
-
-
