9 User Messaging Service (UMS)のカスタムWLSTコマンド

Oracle User Messaging Serviceは、アプリケーションからデバイスにメッセージを送信する共通サービスを提供します。また、着信メッセージをデバイスからアプリケーションにルーティングします。

この章では、Oracle User Messaging Service (UMS)で使用可能なWLSTコマンドについて説明します。

9.1 UMS WLSTコマンド・グループ

UMS WLSTコマンドは、コマンド・グループ「ums」の下にリストされています。

表9-1にリストされているUser Messaging Serviceコマンドを使用して、バックグラウンド・データベースからユーザー・メッセジング・プリファレンスをダウンロードします。

注意:

これらのコマンドを使用するには、コンポーネントがインストールされているOracleホームからWLSTを起動する必要があります。『Oracle Fusion Middlewareの管理』のカスタムWLSTコマンドの使用に関する項を参照してください。

表9-1 WLST構成用のUser Messaging Service

コマンド・カテゴリ	説明
9.1項「UMS WLSTコマンド・グループ」	Oracle User Messaging Serviceコマンドを管理します。

9.1.1 configUserMessagingDriver

コマンド・カテゴリ: ums

WLST使用: オンライン

9.1.1.1 説明

configUserMessagingDriverは、メッセージング・ドライバの構成に使用されます。

新しいドライバ構成のベース・ドライバ・タイプ(email、xmppなど)および短縮名を指定します。指定したアプリケーション名の前に文字列usermessagingdriver-が付加されます。

9.1.1.2 構文

configUserMessagingDriver(baseDriver, appName, driverProperties, clusterName=None propertyGroups=None)

引数	定義
`baseDriver`	ベース・メッセージング・ドライバ・タイプを指定します。 email、extension、smpp、twitter、xmppなどの既知のドライバ・タイプにする必要があります。
`appName`	デプロイメントの短い説明の名前。指定した値の前に文字列usermessagingdriver-が付加されます
`driverProperties`	ドライバ・プロパティを持つオブジェクト。次のいずれかのクラスのオブジェクトになります。 CommonDriverProperties、EmailDriverProperties、SmppDriverProperties、TwitterDriverPropertiesまたはXmppDriverProperties。ドライバの使用可能なすべてのドライバ・プロパティを確認するには、クラスの`dict`フィールドを出力します。次に例を示します。 `print CommonDriverProperties().__dict__` `print EmailDriverProperties().__dict__`
`clusterName`	オプション。この構成を有効とするクラスタの名前。指定されない場合は、この構成がドメイン全体で有効となります。
`propertyGroups`	オプション。追加または更新するプロパティ・グループのリスト。リスト内の項目は、クラスExtensionDriverPropertiesである必要があります。

9.1.1.3 例

例9-1 xmppという名前でXMPPドライバを構成する場合

driverProperties = XmppDriverProperties()
driverProperties.SenderAddresses = 'IM:alice@example.com'
driverProperties.IMServerHost = 'example.com'
driverProperties.IMServerUsername = 'alice'
driverProperties.IMServerPassword = 'secret'
configUserMessagingDriver(baseDriver='xmpp', appName='xmpp', 
   driverProperties=driverProperties, clusterName='my_cluster')

例9-2 extensionという名前で拡張ドライバを構成する場合

driverProperties = CommonDriverProperties()
extensionDriverProperties = ExtensionDriverProperties()
extensionDriverProperties.PropertyGroupName = 'example.com'
extensionDriverProperties.EndpointURL = 'http://domain.example.com/extension'
extensionDriverProperties.MappedDomain = 'example.com'
extensionDriverProperties.Protocol = 'popup'
configUserMessagingDriver(baseDriver='extension', appName='extension',
   driverProperties=driverProperties, 
   propertyGroups=[extensionDriverProperties])

9.1.2 configUserMessagingServer

コマンド・カテゴリ: ums

WLST使用: オンライン

9.1.2.1 説明

configUserMessagingServerは、メッセージング・サーバーの構成に使用されます。

9.1.2.2 構文

configUserMessagingServer(serverProperties, clusterName=None)

引数定義

引数	定義
`serverProperties`	サーバー・プロパティを持つオブジェクト。クラスServerPropertiesのオブジェクトである必要があります。使用可能なすべてのプロパティを確認するには、クラスの`dict`フィールドを出力します。次に例を示します。 `print serverProperties().__dict__`
`clusterName`	オプション。この構成を有効とするクラスタの名前。指定されない場合は、この構成がドメイン全体で有効となります。

serverProperties

サーバー・プロパティを持つオブジェクト。クラスServerPropertiesのオブジェクトである必要があります。

使用可能なすべてのプロパティを確認するには、クラスのdictフィールドを出力します。次に例を示します。

print serverProperties().__dict__

clusterName

オプション。この構成を有効とするクラスタの名前。指定されない場合は、この構成がドメイン全体で有効となります。

9.1.2.3 例

例9-3 my_clusterという名前のクラスタ内のUMSサーバーのJPSコンテキスト名を構成する場合

serverProperties = ServerProperties()
serverProperties.JpsContext = 'my_jps_context'
configUserMessagingServer(serverProperties=serverProperties, clusterName='my_cluster')

例9-4 ドメイン内のUMSサーバーのセキュリティ・プリンシパルを構成する場合

serverProperties = ServerProperties()
serverProperties.SecurityPrincipal = 'MyUser'
configUserMessagingServer(serverProperties=serverProperties)

9.1.3 manageUserCommunicationPrefs

コマンド・カテゴリ: ums

WLST使用: オフライン

9.1.3.1 説明

manageUserCommunicationPrefsは、ユーザー・メッセージング・プリファレンスをバックエンド・データベースから指定したXMLファイルにダウンロードするため、またはユーザー・メッセージング・プリファレンスをXMLファイルからバックエンド・データベースにアップロードするため、またはユーザー・プリファレンスをバックアップ・データベースから削除してプリファレンスを指定したXMLファイルにバックアップするために使用されます。

9.1.3.2 構文

manageUserCommunicationPrefs (operation={'download' | 'upload' | 'delete'}, filename='file_name', url='jndi_url', username='username', password='password'
 [, encoding='character_encoding'] [, guid='guid1,guid2, ...' ] [, merge={'create_new' | 'overwrite' | 'append'}] )

引数	定義
`operation`	実行するアップロードまたはダウンロード操作を指定します。
`filename`	ダウンロードの場合、ユーザー・プリファレンスのダウンロード先の一意のファイル名(パス)。たとえば、/tmp/download.xml (Linux)またはC:\\temp\\download.xml (Windows)です。アップロードの場合、ユーザー・プリファレンスのアップロード元のファイル名(パス)。
`url`	User Messaging ServerにアクセスするためのJNDI URL。たとえば、`t3://<hostname>:<port>`です。
`username`	User Messaging Serverにアクセスするためのログイン権限を持つユーザー名。
`password`	ユーザー名のパスワード。
`encoding`	(オプション)ユーザー・プリファレンスのダウンロードに使用する文字エンコーディング。
`guid`	(オプション)プリファレンスのダウンロードに使用するユーザー・リストのグローバル一意識別子(GUID)。guidが指定されない場合、すべてのユーザーのプリファレンスがダウンロードされます。
`merge`	(オプション)この引数はアップロード専用です。有効な値は次のとおりです。 `create_new` (デフォルト): 新規のユーザー・デバイス、デバイス・アドレスまたはルールセット・エンティティ(あるいはその両方)を作成します。同じプライマリ・キーを持つエンティティがすでに存在する場合は、例外がスローされ、処理が停止します。 `overwrite`: ユーザーの既存のすべてのエンティティを削除して、新規エンティティを作成します。 `append`: 既存以外のエンティティのみをアップロードします。

9.1.3.3 例

注意:

下のURLで、ポート7001はUMSがデプロイされている管理対象サーバー・ポートを表します。

すべてのユーザーのユーザー・メッセージング・プリファレンスを指定されたファイルにダウンロードするには、次のコマンドを実行します。

wls:offline> manageUserCommunicationPrefs(operation='download', 
filename='download.xml', url='t3://localhost:7001', username='weblogic', 
password='<password>')

すべてのユーザーのユーザー・メッセージング・プリファレンスを、UTF-8文字エンコーディングを使用して指定されたファイルにダウンロードするには、次のコマンドを実行します。

wls:offline> manageUserCommunicationPrefs(operation='download', 
filename='download.xml', url='t3://localhost:7001', username='weblogic', 
password='<password>', encoding='UTF-8')

GUIDが'john.doe'のユーザーのユーザー・メッセージング・プリファレンスを指定されたファイルにダウンロードするには、次のコマンドを実行します。

wls:offline> manageUserCommunicationPrefs(operation='download', 
filename='download.xml', url='t3://localhost:7001', username='weblogic', 
password='<password>', guid='john.doe')

GUIDが'john.doe'および'jane.doe'のユーザーのユーザー・メッセージング・プリファレンスを、UTF-8文字エンコーディングを使用して指定されたファイルにダウンロードするには、次のコマンドを実行します。

wls:offline> manageUserCommunicationPrefs(operation='download', 
filename='download.xml', url='t3://localhost:7001', username='weblogic', 
password='<password>', guid='john.doe,jane.doe', encoding='UTF-8')

ユーザー・メッセージング・プリファレンスを指定されたファイルからバックエンド・データベースにアップロードするには、次のコマンドを実行します。

wls:offline> manageUserCommunicationPrefs(operation='upload', filename='upload.xml', 
url='t3://localhost:7001', username='weblogic', password='<password>')

ユーザー・メッセージング・プリファレンスを指定されたファイルからバックエンド・データベースにアップロードして、既存のプリファレンスを上書きするには、次のコマンドを実行します。

wls:offline> manageUserCommunicationPrefs(operation='upload', filename='upload.xml', 
url='t3://localhost:8001', username='weblogic', password='<password>', 
merge='overwrite')

GUIDが'john.doe'のユーザーのユーザー・プリファレンスを削除し、指定したファイルにプリファレンスをバックアップするには、次のコマンドを実行します。

wls:offline> manageUserCommunicationPrefs(operation='delete', filename='backup.xml', url='t3://localhost:7001', username='weblogic', password='<password>', guid='john.doe')

GUIDが'john.doe'および'jane.doe'のユーザーのユーザー・メッセージング・プリファレンスを削除し、UTF-8文字エンコーディングを使用して指定されたファイルにプリファレンスをバックアップするには、次のコマンドを実行します。

wls:offline> manageUserCommunicationPrefs(operation='delete', filename='backup.xml', url='t3://localhost:7001', username='weblogic', password='<password>', guid='john.doe,jane.doe', encoding='UTF-8')