Red Hat Summit105.6. API パラメーター (1 API)
Olingo4 エンドポイントは API ベースのコンポーネントであり、使用される API 名と API メソッドに基づく追加のパラメーターがあります。API 名と API メソッドは、apiName/methodName パスパラメーターとしてエンドポイント URI に配置されます。
olingo4:apiName/methodName
olingo4:apiName/methodName次の表に示すように、1 個の API 名があります。
| API 名 | タイプ | 説明 |
|---|---|---|
| 両方 | Olingo4 クライアント Api インターフェイス |
各 API は、以降のセクションで説明します。
105.6.1. API: DEFAULT
producer と consumer の両方がサポート対象
DEFAULT API は、次の構文で定義されます。
olingo4:DEFAULT/methodName?[parameters]
olingo4:DEFAULT/methodName?[parameters]以下の表に 9 個のメソッドをリストし、その後に各メソッドの詳細な構文を示します。(API メソッドには、名前の代わりに構文で使用できる省略形の エイリアス を付けることができます)
| メソッド | エイリアス | 説明 |
|---|---|---|
| OData アクションを呼び出します。 | ||
| バッチリクエストを実行します | ||
| 新しい OData リソースを作成します。 | ||
| OData リソースを削除し、org でコールバックを呼び出します。 | ||
| HTTP MERGE を使用して、OData リソースに対するパッチの適用/マージを行います。 | ||
| HTTP PATCH を使用して、OData リソースに対するパッチの適用/マージを行います。 | ||
| OData リソースを読み取り、適切な結果でコールバックを呼び出します。 | ||
| OData リソースを更新します。 | ||
| OData リソースを読み取り、解析されていない入力ストリームでコールバックを呼び出します。 |
105.6.1.1. Method action
署名:
- void action(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler);
olingo4/action API メソッドには、次の表に示すパラメーターがあります。
| パラメーター | 説明 | タイプ |
|---|---|---|
| data | アクションデータ | Object |
| edm | サービス Edm | Edm |
| endpointHttpHeaders | コンポーネントバージョンを追加/オーバーライドする HTTP ヘッダー | Map |
| resourcePath | アクションへのリソースパス | String |
| responseHandler | Org.apache.olingo.client.api.domain.ClientEntity コールバックハンドラー | Olingo4ResponseHandler |
105.6.1.2. Method batch
署名:
- void batch(org.apache.olingo.commons.api.edm.Edm edm, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler<java.util.List<org.apache.camel.component.olingo4.api.batch.Olingo4BatchResponse>> responseHandler);
olingo4/batch API メソッドには、次の表に示すパラメーターがあります。
| パラメーター | 説明 | タイプ |
|---|---|---|
| data | オーダーした org.apache.camel.component.olingo4.api.batch.Olingo4BatchRequest リスト | Object |
| edm | サービス Edm | Edm |
| endpointHttpHeaders | コンポーネントバージョンを追加/オーバーライドする HTTP ヘッダー | Map |
| responseHandler | コールバックハンドラー | Olingo4ResponseHandler |
105.6.1.3. Method create
署名:
- void create(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler);
olingo4/create API メソッドには、次の表に示すパラメーターがあります。
| パラメーター | 説明 | タイプ |
|---|---|---|
| data | 要求データ | Object |
| edm | サービス Edm | Edm |
| endpointHttpHeaders | コンポーネントバージョンを追加/オーバーライドする HTTP ヘッダー | Map |
| resourcePath | 作成するリソースパス | String |
| responseHandler | コールバックハンドラー | Olingo4ResponseHandler |
105.6.1.4. メソッド: DELETE
署名:
- void delete(String resourcePath, java.util.Map<String, String> endpointHttpHeaders, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler<org.apache.olingo.commons.api.http.HttpStatusCode> responseHandler);
olingo4/delete API メソッドには、次の表に示すパラメーターがあります。
| パラメーター | 説明 | タイプ |
|---|---|---|
| endpointHttpHeaders | コンポーネントバージョンを追加/オーバーライドする HTTP ヘッダー | Map |
| resourcePath | Entry のリソースパス | String |
| responseHandler | org.apache.olingo.commons.api.http.HttpStatusCode コールバックハンドラー | Olingo4ResponseHandler |
105.6.1.5. Method merge
署名:
- void merge(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler);
olingo4/merge API メソッドには、次の表に示すパラメーターがあります。
| パラメーター | 説明 | タイプ |
|---|---|---|
| data | データに対してパッチの適用/マージを行います。 | Object |
| edm | サービス Edm | Edm |
| endpointHttpHeaders | コンポーネントバージョンを追加/オーバーライドする HTTP ヘッダー | Map |
| resourcePath | 更新するリソースパス | String |
| responseHandler | Org.apache.olingo.client.api.domain.ClientEntity コールバックハンドラー | Olingo4ResponseHandler |
105.6.1.6. Method patch
署名:
- void patch(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler);
olingo4/patch API メソッドには、次の表に示すパラメーターがあります。
| パラメーター | 説明 | タイプ |
|---|---|---|
| data | データに対してパッチの適用/マージを行います。 | Object |
| edm | サービス Edm | Edm |
| endpointHttpHeaders | コンポーネントバージョンを追加/オーバーライドする HTTP ヘッダー | Map |
| resourcePath | 更新するリソースパス | String |
| responseHandler | Org.apache.olingo.client.api.domain.ClientEntity コールバックハンドラー | Olingo4ResponseHandler |
105.6.1.7. Method read
署名:
- void read(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> queryParams, java.util.Map<String, String> endpointHttpHeaders, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler);
olingo4/read API メソッドには、次の表に示すパラメーターがあります。
| パラメーター | 説明 | タイプ |
|---|---|---|
| edm | サービス Edm、read(null, $metdata, null, responseHandler) 呼び出しから読み取ります。 | Edm |
| endpointHttpHeaders | コンポーネントバージョンを追加/オーバーライドする HTTP ヘッダー | Map |
| queryParams | OData クエリーパラメーター http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc453752288 | Map |
| resourcePath | OData のリソースパス | String |
| responseHandler | コールバックハンドラー | Olingo4ResponseHandler |
105.6.1.8. Method update
署名:
- void update(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler);
oligo4/update API メソッドには、次の表に示すパラメーターがあります。
| パラメーター | 説明 | タイプ |
|---|---|---|
| data | 更新されたデータ | Object |
| edm | サービス Edm | Edm |
| endpointHttpHeaders | コンポーネントバージョンを追加/オーバーライドする HTTP ヘッダー | Map |
| resourcePath | 更新するリソースパス | String |
| responseHandler | Org.apache.olingo.client.api.domain.ClientEntity コールバックハンドラー | Olingo4ResponseHandler |
105.6.1.9. Method uread
署名:
- void uread(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> queryParams, java.util.Map<String, String> endpointHttpHeaders, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler<java.io.InputStream> responseHandler);
olingo4/uread API メソッドには、次の表に示すパラメーターがあります。
| パラメーター | 説明 | タイプ |
|---|---|---|
| edm | サービス Edm、read(null, $metdata, null, responseHandler) 呼び出しから読み取ります。 | Edm |
| endpointHttpHeaders | コンポーネントバージョンを追加/オーバーライドする HTTP ヘッダー | Map |
| queryParams | OData クエリーパラメーター http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc453752288 | Map |
| resourcePath | OData のリソースパス | String |
| responseHandler | コールバックハンドラー | Olingo4ResponseHandler |
olingo4 API は、上記のパラメーターの他に上記の任意のクエリーパラメーターも使用できます。
いずれのパラメーターも、エンドポイント URI で指定するか、メッセージヘッダーで動的に指定できます。メッセージヘッダー名は、CamelOlingo4.parameter の形式である必要があります。inBody パラメーターはメッセージヘッダーをオーバーライドします。つまり、エンドポイントパラメーター inBody=myParameterNameHere は CamelOlingo4.myParameterNameHere ヘッダーをオーバーライドします。
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}