이 콘텐츠는 선택한 언어로 제공되지 않습니다.

Chapter 110. Olingo2


Olingo2 Component

Available as of Camel 2.14
The Olingo2 component utilizes Apache Olingo version 2.0 APIs to interact with OData 2.0 and 3.0 compliant services. A number of popular commercial and enterprise vendors and products support the OData protocol. A sample list of supporting products can be found on the OData website.
The Olingo2 component supports reading feeds, delta feeds, entities, simple and complex properties, links, counts, using custom and OData system query parameters. It supports updating entities, properties, and association links. It also supports submitting queries and change requests as a single OData batch operation.
The component supports configuring HTTP connection parameters and headers for OData service connection. This allows configuring use of SSL, OAuth2.0, etc. as required by the target OData service.
Maven users will need to add the following dependency to their pom.xml for this component:
	<dependency>
    	<groupId>org.apache.camel</groupId>
    	<artifactId>camel-olingo2</artifactId>
    	<version>${camel-version}</version>
	</dependency>
Copy to Clipboard Toggle word wrap

URI format

olingo2://endpoint/<resource-path>?[options]
Copy to Clipboard Toggle word wrap

Olingo2Component

The Olingo2 Component can be configured with the options below. These options can be provided using the component's bean property configuration of type org.apache.camel.component.olingo2.Olingo2Configuration.
Expand
Option
Type
Description
serviceUri
String
Target OData service base URI, e.g. http://services.odata.org/OData/OData.svc
contentType
String
Content-Type header value can be used to specify JSON or XML message format, defaults to application/json;charset=utf-8
connectTimeout
int
HTTP connection creation timeout in milliseconds, defaults to 30,000 (30 seconds)
socketTimeout
int
HTTP request timeout in milliseconds, defaults to 30,000 (30 seconds)
httpHeaders
java.util.Map<String, String>
Custom HTTP headers to inject into every request, this could include OAuth tokens, etc.
proxy
org.apache.http.HttpHost
HTTP proxy server configuration
sslContext
javax.net.ssl.SSLContext
HTTP SSL configuration
httpAsyncClientBuilder
org.apache.http.impl.nio.client.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

Producer Endpoints

Producer endpoints can use endpoint names and options listed next. Producer endpoints can also use a special option inBody that in turn should contain the name of the endpoint option whose value will be contained in the Camel Exchange In message. The inBody option defaults to data for endpoints that take that option.
Any of the endpoint options can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelOlingo2.<option>. Note that the inBody option overrides message header, i.e. the endpoint option inBody=option would override a CamelOlingo2.option header. In addition, query parameters can be specified
Note that the resourcePath option can either in specified in the URI as a part of the URI path, as an endpoint option ?resourcePath=<resource-path> or as a header value CamelOlingo2.resourcePath. The OData entity key predicate can either be a part of the resource path, e.g. Manufacturers('1'), where '1' is the key predicate, or be specified separately with resource path Manufacturers and keyPredicate option '1'.
Expand
Endpoint
Options
HTTP Method
Result Body Type
batch
data
POST with multipart/mixed batch request java.util.List&lt;org.apache.camel.component.olingo2.api.batch.Olingo2BatchResponse>
create
data, resourcePath
POST org.apache.olingo.odata2.api.ep.entry.ODataEntry for new entries org.apache.olingo.odata2.api.commons.HttpStatusCodes for other OData resources
delete
resourcePath
DELETE org.apache.olingo.odata2.api.commons.HttpStatusCodes
merge
data, resourcePath
MERGE org.apache.olingo.odata2.api.commons.HttpStatusCodes
patch
data, resourcePath
PATCH org.apache.olingo.odata2.api.commons.HttpStatusCodes
read
queryParams, resourcePath
GET Depends on OData resource being queried as described next
update
data, resourcePath
PUT org.apache.olingo.odata2.api.commons.HttpStatusCodes

OData Resource Type Mapping

The result of read endpoint and data type of data option depends on the OData resource being queried, created or modified.
Expand
OData Resource Type
Resource URI from resourcePath and keyPredicate
In or Out Body Type
Entity data model
$metadata
org.apache.olingo.odata2.api.edm.Edm
Service document
/
org.apache.olingo.odata2.api.servicedocument.ServiceDocument
OData feed
<entity-set>
org.apache.olingo.odata2.api.ep.feed.ODataFeed
OData entry
<entity-set>(<key-predicate>)
org.apache.olingo.odata2.api.ep.entry.ODataEntry for Out body (response), java.util.Map&lt;String, Object>, for In body (request).
Simple property
<entity-set>(<key-predicate>)/<simple-property>
Appropriate Java data type as described by <link xl:href="http://olingo.apache.org/javadoc/odata2/index.html?org/apache/olingo/odata2/api/edm/class-use/EdmProperty.html" >Olingo EdmProperty</link>
Simple property value
<entity-set>(<key-predicate>)/<simple-property>/$value
Appropriate Java data type as described by <link xl:href="http://olingo.apache.org/javadoc/odata2/index.html?org/apache/olingo/odata2/api/edm/class-use/EdmProperty.html" >Olingo EdmProperty</link>
Complex property
<entity-set>(<key-predicate>)/<complex-property>
java.util.Map&lt;String, Object>
Zero or one association link
<entity-set>(<key-predicate>/$link/<one-to-one-entity-set-property>
String for response java.util.Map&lt;String, Object> with key property names and values for request
Zero or many association links
<entity-set>(<key-predicate>/$link/<one-to-many-entity-set-property>
java.util.List&lt;String> for response java.util.List&lt;java.util.Map&lt;String, Object>> containing list of key property names and values for request
Count
<resource-uri>/$count
java.lang.Long

URI Options

If a value is not provided for queryParams either in the endpoint URI or in a message header, it will be assumed to be null. Note that the null value will only be used if other options do not satisfy matching endpoints.
Expand
Name
Type
Description
data
Object
Data with appropriate type used to create or modify the OData resource
keyPredicate
String
Key predicate to create a parameterized OData resource endpoint. Useful for create/update operations where the key predicate value is dynamically provided in a header
queryParams
java.util.Map&lt;String, String>
OData system options and custom query options. For more information see OData 2.0 URI Conventions
resourcePath
String
OData resource path, may or may not contain key predicate
*
String
Any other URI option is treated as a query parameter and added to query parameter map, overwriting entries in a queryParams option, if also specified

Consumer Endpoints

Only the read endpoint can be used as a consumer endpoint. Consumer endpoints can use Scheduled Poll Consumer Options with a consumer. prefix to schedule endpoint invocation. By default consumer endpoints that return an array or collection will generate one exchange per element, and their routes will be executed once for each exchange. This behavior can be disabled by setting the endpoint property consumer.splitResult=false.

Message Headers

Any URI option can be provided in a message header for producer endpoints with a CamelOlingo2. prefix.

Message Body

All result message bodies utilize objects provided by the underlying Apache Olingo 2.0 API used by the Olingo2Component. Producer endpoints can specify the option name for incoming message body in the inBody endpoint URI parameter. For endpoints that return an array or collection, a consumer endpoint will map every element to distinct messages, unless consumer.splitResult is set to false.

Use cases

The following route reads top 5 entries from the Manufacturer feed ordered by ascending Name property.
from("direct:...")
    .setHeader("CamelOlingo2.$top","5")
    .to("olingo2://read/Manufacturers?orderBy=Name%20asc");
Copy to Clipboard Toggle word wrap
The following route reads Manufacturer entry using the key property value in incoming id header.
from("direct:...")
    .setHeader("CamelOlingo2.keyPredicate", header("id"))
    .to("olingo2://read/Manufacturers");
Copy to Clipboard Toggle word wrap
The following route creates Manufacturer entry using the java.util.Map<String, Object> in body message.
from("direct:...")
    .to("olingo2://create/Manufacturers");
Copy to Clipboard Toggle word wrap
The following route polls Manufacturer delta feed every 30 seconds. The bean blah updates the bean paramsBean to add an updated !deltatoken property with the value returned in the ODataDeltaFeed result. Since the initial delta token is not known, the consumer endpoint will produce an ODataFeed value the first time, and ODataDeltaFeed on subsequent polls.
from("olingo2://read/Manufacturers?queryParams=#paramsBean&consumer.timeUnit=SECONDS&consumer.delay=30")
    .to("bean:blah");
Copy to Clipboard Toggle word wrap
맨 위로 이동
Red Hat logoGithubredditYoutubeTwitter

자세한 정보

평가판, 구매 및 판매

커뮤니티

Red Hat 문서 정보

Red Hat을 사용하는 고객은 신뢰할 수 있는 콘텐츠가 포함된 제품과 서비스를 통해 혁신하고 목표를 달성할 수 있습니다. 최신 업데이트를 확인하세요.

보다 포괄적 수용을 위한 오픈 소스 용어 교체

Red Hat은 코드, 문서, 웹 속성에서 문제가 있는 언어를 교체하기 위해 최선을 다하고 있습니다. 자세한 내용은 다음을 참조하세요.Red Hat 블로그.

Red Hat 소개

Red Hat은 기업이 핵심 데이터 센터에서 네트워크 에지에 이르기까지 플랫폼과 환경 전반에서 더 쉽게 작업할 수 있도록 강화된 솔루션을 제공합니다.

Theme

© 2025 Red Hat