接続の確立

JDBC データソースの作成

Java アプリケーションから接続するJDBC データソースを作成できます。CData JDBC Driver for Box に基づくJDBC データソースの作成は、3つの基本ステップで構成されます。

ドライバーのJAR ファイルをクラスパスに追加します。JAR ファイルはインストールディレクトリの［lib］サブフォルダ内にあります。.lic ファイルはJAR ファイルと同じフォルダ内に配置される必要があることに注意してください。
ドライバークラスを入力します。次に例を示します。
```
cdata.jdbc.box.BoxDriver
```
JDBC URL を入力します。次に例を示します。
```
jdbc:box:InitiateOAuth=GETANDREFRESH;

or

jdbc:cdata:box:InitiateOAuth=GETANDREFRESH;
```
上記の2つ目の形式は、同じURL 形式を使用しているドライバー間でアプリケーションに競合がある場合は、CData ドライバーを使用していることを確認するために常に使用できます。URL は "jdbc:box:" または"jdbc:cdata:box:" のいずれかから始まり、任意の接続プロパティの名前と値のペアをセミコロン区切りで入力します。

Box への接続

本製品は、Box テーブルおよびフォルダへのアクセスを実現します。なお、本製品はBox に格納されているファイルの内容を更新したり、ファイルの内容をテーブルやカラムとしてモデル化したりはできません。

Box への認証

本製品は、OAuth 認証標準を使用して、ユーザーアカウントまたはサービスアカウントからBox に接続します。

Box は埋め込みOAuth クレデンシャルを提供しており、デスクトップアプリケーションまたはヘッドレスマシンからの接続を簡単にします。Web アプリケーションから接続するには、カスタムOAuth アプリケーションの作成で説明するようにカスタムOAuth アプリケーションを作成する必要があります。

以下のサブセクションでは、利用可能なOAuth フローでのBox への認証について詳しく説明します。カスタムOAuth アプリケーションの作成についての情報と、すでに埋め込みOAuth 認証情報を持つ認証フローでもカスタムOAuth アプリケーションを作成したほうがよい場合の説明については、カスタムOAuth アプリケーションの作成を参照してください。

Box で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

ユーザーアカウント（OAuth）

AuthScheme は、すべてのユーザーアカウントフローでOAuth に設定する必要があります。

デスクトップアプリケーション

CData は、OAuth デスクトップ認証を簡略化する埋め込みOAuth アプリケーションを提供します。または、カスタムOAuth アプリケーションを作成して接続することも可能です。カスタムOAuth アプリケーションについて、詳しくはカスタムOAuth アプリケーションの作成を参照してください。

OAuth アクセストークンの取得およびリフレッシュ

以下を設定して、接続してください。

InitiateOAuth：GETANDREFRESH。InitiateOAuth を使うと、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。
カスタムアプリケーションのみ：
- OAuthClientId：アプリの登録時に割り当てられたクライアントId。
- OAuthClientSecret：アプリの登録時に割り当てられたクライアントシークレット。
- CallbackURL：アプリの登録時に定義されたリダイレクトURI。次に例を示します。 https://localhost:3333

接続すると、本製品はデフォルトブラウザでBox のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。本製品はこれでOAuth プロセスを完了します。

本製品はBox からアクセストークンを取得し、それを使ってデータをリクエストします。
OAuth 値はOAuthSettingsLocation で指定された場所に保存され、接続間で永続化されるようにします。

本製品はアクセストークンの期限が切れると自動的にリフレッシュします。

Web アプリケーション

Web アプリケーション経由で接続する場合は、Box にカスタムOAuth アプリケーションを作成および登録する必要があります。それから本製品を使用してOAuth トークンの値を取得および管理します。詳しくは、カスタムOAuth アプリケーションの作成を参照してください。

OAuth アクセストークンの取得

次の接続プロパティを設定し、OAuthAccessToken を取得します。

OAuthClientId：カスタムOAuth アプリケーションの設定で指定したクライアントId。
OAuthClientSecret：カスタムOAuth アプリケーションの設定で指定したクライアントシークレット。

ストアドプロシージャを呼び出し、OAuth 交換を完了します。

GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。CallbackURL インプットをカスタムOAuth アプリケーションの設定時に指定したリダイレクトURI に設定します。ストアドプロシージャがOAuth エンドポイントのURL を返します。
ステップ1でストアドプロシージャが返したURL に移動します。ログインして、Web アプリケーションを認可します。認証後、ブラウザはリダイレクトURI にリダイレクトします。リダイレクトURI にはcode というパラメータが付加されます。このパラメータの値を控えておきます。
GetOAuthAccessToken ストアドプロシージャを呼び出します。AuthMode インプットをWEB に設定します。Verifier インプットを、リダイレクトURI のクエリ文字列のcode パラメータに設定します。

アクセストークンとリフレッシュトークンを取得した後、データに接続し、OAuth アクセストークンを自動または手動でリフレッシュすることが可能です。

OAuth アクセストークンの自動リフレッシュ

本製品がOAuth アクセストークンを自動的にリフレッシュするようにするには、最初のデータ接続で次のように設定します。

InitiateOAuth：REFRESH。
OAuthClientId：カスタムOAuth アプリケーションの設定で指定したクライアントId。
OAuthClientSecret：カスタムOAuth アプリケーションの設定で指定したクライアントシークレット。
OAuthAccessToken：GetOAuthAccessToken によって返されたアクセストークン。
OAuthRefreshToken：GetOAuthAccessToken によって返されたリフレッシュトークン。
OAuthSettingsLocation：本製品がOAuth 値を保存する場所。これは接続間で維持されます。

OAuth アクセストークンの手動リフレッシュ

データ接続時に手動でOAuth アクセストークンをリフレッシュするために必要な値は、OAuth リフレッシュトークンのみです。 GetOAuthAccessToken によって返されたExpiresIn パラメータ値が経過した後に、RefreshOAuthAccessToken ストアドプロシージャを使用し、手動でOAuthAccessToken をリフレッシュします。次に、以下の接続プロパティを設定します。

OAuthClientId：カスタムOAuth アプリケーションの設定で指定したクライアントId。
OAuthClientSecret：カスタムOAuth アプリケーションの設定で指定したクライアントシークレット。

ここでRefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを指定します。新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定し、新しい接続をオープンします。

最後に、OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

ヘッドレスマシン

ヘッドレスマシンのユーザーアカウントでOAuth を使用するようにドライバーを設定するには、インターネットブラウザに対応した別の端末で認証する必要があります。

以下のオプションから選択します。
- オプション1：後述の「Verifier code を取得および交換」に従い、OAuthVerifier 値を取得します。
- オプション2：インターネットブラウザに対応したマシンに本製品をインストールし、後述の「OAuth 設定を転送」の説明に従い、通常のブラウザベースのフローで認証後にOAuth 認証値を転送します。
次に、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするように本製品を設定します。

オプション1：Verifier code を取得および交換

Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。

インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。

以下のオプションから選択します。
- 埋め込みOAuth アプリケーションを使用する場合は、GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
- カスタムOAuth アプリケーションを使用するには、以下のプロパティを設定します。
  - InitiateOAuth：OFF。
  - OAuthClientId：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントId。
  - OAuthClientSecret：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。
  次に、適切なCallbackURL を指定してGetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
ログインして、本製品にアクセス許可を与えます。リダイレクトURI にリダイレクトされます。リダイレクトURI にcode というパラメータが付加されることに注意してください。このパラメータの値を控えておきます。OAuthVerifier 接続プロパティを設定するために使用されます。

次に、OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換する必要があります。

ヘッドレスマシンでは、OAuth 認証値を取得するには次のプロパティを設定します。

InitiateOAuth：REFRESH。
OAuthVerifier：控えておいたverifier code（リダイレクトURI のcode パラメータの値）。
OAuthSettingsLocation：暗号化されたOAuth 認証値を指定された場所に永続化。
カスタムアプリケーションのみ：
- OAuthClientId：カスタムOAuth アプリケーション設定のクライアントId。
- OAuthClientSecret：カスタムOAuth アプリケーション設定のクライアントシークレット。

接続をテストしてOAuth 設定ファイルを生成し、以下のプロパティを再設定して接続します。

InitiateOAuth：REFRESH。
OAuthSettingsLocation：暗号化されたOAuth 認証値が保存される場所。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品に読み書きのアクセス許可を与えることを確認してください。
カスタムアプリケーションのみ：
- OAuthClientId：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントId。
- OAuthClientSecret：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。

オプション2：OAuth 設定を転送

ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバーとの接続をインストールし、作成する必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。

「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。

接続をテストしてOAuth 設定ファイルを生成し、OAuth 設定ファイルをヘッドレスマシンにコピーします。

ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。

InitiateOAuth：REFRESH。
OAuthSettingsLocation：ブラウザでマシンからコピーしたOAuth 設定ファイルの場所。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品に読み書きのアクセス許可を与えることを確認してください。
カスタムアプリケーションのみ：
- OAuthClientId：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントId。
- OAuthClientSecret：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。

サービスアカウント（OAuthJWT）

サービスアカウントには、ブラウザによるユーザー認証が不要なサイレント認証があります。また、サービスアカウントを使用して、エンタープライズ全体のアクセススコープを本製品に委任することもできます。

サービスアカウントを使用するには、カスタムOAuth アプリケーションの作成で説明するように、カスタムOAuth アプリケーションの作成と認可が必要です。これでサービスアカウントにアクセス権があるBox データに接続できます。

次の接続プロパティを設定して、接続してください。

AuthScheme：OAuthJWT。
OAuthClientId：カスタムOAuth アプリケーションの設定で指定したクライアントId。
OAuthClientSecret：カスタムOAuth アプリケーションの設定で指定したクライアントシークレット。
OAuthJWTCertType：PEMKEY_FILE。
OAuthJWTCert：生成した.pem ファイルのパス。
OAuthJWTCertPassword：.pem ファイルのパスワード。
OAuthJWTCertSubject：証明書のサブジェクト。証明書ストアの1番目の証明書を選択するには、*（アスタリスク）を設定します。
OAuthJWTSubjectType：Application Access Values で指定した値と同じで、"enterprise" または"user" のいずれか。この接続プロパティのデフォルト値は"enterprise" です。
OAuthJWTSubject：サブジェクトタイプがenterprise に設定されている場合は、これをエンタープライズID に設定します。サブジェクトタイプがuser に設定されている場合は、アプリケーションのユーザーID に設定します。
OAuthJWTPublicKeyId：アプリケーション設定の公開キーID。

接続すると、本製品はサービスアカウントでのOAuth フローを完了します。

本製品に要求されるクレームセットでJWT を作成し、サインします。
JWT はアクセストークンと交換されます。
OAuthSettingsLocation にOAuth 値を保存し、接続間で永続化されるようにします。
トークンの期限が切れたときは、JWT を送り、新しいアクセストークンと交換します。

BOXJSON OAuthJWTCertType

サービスアカウントおよびBOXJSON OauthJWTCertType を使用して認証するには、以下のプロパティを設定します。

AuthScheme：OAuthJWT。
InitiateOAuth：GETANDREFRESH。
OAuthJWTCertType：BOXJSON。 OAuthJWTCert：Box が提供するJSON ファイルへのパス。

システム内のファイルを使用するのが難しい場合は、JSON ファイルの内容を接続文字列に直接コピーすることができます。次のプロパティを設定します。

AuthScheme：OAuthJWT。
InitiateOAuth：GETANDREFRESH。
OAuthJWTCertType：BOXJSONBLOB。
OAuthJWTCert：Box が提供するJSON ファイルの内容。