Message Webject
以下の Webject をサードパーティの MOM と併用すると、一般的なメッセージ機能とタスクキュー機能を実行できます。
• Browse-Queue
• Call-RemoteProcedure
• Call-SOAPService
• Create-Object
• Delete-Object
• Delete-Results
• Query-Object
• Query-Results
• Queue-Task
• Send-Mail
• Subscribe-Queue
• Unsubscribe-Queue
すべての Message Webject は、webject タグの MSGtype 属性値を使用します。
Browse-Queue
キューのメッセージまたは一連のメッセージを選択し、実際にはメッセージの内容を返さないでメッセージのプロパティを表示できるようにします。
|
|
この Webject を使用するには、メッセージの送受信ができるように、またはタスクをキューに入れるように環境を設定する必要があります。
|
構文
<ie:webject name="Browse-Queue" type="MSG">
<ie:param name="ATTRIBUTE" data="attribute_name"/>
<ie:param name="DBUSER" data="username"/>
<ie:param name="GROUP_OUT" data="group_name"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="QUEUE" data="managed_queue_name"/>
<ie:param name="WHERE" data="message_selector"/>
</ie:webject>
パラメータ
|
必須
|
選択
|
オプション
|
|
QUEUE
|
|
ATTRIBUTE
|
|
|
DBUSER
|
|
|
SERVICE
|
|
|
GROUP_OUT
|
|
|
PASSWD
|
|
|
WHERE
|
ATTRIBUTE
出力グループに属性として追加する JMS プロパティを指定します。キューに入れるときにメッセージに手動で設定するプロパティに加えて、以下の JMS 固有のプロパティも返される場合があります。
◦ JMSDestination
◦ JMSDeliveryMode
◦ JMSMessageID
◦ JMSTimestamp
◦ JMSCorrelationID
◦ JMSReplyTo
◦ JMSRedelivered
◦ JMSExpiration
◦ JMSPriority
◦ JMSType
このパラメータのデフォルトはアスタリスク (*) です。この場合、属性として設定されているすべてのプロパティが返されます。このパラメータはオプションです。
DBUSER
MOM への接続時に使用するユーザー名。このパラメータを指定すると、そのパラメータ値は、認証済みユーザーの既存の資格証明マッピング、または MOM への接続に使用するサービスの
.msg.username および
.jms.username プロパティで指定されている値よりも優先されます。詳細については、
MOM の資格証明マッピングを参照してください。
このパラメータを省略すると、Info*Engine のメッセージ送受信ソフトウェア用のマッピングされた認証が使用されます。このようなマッピングが見つからない場合は、Java Messaging Service (JMS) 用のマッピングされた認証が使用されます。これらのマッピングされた資格証明がいずれも見つからない場合は、.msg.username プロパティで設定されている値が使用されます。.msg.username プロパティが設定されていない場合は、.jms.username プロパティで設定されている値が使用されます。いずれのプロパティも設定されておらず、この DBUSER パラメータに値を指定しない場合、Info*Engine は MOM に接続するときにユーザー名を指定せず、匿名の接続を試みます。
このパラメータはオプションです。
SERVICE
特定の JMS サービスに接続できるように設定されている Info*Engine プロパティセットの名前。これにより、単一の Info*Engine 仮想マシン (VM) に対して複数の JMS サービスを設定できます。このパラメータはオプションです。
GROUP_OUT
メッセージキューのオブジェクトのキュー識別子を含む、作成するグループの名前。このパラメータのデフォルトは browse-results です。このパラメータはオプションです。
PASSWD
MOM への接続時に使用するパスワード。このパラメータを指定すると、そのパラメータ値は、認証済みユーザーの既存の資格証明マッピング、または MOM への接続に使用するサービスの
.msg.password および
.jms.password プロパティで指定されている値よりも優先されます。詳細については、
MOM の資格証明マッピングを参照してください。
このパラメータを省略すると、Info*Engine のメッセージ送受信ソフトウェア用のマッピングされた認証が使用されます。このようなマッピングが見つからない場合は、Java Messaging Service (JMS) 用のマッピングされた認証が使用されます。このようなマッピングされた資格証明がいずれも見つからない場合は、.msg.password プロパティで設定されている値が使用されます。.msg.password プロパティが設定されていない場合は、.jms.password プロパティで設定されている値が使用されます。いずれのプロパティも設定されず、この PASSWD パラメータに値を指定していない場合は、MOM に接続するときに Info*Engine はパスワードを指定しません。
このパラメータはオプションです。
QUEUE
ブラウズする管理キューの LDAP 相対識別名。値は設定されているベース URI を基準とする LDAP 相対識別名です。相対の場合に、明示的に指定されていない場合、cn= (共有名の属性) は暗黙的です。このパラメータは必須です。
WHERE
キューからメッセージを選択するときに使用する JMS where 節。where 節が指定されていない場合、キューのすべてのメッセージが返されます。このパラメータはオプションです。
例
以下の例は、すべての属性を確認するために指定されたキューをブラウズしてから、Return-Groups Webject を使用してデフォルトの browse-results グループを返します。
<%@page language="java" session="false"%>
<%@taglib uri="http://www.ptc.com/infoengine/taglib/core"
prefix="ie"%>
<ie:webject name="Browse-Queue" type="MSG">
<ie:param name="QUEUE" data="$(@FORM[]QUEUE[0])"/>
</ie:webject>
<ie:webject name="Return-Groups" type="GRP">
<ie:param name="GROUP_IN" data="*"/>
</ie:webject>
この例を実際に実行するには、QUEUE 変数を識別するフォームを指定する必要があります。
Call-RemoteProcedure
サードパーティ Simple Object Access Protocol (SOAP) サービスへのリモートプロシージャコール (RPC) を行います。RPC 呼び出しの結果は、グループの形式で Info*Engine タスクまたは JSP 作成者に返されます。グループは SOAP レスポンスの XML 構造を模倣します。RPC 呼び出しの結果が 1 つの値または単純な値の配列になる簡単なケースでは、各要素に 1 つの属性が含まれる基本的な Info*Engine グループが返されます。RPC サービスは、レスポンスで複雑なデータ構造を返す場合があります。その場合、複数の属性を持った複数の要素を含んでいる可能性のあるグループが返されます。深くネストされた XML が返される場合、結果として生成される Info*Engine グループも深くネストされ、値が要素である属性を含んでいます。このようなレスポンスを処理するには、処理するタスクまたは JSP 内でスクリプトレットコードの使用が必要になる場合があります。
構文
<ie:webject name="Call-RemoteProcedure" type="MSG">
<ie:param name="WSDL" data="url"/>
<ie:param name="OPERATION" data="operationName"/>
<ie:param name="GROUP_OUT" data="groupName"/>
<ie:param name="GROUP_IN" data="groupName"/>
<ie:param name="SERVICE" data="soapServiceName"/>
<ie:param name="PORT" data="soapPortName"/>
<ie:param name="PARAM" data="name=data"/>
<ie:param name="DBUSER" data="username"/>
<ie:param name="PASSWORD" data="password"/>
<ie:param name="AUTHORIZATION" data="Base64"/>
</ie:webject>
パラメータ
|
必須
|
選択
|
オプション
|
|
OPERATION
|
|
AUTHORIZATION
|
|
WSDL
|
|
DBUSER
|
|
|
GROUP_IN
|
|
|
GROUP_OUT
|
|
|
PARAM
|
|
|
PASSWD
|
|
|
PORT
|
|
|
SERVICE
|
AUTHORIZATION
Authorization HTTP ヘッダーを通して Web ブラウザから Web サーバーに渡される、Base64 でエンコードされたユーザー名とパスワード。このパラメータは、SOAP の終点が http または https の場合に使用します。指定した場合、SOAP の終点との接続を確立するときに資格証明が使用されます。DBUSER と PASSWORD を指定した場合、AUTHORIZATION 値の代わりにこれらの値が使用されます。このパラメータはオプションです。
DBUSER
終点のサポートプロトコルが http または https である場合、SOAP の終点と接続する際に入力されたユーザー名。DBUSER を指定した場合、PASSWORD も指定する必要があります。PASSWORD を指定しないと、DBUSER は無視されます。これはオプションのパラメータです。
GROUP_IN
送信する SOAP リクエストを表す Info*Engine グループ。入力グループにあるすべての属性は、XML 要素として追加されます。属性値は、それらの XML 要素の値として追加されます。属性値を要素に設定して、XML 要素をネストできます。このパラメータを使用して、複雑な任意の SOAP リクエストを作成できます。入力グループから生成された要素はすべて、操作名を名前として持つ標準 RPC の最上位の要素に追加されます。これはオプションのパラメータです。指定した場合、Webject による入力の検証は行われません。
GROUP_OUT
RPC 呼び出しの結果の保存先である Info*Engine グループの名前。出力グループ内にあるデータは、SOAP レスポンス内にあるタイプ情報に基づいて厳密にタイプ指定される必要があります。これはオプションのパラメータです。デフォルト値は rpcOutput です。
OPERATION
実行される操作の名前。これは必須のパラメータです。操作名は、WSDL パラメータによって参照される WSDL ドキュメントによって公開される必要があります。
PARAM
RPC で送信するパラメータの名前と値。値は、name=data の形式にする必要があります。Call-RemoteProcedure は、指定したパラメータを WSDL に対して検証して、必要なすべてのパラメータが存在し、指定したパラメータがサービスによって認識され、パラメータの最大および最小オカレンスが厳守され、パラメータ値のタイプが適切であることを確認します。入力パラメータを必要としない操作もあるので、このパラメータはオプションです。Web サービスが問題の操作に対して特定のパラメータを必要とする場合は、このパラメータを指定する必要があります。指定されていなければ、例外が発生します。
PASSWORD
終点のサポートプロトコルが http または https の場合に SOAP の終点との接続に使用するパスワード。PASSWORD を指定した場合、DBUSER も指定する必要があります。DBUSER を指定しないと、PASSWORD は無視されます。これはオプションのパラメータです。
PORT
使用する SOAP ポートの名前。WSDL ドキュメントで、SOAP サービスが複数のポートに結合されている場合があります。選択した SERVICE が複数のポートに結合されている場合、このパラメータを指定する必要があります。選択した SERVICE が 1 つのポートにのみ結合されている場合、そのポートが使用されます。
SERVICE
使用する SOAP サービスの名前。WSDL ドキュメントで複数の SOAP サービスが公開される場合があります。WSDL パラメータによって参照される WSDL ドキュメントで複数のサービスが公開されている場合は、このパラメータを指定する必要があります。WSDL パラメータによって参照される WSDL ドキュメントで 1 つのサービスのみが公開されている場合は、そのサービスが使用されます。
WSDL
Web Services Definition Language (WSDL) ドキュメントを参照します。この値は、Call-RemoteProcedure で読み取り可能なコンテンツを持つ URL にする必要があります。WSDL ドキュメントは、Web サービスについて、サポートするサービス名、各サービスがサポートする操作、各操作が必要とする (またはサポートする) パラメータ、SOAP リクエストの生成方法 (パラメータの順序、使用するネームスペース) を記述します。これは必須のパラメータです。特定の SOAP サービスにそれを記述する WSDL ドキュメントがない場合は、それを作成する必要があります。指定した URL が http または https であり、認証を必要とする場合は、以下のように指定できます。
http://<ユーザー>:<パスワード>@host/path/to/wsdl/。
例
<%@page language="java"
%><%@ taglib uri="http://www.ptc.com/infoengine/taglib/core" prefix="ie"
%><html>
<head><title>Weather by Zip</title></head>
<body>
<%
String zip = request.getParameter ( "zipCode" );
if ( zip != null ) {
%><ie:webject name="Call-RemoteProcedure" type="MSG">
<ie:param name="WSDL"
data="http://www.vbws.com/services/weatherretriever.asmx?WSDL"/>
<ie:param name="OPERATION" data="GetWeather"/>
<ie:param name="PORT" data="WeatherRetrieverSoap"/>
<ie:param name="PARAM" data="zipCode=$(@FORM[]zipCode[])"/>
</ie:webject><%
} %>
<form method="GET">
Zip: <input type=text size=10 name=zipCode value="<%=
(zip==null?"":zip)%>">
<input type=submit value="Get Weather" name=temp>
</form>
<%
if ( zip != null ) {
%><br><br>
<table>
<tr><td colspan=2 align=middle><img src="<ie:getValue name=
"IconUrl"/>"></td></tr>
<tr><td align=right><strong>Last Updated:<strong><td><td><ie:getValue
name="LastUpdated"/></td><tr>
<tr><td align=right><strong>Conditions:
</strong></td><td><ie:getValue name="Conditions"/></td></tr>
<tr><td align=right><strong>CurrentTemp:
<strong><td><td><ie:getValue name="CurrentTemp"/></td></tr>
<tr><td align=right><strong>Humidity:
</strong><td><td><ie:getValue name="Humidity"/></td></tr>
<tr><td align=right><strong>Barometer:</strong><td><td><ie:getValue
name="Barometer"/></td></tr>
<tr><td align=right><strong>Barometer Direction:
<strong><td><td><ie:getValue
name="BarometerDirection"/></td></tr>
</table><%}%></body></html>
Call-SOAPService
サードパーティ Simple Object Access Protocol (SOAP) サービスへのリクエストを作成します。この Webject は、Info*Engine グループと XSL テンプレートを使用して、SOAP リクエストをフォーマットします。Webject の出力は、SOAP レスポンスボディを模倣する Info*Engine グループとして直接生成できます。または、XSL テンプレートを指定して、SOAP レスポンスを Info*Engine グループに変換できます。
SOAP エラーが発生すると、com.infoengine.exception.fatal.IERemoteException のインスタンスが生成されます。
構文
<ie:webject name="Call-SOAPService" type="MSG">
<ie:param name="DBUSER" data="username"/>
<ie:param name="ENDPOINT" data="url"/>
<ie:param name="GROUP_IN" data="groupName"/>
<ie:param name="GROUP_OUT" data="groupName"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="SOAP_ACTION" data="operationName"/>
<ie:param name="XSL_URL" data="url"/>
<ie:param name="XSL_RESPONSE_URL" data="url"/>
<ie:param name="XSL_DBUSER" data="username"/>
<ie:param name="XSL_PASSWD" data="passwd"/>
</ie:webject>
パラメータ
|
必須
|
選択
|
オプション
|
|
ENDPOINT
|
|
DBUSER
|
|
GROUP_IN
|
|
EXCEPTION_ON_FAULT
|
|
XSL_URL
|
|
GROUP_OUT
|
|
|
PASSWD
|
|
|
SOAP_ACTION
|
|
|
XSL_DBUSER
|
|
|
XSL_PASSWD
|
|
|
XSL_RESPONSE_URL
|
DBUSER
ENDPOINT に対する認証に使用するユーザー名。このパラメータは、ENDPOINT パラメータで指定された SOAP 終点が認証を必要とする場合に、PASSWD とともに使用されます。このパラメータはオプションです。
ENDPOINT
SOAP リクエストを送信する必要のある SOAP 終点の URL。このパラメータは必須です。
EXCEPTION_ON_FAULT
サービスが SOAP エラーで応答する場合に例外が発生するかどうかを指定します。デフォルト値は true です。パラメータが false に設定されている場合、エラーが発生しても例外は発生しません。結果を変換するために XSL が使用されている場合は、XSL テンプレートを使用してエラーを Info*Engine データ (detail 要素のコンテンツと実行されたその他の操作を含む) に変換できます。XSL が使用されていない場合は、Webject はエラーを Info*Engine グループに変換します。このパラメータはオプションです。
GROUP_IN
XSL_URL で指定された XSL テンプレートと結合するデータを含んでいる Info*Engine グループ。このパラメータは必須です。
GROUP_OUT
SOAP レスポンスを表す Info*Engine グループの名前。XSL_RESPONSE_URL が指定されている場合、このパラメータは、SOAP レスポンスを GROUP_OUT 値の名前を持つ Info*Engine グループに変換する際に使用されます。XSL_RESPONSE_URL が指定されていない場合、このグループには、レスポンスに単一の要素と、XML 要素ごとに 1 つの属性が含まれます。属性の値は、要素データを表すオブジェクト、またはネストされた追加の XML 要素を表す Info*Engine 要素です。属性の名前は、対応する XML 要素の名前と一致します。このパラメータのデフォルト値は SOAPResponse です。このパラメータはオプションです。
PASSWD
DBUSER に対応するパスワード。このパラメータはオプションです。
SOAP_ACTION
送信する必要がある SOAPAction ヘッダーの値 (存在する場合)。このパラメータはオプションです。
XSL_DBUSER
XSL_URL および XSL_RESPONSE_URL に対する認証に使用するユーザー名。このパラメータは、Webject によって使用される XSL テンプレートが、認証を必要とするリモート HTTP サーバー上にある場合に、XSL_PASSWD とともに使用されます。このパラメータはオプションです。
XSL_PASSWD
XSL_DBUSER に対応するパスワード。このパラメータはオプションです。
XSL_RESPONSE_URL
SOAP レスポンスの処理に使用される XSL テンプレートの場所。XSL テンプレートは、GROUP_OUT を作成する際に SOAP レスポンスと結合されます。このパラメータはオプションです。
Auth-Map コンテキストグループのデータを使用すると、完全修飾 URL の参照が解除されます。Auth-Map は完全修飾 URL で見つかったドメイン名に基づくユーザー名およびパスワードでサーチされます。たとえば、完全修飾 URL が
http://machine.com/infoengine/servlet/IE/tasks/createGroupData.xml
であれば、
http://machine.com の INSTANCE 名を持つユーザー名とパスワードが Auth-Map コンテキストグループでサーチされます。ユーザー名とパスワードが見つかると、URL にアクセスするときに BASIC 認証情報が使用されます。ユーザー名とパスワードが見つからない場合、認証情報はリモート Web サーバーに送信されません。
データ値に :// 文字列が含まれている場合は、完全修飾インターネット URL であると見なされます。データ値に文字列が含まれていない場合は、現在のタスクルートディレクトリに関連するローカルファイルであると見なされます。
XSL_URL
SOAP リクエストの生成に使用される XSL テンプレートの場所。XSL テンプレートは、SOAP リクエストを生成する際に GROUP_IN と結合されます。
SOAP リクエストおよびレスポンスを変換するために使用される XSL 文書を作成するときに、XML ドキュメントのリクエストとレスポンスのペアの例が使用できる場合は、それらを XML のテンプレートとして使用できます。このようなリクエストおよびレスポンスのドキュメントの例が使用できない場合、XSL 作成者は Web サービスの WSDL ドキュメントによって提供されるスキーマに細心の注意を払う必要があります。有効で使用可能な XML を Web サービスに提供するには、WSDL ドキュメントに準拠する必要があります。サービスの実装方法によっては、サービスで使用できるものが制限される場合があります。ただし、WSDL に用意されているスキーマは、そのまま使用する必要があり、すべての XML 要素および属性の順序、大文字小文字、選択性、多重度、およびデータタイプに準拠することで、そのスキーマを検証する XML を作成するために使用する必要があります。
Auth-Map コンテキストグループのデータを使用すると、完全修飾 URL の参照が解除されます。Auth-Map は完全修飾 URL で見つかったドメイン名に基づくユーザー名およびパスワードでサーチされます。たとえば、完全修飾 URL が
http://machine.com/infoengine/servlet/IE/tasks/createGroupData.xml
であれば、
http://machine.com の INSTANCE 名を持つユーザー名とパスワードが Auth-Map コンテキストグループでサーチされます。ユーザー名とパスワードが見つかると、URL にアクセスするときに BASIC 認証情報が使用されます。ユーザー名とパスワードが見つからない場合、認証情報はリモート Web サーバーに送信されません。
データ値に :// 文字列が含まれている場合は、完全修飾インターネット URL であると見なされます。データ値に文字列が含まれていない場合は、現在のタスクルートディレクトリに関連するローカルファイルであると見なされます。
このパラメータは必須です。
例: Translate-Group と XSL
|
|
サンプルコードではコードの内容を明確にするために Info*Engine SOAP コメントが使用されています。SOAP および SOAP コメントの詳細については、 SOAP サービスを参照してください。 |
この例では、Translate-Group Webject と XSL を使用して、複雑な Info*Engine グループとして Call-SOAPService Webject から返された SOAP レスポンスを簡略化します。
hostlookup.xml
<%@page language="java" import="java.util.StringTokenizer,com.infoengine.
object.
IeMultipartInputStream,java.io.ByteArrayInputStream"%>
<%@taglib uri="http://www.ptc.com/infoengine/taglib/core"
prefix="ie"%>
<!--com.infoengine.soap.rpc.def
Resolves information about a host name.
@param string host The hostname
@return INFOENGINE_GROUP $(output)-->
<ie:webject name="Create-Group" type="GRP">
<ie:param name="ELEMENT" data="host=$(@FORM[]host[])"
default="www.google.com"/>
<ie:param name="CLASS" data="parameters"/>
<ie:param name="GROUP_OUT" data="parameters"/>
</ie:webject>
<ie:webject name="Call-SOAPService" type="MSG">
<ie:param name="ENDPOINT"
data="http://www.esynaps.com/webservices/YourHostInfo.asmx"/>
<ie:param name="SOAP_ACTION"
data="http://tempuri.org/GetHostInfoByName"/>
<ie:param name="XSL_URL"
data="/com/company/hostlookup/ hostlookupRequest.xsl"/>
<ie:param name="GROUP_IN" data="parameters"/>
<ie:param name="GROUP_OUT" data="response"/>
<ie:param name="CLASS" data="response"/>
</ie:webject>
<ie:webject name="Translate-Group" type="GRP">
<ie:param name="GROUP_IN" data="response"/>
<ie:param name="XSL_URL"
data="/com/company/hostlookup/
hostlookupResponse.xsl"/>
<ie:param name="GROUP_OUT" data="$(@FORM[]group_out[])"
default="output"/>
<ie:param name="CLASS" data="lookupResponse"/>
</ie:webject>
hostlookupRequest.xsl
<?xml version='1.0'?>
<xsl:stylesheet
xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"
xmlns:wc="http://www.ptc.com/infoengine/1.0">
<xsl:template match="/wc:COLLECTION/parameters/wc:INSTANCE">
<soap:Envelope xmlns:s0="http://tempuri.org/"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<s0:GetHostInfoByName>
<s0:Name><xsl:value-of select="host"/></s0:Name>
</s0:GetHostInfoByName>
</soap:Body>
</soap:Envelope>
</xsl:template>
</xsl:stylesheet>
hostlookupResponse.xsl
例: XSL_RESPONSE_URL
この例では、XSL_RESPONSE_URL パラメータを使用して、SOAP レスポンスを前述の例で作成されたものと同じグループに変換します。
hostlookup2.xml
<%@page language="java" import="java.util.StringTokenizer,com.
infoengine.object.
IeMultipartInputStream,java.io.ByteArrayInputStream"%>
<%@taglib uri="http://www.ptc.com/infoengine/taglib/core"
prefix="ie"%>
<!--com.infoengine.soap.rpc.def
Resolves information about a host name, goes straight from SOAP
response to group.
@param string host The hostname
@return INFOENGINE_GROUP $(output)
-->
<ie:webject name="Create-Group" type="GRP">
<ie:param name="ELEMENT" data="host=$(@FORM[]host[])"
default="www.google.com"/>
<ie:param name="CLASS" data="parameters"/>
<ie:param name="GROUP_OUT" data="parameters"/>
</ie:webject>
<ie:webject name="Call-SOAPService" type="MSG">
<ie:param name="ENDPOINT"
data="http://www.esynaps.com/webservices/YourHostInfo.asmx"/>
<ie:param name="SOAP_ACTION"
data="http://tempuri.org/GetHostInfoByName"/>
<ie:param name="XSL_URL"
data="/soap/document/hostlookup/hostlookupRequest.xsl"/>
<ie:param name="XSL_RESPONSE_URL"
data="/soap/document/hostlookup/hostlookupResponseSOAP.xsl"/>
<ie:param name="GROUP_IN" data="parameters"/>
<ie:param name="GROUP_OUT" data="output"/>
<ie:param name="CLASS" data="output"/>
</ie:webject>
hostlookupResponseSOAP.xsl
Create-Object
JMS メッセージを作成し、JMS メッセージキューにそのメッセージを配置します。メッセージのタイプと内容は、そのパラメータによって制御されます。
|
|
この Webject を使用するには、メッセージの送受信用に環境を設定する必要があります。
|
構文
<ie:webject name="Create-Object" type="MSG">
<ie:param name="DBUSER" data="username"/>
<ie:param name="GROUP_IN" data ="group_name"/>
<ie:param name="GROUP_OUT" data ="status_group_name"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="PRIORITY" data ="numeric_value"/>
<ie:param name="PROPERTY" data ="name_value_pair"/>
<ie:param name="PUT_BOOLEAN" data ="[TRUE | FALSE]"/>
<ie:param name="PUT_BYTE" data ="byte"/>
<ie:param name="PUT_BYTES" data ="bytes"/>
<ie:param name="PUT_CHAR" data ="char"/>
<ie:param name="PUT_DOUBLE" data ="double"/>
<ie:param name="PUT_FLOAT" data ="float"/>
<ie:param name="PUT_INT" data ="int"/>
<ie:param name="PUT_LONG" data ="long"/>
<ie:param name="PUT_SHORT" data ="short"/>
<ie:param name="PUT_STRING" data ="string"/>
<ie:param name="QUEUE" data ="managed_queue_name"/>
<ie:param name="TIME_TO_LIVE" data="minutes"/>
<ie:param name="TYPE" data ="message_type"/>
</ie:webject>
パラメータ
|
必須
|
選択
|
オプション
|
|
QUEUE
|
PUT_BOOLEAN
|
DBUSER
|
|
PUT_BYTE
|
GROUP_IN
|
|
PUT_BYTES
|
GROUP_OUT
|
|
PUT_INT
|
PASSWD
|
|
PUT_CHAR
|
PRIORITY
|
|
PUT_DOUBLE
|
PROPERTY
|
|
PUT_FLOAT
|
TIME_TO_LIVE
|
|
PUT_LONG
|
SERVICE
|
|
PUT_SHORT
|
|
|
PUT_STRING
|
|
|
TYPE
|
|
DBUSER
MOM への接続時に使用するユーザー名。このパラメータを指定すると、そのパラメータ値は、認証済みユーザーの既存の資格証明マッピング、または MOM への接続に使用するサービスの
.msg.username および
.jms.username プロパティで指定されている値よりも優先されます。詳細については、
MOM の資格証明マッピングを参照してください。
このパラメータを省略すると、Info*Engine のメッセージ送受信ソフトウェア用のマッピングされた認証が使用されます。このようなマッピングが見つからない場合は、Java Messaging Service (JMS) 用のマッピングされた認証が使用されます。これらのマッピングされた資格証明がいずれも見つからない場合は、.msg.username プロパティで設定されている値が使用されます。.msg.username プロパティが設定されていない場合は、.jms.username プロパティで設定されている値が使用されます。いずれのプロパティも設定されておらず、この DBUSER パラメータに値を指定しない場合、Info*Engine は MOM に接続するときにユーザー名を指定せず、匿名の接続を試みます。
このパラメータはオプションです。
GROUP_IN
Info*Engine グループの名前です。リクエストをシリアル化します。値がアスタリスク (*) であれば、すべてのグループをシリアル化することを意味します。TYPE パラメータが Info*Engine である場合のみ、このパラメータは有効です。このパラメータはオプションです。
GROUP_OUT
正常に終了すると作成されるステータスグループの名前です。このパラメータのデフォルトでは、"create-results" という名前のグループを作成します。このパラメータはオプションです。
PASSWD
MOM への接続時に使用するパスワード。このパラメータを指定すると、そのパラメータ値は、認証済みユーザーの既存の資格証明マッピング、または MOM への接続に使用するサービスの
.msg.password および
.jms.password プロパティで指定されている値よりも優先されます。詳細については、
MOM の資格証明マッピングを参照してください。
このパラメータを省略すると、Info*Engine のメッセージ送受信ソフトウェア用のマッピングされた認証が使用されます。このようなマッピングが見つからない場合は、Java Messaging Service (JMS) 用のマッピングされた認証が使用されます。このようなマッピングされた資格証明がいずれも見つからない場合は、.msg.password プロパティで設定されている値が使用されます。.msg.password プロパティが設定されていない場合は、.jms.password プロパティで設定されている値が使用されます。いずれのプロパティも設定されず、この PASSWD パラメータに値を指定していない場合は、MOM に接続するときに Info*Engine はパスワードを指定しません。このパラメータはオプションです。
PRIORITY
送信メッセージに設定する整数の優先度を指定します。JMS キューの優先度の有効範囲は、0 ～ 9 で、通常のデフォルト値は 4 です。Info*Engine は優先度を無視しますが、Info*Engine によってキューに入れられたメッセージを受信するサードパーティのソフトウェアではこれが使用される場合があります。このパラメータはオプションです。
PROPERTY
JMS 送信メッセージに設定する名前と値のペアを指定します。Info*Engine はこれらのプロパティを無視しますが、サードバーティのソフトウェアではこれが使用される場合があります。PROPERTY の値のフォーマットは以下のとおりです。
name=value
ここで、
◦ name - プロパティ名
◦ value - 対応するプロパティの値
このパラメータのデフォルトの動作では、送信メッセージに追加プロパティを設定しません。このパラメータはオプションです。
PUT_BOOLEAN
Java ブール値を JMS メッセージに配置します。値は TRUE または FALSE のいずれかで指定します。このパラメータは、TYPE が BytesMessage、MapMessage、または StreamMessage として指定される場合にのみ使用できます。
PUT_BYTE
JMS メッセージにシングルバイトを配置します。このパラメータは、TYPE が BytesMessage、MapMessage、または StreamMessage として指定される場合にのみ使用できます。
PUT_BYTES
JMS メッセージに複数のバイトを配置します。このパラメータは、TYPE が BytesMessage、MapMessage、または StreamMessage として指定される場合にのみ使用できます。
PUT_CHAR
JMS メッセージに 1 つの Java 文字を配置します。このパラメータは、TYPE が BytesMessage、MapMessage、または StreamMessage として指定される場合にのみ使用できます。
PUT_DOUBLE
JMS メッセージに Java ダブル (実数) 値を配置します。このパラメータは、TYPE が BytesMessage、MapMessage、または StreamMessage として指定される場合にのみ使用できます。
PUT_FLOAT
JMS メッセージに浮動小数点値を配置します。このパラメータは、TYPE が BytesMessage、MapMessage、または StreamMessage として指定される場合にのみ使用できます。
PUT_INT
JMS メッセージに整数を配置します。このパラメータは、TYPE が BytesMessage、MapMessage、または StreamMessage として指定される場合にのみ使用できます。
PUT_LONG
JMS メッセージに long 型整数を配置します。このパラメータは、TYPE が BytesMessage、MapMessage、または StreamMessage として指定される場合にのみ使用できます。
PUT_SHORT
JMS メッセージに short 型整数を配置します。このパラメータは、TYPE が BytesMessage、MapMessage、または StreamMessage として指定される場合にのみ使用できます。
PUT_STRING
JMS メッセージに java.lang.String のインスタンスを配置します。このパラメータは、TYPE が BytesMessage、TextMessage、MapMessage、または StreamMessage として指定される場合にのみ使用できます。
QUEUE
新しいメッセージをサブミットする JMS キューの LDAP 相対識別名です。値は設定されているベース URI を基準とする LDAP 相対識別名です。相対の場合に、明示的に指定されていない場合、cn= (共有名の属性) は暗黙的です。このパラメータは必須です。
TIME_TO_LIVE
キューに入れたメッセージが有効である時間を分単位で指定します。このパラメータのデフォルトは 0 です。この場合、メッセージは無制限に有効です。このパラメータはオプションです。
SERVICE
特定の JMS サービスに接続できるように設定されている Info*Engine プロパティセットの名前。これにより、単一の Info*Engine 仮想マシン (VM) に対して複数の JMS サービスを設定できます。このパラメータはオプションです。
TYPE
作成する JMS メッセージのタイプを識別します。メッセージタイプは大文字と小文字を区別します。可能なメッセージタイプは以下のとおりです。
◦ InfoEngine - Info*Engine の通信に使用します。シリアル化された VDB グループは GROUP_IN パラメータによって制御されます。
◦ BytesMessage - 送信メッセージで、このタイプはサードパーティの受信者に特有のメッセージを構築するいくつかの PUT_type パラメータをサポートします。受信メッセージは Unknown と同じ方法で処理されます。BytesMessage のコンテンツは、呼び出しタスクへの入力ストリームの BLOB データとして供給されます。
◦ TextMessage - PUT_STRING パラメータのみをサポートします。複数の PUT_STRING パラメータ値が連結されて送信 TextMessage が作成されます。
◦ MapMessage - 送信メッセージに対して、name=data の形式の値を持ついくつかの PUT_type パラメータを指定できます。値の name 部分が MapMessage に data を配置するときに使用するキーです。
◦ StreamMessage - 送信メッセージで、このタイプはサードパーティの受信者に特有のメッセージを構築するいくつかの PUT_type パラメータをサポートします。
◦ Unknown - BLOB データを BytesMessage に切り替えます。受信メッセージで、新しい空の IeRequest が作成され、メッセージのコンテンツは BLOB データとして連結されます。
以下の表は、各 PUT_type パラメータに指定できるメッセージタイプを示したものです。
|
BytesMessage
|
TextMessage
|
MapMessage
|
StreamMessage
|
|
PUT_BOOLEAN
|
X
|
|
X
|
X
|
|
PUT_BYTE
|
X
|
|
X
|
X
|
|
PUT_BYTES
|
X
|
|
X
|
X
|
|
PUT_CHAR
|
X
|
|
X
|
X
|
|
PUT_DOUBLE
|
X
|
|
X
|
X
|
|
PUT_FLOAT
|
X
|
|
X
|
X
|
|
PUT_INT
|
X
|
|
X
|
X
|
|
PUT_LONG
|
X
|
|
X
|
X
|
|
PUT_SHORT
|
X
|
|
X
|
X
|
|
PUT_STRING
|
X
|
X
|
X
|
X
|
|
|
BytesMessage での STRING タイプのサポートによって、文字列の値は実際には文字列として書き込まれるのではなく、バイト配列として書き込まれます。
|
このパラメータのデフォルト値は InfoEngine です。これは Info*Engine リクエストがシリアル化され、キューに配置されることを意味します。この場合の「シリアル化」とは、実際の Java のシリアル化を意味する場合と、XML への Info*Engine リクエストのシリアル化を意味する場合 (BLOB データもキューに入れられる必要がある場合) があります。
例
以下の例は、JMS メッセージを作成し、それを指定したキューにサブミットします。
<%@page language="java" session="false"%>
<%@taglib uri="http://www.ptc.com/infoengine/taglib/core"
prefix="ie"%>
<ie:webject name="Create-Object" type="MSG">
<ie:param name="DBUSER" data="$(@FORM[]dbuser[])"/>
<ie:param name="PASSWD" data="$(@FORM[]passwd[])"/>
<ie:param name="QUEUE" data="$(@FORM[]queue[])"/>
<ie:param name="TIME_TO_LIVE" data="$(@FORM[]time[])"/>
<ie:param name="PRIORITY" data="$(@FORM[]priority[])"/>
<ie:param name="TYPE" data="TextMessage"/>
<ie:param name="PUT_STRING" data="$(@FORM[]string[])"/>
<ie:param name="GROUP_OUT" data="results"/>
</ie:webject>
この例を実際に実行するには、dbuser、passwd、queue、time、priority、および string 変数を識別するフォームを指定する必要があります。
以下の例は、サードパーティのアプリケーションで処理される XML データが含まれている TextMessage をキューに追加する場合の、Create-Object Webject の使用方法を示しています。
<%@page language="java"%>
<%@taglib uri="http://www.ptc.com/infoengine/taglib/core" prefix="ie"%>
<!-- get an "employee object from JDBC/JNDI or where ever,
for the purposes of example just using Create-Group -->
<ie:webject name="Create-Group" type="GRP">
<ie:param name="ELEMENT"
data="name=joe:email=joe@somewhere.nice"/>
<ie:param name="ELEMENT" data="name=bob:email=bob@nowhere.net"/>
<ie:param name="GROUP_OUT" data="employees"/>
</ie:webject>
<!-- xml-ize the parts -->
<ie:webject name="Format-Group" type="GRP">
<ie:param name="GROUP_IN" data="employees" />
<ie:param name="GROUP_OUT" data="formatted"/>
<ie:param name="ATTRIBUTE" data="name"/>
<ie:param name="ATTRIBUTE" data="email"/>
<ie:param name="FORMAT"
data="<employee><name>{0}</name><email>{1}</email></employee>"/>
</ie:webject>
<!-- turn them into an XML document and put in in a TextMessage on
my queue -->
<ie:webject name="Create-Object" type="MSG">
<ie:param name="PUT_STRING" data="<?xml version='1.0'> "/>
<ie:param name="PUT_STRING" data="<employees> "/>
<ie:param name="PUT_STRING"
data="$(formatted[*]nameemail[0]) "
valueSeparator=";" delim=";" />
<ie:param name="PUT_STRING" data="</employees> "/>
<ie:param name="TYPE" data="TextMessage"/>
<ie:param name="QUEUE" data="cn=The.Q"/>
</ie:webject>
Delete-Object
JMS キューからメッセージを除去します。
|
|
この Webject を使用するには、メッセージの送受信用に環境を設定する必要があります。
|
構文
<ie:webject name="Delete-Object" type="MSG">
<ie:param name="DBUSER" data="username"/>
<ie:param name="GROUP_OUT" data="group_name"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="QUEUE" data="managed_queue_name"/>
<ie:param name="WHERE" data="message_selector"/>
</ie:webject>
パラメータ
|
必須
|
選択
|
オプション
|
|
QUEUE
|
|
DBUSER
|
|
|
SERVICE
|
|
|
GROUP_OUT
|
|
|
PASSWD
|
|
|
WHERE
|
DBUSER
MOM への接続時に使用するユーザー名。このパラメータを指定すると、そのパラメータ値は、認証済みユーザーの既存の資格証明マッピング、または MOM への接続に使用するサービスの
.msg.username および
.jms.username プロパティで指定されている値よりも優先されます。詳細については、
MOM の資格証明マッピングを参照してください。
このパラメータを省略すると、Info*Engine のメッセージ送受信ソフトウェア用のマッピングされた認証が使用されます。このようなマッピングが見つからない場合は、Java Messaging Service (JMS) 用のマッピングされた認証が使用されます。これらのマッピングされた資格証明がいずれも見つからない場合は、.msg.username プロパティで設定されている値が使用されます。.msg.username プロパティが設定されていない場合は、.jms.username プロパティで設定されている値が使用されます。いずれのプロパティも設定されておらず、この DBUSER パラメータに値を指定しない場合、Info*Engine は MOM に接続するときにユーザー名を指定せず、匿名の接続を試みます。
このパラメータはオプションです。
SERVICE
特定の JMS サービスに接続できるように設定されている Info*Engine プロパティセットの名前。これにより、単一の Info*Engine 仮想マシン (VM) に対して複数の JMS サービスを設定できます。このパラメータはオプションです。
GROUP_OUT
正常に終了すると作成されて返されるステータスグループの名前。このパラメータのデフォルトは delete-results です。このパラメータはオプションです。
PASSWD
MOM への接続時に使用するパスワード。このパラメータを指定すると、そのパラメータ値は、認証済みユーザーの既存の資格証明マッピング、または MOM への接続に使用するサービスの
.msg.password および
.jms.password プロパティで指定されている値よりも優先されます。詳細については、
MOM の資格証明マッピングを参照してください。
このパラメータを省略すると、Info*Engine のメッセージ送受信ソフトウェア用のマッピングされた認証が使用されます。このようなマッピングが見つからない場合は、Java Messaging Service (JMS) 用のマッピングされた認証が使用されます。このようなマッピングされた資格証明がいずれも見つからない場合は、.msg.password プロパティで設定されている値が使用されます。.msg.password プロパティが設定されていない場合は、.jms.password プロパティで設定されている値が使用されます。いずれのプロパティも設定されず、この PASSWD パラメータに値を指定していない場合は、MOM に接続するときに Info*Engine はパスワードを指定しません。
このパラメータはオプションです。
QUEUE
JMS キューの LDAP 相対識別名を識別し、メッセージを除去します。値は設定されているベース URI を基準とする LDAP 相対識別名です。相対の場合に、明示的に指定されていない場合、cn= (共有名の属性) は暗黙的です。このパラメータは必須です。
WHERE
Sun Java Message Service 仕様の定義に従って、正しくフォーマットされた JMS メッセージセレクタを指定します。このパラメータは、メッセージキューから削除するメッセージのサブセットを選択するときに使用します。キューのサブセットの最初のメッセージが削除されます。このパラメータのデフォルトの動作は、キューの最初のメッセージの削除です。このパラメータはオプションです。
例
以下の例は、指定されたキューから JMS メッセージを削除します。
<%@page language="java" session="false"%>
<%@taglib uri="http://www.ptc.com/infoengine/taglib/core"
prefix="ie"%>
<ie:webject name="Delete-Object" type="MSG">
<ie:param name="DBUSER" data="$(@FORM[]dbuser[])"/>
<ie:param name="PASSWD" data="$(@FORM[]passwd[])"/>
<ie:param name="QUEUE" data="$(@FORM[]queue[])"/>
<ie:param name="WHERE" data="$(@FORM[]where[])"/>
<ie:param name="GROUP_OUT" data="results"/>
</ie:webject>
この例を実際に実行するには、dbuser、passwd、queue、および where 変数を識別するフォームを指定する必要があります。
Delete-Results
Info*Engine のタスクキューからのメッセージを読み込み、削除します。メッセージには既知の Info*Engine オブジェクトが含まれていると見なされます。通常これはユーザーに返すグループです。
|
|
この Webject を使用するには、タスクをキューに入れるように環境を設定する必要があります。
|
構文
<ie:webject name="Delete-Results" type="MSG">
<ie:param name="DBUSER" data="username"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="QUEUE" data="<managed_queue_name>"/>
<ie:param name="WHERE" data="<message_selector>"/>
</ie:webject>
パラメータ
|
必須
|
選択
|
オプション
|
|
|
DBUSER
|
|
|
SERVICE
|
|
|
PASSWD
|
|
|
QUEUE
|
|
|
WHERE
|
DBUSER
MOM への接続時に使用するユーザー名。このパラメータを指定すると、そのパラメータ値は、認証済みユーザーの既存の資格証明マッピング、または MOM への接続に使用するサービスの
.msg.username および
.jms.username プロパティで指定されている値よりも優先されます。詳細については、
MOM の資格証明マッピングを参照してください。
このパラメータを省略すると、Info*Engine のメッセージ送受信ソフトウェア用のマッピングされた認証が使用されます。このようなマッピングが見つからない場合は、Java Messaging Service (JMS) 用のマッピングされた認証が使用されます。これらのマッピングされた資格証明がいずれも見つからない場合は、.msg.username プロパティで設定されている値が使用されます。.msg.username プロパティが設定されていない場合は、.jms.username プロパティで設定されている値が使用されます。いずれのプロパティも設定されておらず、この DBUSER パラメータに値を指定しない場合、Info*Engine は MOM に接続するときにユーザー名を指定せず、匿名の接続を試みます。
このパラメータはオプションです。
SERVICE
特定の JMS サービスに接続できるように設定されている Info*Engine プロパティセットの名前。これにより、単一の Info*Engine 仮想マシン (VM) に対して複数の JMS サービスを設定できます。このパラメータはオプションです。
PASSWD
MOM への接続時に使用するパスワード。このパラメータを指定すると、そのパラメータ値は、認証済みユーザーの既存の資格証明マッピング、または MOM への接続に使用するサービスの
.msg.password および
.jms.password プロパティで指定されている値よりも優先されます。詳細については、
MOM の資格証明マッピングを参照してください。
このパラメータを省略すると、Info*Engine のメッセージ送受信ソフトウェア用のマッピングされた認証が使用されます。このようなマッピングが見つからない場合は、Java Messaging Service (JMS) 用のマッピングされた認証が使用されます。このようなマッピングされた資格証明がいずれも見つからない場合は、.msg.password プロパティで設定されている値が使用されます。.msg.password プロパティが設定されていない場合は、.jms.password プロパティで設定されている値が使用されます。いずれのプロパティも設定されず、この PASSWD パラメータに値を指定していない場合は、MOM に接続するときに Info*Engine はパスワードを指定しません。
このパラメータはオプションです。
QUEUE
管理キューの LDAP 識別名。値は設定されているベース URI を基準とする LDAP 相対識別名です。相対の場合に、明示的に指定されていない場合、cn= (共有名の属性) は暗黙的です。このパラメータのデフォルトでは、com.infoengine.msg.defaultResponseQueue プロパティで指定されている値を使用します。
このパラメータはオプションです。
WHERE
Sun Java Message Service 仕様の定義に従って、正しくフォーマットされた JMS メッセージセレクタを指定します。このパラメータは、メッセージキューから削除するメッセージのサブセットを選択するときに使用します。キューのサブセットの最初のメッセージが削除されます。
Queue-Task Webject の CORRELATION_ID パラメータの値を WHERE 値として使用して該当する結果を選択できます。
このパラメータのデフォルトは、SERVER コンテキストグループ内にあるユーザー ID から導出され、このユーザーメッセージを含んでいるサブセットになります。このパラメータはオプションです。
例
以下の例は、指定されたキューからメッセージを読み込み、その後メッセージを削除します。
<%@page language="java" session="false" %>
<%@taglib uri="http://www.ptc.com/infoengine/taglib/core"
prefix="ie"%>
<ie:webject name="delete-results" type="MSG">
<ie:param name="QUEUE" data="$(FORM[]QUEUE[0])"/>
<ie:param name="CORRELATION_ID"
data="$(FORM[]CORRID[0])"/>
<ie:param name="WHERE" data="$(@FORM[]where[0])"/>
<ie:param nam
<ie:webject name="Return-Groups" type="GRP">
<ie:param name="GROUP_IN" data="*"/>
</ie:webject>
この例を実際に実行するには、QUEUE、CORRID、および where 変数を識別するフォームを指定する必要があります。
Query-Object
JMS メッセージキューからメッセージを読み込みます。返すメッセージがない場合は、com.infoengine.exception.nonfatal.IERequestTimeOutException のインスタンスが生成されます。
|
|
この Webject を使用するには、メッセージの送受信用に環境を設定する必要があります。
|
構文
<ie:webject name="Query-Object" type="MSG">
<ie:param name="BLOB_COUNT" data="number"/>
<ie:param name="DBUSER" data="username"/>
<ie:param name="DELETE" data="[TRUE | FALSE]"/>
<ie:param name="GET_BOOLEAN" data ="[TRUE | FALSE]"/>
<ie:param name="GET_BYTE" data ="byte"/>
<ie:param name="GET_BYTES" data ="bytes"/>
<ie:param name="GET_CHAR" data ="char"/>
<ie:param name="GET_DOUBLE" data ="double"/>
<ie:param name="GET_FLOAT" data ="float"/>
<ie:param name="GET_INT" data ="int"/>
<ie:param name="GET_LONG" data ="long"/>
<ie:param name="GET_SHORT" data ="short"/>
<ie:param name="GET_STRING" data ="string"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="QUEUE" data="managed_queue_name"/>
<ie:param name="WHERE" data="message_selector"/>
</ie:webject>
パラメータ
|
必須
|
選択
|
オプション
|
|
QUEUE
|
|
BLOB_COUNT
|
|
|
DBUSER
|
|
|
SERVICE
|
|
|
DELETE
|
|
|
GET_BOOLEAN
|
|
|
GET_BYTE
|
|
|
GET_BYTES
|
|
|
GET_CHAR
|
|
|
GET_DOUBLE
|
|
|
GET_FLOAT
|
|
|
GET_INT
|
|
|
GET_LONG
|
|
|
GET_SHORT
|
|
|
GET_STRING
|
|
|
PASSWD
|
|
|
WHERE
|
BLOB_COUNT
呼び出し元の出力ストリームで返す BLOB の数。返されない BLOB はほかのタスクまたは Webject への入力として使用できます。このパラメータのデフォルトは 0 です。このパラメータはオプションです。
DBUSER
MOM への接続時に使用するユーザー名。このパラメータを指定すると、そのパラメータ値は、認証済みユーザーの既存の資格証明マッピング、または MOM への接続に使用するサービスの
.msg.username および
.jms.username プロパティで指定されている値よりも優先されます。詳細については、
MOM の資格証明マッピングを参照してください。
このパラメータを省略すると、Info*Engine のメッセージ送受信ソフトウェア用のマッピングされた認証が使用されます。このようなマッピングが見つからない場合は、Java Messaging Service (JMS) 用のマッピングされた認証が使用されます。これらのマッピングされた資格証明がいずれも見つからない場合は、.msg.username プロパティで設定されている値が使用されます。.msg.username プロパティが設定されていない場合は、.jms.username プロパティで設定されている値が使用されます。いずれのプロパティも設定されておらず、この DBUSER パラメータに値を指定しない場合、Info*Engine は MOM に接続するときにユーザー名を指定せず、匿名の接続を試みます。このパラメータはオプションです。
SERVICE
特定の JMS サービスに接続できるように設定されている Info*Engine プロパティセットの名前。これにより、単一の Info*Engine 仮想マシン (VM) に対して複数の JMS サービスを設定できます。このパラメータはオプションです。
DELETE
キューからメッセージを読み込んで、除去するかどうかを指定します。このパラメータのデフォルトは TRUE です。この場合は、キューからオブジェクトを読み込んだ後、削除します。無効にするには、FALSE を使用します。このパラメータはオプションです。
GET_BOOLEAN
Java ブール値を JMS メッセージから読み込みます。値は TRUE または FALSE のいずれかで指定します。受信メッセージのタイプが StreamMessage の場合にのみ、このパラメータを使用できます。このパラメータはオプションです。
GET_BYTE
JMS メッセージからシングルバイトを読み込みます。受信メッセージのタイプが StreamMessage の場合にのみ、このパラメータを使用できます。このパラメータはオプションです。
GET_BYTES
JMS メッセージから複数のバイトを読み込みます。受信メッセージのタイプが StreamMessage の場合にのみ、このパラメータを使用できます。このパラメータはオプションです。
GET_CHAR
JMS メッセージから 1 つの Java 文字を読み込みます。受信メッセージのタイプが StreamMessage の場合にのみ、このパラメータを使用できます。このパラメータはオプションです。
GET_DOUBLE
JMS メッセージから Java ダブル (実数) 値を読み込みます。受信メッセージのタイプが StreamMessage の場合にのみ、このパラメータを使用できます。このパラメータはオプションです。
GET_FLOAT
JMS メッセージから浮動小数点値を読み込みます。受信メッセージのタイプが StreamMessage の場合にのみ、このパラメータを使用できます。このパラメータはオプションです。
GET_INT
JMS メッセージから整数を読み込みます。受信メッセージのタイプが StreamMessage の場合にのみ、このパラメータを使用できます。このパラメータはオプションです。
GET_LONG
JMS メッセージから long 型整数を読み込みます。受信メッセージのタイプが StreamMessage の場合にのみ、このパラメータを使用できます。このパラメータはオプションです。
GET_SHORT
JMS メッセージから short 型整数を読み込みます。受信メッセージのタイプが StreamMessage の場合にのみ、このパラメータを使用できます。このパラメータはオプションです。
GET_STRING
JMS メッセージから java.lang.String のインスタンスを読み込みます。受信メッセージのタイプが StreamMessage の場合にのみ、このパラメータを使用できます。このパラメータはオプションです。
PASSWD
MOM への接続時に使用するパスワード。このパラメータを指定すると、そのパラメータ値は、認証済みユーザーの既存の資格証明マッピング、または MOM への接続に使用するサービスの
.msg.password および
.jms.password プロパティで指定されている値よりも優先されます。詳細については、
MOM の資格証明マッピングを参照してください。
このパラメータを省略すると、Info*Engine のメッセージ送受信ソフトウェア用のマッピングされた認証が使用されます。このようなマッピングが見つからない場合は、Java Messaging Service (JMS) 用のマッピングされた認証が使用されます。このようなマッピングされた資格証明がいずれも見つからない場合は、.msg.password プロパティで設定されている値が使用されます。.msg.password プロパティが設定されていない場合は、.jms.password プロパティで設定されている値が使用されます。いずれのプロパティも設定されず、この PASSWD パラメータに値を指定していない場合は、MOM に接続するときに Info*Engine はパスワードを指定しません。
このパラメータはオプションです。
QUEUE
メッセージを取り出す JMS キューの相対識別名。値は設定されているベース URI を基準とする LDAP 相対識別名です。相対の場合に、明示的に指定されていない場合、cn= (共有名の属性) は暗黙的です。このパラメータは必須です。
WHERE
Sun Java Message Service 仕様の定義に従って、正しくフォーマットされた JMS メッセージセレクタを指定します。このパラメータは、メッセージキューから読み込むメッセージのサブセットを選択するときに使用します。キューのサブセットの最初のメッセージが返されます。このパラメータのデフォルトでは、キューのすべてのメッセージを選択します。このパラメータはオプションです。
例
以下の例は、指定されたキューから JMS メッセージを読み込みます。
<%@page language="java" session="false" %>
<%@taglib uri="http://www.ptc.com/infoengine/taglib/core"
prefix="ie"%>
<ie:webject name="Query-Object" type="MSG">
<ie:param name="DBUSER" data="$(@FORM[]dbuser[])"/>
<ie:param name="PASSWD" data="$(@FORM[]passwd[])"/>
<ie:param name="DELETE" data="$(@FORM[]delete[])"/>
<ie:param name="QUEUE" data="$(@FORM[]queue[])"/>
<ie:param name="WHERE" data="$(@FORM[]where[])"/>
</ie:webject>
この例を実際に実行するには、dbuser、passwd、delete、および where 変数を識別するフォームを指定する必要があります。
Query-Results
Info*Engine タスクキューからメッセージを読み込み、結果を返します。デフォルト設定では、その後でキューからメッセージを削除します。メッセージには既知の Info*Engine オブジェクトが含まれていると見なされます。通常これはユーザーに返すグループです。
|
|
この Webject を使用するには、タスクをキューに入れるように環境を設定する必要があります。
|
構文
<ie:webject name="Query-Results" type="MSG">
<ie:param name="CORRELATION_ID" data="message_selector"/>
<ie:param name="DBUSER" data="username"/>
<ie:param name="DELETE" data="[TRUE | FALSE]"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="QUEUE" data="managed_queue_name"/>
<ie:param name="WAIT_TIME" data="wait_time"/>
<ie:param name="WHERE" data="message_selector"/>
</ie:webject>
パラメータ
|
必須
|
選択
|
オプション
|
|
|
CORRELATION_ID
|
|
|
DBUSER
|
|
|
SERVICE
|
|
|
DELETE
|
|
|
PASSWD
|
|
|
QUEUE
|
|
|
WAIT_TIME
|
|
|
WHERE
|
CORRELATION_ID
JMS ヘッダーの相関識別子。この値は、レスポンスキューから結果を選択するために使用され、Queue-Task Webject で実行するためにタスクをキューに入れる際に使用される CORRELATION_ID パラメータの値と一致しています。このパラメータはオプションです。
DBUSER
MOM への接続時に使用するユーザー名。このパラメータを指定すると、そのパラメータ値は、認証済みユーザーの既存の資格証明マッピング、または MOM への接続に使用するサービスの
.msg.username および
.jms.username プロパティで指定されている値よりも優先されます。詳細については、
MOM の資格証明マッピングを参照してください。
このパラメータを省略すると、Info*Engine のメッセージ送受信ソフトウェア用のマッピングされた認証が使用されます。このようなマッピングが見つからない場合は、Java Messaging Service (JMS) 用のマッピングされた認証が使用されます。これらのマッピングされた資格証明がいずれも見つからない場合は、.msg.username プロパティで設定されている値が使用されます。.msg.username プロパティが設定されていない場合は、.jms.username プロパティで設定されている値が使用されます。いずれのプロパティも設定されておらず、この DBUSER パラメータに値を指定しない場合、Info*Engine は MOM に接続するときにユーザー名を指定せず、匿名の接続を試みます。
このパラメータはオプションです。
SERVICE
特定の JMS サービスに接続できるように設定されている Info*Engine プロパティセットの名前。これにより、単一の Info*Engine 仮想マシン (VM) に対して複数の JMS サービスを設定できます。このパラメータはオプションです。
DELETE
正常にユーザーにメッセージを返したときに、キューからそのメッセージを削除するかどうかを示します。値を TRUE に指定すると、メッセージは削除されます。値を FALSE に指定すると、メッセージは削除されません。このパラメータのデフォルトは TRUE です。このパラメータはオプションです。
PASSWD
MOM への接続時に使用するパスワード。このパラメータを指定すると、そのパラメータ値は、認証済みユーザーの既存の資格証明マッピング、または MOM への接続に使用するサービスの .msg.password および .jms.password プロパティで指定されている値よりも優先されます。
このパラメータを省略すると、Info*Engine のメッセージ送受信ソフトウェア用のマッピングされた認証が使用されます。このようなマッピングが見つからない場合は、Java Messaging Service (JMS) 用のマッピングされた認証が使用されます。このようなマッピングされた資格証明がいずれも見つからない場合は、.msg.password プロパティで設定されている値が使用されます。.msg.password プロパティが設定されていない場合は、.jms.password プロパティで設定されている値が使用されます。いずれのプロパティも設定されず、この PASSWD パラメータに値を指定していない場合は、MOM に接続するときに Info*Engine はパスワードを指定しません。
このパラメータはオプションです。
QUEUE
管理キューの LDAP 識別名です。値は設定されているベース URI を基準とする LDAP 相対識別名です。相対の場合に、明示的に指定されていない場合、cn= (共有名の属性) は暗黙的です。このパラメータのデフォルトでは、com.infoengine.msg.defaultResultsQueue プロパティで指定されている値を使用します。
このパラメータはオプションです。
WAIT_TIME
指定されたキューに結果が到達するまでの待ち時間 (秒単位)。このパラメータのデフォルトは 0 です。このパラメータはオプションです。
WHERE
Sun Java Message Service 仕様の定義に従って、正しくフォーマットされた JMS メッセージセレクタを指定します。このパラメータは、メッセージキューから読み込むメッセージのサブセットを選択するときに使用します。キューのサブセットの最初のメッセージが返されます。
Queue-Task Webject の CORRELATION_ID パラメータの値を WHERE 値として使用して該当する結果を選択できます。
このパラメータのデフォルトは、SERVER コンテキストグループ内にあるユーザー ID から導出され、このユーザーメッセージを含んでいるサブセットになります。このパラメータはオプションです。
例
以下の例は、指定されたキューからメッセージを読み込み、結果を返します。
<%@page language="java" session="false"%>
<%@taglib uri="http://www.ptc.com/infoengine/taglib/core"
prefix="ie"%>
<ie:webject name="Query-Results" type="MSG">
<ie:param name="QUEUE" data="$(@FORM[]queue[0])"/>
<ie:param name="CORRELATION_ID"
data="$(@FORM[]corrid[0])"/>
<ie:param name="WHERE" data="$(@FORM[]where[0])"/>
<ie:param name="DELETE" data="$(@FORM[]delete[])"/>
<ie:param name="WAIT_TIME" data="10"/>
</ie:webject>
<ie:webject name="Return-Groups" type="GRP">
<ie:param name="GROUP_IN" data="*"/>
</ie:webject>
この例を実際に実行するには、queue、corrid、where、および delete 変数を識別するフォームを指定する必要があります。
Queue-Task
Info*Engine のタスクキューの購読ユーザーが、実行するタスクをキューに追加できるようにします。タスクは、タスク実行名、および必要な場合は 1 つまたは複数の既存の Info*Engine グループから構築されます。
|
|
この Webject を使用するには、タスクをキューに入れるように環境を設定する必要があります。
|
構文
<ie:webject name=Queue-Task type="MSG">
<ie:param name="CORRELATION_ID" data="message_selector"/>
<ie:param name="DBUSER" data="username"/>
<ie:param name="DESTINATION" data="queue_name"/>
<ie:param name="GROUP_IN" data="group_name"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="PRIORITY" data="numeric_value"/>
<ie:param name="QUEUE" data="queue_name"/>
<ie:param name="RESULT_TIME_TO_LIVE" data="minutes"/>
<ie:param name="TASK" data="task_uri"/>
<ie:param name="TASK_TIME_TO_LIVE" data="minutes"/>
</ie:webject>
パラメータ
|
必須
|
選択
|
オプション
|
|
TASK
|
|
CORRELATION_ID
|
|
|
DBUSER
|
|
|
SERVICE
|
|
|
DESTINATION
|
|
|
GROUP_IN
|
|
|
PASSWD
|
|
|
PRIORITY
|
|
|
QUEUE
|
|
|
RESULT_TIME_TO_LIVE
|
|
|
TASK_TIME_TO_LIVE
|
CORRELATION_ID
結果の JMS ヘッダの相関識別子として設定する JMS メッセージセレクタを指定します。その後、このパラメータの値は、対応する結果を選択する Query-Results または Delete-Results Webject の WHERE パラメータの値として使用できます。
このパラメータのデフォルト値は、SERVER コンテキストグループ内にある auth-user HTTP ヘッダ値から導出されます。auth-user を定義せず、明示的な相関識別子を指定しない場合、相関識別子はタスクに関連付けられません。この場合は、Query-Task から返される Info*Engine グループは、タスクと関連付けられている相関識別子の値を返します。このパラメータはオプションです。
DESTINATION
タスクの実行後、レスポンスを入れるキューの LDAP 識別名。このパラメータのデフォルトでは、com.infoengine.msg.defaultResponseQueue プロパティで指定されている値を使用します。このパラメータはオプションです。
DBUSER
MOM への接続時に使用するユーザー名。このパラメータを指定すると、そのパラメータ値は、認証済みユーザーの既存の資格証明マッピング、または MOM への接続に使用するサービスの
.msg.username および
.jms.username プロパティで指定されている値よりも優先されます。詳細については、
MOM の資格証明マッピングを参照してください。
このパラメータを省略すると、Info*Engine のメッセージ送受信ソフトウェア用のマッピングされた認証が使用されます。このようなマッピングが見つからない場合は、Java Messaging Service (JMS) 用のマッピングされた認証が使用されます。これらのマッピングされた資格証明がいずれも見つからない場合は、.msg.username プロパティで設定されている値が使用されます。.msg.username プロパティが設定されていない場合は、.jms.username プロパティで設定されている値が使用されます。いずれのプロパティも設定されておらず、この DBUSER パラメータに値を指定しない場合、Info*Engine は MOM に接続するときにユーザー名を指定せず、匿名の接続を試みます。このパラメータはオプションです。
SERVICE
特定の JMS サービスに接続できるように設定されている Info*Engine プロパティセットの名前。これにより、単一の Info*Engine 仮想マシン (VM) に対して複数の JMS サービスを設定できます。このパラメータはオプションです。
GROUP_IN
キューに入れるタスクに添付するローカル VDB Info*Engine グループのオブジェクト名。デフォルトの動作は、グループを添付しません。このパラメータには複数のグループを指定できます。このパラメータはオプションです。
PASSWD
MOM への接続時に使用するパスワード。このパラメータを指定すると、そのパラメータ値は、認証済みユーザーの既存の資格証明マッピング、または MOM への接続に使用するサービスの .msg.password および .jms.password プロパティで指定されている値よりも優先されます。
このパラメータを省略すると、Info*Engine のメッセージ送受信ソフトウェア用のマッピングされた認証が使用されます。このようなマッピングが見つからない場合は、Java Messaging Service (JMS) 用のマッピングされた認証が使用されます。このようなマッピングされた資格証明がいずれも見つからない場合は、.msg.password プロパティで設定されている値が使用されます。.msg.password プロパティが設定されていない場合は、.jms.password プロパティで設定されている値が使用されます。いずれのプロパティも設定されず、この PASSWD パラメータに値を指定していない場合は、MOM に接続するときに Info*Engine はパスワードを指定しません。このパラメータはオプションです。
PRIORITY
送信メッセージに設定する整数の優先度を指定します。JMS キューの優先度の有効範囲は、0 ～ 9 で、通常のデフォルト値は 4 です。Info*Engine は優先度を無視しますが、Info*Engine によって送信されたイベントを受信するサードパーティのソフトウェアではこれが使用される場合があります。このパラメータのデフォルトでは、優先度を設定しません。これによって、メッセージは MOM のデフォルトの優先度でキューに入れられます。このパラメータはオプションです。
QUEUE
タスクを配置するキューの LDAP 識別名。このパラメータのデフォルトでは、com.infoengine.msg.defaultExecutionQueue プロパティで指定されている値を使用します。このパラメータはオプションです。
RESULT_TIME_TO_LIVE
MOM によって破棄されるまで、タスクの実行結果がレスポンスキュー内に保持される時間を指定する数値を示します。このパラメータは数の文字列で分単位で指定します。このパラメータのデフォルトは 0 です。この場合、MOM によってレスポンスは破棄されません。このパラメータはオプションです。
TASK
EXECUTION_QUEUE のリスナーが実行する XML タスクファイルの場所である URI を指定します。URI は以下の相対 URI または絶対 URI のどちらかです。
◦ 相対 URI の参照ファイル。ローカル Info*Engine のタスクプロセッサに定義されたルートファイルシステムディレクトリに常駐します。
◦ 絶対 URI の参照ファイル。ローカルファイルシステム、またはリモート HTTP サーバーに常駐するか、またはアクセス可能な LDAP ディレクトリを介して参照されます。
このパラメータは必須です。
|
|
NT システムではバックスラッシュ (\) をディレクトリのセパレータとして使用しますが、本ガイドの URI ではファイルパスのセパレータとしてスラッシュ (/) を使用します。スラッシュを指定すると、Info*Engine はすべてのシステム URI を正しく識別します。NT URI にバックスラッシュを使用する場合、URI でバックスラッシュをエスケープする必要があります。つまり、URI では 1 つの \ について 2 つ \\ と入力します。
|
TASK_TIME_TO_LIVE
MOM によって破棄されるまで、実行キューにメッセージを保持する時間を指定した数値を示します。このパラメータは数の文字列で分単位で指定します。このパラメータのデフォルトは 0 です。この場合、MOM によってメッセージは破棄されません。このパラメータはオプションです。
例
以下の例は、指定されたタスクを指定されたキューに追加します。
<%@page language="java" session="false"%>
<%@taglib uri="http://www.ptc.com/infoengine/taglib/core" prefix="ie"%>
<ie:webject name="queue-task" type="MSG">
<ie:param name="TASK" data="$(@FORM[]TASK[0])"
default="/com/company/CreateGroup.xml"/>
<ie:param name="QUEUE" data="$(@FORM[]QUEUE[0])"/>
<ie:param name="TASK_TIME_TO_LIVE"
data="$(@FORM[]TTTL[0])"/>
<ie:param name="RESULT_TIME_TO_LIVE"
data="$(@FORM[]RTTL[0])"/>
<ie:param name="DESTINATION" data="$(@FORM[]DEST[0])"/>
<ie:param name="CORRELATION_ID"
data="$(@FORM[]CORRID[0])"/>
<ie:param name="PRIORITY" data="$(@FORM[]PRIORITY[])"/>
<ie:param name="GROUP_OUT" data="myQueueResults"/>
</ie:webject>
この例を実際に実行するには、TASK、QUEUE、TTTL、RTTL、DEST、CORRID、および PRIORITY 変数を識別するフォームを指定する必要があります。
Send-Mail
電子メールメッセージを作成して送信します。Send-Mail は、メッセージの件名および本文と同様に、プライマリ、コピー、およびブラインドコピーの受信者の指定をサポートします。複数のメッセージ本文タイプを含んでいる、複数の部分から構成される MIME メッセージを作成して送信できます。これによって、メッセージ本文を Webject パラメータを使用した簡単なテキスト、またはタスク入力ストリームを使用した BLOB として指定できます。
構文
<ie:webject name="Send-Mail" type="MSG">
<ie:param name="BCC" data="e-mail_address"/>
<ie:param name="BLOB_COUNT" data="number"/>
<ie:param name="CC" data="e-mail_address"/>
<ie:param name="CONNECTION_TIMEOUT" data="milliseconds"/>
<ie:param name="CONTENT" data="message_body"/>
<ie:param name="CONTENT_TYPE" data="MIME_type"/>
<ie:param name="CONTENT_URL_LANGUAGE" data="
<ie:param name="DBUSER" data="username"/>
<ie:param name="FROM" data="e-mail_address"/>
<ie:param name="GROUP_OUT" data="results"/>
<ie:param name="HEADERS_CHARSET" data="
<ie:param name="MAIL_SERVER" data="host_name"/>
<ie:param name="MAX_DELIVERY_TIME" data="
<ie:param name="MULTIPART_TYPE" data="
<ie:param name="PASSWD" data="password"/>
<ie:param name="PASSWORD" data="password"/>
<ie:param name="REPLY_TO" data="e-mail_address"/>
<ie:param name="SUBJECT" data="message_subject"/>
<ie:param name="TIMEOUT" data="milliseconds"/>
<ie:param name="TO" data="e-mail_address"/>
<ie:param name="USERNAME" data="user_name"/>
</webject>
パラメータ
|
必須
|
選択
|
オプション
|
|
以下のように変更します。
|
BLOB_COUNT
|
CC
|
|
|
CONNECTION_TIMEOUT
|
|
CONTENT
|
BCC
|
|
CONTENT_LINE_BREAK
|
DBUSER
|
|
CONTENT_TYPE
|
FROM
|
|
CONTENT_URL
|
GROUP_OUT
|
|
|
HEADER
|
|
|
HEADERS_CHARSET
|
|
|
MAIL_SERVER
|
|
|
MAX_DELIVERY_TIME
|
|
|
MULTIPART_TYPE
|
|
|
PASSWD
|
|
|
PASSWORD
|
|
|
REPLY_TO
|
|
|
SUBJECT
|
|
|
TIMEOUT
|
|
|
USERNAME
|
BCC
メッセージのブラインドコピー受信者の電子メールアドレス。これらの受信者はそれぞれメッセージのコピーを受信しますが、これらのアドレスはほかのブラインドコピー受信者を含めて、ほかの受信者に公開されません。このパラメータを複数回指定して、複数のブラインドコピー受信者を指定できます。パラメータのインスタンスごとに 1 つのアドレスを指定します。このパラメータはオプションです。
BLOB_COUNT
入力ストリームから読み取る BLOB 数。CONTENT パラメータも指定した場合、BLOB は添付資料としてメッセージに追加されます。CONTENT パラメータを指定しない場合は、BLOB はメッセージになります。
CC
メッセージのコピーを送信する、プライマリ以外の受信者の電子メールアドレス。このパラメータを複数回指定して、複数のコピー受信者を指定できます。パラメータのインスタンスごとに 1 つのアドレスを指定します。このパラメータはオプションです。
CONTENT
メッセージ本文のテキスト。CONTENT パラメータの各インスタンスは CONTENT_TYPE パラメータのインスタンスに対応し、CONTENT パラメータの MIME コンテンツタイプを指定します。CONTENT_TYPE を指定しない場合、BLOB_COUNT パラメータを指定しないと CONTENT パラメータはデフォルトのプレーンテキストに指定されます。このパラメータには複数の値を指定できます。
CONTENT_LINE_BREAK
このパラメータは改行に使用する文字列 (複数も可) を指定できる複数値のパラメータです。電子メールのコンテンツに、このパラメータで示される値が見つかると、改行に置き換えられます。
CONTENT_TYPE
対応する CONTENT パラメータの MIME コンテンツタイプ。CONTENT_TYPE パラメータの各インスタンスは、CONTENT パラメータのインスタンスに対応し、そのパラメータの MIME コンテンツタイプを指定します。CONTENT_TYPE パラメータを指定しない場合、CONTENT パラメータの MIME コンテンツタイプはデフォルト値である text/plain になります。同様に、CONTENT パラメータよりも CONTENT_TYPE パラメータのほうが少ない場合、text/plain 値が CONTENT_TYPE パラメータのリストに暗黙的に追加されます。
CONTENT_URL
CONTENT_URL パラメータには、複数の値を指定できます。各値は、開いて読み取られる URL を指定します。URL から読み取られたコンテンツは、送信されるメッセージ本文 (メインボディまたはアタッチメント) になります。
DBUSER
SMTP メールサーバーへの接続時に使用するユーザー名。このパラメータはオプションです。
FROM
メッセージの発信者の電子メールアドレス。このパラメータのデフォルトでは、com.infoengine.mail.originator プロパティの値が使用されます。プロパティが存在せず、FROM パラメータを指定していない場合は、例外が発生します。このパラメータはオプションです。
GROUP_OUT
出力グループのオプションの名前。このパラメータが指定されると、sent、unsent、および invalid の 3 つの属性を持つ 1 つの要素を含んだ出力グループが返されます。
◦ sent 属性は、メッセージが送信されたアドレスを示します。
◦ unsent 属性は、有効であるが (たとえば、メールサーバーが使用不可であったために) メッセージを送信できなかったアドレスを示します
◦ invalid 属性は、無効なアドレスを示します。
HEADER
送信メッセージに追加するオプションのヘッダー。このパラメータには複数の値を指定できます。
このパラメータのフォーマットは name=value です (value は引用符で囲みません)。
たとえば、次の値を指定すると、そのユーザーが実際に CC リストに含まれていない (電子メールを受信しない) 場合でも、CC ヘッダーがメッセージに追加されます。
cc=user@host.com
|
|
このパラメータは、電子メールを複数の言語で受信者に送信する場合に便利です。受信者グループに異なる言語ロケールが設定されている場合、Windchill はロケール別に電子メールを送信します。ただし、言語ごとに電子メールを送信する場合、受信者リストには同じロケールを共有するユーザーしか表示されません。1 つの電子メールに対して複数のロケールグループが含まれているかどうかについて混乱しないように、HEADER を cc=user@host.com に設定できます。
|
HEADERS_CHARSET
件名ヘッダーなどの電子メールヘッダーで使用する文字セットの名前。
MAIL_SERVER
受信者に送信されるルーティング用メッセージの SMTP メールサーバーのインターネットドメイン名。このパラメータのデフォルトでは、com.infoengine.mail.smtp.server プロパティからメールサーバー名を取得します。プロパティが存在せず、MAIL_SERVER を指定していない場合、メールサーバーはデフォルトで値ある localhost になります。このパラメータはオプションです。
MAX_DELIVERY_TIME
有効なアドレスにメッセージの配信を試みる時間の最大長さ (秒単位)。このパラメータは、メールの転送において (メールサーバーの一時的な使用不可や混雑などの理由により) 有効なアドレスがメールサーバーで承認されない場合に使用されます。デフォルト値は 60 秒です。
MULTIPART_TYPE
複数の CONTENT および CONTENT_URL パラメータ値が指定された場合の、マルチパートメッセージの MIME サブタイプ。このパラメータのデフォルト値は mixed です。
PASSWD
DBUSER パラメータと関連付けられているパスワード。このパラメータはオプションです。
PASSWORD
SMTP メールサーバーへの認証時に指定するパスワード。PASSWORD は USERNAME とともに使用できますが、両方のパラメータを指定する必要はありません。このパラメータのデフォルトでは、.mail.smtp.password プロパティからパスワードを取得します。このパラメータはオプションです。
REPLY_TO
返信先の電子メールアドレス。このパラメータには複数の値を指定できます。パラメータのインスタンスごとに 1 つの電子メールアドレスを指定します。このパラメータのデフォルトでは、FROM によって指定されたアドレスに返信します。このパラメータはオプションです。
SUBJECT
メッセージの件名ヘッダー。指定していない場合、メッセージに件名ヘッダは含まれません。このパラメータはオプションです。
以下のように変更します。
メッセージのプライマリ受信者の電子メールアドレス (複数も可)。複数回指定して、複数のプライマリ受信者を指定できます。パラメータのインスタンスごとに 1 つのアドレスを指定します。これは必須のパラメータです。
USERNAME
SMTP メールサーバーへの認証時に指定するパスワード。USERNAME は PASSWORD とともに使用できますが、両方のパラメータを指定する必要はありません。このパラメータのデフォルトでは、.mail.smtp.username プロパティからユーザー名を取得します。プロパティが存在せず、USERNAME を指定していない場合、メールサーバーに匿名のバインディングを試みます。このパラメータはオプションです。
例
以下の例は、ユーザー入力に基づいて電子メールを送信します。
<%@page language="java" session="false"%>
<%@taglib uri="http://www.ptc.com/infoengine/taglib/core"
prefix="ie"%>
<ie:webject name="Send-Mail" type="MSG">
<ie:param name="USERNAME" data="$(@FORM[]user[])"/>
<ie:param name="PASSWORD" data="$(@FORM[]password[])"/>
<ie:param name="TO" data="$(@FORM[]to[])"/>
<ie:param name="FROM" data="$(@FORM[]from[])"/>
<ie:param name="SUBJECT" data="$(@FORM[]subject[])"/>
<ie:param name="CONTENT_TYPE"
data="$(@FORM[]contentType[])"/>
<ie:param name="CONTENT" data="$(@FORM[]content[])"/>
</ie:webject>
この例を実際に実行するには、user、password、to、from、subject、contentType、および content 変数を識別するフォームを指定する必要があります。
Subscribe-Queue
指定されたキューにメッセージが受信されると、MOM 実装に呼び出されるイベントハンドラを登録します。
|
|
この Webject を使用するには、タスクをキューに入れるように環境を設定する必要があります。
|
構文
<ie:webject name=Subscribe-Queue type="MSG">
<ie:param name="DBUSER" data="username"/>
<ie:param name="EXECUTE_TASK" data="task_name"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="QUEUE" data="managed_queue_name"/>
<ie:param name="WHERE" data="jms_message_selector"/>
<ie:param name="MAX_CONCURRENCY"="managed_receiver_generation"/>
</ie:webject>
パラメータ
|
必須
|
選択
|
オプション
|
|
|
DBUSER
|
|
|
SERVICE
|
|
|
EXECUTE_TASK
|
|
|
PASSWD
|
|
|
QUEUE
|
|
|
WHERE
|
|
|
MAX_CONCURRENCY
|
DBUSER
MOM への接続時に使用するユーザー名。このパラメータを指定すると、そのパラメータ値は、認証済みユーザーの既存の資格証明マッピング、または MOM への接続に使用するサービスの .msg.username および .jms.username プロパティで指定されている値よりも優先されます。
このパラメータを省略すると、Info*Engine のメッセージ送受信ソフトウェア用のマッピングされた認証が使用されます。このようなマッピングが見つからない場合は、Java Messaging Service (JMS) 用のマッピングされた認証が使用されます。これらのマッピングされた資格証明がいずれも見つからない場合は、.msg.username プロパティで設定されている値が使用されます。.msg.username プロパティが設定されていない場合は、.jms.username プロパティで設定されている値が使用されます。いずれのプロパティも設定されておらず、この DBUSER パラメータに値を指定しない場合、Info*Engine は MOM に接続するときにユーザー名を指定せず、匿名の接続を試みます。
このパラメータはオプションです。
EXECUTE_TASK
メッセージが購読されるキューに受信されるときに実行されるタスク。受信メッセージに実行するタスクが含まれていない場合は、このパラメータで指定したタスクが実行されます。
EXECUTE_TASK を指定しない場合、購読でそのキューの Info*Engine リクエストのみが処理され、ほかの受信メッセージは却下されます。このパラメータはオプションです。
MAX_CONCURRENCY
キューの購読によって生成される受信者の数。これは、Info*Engine システムが同時に処理するメッセージの最大数を指定します。デフォルト値は 1 で、メッセージが逐次処理されます。
MAX_CONCURRENCY が 1 より大きい値に設定されていると、キューに配置されているメッセージは必ずしもキューに配置された順序で処理されるとはかぎりません。メッセージの順序が重要な場合は、このパラメータを使用しないでください。このパラメータはオプションです。
|
|
このパラメータを指定しても、すべての受信者がキューの負荷を受けたときにビジー状態になるとはかぎりません。この機能は、接続先の MOM を決定するコンフィギュレーションに部分的に依存しています。
このため、Tibco EMS は "prefetch" というキューのプロパティをサポートしています。このプロパティのデフォルト値は 5 であり、これは任意の受信者が同時に 5 つのメッセージを受信することを意味します。したがって、キュー内のデータの量によっては、MAX_CONCURRENCY の値が大きすぎると、特定の受信者がアイドル状態のままになる可能性があります。たとえば、Tibco EMS のデフォルトのキューのコンフィギュレーション (受信者につき 5 メッセージ) を使用する場合に、キューに 15 のメッセージがあり、購読時に MAX_CONCURRENCY を 4 に設定した場合、4 人の有効な受信者のうち実際に使用されるのは 3 人のみになります (実際の同時実行受信者は 3 人になります)。15 のメッセージは prefetch のデフォルト値である 5 で除算され、最初の 3 人の受信者に均等に配分されるため、4 人目はアイドル状態のままになります。対象のキューの prefetch の値を 1 に設定すると、すべての受信者がビジー状態になりますが、通常のメッセージのサイズが大きい場合は、メッセージ間に遅延が生じることがあります。
|
PASSWD
MOM への接続時に使用するパスワード。このパラメータを指定すると、そのパラメータ値は、認証済みユーザーの既存の資格証明マッピング、または MOM への接続に使用するサービスの
.msg.password および
.jms.password プロパティで指定されている値よりも優先されます。詳細については、
MOM の資格証明マッピングを参照してください。
このパラメータを省略すると、Info*Engine のメッセージ送受信ソフトウェア用のマッピングされた認証が使用されます。このようなマッピングが見つからない場合は、Java Messaging Service (JMS) 用のマッピングされた認証が使用されます。このようなマッピングされた資格証明がいずれも見つからない場合は、.msg.password プロパティで設定されている値が使用されます。.msg.password プロパティが設定されていない場合は、.jms.password プロパティで設定されている値が使用されます。いずれのプロパティも設定されず、この PASSWD パラメータに値を指定していない場合は、MOM に接続するときに Info*Engine はパスワードを指定しません。
このパラメータはオプションです。
QUEUE
管理キューの LDAP 識別名。値は設定されているベース URI を基準とする LDAP 相対識別名または完全修飾 LDAP 識別名です。相対の場合に、明示的に指定されていない場合、cn= (共有名の属性) は暗黙的です。このパラメータのデフォルトでは、com.infoengine.msg.defaultExecutionQueue プロパティで指定されている値を使用します。このような値がない場合は、QUEUE パラメータを指定する必要があります。このパラメータはオプションです。
SERVICE
特定の JMS サービスに接続できるように設定されている Info*Engine プロパティセットの名前。これにより、単一の Info*Engine 仮想マシン (VM) に対して複数の JMS サービスを設定できます。このパラメータはオプションです。
WHERE
Sun Java Message Service 仕様の定義に従って、正しくフォーマットされた JMS メッセージセレクタ。このパラメータは、指定されたキューから実行するメッセージのサブセットを選択するときに使用します。このパラメータのデフォルトでは、キューに受信したすべてのメッセージの購読します。このパラメータはオプションです。
例
以下の例は、指定されたキューを監視する購読を登録します。
<%@page language="java" session="false"%>
<%@taglib uri="http://www.ptc.com/infoengine/taglib/core"
prefix="ie"%>
<ie:webject name="Subscribe-Queue" type="MSG">
<ie:param name="QUEUE" data="$(@FORM[]queue[0])"/>
<ie:param name="WHERE" data="$(@FORM[]where[0])"/>
</ie:webject>
この例を実際に実行するには、queue および where 変数を識別するフォームを指定する必要があります。
Unsubscribe-Queue
指定されたキューにメッセージが受信されると、MOM 実装に呼び出されるイベントハンドラを登録削除します。
|
|
この Webject を使用するには、タスクをキューに入れるように環境を設定する必要があります。
|
構文
<ie:webject name=Unsubscribe-Queue type="MSG">
<ie:param name="QUEUE" data="managed_queue_name"/>
<ie:param name="WHERE" data="jms_message_selector"/>
</ie:webject>
パラメータ
|
必須
|
選択
|
オプション
|
|
|
GROUP_OUT
|
|
|
QUEUE
|
|
|
WHERE
|
|
|
SERVICE
|
GROUP_OUT
正常に終了すると作成されるステータスグループの名前。このパラメータのデフォルトの動作では、"unsubscribe-results" というグループを作成します。このパラメータはオプションです。
QUEUE
管理キューの LDAP 識別名。値は設定されているベース URI を基準とする LDAP 相対識別名です。相対の場合に、明示的に指定されていない場合、cn= (共有名の属性) は暗黙的です。このパラメータのデフォルトでは、com.infoengine.msg.defaultExecutionQueue プロパティで指定されている値を使用します。このような値がない場合は、QUEUE パラメータを指定する必要があります。このパラメータはオプションです。
WHERE
Sun Java Message Service 仕様の定義に従って、正しくフォーマットされた JMS メッセージセレクタ。このパラメータは、指定されたキューから購読解除するキューリスナーを選択するときに使用します。このパラメータのデフォルトでは、メッセージセレクタと関連付けられていないキューリスナーを購読解除します。このパラメータはオプションです。
SERVICE
特定の JMS サービスに接続できるように設定されている Info*Engine プロパティセットの名前。これにより、単一の Info*Engine 仮想マシン (VM) に対して複数の JMS サービスを設定できます。このパラメータはオプションです。
例
以下の例は、指定されたキューを監視する購読をキャンセルします。
<%@page language="java" session="false"%>
<%@taglib uri="http://www.ptc.com/infoengine/taglib/core"
prefix="ie"%>
<ie:webject name="Unsubscribe-Queue" type="MSG">
<ie:param name="QUEUE" data="$(@FORM[]queue[0])"/>
</ie:webject>
この例を実際に実行するには、queue 変数を識別するフォームを指定する必要があります。
