方法 : クライアントアプリケーションサービスを構成する

[アーティクル]
08/09/2011

ここでは、Visual Studio プロジェクトデザイナーを使用して、クライアントアプリケーションサービスを有効にし、構成する方法について説明します。クライアントアプリケーションサービスを使用してユーザーを検証したり、既存の Microsoft Ajax アプリケーションサービスからユーザーロールおよびユーザー設定を取得したりすることができます。「クライアントアプリケーションサービスの概要」に説明されているように、構成後、アプリケーションコードで有効になっているサービスにアクセスできます。 Microsoft Ajax アプリケーションサービスの詳細については、「ASP.NET アプリケーションサービスの概要」を参照してください。

クライアントアプリケーションサービスの有効化および構成は、プロジェクトデザイナーの [サービス] ページで行うことができます。 [サービス] ページは、プロジェクトの App.config ファイルの値を更新します。 プロジェクトデザイナーを表示するには、[プロジェクト] メニューの [プロパティ] をクリックします。 [サービス] ページの詳細については、「[サービス] ページ (プロジェクトデザイナー)」を参照してください。 プロジェクトデザイナーの詳細については、「プロジェクトデザイナーの概要」を参照してください。

クライアントアプリケーションサービスの基本構成の設定方法を、次の手順で説明します。詳細構成オプションについては、後のセクションで説明します。

クライアントアプリケーションサービスを構成するには

ソリューションエクスプローラーでプロジェクトノードを選択し、[プロジェクト] メニューの [プロパティ] をクリックします。

プロジェクトデザイナーが表示されます。
[サービス] タブをクリックします。次の図に示すような [サービス] ページが表示されます。
[サービス] ページで、[クライアントアプリケーションサービスを有効にする] を選択します。

注意

クライアントアプリケーションサービスは、.NET Framework の完全バージョンを必要とし、.Net Framework クライアントプロファイルではサポートされていません。 [クライアントアプリケーションサービスを有効にする] チェックボックスがオフになっている場合は、ターゲットフレームワークが .NET Framework 3.5 またはそれ以降に設定されていることを確認します。 C# でターゲットフレームワークの設定を表示するには、プロジェクトデザイナーを開き、[アプリケーション] ページをクリックします。 Visual Basic でターゲットフレームワークの設定を表示するには、プロジェクトデザイナーを開き、[コンパイル] ページ、[詳細コンパイルオプション] の順にクリックします。
独自のログインコントロールまたはダイアログボックスを作成する場合には [フォーム認証を使用する] を選択し、オペレーティングシステムによって提供される ID を使用する場合には [Windows 認証を使用する] をクリックします。詳細については、「クライアントアプリケーションサービスの概要」を参照してください。

注意

[Windows 認証を使用する] を選択した場合、クライアントアプリケーションサービスは自動的に SQL Server Compact Edition version 3.5 データベースを使用するように構成されます。これは [サービスの詳細設定] ダイアログボックスで示されます。これについては、次のセクションで説明します。その後に [フォーム認証を使用する] を選択しても、[カスタム接続文字列を使用] 設定は自動的にオフになりません。 SQL Server Compact 3.5 データベースが Windows 認証で使用するために既に生成されている場合、これがエラーの原因になります。このエラーを解決するには、[サービスの詳細設定] ダイアログボックスで [カスタム接続文字列を使用] 設定をオフにします。
[フォーム認証を使用する] を選択した場合、[認証サービスの場所] ボックスで、サービスホストの URL を指定する必要があります。このとき、ファイル名は含めません。デザイナーが、構成ファイルに値を書き込むときに、自動的に標準ファイル名 (Authentication_JSON_AppService.axd) を付け加えます。
[フォーム認証を使用する] を選択した場合、オプションで [資格情報プロバイダーの型名] ボックスに値を指定できます。資格情報プロバイダーは IClientFormsAuthenticationCredentialsProvider インターフェイスを実装する必要があります。資格情報プロバイダーを使用することによって、他のアプリケーションコードからログインユーザーインターフェイスを分離することができます。これにより、複数のアプリケーションで使用できる単一のログインダイアログボックスを作成できます。詳細については、「方法: クライアントアプリケーションサービスでユーザーのログインを実装する」を参照してください。

資格情報プロバイダーを指定する場合は、アセンブリ修飾型名として指定する必要があります。詳細については、「Type.AssemblyQualifiedName」および「アセンブリ名」を参照してください。最も単純な形式では、アセンブリ修飾型名は次の例のようになります。
```
MyNamespace.MyLoginClass, MyAssembly
```
[ロールサービスの場所] ボックスと [Web 設定サービスの場所] ボックスに、各サービスの場所を指定します。このとき、ファイル名は含めません。デザイナーが、構成ファイルに値を書き込むときに、自動的に標準ファイル名 (Role_JSON_AppService.axd と Profile_JSON_AppService.axd) を付け加えます。
オプションで、[詳細設定] をクリックし、ローカルキャッシュ動作などの詳細設定を変更します。詳細については、次の手順を参照してください。

詳細構成

やや一般的でないシナリオによるクライアントアプリケーションサービスの構成方法を、次の手順で説明します。たとえば、公の場所に配置されたアプリケーションに対してこれらの構成オプションを使用することも、暗号化された SQL Server Compact Edition version 3.5 データベースをローカルデータキャッシュとして使用するためにこれらの構成オプションを使用することもできます。

クライアントアプリケーションサービスの詳細設定を構成するには

プロジェクトデザイナーの [サービス] ページで [詳細設定] をクリックします。

次の図のような [サービスの詳細設定] ダイアログボックスが表示されます。このダイアログボックスの詳細については、「[サービスの詳細設定] ダイアログボックス」を参照してください。
[オフラインでログインできるようにパスワードのハッシュをローカルに保存する] をオンまたはオフにします。このオプションをオンにした場合、ユーザーのパスワードは暗号化された形式でローカルにキャッシュされます。これは、アプリケーションにオフラインモードを実装する場合に便利です。このオプションをオンにした場合、IsOffline プロパティが true に設定されている場合でもユーザーの検証を実行できます。オフラインモードの詳細については、「方法 : クライアントアプリケーションサービスをオフラインモードで操作する」を参照してください。
[サーバー Cookie の期限が切れた場合は常に再度ログオンすることをユーザーに要求する] をオンまたはオフにします。認証 Cookie はリモートサービスで構成され、ユーザーのログインがアクティブであり続ける期間を示します。 Cookie の構成方法の詳細については、「authentication の forms 要素 (ASP.NET 設定スキーマ)」の timeout 属性を参照してください。

このオプションをオンにした場合は、リモートロールサービスまたは Web 設定サービスに、認証 Cookie の期限が切れた後にアクセスしようとすると、WebException がスローされます。この例外を処理し、再度ユーザーを検証するためのログインダイアログボックスを表示できます。この動作の例については、「チュートリアル : クライアントアプリケーションサービスの使用」を参照してください。このオプションは、公の場所に配置されたアプリケーションで、使用後も実行されたままのアプリケーションから離れたユーザーを、無期限に認証済みにしない場合に便利です。

このオプションをオフにした場合は、認証 Cookie の期限が切れた後にユーザーがリモートサービスにアクセスしようとすると、自動的に再検証が行われます。
[ロールサービスのキャッシュのタイムアウト] に値を指定します。この時間間隔には、ロールが頻繁に更新される場合には小さな値を、ロールの更新頻度が低い場合には大きな値を設定します。オフラインモードを実装する場合には、アプリケーションがオフラインの間にロール情報が期限切れにならないように大きな値を設定します。

IsInRole メソッドが呼び出されると、ロールプロバイダーはキャッシュされたロール値またはロールサービスにアクセスします。プログラムによってキャッシュをリセットし、強制的にこのメソッドをリモートサービスにアクセスさせるには、ResetCache メソッドを呼び出します。
[カスタム接続文字列を使用] をオンまたはオフにします。詳細については、次の手順を参照してください。

ローカルキャッシュ用データベースを使用するようにクライアントアプリケーションサービスを構成するには

プロジェクトデザイナーの [サービス] ページで [詳細設定] をクリックします。

[サービスの詳細設定] ダイアログボックスが表示されます。
[カスタム接続文字列を使用] をオンにします。

テキストボックスに Data Source = |SQL/CE| という既定値が表示されます。
SQL Server Compact Edition version 3.5 データベースを生成し使用するには、既定の接続文字列値を保持します。Visual Studio はデータベースファイルを生成し、これを Application.UserAppDataPath プロパティで指定されるディレクトリに格納します。
暗号化された SQL Server Compact 3.5 データベースを生成し使用するには、次の例のように password 値と encrypt database 値を接続文字列に追加します。

注意

強力なパスワードを指定してください。データベースが生成された後にパスワードを変更することはできません。
```
Data Source = |SQL/CE|;password=<password>;encrypt database=true
```
独自の SQL Server データベースを使用するには、独自の接続文字列を指定します。有効な接続文字列形式については、SQL Server のドキュメントを参照してください。このデータベースは自動的には生成されません。接続文字列は、次の SQL ステートメントを使用して作成できる既存のデータベースを参照する必要があります。
```
CREATE TABLE ApplicationProperties (PropertyName nvarchar(256),
    PropertyValue nvarchar(256))
CREATE TABLE UserProperties (PropertyName nvarchar(256),
    PropertyValue nvarchar(256))
CREATE TABLE Roles (UserName nvarchar(256), 
    RoleName nvarchar(256))
CREATE TABLE Settings (PropertyName nvarchar(256), 
    PropertyStoredAs nvarchar(1), PropertyValue nvarchar(2048))
```

カスタムプロバイダーの使用

既定では、クライアントアプリケーションサービス機能は、System.Web.ClientServices.Providers 名前空間のプロバイダーを使用します。 プロジェクトデザイナーの [サービス] ページを使用してアプリケーションを構成すると、これらのプロバイダーへの参照が App.config ファイルに追加されます。これらの既定のプロバイダーは、サーバー上の対応するプロバイダーにアクセスします。 Web サービスは、通常、SqlMembershipProvider や SqlRoleProvider などのプロバイダーを介してユーザーデータにアクセスするように構成されています。

カスタムサービスプロバイダーを使用する必要がある場合には、通常、サーバー側のプロバイダーを変更するため、そのサーバーにアクセスするすべてのクライアントアプリケーションに影響が出ます。ただし、クライアント側で既定以外のプロバイダーを使用するという選択肢もあります。次の手順に示されているように、プロジェクトの App.config ファイルでカスタム認証プロバイダーまたはカスタムロールプロバイダーを指定することができます。カスタム認証プロバイダーとカスタムロールプロバイダーを作成する方法については、「メンバーシッププロバイダーの実装」および「ロールプロバイダーの実装」を参照してください。また、プロジェクトの Settings クラス (C# では Properties.Settings.Default、Visual Basic では My.Settings としてアクセス) を変更することにより、カスタム設定プロバイダーを使用することもできます。詳細については、「アプリケーション設定アーキテクチャ」を参照してください。

既定以外のプロバイダーを使用するようにクライアントアプリケーションサービスを構成するには

既定以外の認証サービスプロバイダーまたはロールサービスプロバイダーを使用するには、まず、[サービス] ページを使用してその他のすべての構成設定を完了します。
プロジェクトデザイナーを終了します。これは、設定の変更がない場合でも [サービス] ページが App.config ファイルを自動的に更新するため必要です。ここで説明するように App.config ファイルを手動で変更した後に [サービス] ページに戻ると、変更内容はリセットされます。
ソリューションエクスプローラーで、App.config をダブルクリックします。

アプリケーション構成ファイルがテキストエディターで開かれます。
<membership> 要素内の <providers> 要素または <roleManager> 要素を検索します。これらの要素は <system.web> 要素の子です。 <membership> 要素は認証プロバイダーを指定するのに使用され、<roleManager> 要素はロールプロバイダーを指定するのに使用されます。
<providers> 要素の子として <add> 要素を追加します。次の例に示すように name 属性と type 属性を指定する必要があります。 type 属性値は、アセンブリ修飾型名である必要があります。詳細については、「Type.AssemblyQualifiedName」および「アセンブリ名」を参照してください。
```
<add name="MyCustomRoleProvider" type="MyNamespace.MyRoleProvider, MyAssembly" />
```
<membership> 要素または <roleManager> 要素の defaultProvider 属性を変更して、前の手順で追加した <add> 要素の name 値を指定します。
```
<roleManager enabled="true" defaultProvider="MyCustomRoleProvider">
```

参照

方法 : クライアント アプリケーション サービスを構成する

クライアント アプリケーション サービスを構成するには

詳細構成

クライアント アプリケーション サービスの詳細設定を構成するには

ローカル キャッシュ用データベースを使用するようにクライアント アプリケーション サービスを構成するには

カスタム プロバイダーの使用

既定以外のプロバイダーを使用するようにクライアント アプリケーション サービスを構成するには

参照

処理手順

参照

概念

その他の技術情報

その他のリソース