プライマリ・コンテンツに移動
Oracle® Fusion Middlewareインフラストラクチャ・コンポーネントWLSTコマンド・リファレンス
12c (12.2.1)
E69981-01
  ドキュメント・ライブラリへ移動
ライブラリ		 製品リストへ移動
製品		 目次へ移動
目次
前
前 		  

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

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

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

UMS WLSTコマンド・グループ

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


注意:

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

configUserMessagingDriver

コマンド・カテゴリ: ums

WLST使用: オンライン

説明

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

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

構文

configUserMessagingDriver(baseDriver, appName, driverProperties, clusterName=None,serverName=None, enabled=true)

propertyGroupsの使用は、12.2.1以降非推奨です。非推奨になった構文:

configUserMessagingDriver(baseDriver, appName, driverProperties, 
clusterName=None 
         serverName=None, propertyGroups=None, enabled=true)
引数 定義
baseDriver ベース・メッセージング・ドライバ・タイプを指定します。

apns、email、extension、smpp、twitter、xmppなどの既知のドライバ・タイプにする必要があります。
appName デプロイメントの短い説明の名前。指定した値の前に文字列usermessagingdriver-が付加されます
driverProperties ドライバ・プロパティを持つオブジェクト。次のいずれかのクラスのオブジェクトになります。

CommonDriverProperties、ApnsDriverProperties、EmailDriverProperties、SmppDriverProperties、ExtensionDriverProperties、TwitterDriverPropertiesまたはXmppDriverProperties。

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

print CommonDriverProperties().__dict__

print EmailDriverProperties().__dict__
serverName オプション。この構成を有効にする管理対象サーバーの名前。clusterNameまたはServerNameのいずれかを指定する必要があります。両方は許可されていません。両方がNoneである場合、構成はすべての管理対象サーバーで管理対象サーバー・レベル構成になります。
clusterName オプション。この構成を有効にするクラスタの名前。clusterNameまたはserverNameのいずれかを指定する必要があります。両方は許可されていません。両方がNoneである場合、構成はすべての管理対象サーバーで管理対象サーバー・レベル構成になります。
enabled オプション。構成を有効または無効にするかどうかを指定します。

設定されていない場合、デフォルト値はtrueです。

例

例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 = ExtensionDriverProperties()
extensionDriverProperties.EndpointURL = 'http://domain.example.com/extension'
extensionDriverProperties.MappedDomain = 'example.com'
extensionDriverProperties.Protocol = 'popup'
configUserMessagingDriver(baseDriver='extension', appName='extension',
   driverProperties=driverProperties)

configUserMessagingServer

コマンド・カテゴリ: ums

WLST使用: オンライン

説明

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

構文

configUserMessagingServer(serverProperties, clusterName=None), serverName=None)
引数 定義
serverProperties サーバー・プロパティを持つオブジェクト。クラスServerPropertiesのオブジェクトである必要があります。

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

print serverProperties().__dict__
clusterName オプション。この構成を有効にする管理対象サーバーの名前。clusterNameまたはServerNameのいずれかを指定する必要があります。両方は許可されていません。両方がNoneである場合、構成はすべての管理対象サーバーで管理対象サーバー・レベル構成になります。
serverName オプション。この構成を有効にするクラスタの名前。clusterNameまたはserverNameのいずれかを指定する必要があります。両方は許可されていません。両方がNoneである場合、構成はすべての管理対象サーバーで管理対象サーバー・レベル構成になります。

例

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

manageUserCommunicationPrefs

コマンド・カテゴリ: ums

WLST使用: オフライン

説明

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

構文

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が指定されない場合、すべてのユーザーのプリファレンスがダウンロードされます。削除の場合、GUIDは、この操作でプリファレンスが削除されるユーザーを指定します。
merge (オプション)この引数はアップロード専用です。有効な値は次のとおりです。

create_new (デフォルト): 新規のユーザー・デバイス、デバイス・アドレスまたはルールセット・エンティティ(あるいはその両方)を作成します。同じプライマリ・キーを持つエンティティがすでに存在する場合は、例外がスローされ、処理が停止します。

overwrite: ユーザーの既存のすべてのエンティティを削除して、新規エンティティを作成します。

append: 既存以外のエンティティのみをアップロードします。

例


注意:

下の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')
  前
前 
  ドキュメント・ライブラリへ移動
ライブラリ		 製品リストへ移動
製品		 目次へ移動
目次