RestHttpGemfireAdminTemplate (Spring Data for Pivotal GemFire 2.2.13.RELEASE API)

java.lang.ObjectSE
- org.springframework.data.gemfire.config.admin.AbstractGemfireAdminOperations
- - org.springframework.data.gemfire.config.admin.remote.FunctionGemfireAdminTemplate
  - - org.springframework.data.gemfire.config.admin.remote.RestHttpGemfireAdminTemplate

実装されているすべてのインターフェース:
GemfireAdminOperations
```
public class RestHttpGemfireAdminTemplate
extends FunctionGemfireAdminTemplate
```
RestHttpGemfireAdminTemplate は、GemfireAdminOperations インターフェースを実装するクラスであり、HTTP 経由の管理 REST API インターフェースを使用して Pivotal GemFire または Apache Geode クラスターでの管理 (運用) 操作をサポートするために FunctionGemfireAdminTemplate を継承します。特定の管理 (運用) 操作がサポートされていないか、HTTP 経由の管理 REST API インターフェースに対して実装されていない場合は、フォールバックとして Function 実行が使用されます。
導入:
2.0.0
作成者:
John Blum
関連事項:
HttpURLConnectionSE, URISE, ClientCache, Function, GemfireAdminOperations, FunctionGemfireAdminTemplate, HttpHeaders, HttpMethod, HttpStatus, RequestEntity, ResponseEntity, ClientHttpRequestFactory, ClientHttpRequestInterceptor, SimpleClientHttpRequestFactory, RestOperations, RestTemplate

ネストされたクラスの要約

ネストされたクラス
修飾子と型	クラスと説明
`static class`	`RestHttpGemfireAdminTemplate.Builder`
`static class`	`RestHttpGemfireAdminTemplate.FollowRedirectsSimpleClientHttpRequestFactory`

フィールドのサマリー

フィールド
修飾子と型	フィールドと説明
`protected static boolean`	`DEFAULT_CREATE_REGION_SKIP_IF_EXISTS`
`protected static StringSE`	`DEFAULT_HOST`
`protected static boolean`	`DEFAULT_HTTP_FOLLOW_REDIRECTS`
`protected static int`	`DEFAULT_PORT`
`protected static StringSE`	`DEFAULT_SCHEME`
`protected static StringSE`	`HTTP_SCHEME`
`protected static StringSE`	`HTTPS_SCHEME`
`protected static StringSE`	`MANAGEMENT_REST_API_NO_PORT_URL_TEMPLATE`
`protected static StringSE`	`MANAGEMENT_REST_API_URL_TEMPLATE`
`protected static ListSE<StringSE>`	`VALID_SCHEMES`

クラス org.springframework.data.gemfire.config.admin.AbstractGemfireAdminOperations から継承されたフィールド
NOT_IMPLEMENTED

コンストラクターの概要

コンストラクター
コンストラクターと説明
`RestHttpGemfireAdminTemplate(org.apache.geode.cache.client.ClientCache clientCache)` Apache Geode または Pivotal GemFire 管理 REST API インターフェースにアクセスするときに、指定された `ClientCache` で初期化され、デフォルトの HTTP スキーマ、ホスト、ポートで構成された `RestHttpGemfireAdminTemplate` の新しいインスタンスを構築します。
`RestHttpGemfireAdminTemplate(org.apache.geode.cache.client.ClientCache clientCache, StringSE scheme, StringSE host, int port, boolean followRedirects, ListSE<ClientHttpRequestInterceptor> clientHttpRequestInterceptors)` Apache Geode または Pivotal GemFire 管理 REST API インターフェースにアクセスするときに、指定された `ClientCache` で初期化され、指定された HTTP スキーム、ホスト、ポート、リダイレクト、`ClientHttpRequestInterceptors` で構成された `RestHttpGemfireAdminTemplate` の新しいインスタンスを構築します。
`RestHttpGemfireAdminTemplate(org.apache.geode.cache.client.ClientCache clientCache, StringSE scheme, StringSE host, int port, boolean followRedirects, ListSE<ClientHttpRequestInterceptor> clientHttpRequestInterceptors, ListSE<RestTemplateConfigurer> restTemplateConfigurers)` Apache Geode または Pivotal GemFire 管理 REST API インターフェースにアクセスするときに、指定された `ClientCache` で初期化され、指定された HTTP スキーム、ホスト、ポート、リダイレクト、`ClientHttpRequestInterceptors` で構成された `RestHttpGemfireAdminTemplate` の新しいインスタンスを構築します。

方法の概要

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`createIndex(IndexDefinition indexDefinition)` 指定された `schema object definition` に基づいて `Region` OQL `Index` を作成します。
`void`	`createRegion(RegionDefinition regionDefinition)` 指定された `schema object definition` に基づいてキャッシュ `Region` を作成します。
`protected StringSE`	`getManagementRestApiUrl()` 解決された Pivotal GemFire/Apache Geode 管理 REST API URL への参照を返します。
`protected <T extends RestOperations> T`	`getRestOperations()` REST API 呼び出しを実行するために使用される `RestOperations` への参照を返します。
`protected <T extends ClientHttpRequestFactory> T`	`newClientHttpRequestFactory(boolean followRedirects)` HTTP クライアントリクエストを行うために、`ClientHttpRequestFactory` の新しいインスタンスを構築します。
`protected <T extends RestOperations> T`	`newRestOperations(ClientHttpRequestFactory clientHttpRequestFactory, ListSE<ClientHttpRequestInterceptor> clientHttpRequestInterceptors, ListSE<RestTemplateConfigurer> restTemplateConfigurers)` HTTP 経由で REST API 操作を実行するために、Spring `RestTemplate` の新しいインスタンスを構築します。
`protected URISE`	`resolveCreateIndexUri()`
`protected URISE`	`resolveCreateRegionUri()`

クラス org.springframework.data.gemfire.config.admin.remote.FunctionGemfireAdminTemplate から継承されたメソッド
getAvailableServerRegionIndexes, getAvailableServerRegions, getClientCache, newGemfireFunctionOperations, newGemfireFunctionOperations

クラス org.springframework.data.gemfire.config.admin.AbstractGemfireAdminOperations から継承されたメソッド
createDiskStore, createLuceneIndex

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

インターフェース org.springframework.data.gemfire.config.admin.GemfireAdminOperations から継承されたメソッド
createDiskStores, createDiskStores, createIndexes, createIndexes, createLuceneIndexes, createLuceneIndexes, createRegions, createRegions

- フィールドの詳細
  - DEFAULT_CREATE_REGION_SKIP_IF_EXISTS
```
protected static final boolean DEFAULT_CREATE_REGION_SKIP_IF_EXISTS
```
    関連事項:
    定数フィールド値
  - DEFAULT_HTTP_FOLLOW_REDIRECTS
```
protected static final boolean DEFAULT_HTTP_FOLLOW_REDIRECTS
```
    関連事項:
    定数フィールド値
  - DEFAULT_PORT
```
protected static final int DEFAULT_PORT
```
    関連事項:
    定数フィールド値
  - DEFAULT_HOST
```
protected static final StringSE DEFAULT_HOST
```
    関連事項:
    定数フィールド値
  - DEFAULT_SCHEME
```
protected static final StringSE DEFAULT_SCHEME
```
    関連事項:
    定数フィールド値
  - HTTP_SCHEME
```
protected static final StringSE HTTP_SCHEME
```
    関連事項:
    定数フィールド値
  - HTTPS_SCHEME
```
protected static final StringSE HTTPS_SCHEME
```
    関連事項:
    定数フィールド値
  - MANAGEMENT_REST_API_URL_TEMPLATE
```
protected static final StringSE MANAGEMENT_REST_API_URL_TEMPLATE
```
    関連事項:
    定数フィールド値
  - MANAGEMENT_REST_API_NO_PORT_URL_TEMPLATE
```
protected static final StringSE MANAGEMENT_REST_API_NO_PORT_URL_TEMPLATE
```
    関連事項:
    定数フィールド値
  - VALID_SCHEMES
```
protected static final ListSE<StringSE> VALID_SCHEMES
```
- コンストラクターの詳細
  - RestHttpGemfireAdminTemplate
```
public RestHttpGemfireAdminTemplate(org.apache.geode.cache.client.ClientCache clientCache)
```
    Apache Geode または Pivotal GemFire 管理 REST API インターフェースにアクセスするときに、指定された ClientCache で初期化され、デフォルトの HTTP スキーマ、ホスト、ポートで構成された RestHttpGemfireAdminTemplate の新しいインスタンスを構築します。
    パラメーター:
    clientCache - ClientCache への参照。
    例外:
    IllegalArgumentExceptionSE - ClientCache が null の場合。
    関連事項:
    RestHttpGemfireAdminTemplate(ClientCache, String, String, int, boolean, List), ClientCache
  - RestHttpGemfireAdminTemplate
```
public RestHttpGemfireAdminTemplate(org.apache.geode.cache.client.ClientCache clientCache,
                                    StringSE scheme,
                                    StringSE host,
                                    int port,
                                    boolean followRedirects,
                                    ListSE<ClientHttpRequestInterceptor> clientHttpRequestInterceptors)
```
    Apache Geode または Pivotal GemFire 管理 REST API インターフェースにアクセスするときに、指定された ClientCache で初期化され、指定された HTTP スキーム、ホスト、ポート、リダイレクト、ClientHttpRequestInterceptors で構成された RestHttpGemfireAdminTemplate の新しいインスタンスを構築します。
    パラメーター:
    clientCache - ClientCache への参照
    scheme - 使用する HTTP スキーム (HTTP または HTTPS など) を指定する StringSE。
    host - StringSE には、GemFire/Geode マネージャーのホスト名が含まれます。
    port - GemFire/Geode Manager HTTP サービスが HTTP クライアントをリッスンするポートを指定する整数値。
    followRedirects - HTTP リダイレクト (HTTP ステータスコード 3xx) に従うかどうかを示すブール値。
    clientHttpRequestInterceptors - ClientHttpRequestInterceptor の ListSE は、HTTP リクエストと HTTP レスポンスをインターセプトして装飾するために使用されます。
    例外:
    IllegalArgumentExceptionSE - ClientCache 参照が null の場合。
    関連事項:
    ClientHttpRequestInterceptor, ClientCache
  - RestHttpGemfireAdminTemplate
```
public RestHttpGemfireAdminTemplate(org.apache.geode.cache.client.ClientCache clientCache,
                                    StringSE scheme,
                                    StringSE host,
                                    int port,
                                    boolean followRedirects,
                                    ListSE<ClientHttpRequestInterceptor> clientHttpRequestInterceptors,
                                    ListSE<RestTemplateConfigurer> restTemplateConfigurers)
```
    Apache Geode または Pivotal GemFire 管理 REST API インターフェースにアクセスするときに、指定された ClientCache で初期化され、指定された HTTP スキーム、ホスト、ポート、リダイレクト、ClientHttpRequestInterceptors で構成された RestHttpGemfireAdminTemplate の新しいインスタンスを構築します。
    パラメーター:
    clientCache - ClientCache への参照
    scheme - 使用する HTTP スキーム (HTTP または HTTPS など) を指定する StringSE。
    host - StringSE には、GemFire/Geode マネージャーのホスト名が含まれます。
    port - GemFire/Geode Manager HTTP サービスが HTTP クライアントをリッスンするポートを指定する整数値。
    followRedirects - HTTP リダイレクト (HTTP ステータスコード 3xx) に従うかどうかを示すブール値。
    clientHttpRequestInterceptors - ClientHttpRequestInterceptor の ListSE は、HTTP リクエストと HTTP レスポンスをインターセプトして装飾するために使用されます。
    例外:
    IllegalArgumentExceptionSE - ClientCache 参照が null の場合。
    関連事項:
    ClientCache, RestTemplateConfigurer, ClientHttpRequestInterceptor, newClientHttpRequestFactory(boolean), newRestOperations(ClientHttpRequestFactory, List, List), resolveManagementRestApiUrl(String, String, int)
- メソッドの詳細
  - newClientHttpRequestFactory
```
protected <T extends ClientHttpRequestFactory> T newClientHttpRequestFactory(boolean followRedirects)
```
    HTTP クライアントリクエストを行うために、ClientHttpRequestFactory の新しいインスタンスを構築します。
    パラメーター:
    followRedirects - HTTP リダイレクト (HTTP ステータスコード 3xx) に従うかどうかを示すブール値。
    戻り値:
    新しい ClientHttpRequestFactory。
    関連事項:
    ClientHttpRequestFactory
  - newRestOperations
```
protected <T extends RestOperations> T newRestOperations(ClientHttpRequestFactory clientHttpRequestFactory,
                                                         ListSE<ClientHttpRequestInterceptor> clientHttpRequestInterceptors,
                                                         ListSE<RestTemplateConfigurer> restTemplateConfigurers)
```
    HTTP 経由で REST API 操作を実行するために、Spring RestTemplate の新しいインスタンスを構築します。
    パラメーター:
    clientHttpRequestFactory - ClientHttpRequestFactory は HTTP リクエストオブジェクトの構築に使用されます。
    clientHttpRequestInterceptors - ClientHttpRequestInterceptor の ListSE は、HTTP リクエストと HTTP レスポンスをインターセプトして装飾するために使用されます。
    戻り値:
    Spring の RestTemplate の新しいインスタンス。
    関連事項:
    ClientHttpRequestInterceptor, SimpleClientHttpRequestFactory, RestOperations, RestTemplate
  - getManagementRestApiUrl
```
protected StringSE getManagementRestApiUrl()
```
    解決された Pivotal GemFire/Apache Geode 管理 REST API URL への参照を返します。
    戻り値:
    解決された Pivotal GemFire/Apache Geode 管理 REST API URL を含む StringSE。
  - getRestOperations
```
protected <T extends RestOperations> T getRestOperations()
```
    REST API 呼び出しを実行するために使用される RestOperations への参照を返します。
    戻り値:
    REST API 呼び出しを実行するために使用される RestOperations への参照。
    関連事項:
    RestOperations
  - createIndex
```
public void createIndex(IndexDefinition indexDefinition)
```
    クラスからコピーされた説明: AbstractGemfireAdminOperations
    指定された schema object definition に基づいて Region OQL Index を作成します。
    次で指定:
    インターフェース GemfireAdminOperations の createIndex
    オーバーライド:
    クラス FunctionGemfireAdminTemplate の createIndex
    パラメーター:
    indexDefinition - IndexDefinition は、Region OQL Index を定義する構成メタデータをカプセル化します。
    関連事項:
    IndexDefinition, Index, Region
  - resolveCreateIndexUri
```
protected URISE resolveCreateIndexUri()
```
  - createRegion
```
public void createRegion(RegionDefinition regionDefinition)
```
    クラスからコピーされた説明: AbstractGemfireAdminOperations
    指定された schema object definition に基づいてキャッシュ Region を作成します。
    次で指定:
    インターフェース GemfireAdminOperations の createRegion
    オーバーライド:
    クラス FunctionGemfireAdminTemplate の createRegion
    パラメーター:
    regionDefinition - キャッシュ Region を定義する構成メタデータをカプセル化する RegionDefinition。
    関連事項:
    RegionDefinition, GemFireCache, Region
  - resolveCreateRegionUri
```
protected URISE resolveCreateRegionUri()
```

クラス RestHttpGemfireAdminTemplate

ネストされたクラスの要約

フィールドのサマリー

クラス org.springframework.data.gemfire.config.admin.AbstractGemfireAdminOperations から継承されたフィールド

コンストラクターの概要

方法の概要

クラス org.springframework.data.gemfire.config.admin.remote.FunctionGemfireAdminTemplate から継承されたメソッド

クラス org.springframework.data.gemfire.config.admin.AbstractGemfireAdminOperations から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

インターフェース org.springframework.data.gemfire.config.admin.GemfireAdminOperations から継承されたメソッド

フィールドの詳細

DEFAULT_CREATE_REGION_SKIP_IF_EXISTS

DEFAULT_HTTP_FOLLOW_REDIRECTS

DEFAULT_PORT

DEFAULT_HOST

DEFAULT_SCHEME

HTTP_SCHEME

HTTPS_SCHEME

MANAGEMENT_REST_API_URL_TEMPLATE

MANAGEMENT_REST_API_NO_PORT_URL_TEMPLATE

VALID_SCHEMES

コンストラクターの詳細

RestHttpGemfireAdminTemplate

RestHttpGemfireAdminTemplate

RestHttpGemfireAdminTemplate

メソッドの詳細

newClientHttpRequestFactory

newRestOperations

getManagementRestApiUrl

getRestOperations

createIndex

resolveCreateIndexUri

createRegion

resolveCreateRegionUri