You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2015/06/19 17:32:39 UTC
[4/9] camel git commit: Component docs
Component docs
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/969a5f71
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/969a5f71
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/969a5f71
Branch: refs/heads/master
Commit: 969a5f71e70cc36b5eccc8c8c262c8585f6b35b5
Parents: 8dac850
Author: Claus Ibsen <da...@apache.org>
Authored: Fri Jun 19 17:18:27 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Jun 19 17:38:09 2015 +0200
----------------------------------------------------------------------
.../component/olingo2/Olingo2Component.java | 8 ++++
.../component/olingo2/Olingo2Configuration.java | 42 +++++++++++++-------
.../component/olingo2/Olingo2Endpoint.java | 2 +-
3 files changed, 37 insertions(+), 15 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/969a5f71/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/Olingo2Component.java
----------------------------------------------------------------------
diff --git a/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/Olingo2Component.java b/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/Olingo2Component.java
index dbbdd95..23863ec 100644
--- a/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/Olingo2Component.java
+++ b/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/Olingo2Component.java
@@ -91,6 +91,14 @@ public class Olingo2Component extends AbstractApiComponent<Olingo2ApiName, Oling
return new Olingo2Endpoint(uri, this, apiName, methodName, endpointConfiguration);
}
+ /**
+ * To use the shared configuration
+ */
+ @Override
+ public void setConfiguration(Olingo2Configuration configuration) {
+ super.setConfiguration(configuration);
+ }
+
public Olingo2AppWrapper createApiProxy(Olingo2Configuration endpointConfiguration) {
final Olingo2AppWrapper result;
if (endpointConfiguration.equals(this.configuration)) {
http://git-wip-us.apache.org/repos/asf/camel/blob/969a5f71/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/Olingo2Configuration.java
----------------------------------------------------------------------
diff --git a/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/Olingo2Configuration.java b/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/Olingo2Configuration.java
index d00b808..e383941 100644
--- a/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/Olingo2Configuration.java
+++ b/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/Olingo2Configuration.java
@@ -41,33 +41,22 @@ public class Olingo2Configuration {
@UriPath
@Metadata(required = "true")
private Olingo2ApiName apiName;
-
@UriPath @Metadata(required = "true")
private String methodName;
-
@UriParam
private String serviceUri;
-
- @UriParam
+ @UriParam(defaultValue = "application/json;charset=utf-8")
private String contentType = DEFAULT_CONTENT_TYPE;
-
@UriParam
private Map<String, String> httpHeaders;
-
- // common connection parameters for convenience
- @UriParam
+ @UriParam(defaultValue = "" + DEFAULT_TIMEOUT)
private int connectTimeout = DEFAULT_TIMEOUT;
-
- @UriParam
+ @UriParam(defaultValue = "" + DEFAULT_TIMEOUT)
private int socketTimeout = DEFAULT_TIMEOUT;
-
@UriParam
private HttpHost proxy;
-
@UriParam
private SSLContextParameters sslContextParameters;
-
- // for more complex configuration, use a client builder
@UriParam
private HttpAsyncClientBuilder httpAsyncClientBuilder;
@@ -97,6 +86,9 @@ public class Olingo2Configuration {
return serviceUri;
}
+ /**
+ * Target OData service base URI, e.g. http://services.odata.org/OData/OData.svc
+ */
public void setServiceUri(String serviceUri) {
this.serviceUri = serviceUri;
}
@@ -105,6 +97,9 @@ public class Olingo2Configuration {
return contentType;
}
+ /**
+ * Content-Type header value can be used to specify JSON or XML message format, defaults to application/json;charset=utf-8
+ */
public void setContentType(String contentType) {
this.contentType = contentType;
}
@@ -113,6 +108,9 @@ public class Olingo2Configuration {
return httpHeaders;
}
+ /**
+ * Custom HTTP headers to inject into every request, this could include OAuth tokens, etc.
+ */
public void setHttpHeaders(Map<String, String> httpHeaders) {
this.httpHeaders = httpHeaders;
}
@@ -121,6 +119,9 @@ public class Olingo2Configuration {
return connectTimeout;
}
+ /**
+ * HTTP connection creation timeout in milliseconds, defaults to 30,000 (30 seconds)
+ */
public void setConnectTimeout(int connectTimeout) {
this.connectTimeout = connectTimeout;
}
@@ -129,6 +130,9 @@ public class Olingo2Configuration {
return socketTimeout;
}
+ /**
+ * HTTP request timeout in milliseconds, defaults to 30,000 (30 seconds)
+ */
public void setSocketTimeout(int socketTimeout) {
this.socketTimeout = socketTimeout;
}
@@ -137,6 +141,9 @@ public class Olingo2Configuration {
return proxy;
}
+ /**
+ * HTTP proxy server configuration
+ */
public void setProxy(HttpHost proxy) {
this.proxy = proxy;
}
@@ -145,6 +152,9 @@ public class Olingo2Configuration {
return sslContextParameters;
}
+ /**
+ * To configure security using SSLContextParameters
+ */
public void setSslContextParameters(SSLContextParameters sslContextParameters) {
this.sslContextParameters = sslContextParameters;
}
@@ -153,6 +163,10 @@ public class Olingo2Configuration {
return httpAsyncClientBuilder;
}
+ /**
+ * Custom HTTP async client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext.
+ * Note that a socketTimeout MUST be specified in the builder, otherwise OData requests could block indefinitely
+ */
public void setHttpAsyncClientBuilder(HttpAsyncClientBuilder httpAsyncClientBuilder) {
this.httpAsyncClientBuilder = httpAsyncClientBuilder;
}
http://git-wip-us.apache.org/repos/asf/camel/blob/969a5f71/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/Olingo2Endpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/Olingo2Endpoint.java b/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/Olingo2Endpoint.java
index dee0768..d8a2065 100644
--- a/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/Olingo2Endpoint.java
+++ b/components/camel-olingo2/camel-olingo2-component/src/main/java/org/apache/camel/component/olingo2/Olingo2Endpoint.java
@@ -38,7 +38,7 @@ import org.apache.camel.util.component.ApiMethodPropertiesHelper;
/**
* Represents a Olingo2 endpoint.
*/
-@UriEndpoint(scheme = "olingo2", title = "Olingo2", syntax = "olingo2:apiName/methodName", consumerClass = Olingo2Consumer.class, consumerPrefix = "consumer")
+@UriEndpoint(scheme = "olingo2", title = "Olingo2", syntax = "olingo2:apiName/methodName", consumerClass = Olingo2Consumer.class, label = "cloud")
public class Olingo2Endpoint extends AbstractApiEndpoint<Olingo2ApiName, Olingo2Configuration> {
protected static final String RESOURCE_PATH_PROPERTY = "resourcePath";