接続の確立

JDBC データソースの作成

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

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

or

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

Google Data Catalog への接続

認証プロパティを追加する前に、次の接続プロパティを設定してください。

OrganizationId：接続するGoogle Cloud Platform の組織リソースに関連付けられたID。これはクラウドコンソールに移動して確認してください。
プロジェクトドロップダウンメニューを開き、リストから組織へのリンクをクリックします。このページに組織ID が表示されます。
ProjectId：接続するGoogle Cloud Platform のプロジェクトリソースに関連付けられたID。
クラウドコンソールのダッシュボードに移動し、Select from ドロップダウンメニューからプロジェクトを選択して確認してください。プロジェクトID は、プロジェクト情報カードに表示されます。

Google Data Catalog への認証

本製品は、認証にユーザーアカウント、サービスアカウントおよびGCP インスタンスアカウントの使用をサポートします。

以下のセクションでは、Google Data Catalog の利用可能な認証スキームについて説明します。

ユーザーアカウント（OAuth）
サービスアカウント（OAuthJWT）
GCP インスタンスアカウント

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

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

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

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

認証に関する2つの方法の違いは、カスタムOAuth アプリケーションを使用する場合に、2つの接続プロパティを追加で設定する必要があることだけです。

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

InitiateOAuth：GETANDREFRESH に設定。本製品はOAuth アクセストークンの取得およびリフレッシュを自動的に試みるように指示します。
OAuthClientId：（カスタムアプリのみ）カスタムOAuth アプリケーション設定のクライアントId に設定。
OAuthClientSecret：（カスタムアプリのみ）カスタムOAuth アプリケーション設定のクライアントシークレットに設定。

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

コールバックURL からアクセストークンを取得します。
古いトークンの期限が切れたときは、新しいアクセストークンを取得します。
OAuthSettingsLocation にOAuth 値を保存し、接続間で永続化します。

Web アプリケーション

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

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

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

OAuthClientId：アプリケーション設定のクライアントId に設定。
OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。

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

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

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

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

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

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

次回のデータ接続では、OAuthAccessToken およびOAuthRefreshToken の値は、OAuthSettingsLocation から取得されます。

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

OAuth リフレッシュトークンは、OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値です。

GetOAuthAccessToken によって返されたExpiresIn パラメータ値が経過した後に、RefreshOAuthAccessToken ストアドプロシージャを使用し、手動でOAuthAccessToken をリフレッシュします。次の接続プロパティを設定します。

OAuthClientId：アプリケーション設定のクライアントId に設定。
OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。

次に、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 アプリケーションを使用する場合は、Google Data Catalog OAuth endpoint をクリックし、ブラウザでエンドポイントを開きます。
- カスタムOAuth アプリケーションを使用するには、以下のプロパティを設定し、認証URL を作成します。
  - InitiateOAuth：OFF に設定。
  - OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
  - OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
  次に、適切なCallbackURL を指定してGetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
ログインして、本製品にアクセス許可を与えます。すると、verifier code を含むコールバックURL にリダイレクトされます。
verifier code の値を保存します。後ほどこれをOAuthVerifier 接続プロパティに設定します。

次に、OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換する必要があります。次のプロパティを設定します。

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

InitiateOAuth：REFRESH に設定。
OAuthVerifier：verifier code に設定。
OAuthClientId：（カスタムアプリのみ）カスタムOAuth アプリケーション設定のクライアントId に設定。
OAuthClientSecret：（カスタムアプリのみ）カスタムOAuth アプリケーション設定のクライアントシークレットに設定。
OAuthSettingsLocation：これを設定すると、暗号化されたOAuth 認証値が指定された場所に永続化されます。

OAuth 設定ファイルが生成されたら、以下のように接続プロパティをリセットする必要があります。

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

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

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

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

接続が正常にテストされたら、OAuth 設定ファイルをヘッドレスマシンにコピーします。

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

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

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

サービスアカウントを使用して認証するには、新しいサービスアカウントを作成し、アカウント証明書のコピーを用意する必要があります。サービスアカウントを持っていない場合は、カスタムOAuth アプリの作成の手順に従って作成できます。

JSON ファイルの場合は、以下のプロパティを設定します。

AuthScheme：OAuthJWT に設定。
InitiateOAuth：GETANDREFRESH に設定。
OAuthJWTCertType：GOOGLEJSON に設定。
OAuthJWTCert：Google が提供する.json ファイルへのパスに設定。
OAuthJWTSubject：（オプション）この値は、サービスアカウントがGSuite ドメインの一部で、委任を有効にする場合にのみ設定します。このプロパティの値は、データにアクセスしたいユーザーのE メールアドレスでなければなりません。

PFX ファイルの場合は、代わりに以下のプロパティを設定します。

AuthScheme：OAuthJWT に設定。
InitiateOAuth：GETANDREFRESH に設定。
OAuthJWTCertType：PFXFILE に設定。
OAuthJWTCert：Google が提供する.pfx ファイルへのパスに設定。
OAuthJWTCertPassword：（オプション）.pfx ファイルのパスワードに設定。Google はPFX 証明書を暗号化するため、ほとんどの場合、これを提供する必要があります。
OAuthJWTCertSubject：（オプション）複数の証明書を格納するOAuthJWTCertType を使用している場合にのみ設定します。Google によって生成されたPFX 証明書には設定しないでください。
OAuthJWTIssuer：サービスアカウントのE メールアドレスに設定。このアドレスには、通常iam.gserviceaccount.com ドメインが含まれます。
OAuthJWTSubject：（オプション）この値は、サービスアカウントがGSuite ドメインの一部で、委任を有効にする場合にのみ設定します。このプロパティの値は、データにアクセスしたいユーザーのE メールアドレスです。

GCP インスタンスアカウント

GCP 仮想マシン上で実行している場合は、本製品は仮想マシンに関連付けられたサービスアカウントを使用して認証できます。このモードを使用するには、AuthScheme をGCPInstanceAccount に設定します。