リソース構成スクリプト
スクリプト・ライブラリーは、アプリケーション・サーバーの構成を自動化するための複数のスクリプト・プロシージャーを提供します。 メール、URL、およびリソース環境の構成スクリプトを使用して、 環境内のリソースを作成して構成します。 各スクリプトを個別に実行したり、複数のプロシージャーを組み合わせて、カスタム自動化スクリプトを作成できます。
メール、URL、およびリソース管理スクリプト・プロシージャーは、 app_server_root/scriptLibraries/resources/ ディレクトリーにあります。
有効範囲引数の形式
この有効範囲形式は、有効範囲引数がある、スクリプト・ライブラリー内のスクリプトに適用されます。
セルは、ノード、サーバー、およびクラスター有効範囲ではオプションです。 ノードはサーバー有効範囲では必須です。
タイプは、コンマ (,) またはコロン (:) を使用して区切ることができます。 タイプ (cell =、node =、server=、または cluster =) には、以前の大/小文字を使用できます。
以下の表では、出版の都合上、例が複数行に分割されています。
| 有効範囲 | 内包パス | 構成 ID | タイプ |
|---|---|---|---|
| Cell | /セル:myCell/ |
|
Cell=myCell または cell=myCell |
| ノード | /Cell:myCell/Node:myNode/または /Node:myNode/ |
|
またはまたは
|
| サーバー | または |
|
またはまたは |
| クラスター | または |
|
またはまたは |
createCompleteMailProvider
このスクリプトは、メール・プロバイダーの追加の構成属性を構成します。 メール・プロバイダーは、SMTP、IMAP、および POP3 などのプロトコル・プロバイダーのコレクションをカプセル化します。 一方、メール・セッションはユーザーを認証し、メッセージング・システムへのユーザーのアクセスを制御します。 自身のメール・プロバイダーおよびセッションを構成し、 JavaMail の処理方法をカスタマイズします。 このスクリプトは、作成されたメール・プロバイダーの構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| nodeName | 対象のノードの名前を指定します。 |
| serverName | 対象のサーバーの名前を指定します。 |
| mailProvider名前 | アプリケーション・サーバーがこのメール・セッション用に使用するメール・プロバイダーを指定します。 |
| propName | カスタム・プロパティーの名前を指定します。 |
| propValue | カスタム・プロパティーの値を指定します。 |
| protocolName | プロトコル・プロバイダーの名前を指定します。 アプリケーション・サーバーには、SMTP、IMAP、および POP3 のプロトコル・プロバイダーが含まれています。 |
| className | プロトコル・プロバイダーの実装クラス名を指定します。 |
| mailSession名前 | JavaMail セッション・オブジェクトの管理名を指定します。 |
| JNDIName | 任意のネーミング・サブコンテキストなど、リソースの Java Naming and Directory Interface (JNDI) 名を指定します。 この名前は、クライアント・アプリケーションのデプロイメント記述子で定義されるリソースに対するプラットフォームのバインディング情報と、プラットフォームによって JNDI にバインドされる実際のリソースとの間のリンクを提供します。 |
| mailStoreホスト | メールの受信時にアクセスするサーバーを指定します。 この設定は、メール・ストア・ユーザー ID とパスワードを結合したもので、 有効なメール・アカウントを示します。 例えば、メール・アカウントが次のようになっているとします。john_william@my.company.comこの場合、メール・ストア・ホストは以下のようになります。my.company.com. |
| mailStoreユーザー | 特定のメール・アカウントのユーザー ID を指定します。 例えば、メール・アカウントが次のようになっているとします。john_william@my.company.comこの場合、ユーザーはjohn_william. |
| mailStoreパスワード | 特定のメール・アカウントのパスワードを指定します。 例えば、メール・アカウントが次のようになっているとします。john_william@my.company.com次に、ID のパスワードを入力しますjohn_william. |
構文
AdminResources.createCompleteMailProvider(nodeName,
serverName, mailProviderName, propName, propValue,
protocolName, className, mailSessionName, JNDIName,
mailStoreHost, mailStoreUser, mailStorePassword)
使用例
AdminResources.createCompleteMailProvider("myNode",
"myServer", "myMailProvider", "myProp", "myPropValue", "myMailProtocol",
"com.ibm.mail.myMailProtocol.myMailStore", "myMailSession", "myMailSession/jndi", "server1",
"mailuser", "password")
createCompleteMailProviderAtScope
このスクリプトは、指定した有効範囲のメール・プロバイダーの追加構成属性を構成します。 メール・プロバイダーは、SMTP、IMAP、および POP3 などのプロトコル・プロバイダーのコレクションをカプセル化します。 一方、メール・セッションはユーザーを認証し、メッセージング・システムへのユーザーのアクセスを制御します。 自身のメール・プロバイダーおよびセッションを構成し、 JavaMail の処理方法をカスタマイズします。 このスクリプトは、指定した有効範囲の作成済みメール・プロバイダーの構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| scope | メール・プロバイダーのセル、ノード、サーバー、またはクラスターの 有効範囲 を指定します。 |
| mailProvider名前 | アプリケーション・サーバーがこのメール・セッション用に使用するメール・プロバイダーを指定します。 |
| propName | カスタム・プロパティーの名前を指定します。 |
| propValue | カスタム・プロパティーの値を指定します。 |
| protocolName | プロトコル・プロバイダーの名前を指定します。 アプリケーション・サーバーには、SMTP、IMAP、および POP3 のプロトコル・プロバイダーが含まれています。 |
| className | プロトコル・プロバイダーの実装クラス名を指定します。 |
| タイプ | プロトコル・プロバイダーのタイプを指定します。 有効なオプションは次のとおりです。STOREまたはTRANSPORT. |
| mailSession名前 | JavaMail セッション・オブジェクトの管理名を指定します。 |
| jndiName | 任意のネーミング・サブコンテキストなど、リソースの Java Naming and Directory Interface (JNDI) 名を指定します。 この名前は、クライアント・アプリケーションのデプロイメント記述子で定義されるリソースに対するプラットフォームのバインディング情報と、プラットフォームによって JNDI にバインドされる実際のリソースとの間のリンクを提供します。 |
| otherAttributesList、 mailProviderAttributesList、 mailSessionAttributesList | オプションで、追加の属性を以下の特定のフォーマットで指定します。
|
| 属性 | 説明 |
|---|---|
| クラスパス | 組み合わせることでリソース・プロバイダー・クラスの場所を形成する、 パスまたは Java アーカイブ (JAR)・ファイル名のリストを指定します。 クラスパスは、セミコロン (;) を使用して区切ります。 |
| 説明 | メール・プロバイダーの説明を指定します。 |
| isolatedClassローダー | true に設定すると、メール・プロバイダーが独自のクラス・ローダーにロードされるように指定されます。 重要: ネイティブ・ライブラリー・パスが指定されている場合、プロバイダーを分離することはできません。
|
| nativePath | *.dll や *.so などの任意のネイティブ・ライブラリーへのオプションのパスを指定します。 ネイティブ・パス・エントリーはセミコロン (;) を使用して区切ります。 |
| providerType | このメール・プロバイダーが使用するメール・プロバイダー・タイプを指定します。 |
| 属性 | 説明 |
|---|---|
| カテゴリー (Category) | リソースの分類またはグループ化に使用できるカテゴリーを指定します。 |
| DEBUG | このメール・セッションにデバッグ・モードを使用するかどうかを指定します。 デフォルト値は offです。 |
| 説明 | メール・プロバイダーの説明を指定します。 |
| mailFrom | インターネット E メール・アドレスを指定します。 true に設定すると、このメール・プロバイダーは独自のクラス・ローダーにロードされます。 注意: ネイティブ・ライブラリー・パスが指定されている場合は、プロバイダーを分離することはできません。
|
| mailStoreホスト | メールの受信時に接続するサーバーを指定します。 |
| mailStoreポート | メールの受信時に接続するポートを指定します。 |
| mailStoreユーザー | 受信メール・サーバーが認証を必要とする場合にメール・アカウントのユーザーを指定します。 |
| mailStoreパスワード | 受信メール・サーバーが認証を必要とする場合にメール・アカウントのパスワードを指定します。 |
| mailStoreプロトコル | メールの受信時に使用するプロトコルを指定します。 |
| mailTransportホスト | メールの送信時に接続するサーバーを指定します。 |
| mailTransportポート | メールの送信時に接続するポートを指定します。 |
| mailTransportユーザー | 送信メール・サーバーが認証を必要とする場合にメール・アカウントのユーザーを指定します。 |
| mailTransportパスワード | 送信メール・サーバーが認証を必要とする場合にメール・アカウントのパスワードを指定します。 |
| mailTransportプロトコル | メールの送信時に使用するプロトコルを指定します。 |
| 厳密 | 受信側アドレスが RFC 822 に従って解析されるかどうかを指定します。 デフォルト値は trueです。 |
構文
AdminResources.createCompleteMailProviderAtScope(scope,
mailProviderName, propName, propValue,
protocolName, className, type, mailSessionName, JNDIName, otherAttributesList,
mailProviderAttributesList, mailSessionAttributesList)
使用例
以下のスクリプト例には必須の属性のみが含まれています。
AdminResources.createCompleteMailProviderAtScope("myScope",
"myMailProvider", "myProp", "myPropValue", "myMailProtocol",
"com.ibm.mail.myMailProtocol.myMailStore", "myMailSession", "myMailSession/jndi", "server1", "STORE")
AdminResources.createCompleteMailProviderAtScope("Node=MY4Node09, server=server1", "myMailProvider", "myProp",
"myPropValue", "myMailProtocol", "com.ibm.mail.myMailProtocol.myMailStore", "STORE", "myMailSession", "myMailSession/jndi",
"classpath=c:/temp, description='this is my mail', nativepath=c:/temp/nativepath, isolatedClassLoader=true",
"category=myCategory, debug=true, description='this is my mailsession', mailStoreUser=user1, mailStorePassword=password,
mailStoreHost=user1, mailStorePort=1000, mailTransportUser=user2, mailTransportPassword=password, mailTransportHost=test2,
mailTransportPort=1001, strict=true, mailFrom=test1@gmail.com")以下のスクリプト例には、リスト・フォーマットのオプション属性が含まれています。
AdminResources.createCompleteMailProviderAtScope("/Cell:MY4Cell01/ServerCluster:c1/", "myMailProvider", "myProp",
"myPropValue", "myMailProtocol", "com.ibm.mail.myMailProtocol.myMailStore", "STORE", "myMailSession", "myMailSession/jndi",
[['classpath', 'c:/temp'], ['description', 'this is my mail'], ['nativepath', 'c:/temp/nativepath'],
['isolatedClassLoader', 'true']]
[['category', 'myCategory'], ['debug', 'true'], ['description', 'this is my mailsession'], ['mailStoreUser', 'user1'],
['mailStorePassword', 'password'], ['mailStoreHost', 'user1'], ['mailStorePort', 1000], ['mailTransportUser', 'user2'],
['mailTransportPassword', 'password'], ['mailTransportHost', 'test2'], ['mailTransportPort', 1001], ['strict', 'true'],
['mailFrom', 'test1@gmail.com']])
createMailProvider
このスクリプトは、環境内にメール・プロバイダーを作成します。 アプリケーション・サーバーには、組み込みプロバイダーと呼ばれるデフォルトのメール・プロバイダーが含まれています。 デフォルトのメール・プロバイダーを使用する場合は、メール・セッションを構成するだけで済みます。 カスタマイズしたメール・プロバイダーを使用するには、まず、メール・プロバイダーとセッションを作成する必要があります。 このスクリプトは、作成されたメール・プロバイダーの構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| nodeName | メール・プロバイダーの作成先となるノードの名前を指定します。 |
| serverName | メール・プロバイダーを作成する対象となるサーバーの名前を指定します。 |
| mailProvider名前 | 新しいメール・プロバイダーに割り当てる名前を指定します。 |
構文
AdminResources.createMailProvider(nodeName, serverName,
mailProviderName)
使用例
AdminResources.createMailProvider("myNode", "myServer",
"myMailProvider")
createMailProviderAtScope
このスクリプトは、指定した有効範囲でご使用の環境にメール・プロバイダーを作成します。 アプリケーション・サーバーには、組み込みプロバイダーと呼ばれるデフォルトのメール・プロバイダーが含まれています。 デフォルトのメール・プロバイダーを使用する場合は、メール・セッションを構成するだけで済みます。 カスタマイズしたメール・プロバイダーを使用するには、まず、メール・プロバイダーとセッションを作成する必要があります。 このスクリプトは、指定した有効範囲の作成済みメール・プロバイダーの構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| scope | メール・プロバイダーのセル、ノード、サーバー、またはクラスターの 有効範囲 を指定します。 |
| mailProvider名前 | 新しいメール・プロバイダーに割り当てる名前を指定します。 |
| otherAttributesリスト | オプションで、追加の属性を以下の特定のフォーマットで指定します。
|
| 属性 | 説明 |
|---|---|
| クラスパス | 組み合わせることでリソース・プロバイダー・クラスの場所を形成する、 パスまたは Java アーカイブ (JAR)・ファイル名のリストを指定します。 クラスパスは、セミコロン (;) を使用して区切ります。 |
| 説明 | メール・プロバイダーの説明を指定します。 |
| isolatedClassローダー | true に設定すると、メール・プロバイダーが独自のクラス・ローダーにロードされるように指定されます。 重要: ネイティブ・ライブラリー・パスが指定されている場合、プロバイダーを分離することはできません。
|
| nativePath | *.dll や *.so などの任意のネイティブ・ライブラリーへのオプションのパスを指定します。 ネイティブ・パス・エントリーはセミコロン (;) を使用して区切ります。 |
| providerType | このメール・プロバイダーが使用するメール・プロバイダー・タイプを指定します。 |
構文
AdminResources.createMailProviderAtScope(scope, mailProviderName, otherAttributesList)
使用例
以下のスクリプト例には必須の属性のみが含まれています。
AdminResources.createMailProviderAtScope("myScope", "myMailProvider")
AdminResources.createMailProviderAtScope("Node=MY4Node09, server=server1", "myMailProvider", "classpath=c:/temp,
description='this is my mail', nativepath=c:/temp/nativepath, isolatedClassLoader=true")以下のスクリプト例には、リスト・フォーマットのオプション属性が含まれています。
AdminResources.createMailProviderAtScope("/Cell:MY4Cell01/ServerCluster:c1/", "myMailProvider",
[['classpath', 'c:/temp'],
['description', 'this ismy mail'], ['nativepath', 'c:/temp/nativepath'], ['isolatedClassLoader', 'true']])
createMailSession
このスクリプトは、メール・プロバイダー用の新しいメール・セッションを作成します。 メール・セッションは、javax.mail.Session クラスによって表されます。 メール・セッション・オブジェクトは、ユーザーを認証して、メッセージング・システムへのユーザー・アクセスを制御します。 このスクリプトは、作成されたメール・セッションの構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| nodeName | 対象のノードの名前を指定します。 |
| serverName | 対象のサーバーの名前を指定します。 |
| mailProvider名前 | アプリケーション・サーバーがこのメール・セッション用に使用するメール・プロバイダーを指定します。 |
| mailSession名前 | JavaMail セッション・オブジェクトの管理名を指定します。 |
| JNDIName | ネーミング・サブコンテキストを含む、リソースの JNDI 名を指定します。 この名前は、クライアント・アプリケーションのデプロイメント記述子で定義されるリソースに対するプラットフォームのバインディング情報と、プラットフォームによって JNDI にバインドされる実際のリソースとの間のリンクを提供します。 |
構文
AdminResources.createMailSession(nodeName, serverName,
mailProviderName, mailSessionName, JNDIName)
使用例
AdminResources.createMailSession("myNode", "myServer", "myMailProvider",
"myMailSession", "myMailSession/jndi")
createMailSessionAtScope
このスクリプトは、指定した有効範囲でメール・プロバイダーの新規のメール・セッションを作成します。 メール・セッションは、javax.mail.Session クラスによって表されます。 メール・セッション・オブジェクトは、ユーザーを認証して、メッセージング・システムへのユーザー・アクセスを制御します。 このスクリプトは、指定した有効範囲の作成済みメール・セッションの構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| scope | メール・プロバイダーのセル、ノード、サーバー、またはクラスターの 有効範囲 を指定します。 |
| mailProvider名前 | アプリケーション・サーバーがこのメール・セッション用に使用するメール・プロバイダーを指定します。 |
| mailSession名前 | JavaMail セッション・オブジェクトの管理名を指定します。 |
| JNDIName | ネーミング・サブコンテキストを含む、リソースの JNDI 名を指定します。 この名前は、クライアント・アプリケーションのデプロイメント記述子で定義されるリソースに対するプラットフォームのバインディング情報と、プラットフォームによって JNDI にバインドされる実際のリソースとの間のリンクを提供します。 |
| otherAttributesリスト | オプションで、追加の属性を以下の特定のフォーマットで指定します。
|
| 属性 | 説明 |
|---|---|
| カテゴリー (Category) | リソースの分類またはグループ化に使用できるカテゴリーを指定します。 |
| DEBUG | このメール・セッションにデバッグ・モードを使用するかどうかを指定します。 デフォルト値は offです。 |
| 説明 | メール・プロバイダーの説明を指定します。 |
| mailFrom | インターネット E メール・アドレスを指定します。 true に設定すると、このメール・プロバイダーは独自のクラス・ローダーにロードされます。 注意: ネイティブ・ライブラリー・パスが指定されている場合は、プロバイダーを分離することはできません。
|
| mailStoreホスト | メールの受信時に接続するサーバーを指定します。 |
| mailStoreポート | メールの受信時に接続するポートを指定します。 |
| mailStoreユーザー | 受信メール・サーバーが認証を必要とする場合にメール・アカウントのユーザーを指定します。 |
| mailStoreパスワード | 受信メール・サーバーが認証を必要とする場合にメール・アカウントのパスワードを指定します。 |
| mailStoreプロトコル | メールの受信時に使用するプロトコルを指定します。 |
| mailTransportホスト | メールの送信時に接続するサーバーを指定します。 |
| mailTransportポート | メールの送信時に接続するポートを指定します。 |
| mailTransportユーザー | 送信メール・サーバーが認証を必要とする場合にメール・アカウントのユーザーを指定します。 |
| mailTransportパスワード | 送信メール・サーバーが認証を必要とする場合にメール・アカウントのパスワードを指定します。 |
| mailTransportプロトコル | メールの送信時に使用するプロトコルを指定します。 |
| 厳密 | 受信側アドレスが RFC 822 に従って解析されるかどうかを指定します。 デフォルト値は trueです。 |
構文
AdminResources.createMailSessionAtScope(scope,
mailProviderName, mailSessionName, JNDIName, otherAttributesList)
使用例
以下のスクリプト例には必須の属性のみが含まれています。
AdminResources.createMailSessionAtScope("myScope", "myMailProvider",
"myMailSession", "myMailSession/jndi", attributes")
AdminResources.createMailSessionAtScope("Node=MY4Node09, server=server1", "myMailProvider", "myMailSession",
"myMailSession/jndi", "category=myCategory, debug=true, description='this is my mailsession', mailStoreUser=user1,
mailStorePassword=password, mailStoreHost=user1, mailStorePort=1000, mailTransportUser=user2, mailTransportPassword=password,
mailTransportHost=test2, mailTransportPort=1001, strict=true, mailFrom=test1@gmail.com")以下のスクリプト例には、リスト・フォーマットのオプション属性が含まれています。
AdminResources.createMailSessionAtScope("/Cell:MY4Cell01/ServerClust
er:c1/", "myMailProvider", "myMailSession", "myMailSession/jndi",
[['category','myCategory'], ['description', 'this is mailsession'], ['debug', 'true'],
['mailTransportHost', 'test1'], ['mailTransportUser', 'user2'], ['mailTransportPassword', 'password'],
['mailStoreUser', 'user1'], ['mailStorePassword', 'password'], ['mailStoreHost', 'test2'], ['strict', 'true'],
['mailFrom', 'tester@mail.com']]))
createProtocolProvider
このスクリプトは、構成内にプロトコル・プロバイダーを作成します。プロトコル・プロバイダーは、JavaMail アプリケーションとメール・サーバー間の通信をサポートする特定プロトコルの実装クラスを提供します。 アプリケーション・サーバーには、SMTP、IMAP、および POP3 のプロトコル・プロバイダーが含まれています。 複数のプロトコル用の各カスタム・プロバイダーが必要な場合は、 これらのカスタム・プロバイダーをご使用のアプリケーション・サービス提供環境にインストールしてから、 プロバイダーの構成を行います。 ガイドラインについては、JavaMail API 設計仕様を参照してください。 プロトコル・プロバイダーを構成したら、メール・プロバイダーのページに戻って、 メール・セッションの構成用のリンクを見つけます。 このスクリプトは、作成されたプロトコル・プロバイダーの構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| nodeName | 対象のノードの名前を指定します。 |
| serverName | 対象のサーバーの名前を指定します。 |
| mailProvider名前 | アプリケーション・サーバーがプロトコル・プロバイダーと組み合わせて使用するメール・プロバイダーの名前を指定します。 |
| protocolName | プロトコル・プロバイダーの名前を指定します。 アプリケーション・サーバーには、SMTP、IMAP、および POP3 のプロトコル・プロバイダーが含まれています。 |
| className | プロトコル・プロバイダーの実装クラス名を指定します。 |
| タイプ | プロトコル・プロバイダーのタイプを指定します。 有効なオプションは次のとおりです。STOREまたはTRANSPORT. |
構文
AdminResources.createProtocolProvider(nodeName,
serverName, mailProviderName, protocolName,
className, type)
使用例
AdminResources.createProtocolProvider("myNode", "myServer", "myMailProvider",
"myMailProtocol", "com.ibm.mail.myMailProtocol.myMailStore",
"STORE")
createProtocolProviderAtScope
このスクリプトは、指定した有効範囲でご使用の構成にプロトコル・プロバイダーを作成します。 プロトコル・プロバイダーは、指定した有効範囲で JavaMail アプリケーションとメール・サーバー間の通信をサポートする特定プロトコルの実装クラスを提供します。 アプリケーション・サーバーには、SMTP、IMAP、および POP3 のプロトコル・プロバイダーが含まれています。 複数のプロトコル用の各カスタム・プロバイダーが必要な場合は、 これらのカスタム・プロバイダーをご使用のアプリケーション・サービス提供環境にインストールしてから、 プロバイダーの構成を行います。 ガイドラインについては、JavaMail API 設計仕様を参照してください。 プロトコル・プロバイダーを構成したら、メール・プロバイダーのページに戻って、 メール・セッションの構成用のリンクを見つけます。 このスクリプトは、指定した有効範囲の作成済みプロトコル・プロバイダーの構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| scope | メール・プロバイダーのセル、ノード、サーバー、またはクラスターの 有効範囲 を指定します。 |
| mailProvider名前 | アプリケーション・サーバーがプロトコル・プロバイダーと組み合わせて使用するメール・プロバイダーの名前を指定します。 |
| protocolName | プロトコル・プロバイダーの名前を指定します。 アプリケーション・サーバーには、SMTP、IMAP、および POP3 のプロトコル・プロバイダーが含まれています。 |
| className | プロトコル・プロバイダーの実装クラス名を指定します。 |
| タイプ | プロトコル・プロバイダーのタイプを指定します。 有効なオプションは次のとおりです。STOREまたはTRANSPORT. |
| otherAttributesリスト | オプションで、追加の属性を以下の特定のフォーマットで指定します。
|
| 属性 | 説明 |
|---|---|
| クラスパス | 組み合わせることでリソース・プロバイダー・クラスの場所を形成する、 パスまたは Java アーカイブ (JAR)・ファイル名のリストを指定します。 クラスパスは、セミコロン (;) を使用して区切ります。 |
構文
AdminResources.createProtocolProviderAtScope(nodeName,
serverName, mailProviderName, protocolName,
className, type, otherAttributesList)
使用例
以下のスクリプト例には必須の属性のみが含まれています。
AdminResources.createProtocolProviderAtScope("myScope", "myMailProvider",
"myMailProtocol", "com.ibm.mail.myMailProtocol.myMailStore",
"STORE")
AdminResources.createProtocolProviderAtScope("Node=MY4Node09, server=server1", "myMailProvider", "myMailProtocol",
“com.ibm.mail.myMailProtocol.myMailStore", "STORE", "classpath=c:/temp")以下のスクリプト例には、リスト・フォーマットのオプション属性が含まれています。
AdminResources.createProtocolProviderAtScope("/Cell:MY4Cell01/Server
Cluster:c1/", "myMailProvider", "myMailProtocol", "com.ibm.mail.myMailProtocol.m
yMailStore", "STORE", [['classpath', 'c:/temp']]))
createCompleteResourceEnvProvider
このスクリプトは、リソース環境プロバイダーを構成します。リソース環境プロバイダーは、構成内のリソース環境エントリー・データをリソース・オブジェクトに変換する referenceable をカプセル化します。 このスクリプトは、作成されたリソース環境プロバイダーの構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| nodeName | 対象のノードの名前を指定します。 |
| serverName | 対象のサーバーの名前を指定します。 |
| resourceEnvProviderName | リソース環境プロバイダーに割り当てる名前を指定します。 |
| propName | 設定するカスタム・プロパティーの名前を指定します。 |
| propValue | カスタム・プロパティーの値を指定します。 |
| factoryClass | リソース環境エントリー・データを物理リソースの クラス・インスタンスに変換するファクトリーを指定します。 |
| className | referenceable のクラス名を指定します。 |
| resourceEnvEntryName | リソース環境エントリーの名前を指定します。 |
| JNDIName | ネーミング・サブコンテキストを含む、リソース環境エントリーの JNDI 名を指定します。 この名前は、モジュールのデプロイメント記述子で定義されるリソースに対するプラットフォームのバインディング情報と、 プラットフォームによって JNDI 内にバインドされる実際のリソースとの間のリンケージとして使用します。 |
構文
AdminResources.createCompleteResourceEnvProvider(nodeName,
serverName, resourceEnvProviderName, propName,
propValue, factoryClass, className,
resourceEnvEntryName, JNDIName)
使用例
AdminResources.createCompleteResourceEnvProvider("myNode", "myServer",
"myResEnvProvider", "myProp", "myPropValue", "com.ibm.resource.res1", "java.lang.String",
"myResEnvEntry", "res1/myResEnv")
createCompleteResourceEnvProviderAtScope
このスクリプトは、指定した有効範囲でリソース環境プロバイダーを構成します。 リソース環境プロバイダーは、ご使用の構成内のリソース環境エントリー・データをリソース・オブジェクトに変換する referenceable をカプセル化します。 このスクリプトは、指定した有効範囲の作成済みリソース環境プロバイダーの構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| scope | メール・プロバイダーのセル、ノード、サーバー、またはクラスターの 有効範囲 を指定します。 |
| resourceEnvProviderName | リソース環境プロバイダーに割り当てる名前を指定します。 |
| propName | 設定するカスタム・プロパティーの名前を指定します。 |
| propValue | カスタム・プロパティーの値を指定します。 |
| factoryClass | リソース環境エントリー・データを物理リソースの クラス・インスタンスに変換するファクトリーを指定します。 |
| className | referenceable のクラス名を指定します。 |
| resourceEnvEntryName | リソース環境エントリーの名前を指定します。 |
| jndiName | ネーミング・サブコンテキストを含む、リソース環境エントリーの JNDI 名を指定します。 この名前は、モジュールのデプロイメント記述子で定義されるリソースに対するプラットフォームのバインディング情報と、 プラットフォームによって JNDI 内にバインドされる実際のリソースとの間のリンケージとして使用します。 |
| otherAttributesList、 resourceEnvProviderAttributesList、 resourceEnvEntryAttributesList | オプションで、追加の属性を以下の特定のフォーマットで指定します。
|
| 属性 | 説明 |
|---|---|
| クラスパス | 組み合わせることでリソース・プロバイダー・クラスの場所を形成する、 パスまたは Java アーカイブ (JAR)・ファイル名のリストを指定します。 クラスパスは、セミコロン (;) を使用して区切ります。 |
| 説明 | リソース環境プロバイダーの説明を指定します。 |
| isolatedClassローダー | true に設定すると、リソース環境プロバイダーが独自のクラス・ローダーにロードされるように指定されます。 重要: ネイティブ・ライブラリー・パスが指定されている場合、プロバイダーを分離することはできません。
|
| nativePath | *.dll や *.so などの任意のネイティブ・ライブラリーへのオプションのパスを指定します。 ネイティブ・パス・エントリーはセミコロン (;) を使用して区切ります。 |
| providerType | このリソース環境プロバイダーが使用するリソース・プロバイダー・タイプを指定します。 |
| 属性 | 説明 |
|---|---|
| カテゴリー (Category) | リソースの分類またはグループ化に使用できるカテゴリーを指定します。 |
| 説明 | リソース・プロバイダーの説明を指定します。 |
| providerType | このリソース環境プロバイダーが使用するメール・プロバイダー・タイプを指定します。 |
| Referenceable | Referenceable を指定します。Referenceable は、リソース環境エントリー・データを、物理リソースを表すクラス・インスタンスに変換する、ファクトリーのクラス名をカプセル化します。 |
構文
AdminResources.createCompleteResourceEnvProviderAtScope(scope,
resourceEnvProviderName, propName,
propValue, factoryClass, className,
resourceEnvEntryName, JNDIName, otherAttributesList,
resourceEnvProviderAttributesList, resourceEnvProviderAttributesList)
使用例
以下のスクリプト例には必須の属性のみが含まれています。
AdminResources.createCompleteResourceEnvProviderAtScope("myScope",
"myResEnvProvider", "myProp", "myPropValue", "com.ibm.resource.res1", "java.lang.String",
"myResEnvEntry", "res1/myResEnv")
AdminResources.createCompleteResourceEnvProviderAtScope("Node=MY4Node09, server=server1", "myResEnvProvider", "myProp",
"myPropValue", "com.ibm.resource.res1", "java.lang.String", "myResEnvEntry", "res1/myResEnv", "classpath=c:/temp,
description='this is my resource provider', nativepath=c:/temp/nativepath,
isolatedClassLoader=false", "category=myCategory, description='this is my resource entry',
referenceable=(cells/MY4Cell01/nodes/MY4Node09|resources.xml#Referenceable_1238331401156)")以下のスクリプト例には、リスト・フォーマットのオプション属性が含まれています。
AdminResources.createCompleteResourceEnvProviderAtScope("/Cell:MY4Cell01/ServerCluster:c1/", "myResEnvProvider",
"myProp", "myPropValue", "com.ibm.resource.res1", "java.lang.String", "myResEnvEntry", "res1/myResEnv", [['classpath', 'c:/temp'],
['description', 'this is my resource provider'], ['nativepath','c:/temp/nativepath'], ['isolatedClassLoader', 'false']]
[['category', 'myCategory'], ['description', 'this is my resource entry'],
['referenceable', '(cells/MY4Cell01/nodes/MY4Node09|resources.xml#Referenceable_1238331401156)']])
createResourceEnvEntries
このスクリプトは、構成内にリソース環境エントリーを作成します。 アプリケーション・サーバーの名前空間内では、リソース環境エントリーに含まれるデータは、物理リソースを表すオブジェクトに変換されます。 このリソースは通常、環境リソースと呼ばれます。 このスクリプトは、作成されたリソース環境エントリーの構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| nodeName | 対象のノードの名前を指定します。 |
| serverName | 対象のサーバーの名前を指定します。 |
| resourceEnvProviderName | このエントリーのリソース環境プロバイダーを指定します。 このプロバイダーは、実装時にリソース環境エントリー・データをリソース・オブジェクトに変換するクラスをカプセル化します。 |
| Referenceable | Referenceable を指定します。Referenceable は、リソース環境エントリー・データを、物理リソースを表すクラス・インスタンスに変換する、ファクトリーのクラス名をカプセル化します。 |
| resourceEnvエントリー | 作成するリソース環境エントリーの名前を指定します。 |
| JNDIName | JNDI を使用してこの環境リソースを検索するために使用するストリングを指定します。 このストリングに、リソース環境参照デプロイメント記述子をバインドします。 |
構文
AdminResources.createResourceEnvEntries(nodeName,
serverName, resourceEnvProviderName, referenceable,
resourceEnvEntry, JNDIName)
使用例
AdminResources.createResourceEnvEntries("myNode", "myServer",
"myResEnvProvider", "com.ibm.resource.res1", "myResEnvEntry", "res1/myResEnv")
createResourceEnvEntriesAtScope
このスクリプトは、指定した有効範囲でご使用の構成にリソース環境エントリーを作成します。 アプリケーション・サーバーの名前空間内では、リソース環境エントリーに含まれるデータは、物理リソースを表すオブジェクトに変換されます。 このリソースは通常、環境リソースと呼ばれます。 このスクリプトは、指定した有効範囲の作成済みリソース環境エントリーの構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| scope | メール・プロバイダーのセル、ノード、サーバー、またはクラスターの 有効範囲 を指定します。 |
| resourceEnvProviderName | このエントリーのリソース環境プロバイダーを指定します。 このプロバイダーは、実装時にリソース環境エントリー・データをリソース・オブジェクトに変換するクラスをカプセル化します。 |
| resourceEnvエントリー | 作成するリソース環境エントリーの名前を指定します。 |
| JNDIName | JNDI を使用してこの環境リソースを検索するために使用するストリングを指定します。 このストリングに、リソース環境参照デプロイメント記述子をバインドします。 |
| otherAttributesリスト | オプションで、追加の属性を以下の特定のフォーマットで指定します。
|
| 属性 | 説明 |
|---|---|
| カテゴリー (Category) | リソースの分類またはグループ化に使用できるカテゴリーを指定します。 |
| 説明 | リソース・プロバイダーの説明を指定します。 |
| providerType | このリソース環境プロバイダーが使用するメール・プロバイダー・タイプを指定します。 |
| Referenceable | Referenceable を指定します。Referenceable は、リソース環境エントリー・データを、物理リソースを表すクラス・インスタンスに変換する、ファクトリーのクラス名をカプセル化します。 |
構文
AdminResources.createResourceEnvEntriesAtScope(scope,
resourceEnvProviderName,
resourceEnvEntry, JNDIName, otherAttributesList)
使用例
以下のスクリプト例には必須の属性のみが含まれています。
AdminResources.createResourceEnvEntriesAtScope("myScope",
"myResEnvProvider", "myResEnvEntry", "res1/myResEnv")
AdminResources.createResourceEnvEntriesAtScope("Node=MY4Node09, server=server1", "myResEnvProvider",
"myResEnvEntry", "res1/myResEnv", "category=myCategory, description='this is my resource entry',
referenceable=(cells/MY4Cell01/nodes/MY4Node09|resources.xml#Referenceable_1238331401156)")以下のスクリプト例には、リスト・フォーマットのオプション属性が含まれています。
AdminResources.createResourceEnvEntriesAtScope("/Cell:MY4Cell01/ServerCluster:c1/", "myResEnvProvider",
"myResEnvEntry", "res1/myResEnv", [['category', 'myCategory'], ['description', 'this is my resource entry'],
['referenceable', '(cells/MY4Cell01/nodes/MY4Node09|resources.xml#Referenceable_1238331401156)']])
createResourceEnvProvider
このスクリプトは、構成内にリソース環境プロバイダーを作成します。 リソース環境プロバイダーは、実装時にリソース環境エントリー・データをリソース・オブジェクトに変換するクラスをカプセル化します。 このスクリプトは、作成されたリソース環境プロバイダーの構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| nodeName | 対象のノードの名前を指定します。 |
| serverName | 対象のサーバーの名前を指定します。 |
| resourceEnvProviderName | 作成するリソース環境プロバイダーを指定します。 |
構文
AdminResources.createResourceEnvProvider(nodeName,
serverName, resourceEnvProviderName)
使用例
AdminResources.createResEnvProvider("myNode", "myServer",
"myResEnvProvider")
createResourceEnvProviderAtScope
このスクリプトは、指定した有効範囲でご使用の構成にリソース環境プロバイダーを作成します。 リソース環境プロバイダーは、実装時にリソース環境エントリー・データをリソース・オブジェクトに変換するクラスをカプセル化します。 このスクリプトは、指定した有効範囲の作成済みリソース環境プロバイダーの構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| scope | メール・プロバイダーのセル、ノード、サーバー、またはクラスターの 有効範囲 を指定します。 |
| resourceEnvProviderName | 作成するリソース環境プロバイダーを指定します。 |
| otherAttributesリスト | オプションで、追加の属性を以下の特定のフォーマットで指定します。
|
| 属性 | 説明 |
|---|---|
| クラスパス | 組み合わせることでリソース・プロバイダー・クラスの場所を形成する、 パスまたは Java アーカイブ (JAR)・ファイル名のリストを指定します。 クラスパスは、セミコロン (;) を使用して区切ります。 |
| 説明 | リソース環境プロバイダーの説明を指定します。 |
| isolatedClassローダー | true に設定すると、リソース環境プロバイダーが独自のクラス・ローダーにロードされるように指定されます。 重要: ネイティブ・ライブラリー・パスが指定されている場合、プロバイダーを分離することはできません。
|
| nativePath | *.dll や *.so などの任意のネイティブ・ライブラリーへのオプションのパスを指定します。 ネイティブ・パス・エントリーはセミコロン (;) を使用して区切ります。 |
| providerType | このリソース環境プロバイダーが使用するリソース・プロバイダー・タイプを指定します。 |
構文
AdminResources.createResourceEnvProviderAtScope(scope,
resourceEnvProviderName, otherAttributesList)
使用例
以下のスクリプト例には必須の属性のみが含まれています。
AdminResources.createResEnvProviderAtScope("myScope",
"myResEnvProvider")
AdminResources.createResourceEnvProviderAtScope("Node=MY4Node09, server=server1", "myResEnvProvider",
"classpath=c:/temp, description='this is my resource provider', nativepath=c:/temp/nativepath, isolatedClassLoader=false")以下のスクリプト例には、リスト・フォーマットのオプション属性が含まれています。
AdminResources.createResourceEnvProviderAtScope("/Cell:MY4Cell01/ServerCluster:c1/",
"myResEnvProvider", [['classpath', 'c:/temp'],
['description','this is my resource provider'], ['nativepath', 'c:/temp/nativepath'], ['isolatedClassLoader', 'false']])
createResourceEnvProviderRef
このスクリプトは、構成内にリソース環境プロバイダー参照を作成します。 リソース環境参照は、リソース参照とは異なります。 リソース環境参照を使用すると、アプリケーション・クライアントが論理名を使用して、 サーバー JNDI 名前空間にバインドされているリソースを検索できます。 リソース参照を使用すると、アプリケーションは論理名を使用して、 ローカル JEE リソースを検索できます。 JEE 仕様では、リソースの特定の実装を指定しません。 このスクリプトは、作成されたリソース環境プロバイダー参照 ID の構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| nodeName | 対象のノードの名前を指定します。 |
| serverName | 対象のサーバーの名前を指定します。 |
| resourceEnvProviderName | この参照用のリソース環境プロバイダーを指定します。 このプロバイダーは、実装時にリソース環境エントリー・データをリソース・オブジェクトに変換するクラスをカプセル化します。 |
| factoryClass | リソース環境エントリー・データを物理リソースの クラス・インスタンスに変換するファクトリーのクラスを指定します。 |
| className | referenceable と関連付けるクラス名を指定します。 |
構文
AdminResources.createResourceEnvProviderRef(nodeName,
serverName, resourceEnvProviderName, factoryClass,
className)
使用例
AdminResources.createResourceEnvProviderRef("myNode", "myServer",
"myResEnvProvider", "com.ibm.resource.res1", "java.lang.String")
createResourceEnvProviderRefAtScope
このスクリプトは、指定した有効範囲でご使用の構成にリソース環境プロバイダー参照を作成します。 リソース環境参照は、リソース参照とは異なります。 リソース環境参照を使用すると、アプリケーション・クライアントが論理名を使用して、 サーバー JNDI 名前空間にバインドされているリソースを検索できます。 リソース参照を使用すると、アプリケーションは論理名を使用して、 ローカル JEE リソースを検索できます。 JEE 仕様では、リソースの特定の実装を指定しません。 このスクリプトは、指定した有効範囲の作成済みリソース環境プロバイダー参照 ID の構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| scope | メール・プロバイダーのセル、ノード、サーバー、またはクラスターの 有効範囲 を指定します。 |
| resourceEnvProviderName | この参照用のリソース環境プロバイダーを指定します。 このプロバイダーは、実装時にリソース環境エントリー・データをリソース・オブジェクトに変換するクラスをカプセル化します。 |
| factoryClass | リソース環境エントリー・データを物理リソースの クラス・インスタンスに変換するファクトリーのクラスを指定します。 |
| className | referenceable と関連付けるクラス名を指定します。 |
構文
AdminResources.createResourceEnvProviderRefAtScope(scope,
resourceEnvProviderName, factoryClass,
className, otherAttributesList)
使用例
AdminResources.createResourceEnvProviderRefAtScope("/Node:MY4Node09/Server:server1/",
"myResEnvProvider", "com.ibm.resource.res1", "java.lang.String")
configURLProvider
このスクリプトは、URL プロバイダーを構成します。URL プロバイダーは、アプリケーション・サーバーが特定のプロトコルを介して URL にアクセスするために必要な実装クラスを提供します。 デフォルトの URL プロバイダーは、 IBM® Developer Kit でサポートされているプロトコルを介して接続を提供します。 これらのプロトコルには、HTTP と FTP (File Transfer Protocol: ファイル転送プロトコル) が含まれており、 これらはほとんどの URL に対応しています。
| 引数 | 説明 |
|---|---|
| nodeName | 対象のノードの名前を指定します。 |
| serverName | 対象のサーバーの名前を指定します。 |
| URLProviderName | 構成する URL プロバイダーの名前を指定します。 |
| URLStreamHandlerクラス | 特定の URL プロトコル (FTP など) の java.net.URLStreamHandler クラスを拡張するユーザー定義 Java クラスの完全修飾名を指定します。 |
| URLProtocol (URLProtocol) | このストリーム・ハンドラーがサポートするプロトコルを指定します。 例えば、NNTP、SMTP、FTP などです。 |
| propName | URL プロバイダーに対して設定するカスタム・プロパティーの名前を指定します。 |
| propValue | URL プロバイダーに対して設定するカスタム・プロパティーの値を指定します。 |
| URLNAME | インターネットまたはイントラネットのリソースを指す URL 名を指定します。 例: https://www.ibm.com |
| JNDIName | JNDI 名を指定します。 異なるリソース・タイプにまたがる重複したメール・セッションに対する URL 構成など JNDI 名を割り当てないでください。 同じ有効範囲の同じタイプの複数のリソースに、重複した JNDI 名を割り当てないでください。 |
| URLSpec (URLSpec) | URL の形成元のストリングを指定します。 |
構文
AdminResources.configURLProvider(nodeName, serverName,
URLProviderName, URLStreamHandlerClass, URLProtocol,
propName, propValue, URLName, JNDIName,
URLSpec)
使用例
AdminResources.configURLProvider("myNode", "myServer", "myURLProvider",
"com.ibm.resource.url1", "ftp", "myProp", "myPropValue", "myURL", "url1/myURL",
"myURLSpec")
createCompleteURLProvider
このスクリプトは、URL プロバイダーを作成します。URL プロバイダーは、アプリケーション・サーバーが特定のプロトコルを介して URL にアクセスするために必要な実装クラスを提供します。 デフォルトの URL プロバイダーは、 IBM Developer Kit でサポートされているプロトコルを介して接続を提供します。 これらのプロトコルには、HTTP と FTP (File Transfer Protocol: ファイル転送プロトコル) が含まれており、 これらはほとんどの URL に対応しています。 このスクリプトは、作成された URL プロバイダーの構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| nodeName | 対象のノードの名前を指定します。 |
| serverName | 対象のサーバーの名前を指定します。 |
| URLProviderName | 構成する URL プロバイダーの名前を指定します。 |
| URLStreamHandlerクラス | 特定の URL プロトコル (FTP など) の java.net.URLStreamHandler クラスを拡張するユーザー定義 Java クラスの完全修飾名を指定します。 |
| URLProtocol (URLProtocol) | このストリーム・ハンドラーがサポートするプロトコルを指定します。 例えば、NNTP、SMTP、FTP などです。 |
構文
AdminResources.createCompleteURLProvider(nodeName,
serverName, URLProviderName, URLStreamHandlerClass,
URLProtocol)
使用例
AdminResources.createCompleteURLProvider("myNode", "myServer",
"myURLProvider", "com.ibm.resource.url1", "ftp")
createCompleteURLProviderAtScope
このスクリプトは、指定した有効範囲で URL プロバイダーを作成します。 URL プロバイダーは、アプリケーション・サーバーが特定のプロトコルを介して URL にアクセスするために必要な実装クラスを提供します。 デフォルトの URL プロバイダーは、 IBM Developer Kit でサポートされているプロトコルを介して接続を提供します。 これらのプロトコルには、HTTP と FTP (File Transfer Protocol: ファイル転送プロトコル) が含まれており、 これらはほとんどの URL に対応しています。 このスクリプトは、指定した有効範囲の作成済み URL プロバイダーの構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| scope | メール・プロバイダーのセル、ノード、サーバー、またはクラスターの 有効範囲 を指定します。 |
| URLProviderName | 構成する URL プロバイダーの名前を指定します。 |
| URLStreamHandlerクラス | 特定の URL プロトコル (FTP など) の java.net.URLStreamHandler クラスを拡張するユーザー定義 Java クラスの完全修飾名を指定します。 |
| URLProtocol (URLProtocol) | このストリーム・ハンドラーがサポートするプロトコルを指定します。 例えば、NNTP、SMTP、FTP などです。 |
| propName | URL プロバイダーに対して設定するカスタム・プロパティーの名前を指定します。 |
| propValue | URL プロバイダーに対して設定するカスタム・プロパティーの値を指定します。 |
| URLNAME | インターネットまたはイントラネットのリソースを指す URL 名を指定します。 例: https://www.ibm.com |
| jndiName | JNDI 名を指定します。 異なるリソース・タイプにまたがる重複したメール・セッションに対する URL 構成など JNDI 名を割り当てないでください。 同じ有効範囲の同じタイプの複数のリソースに、重複した JNDI 名を割り当てないでください。 |
| URLSpec (URLSpec) | URL の形成元のストリングを指定します。 |
| otherAttributesList、 urlProviderAttributesList、 urlAttributesList | オプションで、追加の属性を以下の特定のフォーマットで指定します。
|
| 属性 | 説明 |
|---|---|
| クラスパス | 組み合わせることでリソース・プロバイダー・クラスの場所を形成する、 パスまたは Java アーカイブ (JAR)・ファイル名のリストを指定します。 クラスパスは、セミコロン (;) を使用して区切ります。 |
| 説明 | リソース環境プロバイダーの説明を指定します。 |
| isolatedClassローダー | true に設定すると、この URL プロバイダーが独自のクラス・ローダーにロードされるように指定されます。 重要: ネイティブ・ライブラリー・パスが指定されている場合、プロバイダーを分離することはできません。
|
| nativePath | *.dll や *.so などの任意のネイティブ・ライブラリーへのオプションのパスを指定します。 ネイティブ・パス・エントリーはセミコロン (;) を使用して区切ります。 |
| providerType | このリソース環境プロバイダーが使用する URL プロバイダー・タイプを指定します。 |
| 属性 | 説明 |
|---|---|
| カテゴリー (Category) | リソースの分類またはグループ化に使用できるカテゴリーを指定します。 |
| 説明 | リソース・プロバイダーの説明を指定します。 |
| providerType | このリソース環境プロバイダーが使用するメール・プロバイダー・タイプを指定します。 |
| Referenceable | Referenceable を指定します。Referenceable は、リソース環境エントリー・データを、物理リソースを表すクラス・インスタンスに変換する、ファクトリーのクラス名をカプセル化します。 |
構文
AdminResources.createCompleteURLProviderAtScope(Scope,
URLProviderName, URLStreamHandlerClass,
URLProtocol, propName, propValue,
URLName, JNDIName, URLSpec, otherAttributesList,
urlProviderAttributesList, urlAttributesList)
使用例
以下のスクリプト例には必須の属性のみが含まれています。
AdminResources.createCompleteURLProviderAtScope("Scope",
"myURLProvider", "com.ibm.resource.url1", "ftp", myProp", myPropValue",
"myURL", "url1/myURL", "myURLSpec")
AdminResources.createCompleteURLProviderAtScope("Node=MY4Node09, server=server1", "myURLProvider",
"com.ibm.resource.url1",
"ftp","myProp", "myPropValue", "myURL", "url1/myURL", "myURLSpec", "classpath=c:/temp, description='this
is my url provider',
nativepath=c:/temp/nativepath, isolatedClassLoader=true", "category=myCategory, description='this is my url'")以下のスクリプト例には、リスト・フォーマットのオプション属性が含まれています。
AdminResources.createCompleteURLProviderAtScope("/Cell:MY4Cell01/ServerCluster:c1/",
"myURLProvider", "com.ibm.resource.url1",
"ftp","myProp", "myPropValue", "myURL", "url1/myURL", "myURLSpec", [['classpath', 'c:/temp'],
['description', 'this is my urlProvider'],
['nativepath', 'c:/temp/nativepath'], ['isolatedClassLoader', 'true']] [['category', 'myCategory'],
['description', 'this is my url']])
createURL
このスクリプトは、URL プロバイダーを作成します。URL プロバイダーは、アプリケーション・サーバーが特定のプロトコルを介して URL にアクセスするために必要な実装クラスを提供します。 デフォルトの URL プロバイダーは、 IBM Developer Kit でサポートされているプロトコルを介して接続を提供します。 これらのプロトコルには、HTTP と FTP (File Transfer Protocol: ファイル転送プロトコル) が含まれており、 これらはほとんどの URL に対応しています。 このスクリプトは、作成された URL の構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| nodeName | 対象のノードの名前を指定します。 |
| serverName | 対象のサーバーの名前を指定します。 |
| URLProviderName | URL を割り当てる URL プロバイダーの名前を指定します。 |
| URLNAME | 作成する URL の名前を指定します。 |
| JNDIName | JNDI 名を指定します。 異なるリソース・タイプにまたがる重複したメール・セッションに対する URL 構成など JNDI 名を割り当てないでください。 同じ有効範囲の同じタイプの複数のリソースに、重複した JNDI 名を割り当てないでください。 |
| URLSpec (URLSpec) | URL の形成元のストリングを指定します。 |
構文
AdminResources.createURL(nodeName, serverName,
URLProviderName, URLName, JNDIName,
URLSpec)
使用例
AdminResources.createURL("myNode", "myServer", "myURLProvider",
"myURL", "url1/myURL", "myURLSpec")
createURLAtScope
このスクリプトは、指定した有効範囲で URL プロバイダーを作成します。 URL プロバイダーは、アプリケーション・サーバーが特定のプロトコルを介して URL にアクセスするために必要な実装クラスを提供します。 デフォルトの URL プロバイダーは、 IBM Developer Kit でサポートされているプロトコルを介して接続を提供します。 これらのプロトコルには、HTTP と FTP (File Transfer Protocol: ファイル転送プロトコル) が含まれており、 これらはほとんどの URL に対応しています。 このスクリプトは、指定した有効範囲の作成済み URL の構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| scope | メール・プロバイダーのセル、ノード、サーバー、またはクラスターの 有効範囲 を指定します。 |
| URLProviderName | URL を割り当てる URL プロバイダーの名前を指定します。 |
| URLNAME | 作成する URL の名前を指定します。 |
| JNDIName | JNDI 名を指定します。 異なるリソース・タイプにまたがる重複したメール・セッションに対する URL 構成など JNDI 名を割り当てないでください。 同じ有効範囲の同じタイプの複数のリソースに、重複した JNDI 名を割り当てないでください。 |
| URLSpec (URLSpec) | URL の形成元のストリングを指定します。 |
| otherAttributesリスト | オプションで、追加の属性を以下の特定のフォーマットで指定します。
|
| 属性 | 説明 |
|---|---|
| カテゴリー (Category) | リソースの分類またはグループ化に使用できるカテゴリーを指定します。 |
| 説明 | URL プロバイダーの説明を指定します。 |
| providerType | この URL プロバイダーが使用するメール・プロバイダー・タイプを指定します。 |
構文
AdminResources.createURLAtScope(scope,
URLProviderName, URLName, JNDIName,
URLSpec, otherAttributesList)
使用例
以下のスクリプト例には必須の属性のみが含まれています。
AdminResources.createURLAtScope("myScope", "myURLProvider",
"myURL", "url1/myURL", "myURLSpec")
AdminResources.createURLAtScope("Node=MY4Node09, server=server1", "myURLProvider", "myURL", "url1/myURL",
"myURLSpec", "category=myCategory, description='this is my url'")以下のスクリプト例には、リスト・フォーマットのオプション属性が含まれています。
AdminResources.createURLAtScope("/Cell:MY4Cell01/ServerCluster:c1/",
"myURLProvider", "myURL", "url1/myURL", "myURLSpec", [['category', 'myCategory'], ['description', 'this is my url']])
createURLProvider
このスクリプトは、URL プロバイダーを作成します。URL プロバイダーは、アプリケーション・サーバーが特定のプロトコルを介して URL にアクセスするために必要な実装クラスを提供します。 デフォルトの URL プロバイダーは、 IBM Developer Kit でサポートされているプロトコルを介して接続を提供します。 これらのプロトコルには、HTTP と FTP (File Transfer Protocol: ファイル転送プロトコル) が含まれており、 これらはほとんどの URL に対応しています。 このスクリプトは、作成された URL プロバイダーの構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| nodeName | 対象のノードの名前を指定します。 |
| serverName | 対象のサーバーの名前を指定します。 |
| URLProviderName | 構成する URL プロバイダーの名前を指定します。 |
| URLStreamHandlerクラス | 特定の URL プロトコル (FTP など) の java.net.URLStreamHandler クラスを拡張するユーザー定義 Java クラスの完全修飾名を指定します。 |
| URLProtocol (URLProtocol) | このストリーム・ハンドラーがサポートするプロトコルを指定します。 例えば、NNTP、SMTP、FTP などです。 |
構文
AdminResources.createURLProvider(nodeName,
serverName, URLProviderName, URLStreamHandlerClass,
URLProtocol)
使用例
AdminResources.createURLProvider("myNode", "myServer",
"myURLProvider", "com.ibm.resource.url1", "ftp")
createURLProviderAtScope
このスクリプトは、指定した有効範囲で URL プロバイダーを作成します。 URL プロバイダーは、アプリケーション・サーバーが特定のプロトコルを介して URL にアクセスするために必要な実装クラスを提供します。 デフォルトの URL プロバイダーは、 IBM Developer Kit でサポートされているプロトコルを介して接続を提供します。 これらのプロトコルには、HTTP と FTP (File Transfer Protocol: ファイル転送プロトコル) が含まれており、 これらはほとんどの URL に対応しています。 このスクリプトは、指定した有効範囲の作成済み URL プロバイダーの構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| scope | メール・プロバイダーのセル、ノード、サーバー、またはクラスターの 有効範囲 を指定します。 |
| URLProviderName | 構成する URL プロバイダーの名前を指定します。 |
| URLStreamHandlerクラス | 特定の URL プロトコル (FTP など) の java.net.URLStreamHandler クラスを拡張するユーザー定義 Java クラスの完全修飾名を指定します。 |
| URLProtocol (URLProtocol) | このストリーム・ハンドラーがサポートするプロトコルを指定します。 例えば、NNTP、SMTP、FTP などです。 |
| otherAttributesリスト | オプションで、追加の属性を以下の特定のフォーマットで指定します。
|
| 属性 | 説明 |
|---|---|
| クラスパス | 組み合わせることでリソース・プロバイダー・クラスの場所を形成する、 パスまたは Java アーカイブ (JAR)・ファイル名のリストを指定します。 クラスパスは、セミコロン (;) を使用して区切ります。 |
| 説明 | リソース環境プロバイダーの説明を指定します。 |
| isolatedClassローダー | true に設定すると、この URL プロバイダーが独自のクラス・ローダーにロードされるように指定されます。 重要: ネイティブ・ライブラリー・パスが指定されている場合、プロバイダーを分離することはできません。
|
| nativePath | *.dll や *.so などの任意のネイティブ・ライブラリーへのオプションのパスを指定します。 ネイティブ・パス・エントリーはセミコロン (;) を使用して区切ります。 |
| providerType | このリソース環境プロバイダーが使用する URL プロバイダー・タイプを指定します。 |
構文
AdminResources.createURLProviderAtScope(scope,
URLProviderName, URLStreamHandlerClass,
URLProtocol, otherAttributesList)
使用例
以下のスクリプト例には必須の属性のみが含まれています。
AdminResources.createURLProviderAtScope("myScope",
"myURLProvider", "com.ibm.resource.url1", "ftp")
AdminResources.createURLProviderAtScope("Node=MY4Node09, server=server1", "myURLProvider", "com.ibm.resource.url1",
"ftp", "classpath=c:/temp, description='this is my url provider', nativepath=c:/temp/nativepath, isolatedClassLoader=true")以下のスクリプト例には、リスト・フォーマットのオプション属性が含まれています。
AdminResources.createURLProviderAtScope("/Cell:MY4Cell01/ServerCluster:c1/", "myURLProvider", "com.ibm.resource.url1",
"ftp", [['classpath', 'c:/temp'], ['description', 'this is my url provider'], ['nativepath', 'c:/temp/nativepath'],
['isolatedClassLoader', 'true']])
createJAASAuthenticationAlias
このスクリプトは、Java 認証・承認サービス (JAAS) 認証別名を作成します。 この別名は、認証データ・エントリーを識別します。 管理者は、リソース・アダプターまたはデータ・ソースを構成する際に、 対応する別名を使用して、選択する認証データを指定することができます。 このスクリプトは、作成された DB2®認証・承認サービス (JAAS) 認証別名の構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| authAlias名前 | 作成する認証別名の名前を指定します。 |
| authAliasID | 対象となるセキュリティー・ドメインのユーザー ID。 例えば、特定の認証データ・エントリーを使用して DB2への新規接続を開く場合、このエントリーには DB2 ユーザー ID が含まれます。 |
| authAliasPW | 構成リポジトリー内でエンコードされるユーザ ID のパスワードを指定します。 |
構文
AdminResources.createJAASAuthenticationAlias(authAliasName,
authAliasID, authAliasPW)
使用例
AdminResources.createJAASAuthenticationAlias("myJAAS", "user01",
"password")
createLibraryRef
このスクリプトは、グローバル・ライブラリーの使用法を定義するライブラリー参照を作成します。 サーバーにデプロイされている複数のアプリケーションがライブラリー・ファイルを使用できるようにするには、まず、 アプリケーションで必要な個々のライブラリー・ファイルに対して共有ライブラリーを作成します。 共有ライブラリーを作成する場合は、ライブラリー・ファイル用の変数を設定します。 このスクリプトは、作成されたライブラリー参照の構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| libraryRef名前 | 作成するライブラリー参照の名前を指定します。 |
| applicationName | ライブラリー参照と関連付けるアプリケーションの名前を指定します。 |
構文
AdminResources.createLibraryRef(libraryRefName,
applicationName)
使用例
AdminResources.createLibraryRef("myLibrary", "myApplication")
createSharedLibrary
このスクリプトは、構成内に共有ライブラリーを作成します。 サーバーにデプロイされている複数のアプリケーションがライブラリー・ファイルを使用できるようにするには、まず、 アプリケーションで必要な個々のライブラリー・ファイルに対して共有ライブラリーを作成します。 共有ライブラリーを作成する場合は、ライブラリー・ファイル用の変数を設定します。 このスクリプトは、作成されたライブラリーの構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| nodeName | 対象のノードの名前を指定します。 |
| serverName | 対象のサーバーの名前を指定します。 |
| sharedLib名前 | 共有ライブラリーに割り当てる名前を指定します。 |
| sharedLibClassPath | 製品が共有ライブラリーのクラスとリソースを検索する場所のファイル・パスを指定します。 リスト内のパスがファイルである場合、製品はその .jar または 圧縮 .zip ファイルの内容を検索します。 リスト内のパスがディレクトリーである場合、製品はそのディレクトリー内の .jar および .zip ファイルの内容を検索します。 パフォーマンス上の理由から、製品は、 ディレクトリーにサブディレクトリーまたは .jar または .zip ファイル以外のファイルが含まれている場合に限り、 ディレクトリーそのものを検索します。 |
構文
AdminResources.createSharedLibrary(nodeName,
serverName, sharedLibName, sharedLibClassPath)
使用例
AdminResources.createSharedLibrary("myNode", "myServer",
"myLibrary", "c:/myLibrary.zip")AdminResources.createSharedLibrary("myNode", "myServer", "myLibrary",
"/myLibrary.zip")
createSharedLibraryAtScope
このスクリプトは、指定した有効範囲でご使用の構成に共有ライブラリーを作成します。 サーバーにデプロイされている複数のアプリケーションがライブラリー・ファイルを使用できるようにするには、まず、 アプリケーションで必要な個々のライブラリー・ファイルに対して共有ライブラリーを作成します。 共有ライブラリーを作成する場合は、ライブラリー・ファイル用の変数を設定します。 このスクリプトは、指定した有効範囲の作成済みライブラリーの構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| scope | メール・プロバイダーのセル、ノード、サーバー、またはクラスターの 有効範囲 を指定します。 |
| sharedLib名前 | 共有ライブラリーに割り当てる名前を指定します。 |
| sharedLibClassPath | 製品が共有ライブラリーのクラスとリソースを検索する場所のファイル・パスを指定します。 リスト内のパスがファイルである場合、製品はその .jar または 圧縮 .zip ファイルの内容を検索します。 リスト内のパスがディレクトリーである場合、製品はそのディレクトリー内の .jar および .zip ファイルの内容を検索します。 パフォーマンス上の理由から、製品は、 ディレクトリーにサブディレクトリーまたは .jar または .zip ファイル以外のファイルが含まれている場合に限り、 ディレクトリーそのものを検索します。 |
| otherAttributesリスト | オプションで、追加の属性を以下の特定のフォーマットで指定します。
|
| 属性 | 説明 |
|---|---|
| 説明 | 共有ライブラリーの説明を指定します。 |
| isolatedClassローダー | true に設定すると、URL プロバイダーが独自のクラス・ローダーにロードされるように指定されます。 デフォルト値は falseです。重要: ネイティブ・ライブラリー・パスが指定されている場合、プロバイダーを分離することはできません。
|
| nativePath | *.dll や *.so などの任意のネイティブ・ライブラリーへのオプションのパスを指定します。 ネイティブ・パス・エントリーはセミコロン (;) を使用して区切ります。 |
構文
AdminResources.createSharedLibraryAtScope(scope,
sharedLibName, sharedLibClassPath, otherAttributesList)
使用例
以下のスクリプト例には必須の属性のみが含まれています。
AdminResources.createSharedLibraryAtScope("myScope",
"myLibrary", "c:/myLibrary.zip")AdminResources.createSharedLibraryAtScope("myScope", "myLibrary",
"/myLibrary.zip")
以下のスクリプト例には、ストリング・フォーマットのオプション属性が含まれています。
AdminResources.createSharedLibraryAtScope("Node=MY4Node09, server=server1", "myLibrary",
"c:/myLibrary.zip", "description='this is my library',
nativePath=c:/nativepath, isolatedClassLoader=true") AdminResources.createSharedLibraryAtScope("Node=MY4Node09, server=server1", "myLibrary",
"c:/myLibrary.zip", "description='this is my library',
nativePath=/nativepath, isolatedClassLoader=true")
以下のスクリプト例には、リスト・フォーマットのオプション属性が含まれています。
AdminResources.createSharedLibraryAtScope("/Cell:MY4Cell01/ServerCluster:c1/", "myLibrary",
"c:/myLibrary.zip", [['description', 'this is my library'],
['nativePath', 'c:/nativepath'], ['isolatedClassLoader', 'true']])AdminResources.createSharedLibraryAtScope("/Cell:MY4Cell01/ServerCluster:c1/", "myLibrary",
"c:/myLibrary.zip", [['description', 'this is my library'],
['nativePath', '/nativepath'], ['isolatedClassLoader', 'true']])
createScheduler
このスクリプトは、構成内にスケジューラーを作成します。 スケジューラーは、ビジネス・ロジックを実行できるパーシスタントなトランザクション・タイマー・サービスです。 各スケジューラーは独立してタスクを実行し、Java Naming and Directory Interface (JNDI) を使用して JEE アプリケーションからアクセス可能なプログラミング・インターフェースを備えています。 Java Management Extensions (JMX) MBean を使用してスケジューラーを管理することもできます。 スケジューラーの構成および使用の方法については、スケジューラー資料を参照してください。 このスクリプトは、作成されたスケジューラーの構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| nodeName | 対象のノードの名前を指定します。 |
| serverName | 対象のサーバーの名前を指定します。 |
| schedulerName | 管理目的のために、このスケジューラーが認識される名前を指定します。 |
| JNDIName | このスケジューラー・インスタンスが名前空間内でバインドされる場所を決定する JNDI 名を指定します。 リソース参照の使用が推奨されていますが、 クライアントは直接この名前を調べることができます。 |
| scheduleCategory | このスケジューラーを分類またはグループ化する場合に使用できるストリングを指定します。 |
| datasourceJNDI | パーシスタント・タスクが保管されるデータ・ソースの名前を指定します。 名前空間で使用可能なデータ・ソースは、スケジューラーで使用できます。 複数のスケジューラーは、異なるテーブルを使用している場合でも、テーブルの接頭部 を指定することで、単一のデータ・ソースを共有できます。 |
| tablePrefix | スケジューラー・テーブルに付加されるストリングの接頭部を指定します。 各インスタンスが異なる接頭部ストリングを指定した場合、 複数の独立スケジューラーが同じデータベースを共有できます。 |
| pollInterval | スケジューラーがデータベースをポーリングする間隔を秒単位で指定します。 デフォルト値はほとんどのアプリケーションに適した値になっています。 各ポーリング・オペレーションは消費が激しくなることがあります。 間隔が非常に小さく、 多くのタスクがスケジュールされている場合、 ポーリングは非常に多くのシステム・リソースを消費します。 デフォルト値は次のとおりです。30. |
| workMgmtJNDI | スケジューラーと並行して実行できるタスクの数の管理に使用される、作業マネージャーの JNDI 名を指定します。 また、作業マネージャーはタスクに適用される Java EE コンテキストの量を制限することもできます。 |
構文
AdminResources.createScheduler(nodeName, serverName,
schedulerName, JNDIName, scheduleCategory,
datasourceJNDI, tablePrefix, pollInterval, workMgmtJNDI)
使用例
AdminResources.createScheduler("myNode", "myServer", "myScheduler",
"myScheduleJndi", "Default", "jdbc/MyDatasource", "sch1", "30",
"myWorkManager")
createSchedulerAtScope
このスクリプトは、指定した有効範囲でご使用の構成にスケジューラーを作成します。 スケジューラーは、ビジネス・ロジックを実行できるパーシスタントなトランザクション・タイマー・サービスです。 各スケジューラーは独立してタスクを実行し、Java Naming and Directory Interface (JNDI) を使用して Java EE アプリケーションからアクセス可能なプログラミング・インターフェースを備えています。 Java Management Extensions (JMX) MBean を使用してスケジューラーを管理することもできます。 スケジューラーの構成および使用の方法については、スケジューラー資料を参照してください。 このスクリプトは、指定した有効範囲の作成済みスケジューラーの構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| scope | JMS プロバイダーのセル、ノード、サーバー、またはクラスターの 有効範囲 を指定します。 |
| schedulerName | 管理目的のために、このスケジューラーが認識される名前を指定します。 |
| JNDIName | このスケジューラー・インスタンスが名前空間内でバインドされる場所を決定する JNDI 名を指定します。 リソース参照の使用が推奨されていますが、 クライアントは直接この名前を調べることができます。 |
| datasourceJNDI | パーシスタント・タスクが保管されるデータ・ソースの名前を指定します。 名前空間で使用可能なデータ・ソースは、スケジューラーで使用できます。 複数のスケジューラーは、異なるテーブルを使用している場合でも、テーブルの接頭部 を指定することで、単一のデータ・ソースを共有できます。 |
| tablePrefix | スケジューラー・テーブルに付加されるストリングの接頭部を指定します。 各インスタンスが異なる接頭部ストリングを指定した場合、 複数の独立スケジューラーが同じデータベースを共有できます。 |
| pollInterval | スケジューラーがデータベースをポーリングする間隔を秒単位で指定します。 デフォルト値はほとんどのアプリケーションに適した値になっています。 各ポーリング・オペレーションは消費が激しくなることがあります。 間隔が非常に小さく、 多くのタスクがスケジュールされている場合、 ポーリングは非常に多くのシステム・リソースを消費します。 デフォルト値は次のとおりです。30. |
| workMgmtJNDI | スケジューラーと並行して実行できるタスクの数の管理に使用される、作業マネージャーの JNDI 名を指定します。 また、作業マネージャーはタスクに適用される Java EE コンテキストの量を制限することもできます。 |
| schedulerProviderID | このスケジューラーのプロバイダー ID を指定します。 |
| otherAttributesリスト | オプションで、追加の属性を以下の特定のフォーマットで指定します。
|
| 属性 | 説明 |
|---|---|
| カテゴリー (Category) | リソースの分類またはグループ化に使用できるカテゴリーを指定します。 |
| 説明 | URL プロバイダーの説明を指定します。 |
| providerType | この URL プロバイダーが使用するリソース・プロバイダー・タイプを指定します。 |
| datasourceAlias | この URL プロバイダーがデータ・ソースへのアクセスに使用するユーザー名およびパスワードの別名を指定します。 |
| loginConfig名前 | ログイン構成名を指定します。 |
| securityRole | セキュリティー・ロールを指定します。 |
| useAdminロール | このオプションと管理セキュリティーの両方が使用可能な場合に、ユーザーの管理ロールが強制されるように指定します。 ユーザーの管理ロールが強制されるようにするには、スケジューラー JMX コマンドまたは API を使用して、タスクの作成および変更を行う必要があります。 このオプションが使用不可の場合、すべてのユーザーがタスクを作成および変更できます。 デフォルト値は falseです。 |
| Referenceable | Referenceable を指定します。Referenceable は、リソース環境エントリー・データを、物理リソースを表すクラス・インスタンスに変換する、ファクトリーのクラス名をカプセル化します。 |
構文
AdminResources.createSchedulerAtScope(scope,
schedulerName, JNDIName,
datasourceJNDI, tablePrefix, pollInterval, workMgmtJNDI,
ScheduleProviderID, otherAttributesList)
使用例
以下のスクリプト例には必須の属性のみが含まれています。
AdminResources.createSchedulerAtScope("myNode", "myScheduler",
"myScheduleJndi", "Default", "jdbc/MyDatasource", "sch1", "30",
"myWorkManager, "SchedulerProvider(cells/MY4Cell01/nodes/MY4Node09/servers/server1|resources-pme.xml#SchedulerProvider_1)")
AdminResources.createSchedulerAtScope("Node=MY4Node09, server=server1", "myScheduler",
"myScheduleJndi", "jdbc/MyDatasource", "sch1", "30",
"myWorkManager", "SchedulerProvider(cells/MY4Cell01/nodes/MY4Node09/servers/server1|
resources-pme.xml#SchedulerProvider_1)", "category=myCategory,
description='this is my scheduler', datasourceAlias=abc, useAdminRoles=false, loginConfigName=test,
securityRole=user1")以下のスクリプト例には、リスト・フォーマットのオプション属性が含まれています。
AdminResources.createSchedulerAtScope("/Cell:MY4Cell01/ServerCluster:c1/", "myScheduler",
"myScheduleJndi", "jdbc/MyDatasource", "sch1", "30",
"myWorkManager", "SchedulerProvider(cells/MY4Cell01/clusters/c1|resources-pme.xml#SchedulerProvider_1)",
[['category', 'myCategory'],
['description', 'this is my scheduler'], ['datasourceAlias', 'abc'], ['useAdminRoles', 'false'],
['loginConfigName', 'test'], ['securityRole', 'user1']])
createWorkManager
このスクリプトは、構成内に作業マネージャーを作成します。 作業マネージャーには、Java Naming and Directory Interface 内にバインドされるスレッドのプールが含まれています。 このスクリプトは、作成された作業マネージャーの構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| nodeName | 対象のノードの名前を指定します。 |
| serverName | 対象のサーバーの名前を指定します。 |
| workMgr名前 | この作業マネージャーの管理目的用の名前を指定します。 |
| JNDIName | 名前空間で作業マネージャーを調べるのに使用される Java Naming and Directory Interface (JNDI) 名を指定します。 |
| workMgrカテゴリー | この作業マネージャーの分類またはグループ化に使用できるストリングを指定します。 |
| alarmThreads | アラームに使用するために必要な最大スレッド数を指定します。 デフォルト値は次のとおりです。2. |
| minThreads | この作業マネージャーで使用可能なスレッドの最小数を指定します。 |
| maxThreads | この作業マネージャーで使用可能なスレッドの最大数を指定します。 |
| threadPriority | この作業マネージャーで使用可能なスレッドの優先順位を指定します。 各スレッドには優先順位があります。 より高い優先順位を持つスレッドは、低い優先順位のスレッドの前に実行されます。 スレッド優先順位の使用方法について詳しくは、 Java EE 仕様の java.lang.Thread クラスの setPriority メソッドに関する API 資料を参照してください。 |
| isGrowable | この作業マネージャーのスレッド数を増やせるかどうかを 指定します。 次の値を指定してください:trueスレッド数を増やすことができることを示します。 |
| serviceNames | この作業マネージャーで使用可能にするサービスのリストを指定します。 |
構文
AdminResources.createWorkManager(nodeName, serverName,
workMgrName, JNDIName, workMgrCategory,
alarmThreads, minThreads, maxThreads, threadPriority,
isGrowable, serviceNames)
使用例
AdminResources.createWorkManager("myNode", "myServer", "myWorkManager",
"Work Manager", "wm/myWorkManager", "Default", 5, 1, 10, 5, "true",
"AppProfileService UserWorkArea com.ibm.ws.i18n security")
createWorkManagerAtScope
このスクリプトは、指定した有効範囲でご使用の構成に作業マネージャーを作成します。 作業マネージャーには、Java Naming and Directory Interface 内にバインドされるスレッドのプールが含まれています。 このスクリプトは、指定した有効範囲の作成済み作業マネージャーの構成 ID を戻します。
| 引数 | 説明 |
|---|---|
| scope | JMS プロバイダーのセル、ノード、サーバー、またはクラスターの 有効範囲 を指定します。 |
| workMgr名前 | この作業マネージャーの管理目的用の名前を指定します。 |
| JNDIName | 名前空間で作業マネージャーを調べるのに使用される Java Naming and Directory Interface (JNDI) 名を指定します。 |
| alarmThreads | アラームに使用するために必要な最大スレッド数を指定します。 デフォルト値は次のとおりです。2. |
| minThreads | この作業マネージャーで使用可能なスレッドの最小数を指定します。 |
| maxThreads | この作業マネージャーで使用可能なスレッドの最大数を指定します。 |
| threadPriority | この作業マネージャーで使用可能なスレッドの優先順位を指定します。 各スレッドには優先順位があります。 より高い優先順位を持つスレッドは、低い優先順位のスレッドの前に実行されます。 スレッド優先順位の使用方法について詳しくは、 Java EE 仕様の java.lang.Thread クラスの setPriority メソッドに関する API 資料を参照してください。 |
| workManagerProviderID | 親の作業マネージャー・プロバイダーの構成 ID を指定します。 作業マネージャーはこの ID で作成されます。 既存の作業マネージャー・プロバイダーまたは新規の作業マネージャー・プロバイダーの下で作業マネージャーを作成することができます。 以下の wsadmin コマンドは、サーバーの有効範囲から既存の作業マネージャー・プロバイダーの構成 ID を検索する方法の例です。 |
| otherAttributesリスト | オプションで、追加の属性を以下の特定のフォーマットで指定します。
|
| 属性 | 説明 |
|---|---|
| カテゴリー (Category) | リソースの分類またはグループ化に使用できるカテゴリーを指定します。 |
| 説明 | URL プロバイダーの説明を指定します。 |
| providerType | この URL プロバイダーが使用するリソース・プロバイダー・タイプを指定します。 |
| daemonTranクラス | デーモン作業のワークロード分類に使用されるトランザクション・クラスを指定します。 デーモン作業はワークロード・マネージャー・サービス用です。 |
| defTranクラス | z/OS ワークロード・マネージャーのサービス・クラス情報が作業コンテキスト情報に含まれていない場合に、この作業マネージャー・インスタンスによって実行される作業を分類するために使用するトランザクション・クラス名を指定します。 |
| isDistributable | この作業マネージャーを配布可能にするかどうかを指定します。 デフォルト値は falseです。 |
| isGrowable | この作業マネージャーのスレッド数を増やせるかどうかを
指定します。 デフォルト値は trueです。 |
| serviceNames | この作業マネージャーで使用可能にするサービスのリストを指定します。 |
| workReqQFullAction | スレッド・プールが使い尽くされて、作業要求キューがフルになった場合にとるアクションを指定します。 デフォルト値は 0です。 |
| workReqQSize | 作業要求キューのサイズを指定します。 デフォルト値は 0です。 |
| workTimeout | 作業単位の解放が試行される前に待機する時間をミリ秒で指定します。 デフォルト値は 0です。 |
| Referenceable | Referenceable を指定します。Referenceable は、リソース環境エントリー・データを、物理リソースを表すクラス・インスタンスに変換する、ファクトリーのクラス名をカプセル化します。 |
| otherAttributesリスト | オプションで、追加の属性を以下の特定のフォーマットで指定します。
|
構文
AdminResources.createWorkManagerAtScope(scope,
workMgrName, JNDIName,
alarmThreads, minThreads, maxThreads, threadPriority,
workManagerProviderID, otherAttributesList)
使用例
以下のスクリプト例には必須の属性のみが含まれています。
AdminResources.createWorkManagerAtScope("scope", "myWorkManager",
"Work Manager", "Default", 5, 1, 10,
"WorkManagerProvider(cells/MY4Cell01/nodes/MY4Node09/servers/server1|resources-pme.xml#WorkManagerProvider_1)")
AdminResources.createWorkManagerAtScope("Node=MY4Node09, server=server1", "myWorkManager",
"wm/myWorkManager", "5", "1", "10", "5",
"WorkManagerProvider(cells/MY4Cell01/nodes/MY4Node09/servers/server1|resources-pme.xml#WorkManagerProvider_1)")以下のスクリプト例には、リスト・フォーマットのオプション属性が含まれています。
AdminResources.createWorkManagerAtScope("/Cell:MY4Cell01/ServerCluster:c1/", "myWorkManager",
"wm/myWorkManager", "5", "1", "10", "5",
WorkManagerProvider(cells/MY4Cell01/clusters/c1|resources-pme.xml#WorkManagerProvider_1)",
[['category', 'myCategory'], ['description', 'this is my workmanager'],
['daemonTranClass', ''], ['defTranClass', ''], ['isDistributable', 'false'], ['isGrowable', 'true'],
['serviceNames', 'security'], ['workReqQFullAction', 0],
['workReqQSize', 0], ['workTimeout', 10]])
help
| 引数 | 説明 |
|---|---|
| script | 対象のスクリプトの名前を指定します。 |
構文
AdminResources.help(script)
使用例
AdminResources.help("createWorkManager")