ヘッダーをスキップ
Oracle® Fusion Middlewareインフラストラクチャ・コンポーネントのためのWLSTコマンド・リファレンス
12c (12.1.2)
E48021-01
  ドキュメント・ライブラリへ移動
ライブラリ		 製品リストへ移動
製品		 目次へ移動
目次
前
前 		 次
次		  

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

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

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

UMS WLSTコマンド・グループ

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

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


注意:

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

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

コマンド・カテゴリ 説明

UMS WLSTコマンド・グループ

Oracle User Messaging Serviceコマンドを管理します。

configUserMessagingDriver

コマンド・カテゴリ: ums

WLST使用: オンライン

説明

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

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

構文

configUserMessagingDriver(baseDriver, appName, driverProperties, clusterName=None propertyGroups=None)
引数 定義

baseDriver

ベース・メッセージング・ドライバ・タイプを指定します。

email、extension、proxy、smpp、twitter、voicexml、worklist、xmppなどの既知のドライバ・タイプにする必要があります。

appName

新規デプロイメントの短い説明の名前。指定した値の前に文字列usermessagingdriver-が付加されます

driverProperties

ドライバ・プロパティを持つオブジェクト。次のいずれかのクラスのオブジェクトになります。

CommonDriverProperties、EmailDriverProperties、ProxyDriverProperties、SmppDriverProperties、TwitterDriverProperties、VoiceXmlDriverProperties、WorklistDriverPropertiesまたはXmppDriverProperties。

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

print CommonDriverProperties.__dict__

print EmailDriverProperties.__dict__

clusterName

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

propertyGroups

オプション。追加または更新するプロパティ・グループのリスト。リスト内の項目は、クラスExtensionDriverPropertiesである必要があります。

例

例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])

configUserMessagingServer

コマンド・カテゴリ: ums

WLST使用: オンライン

説明

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

構文

configUserMessagingServer(serverProperties, clusterName=None)
引数 定義

serverProperties

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

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

print serverProperties.__dict__

clusterName

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

例

例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)

deployUserMessagingDriver

コマンド・カテゴリ: ums

WLST使用: オンライン

説明

deployUserMessagingDriverは、ユーザー・メッセージング・ドライバの追加インスタンスをデプロイするために使用されます。新しいドライバ・デプロイメントのベース・ドライバ・タイプ(例: email、xmpp、voicexmlなど)および短縮名を指定します。指定したアプリケーション名の前に文字列usermessagingdriver-が付加されます。オプションで、JMSリソースにセキュアに接続するためにドライバのプリンシパル名を指定します(デフォルト値は'OracleSystemUser')。deployコマンドに有効な任意のパラメータを指定でき、ドライバがデプロイされるときに渡されます。

構文

deployUserMessagingDriver(baseDriver, appName, [runAsPrincipalName],[targets], [stageMode], 
[options])
引数 定義

baseDriver

ベース・メッセージング・ドライバ・タイプを指定します。

'email'、'proxy'、'smpp'、'voicexml'または'xmpp'などの既知のドライバ・タイプを指定する必要があります。

appName

新規デプロイメントの短い説明の名前。指定した値の前に文字列usermessagingdriver-が付加されます

runAsPrincipalName

新規デプロイメントの短い説明の名前。指定した値の前に文字列usermessagingdriver-が付加されます

targets

stageMode

options

オプション。deployコマンドに有効な追加の引数を指定でき、新しいドライバがデプロイされる際に渡されます。

deployコマンドの詳細は、『WebLogic Server WLSTコマンド・リファレンス』を参照してください。

例

myEmailという名前の電子メール・ドライバの2番目のインスタンスをデプロイする場合

wls:base_domain/servereConfig> deployUserMessagingDriver(baseDriver='email', 
appName='myEmail')

デプロイメント・ターゲットを指定して、電子メール・ドライバの2番目のインスタンスをデプロイする場合

wls:base_domain/servereConfig> deployUserMessagingDriver(baseDriver='email', 
appName='email2', targets='server1,server2')

manageUserCommunicationPrefs

コマンド・カテゴリ: ums

WLST使用: オフライン

説明

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

構文

manageUserCommunicationPrefs (operation={'download' | 'upload'}, 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: 既存以外のエンティティのみをアップロードします。

例

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

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

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

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

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

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

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

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

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

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

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

wls:offline> manageUserMessagingPrefs(operation='upload', filename='upload.xml', 
url='t3://localhost:8001', username='weblogic', password='<password>', 
merge='overwrite')
  前
前 		 次
次
  ドキュメント・ライブラリへ移動
ライブラリ		 製品リストへ移動
製品		 目次へ移動
目次