7.4.4　Messageインタフェース

(a)　DEFAULT_DELIVERY_MODEフィールド

public static final int DEFAULT_DELIVERY_MODE

メッセージの属性を示す値のデフォルト値を保持しています。デフォルト値はDeliveryMode.PERSISTENT（永続）です。

(b)　DEFAULT_PRIORITYフィールド

public static final int DEFAULT_PRIORITY

メッセージの優先度を示す値のデフォルト値を保持しています。デフォルト値は4です。

(c)　DEFAULT_TIME_TO_LIVEフィールド

public static final long DEFAULT_TIME_TO_LIVE

メッセージの保持時間を示す値のデフォルト値を保持しています。デフォルト値は0です。

(a)　acknowledgeメソッド

public void acknowledge() throws JMSException

現在のメッセージおよび同じセッションで以前に受信し，かつ以前に承認していないすべてのメッセージに対して，メッセージの受信を承認します。メソッドが正常に終了した場合，受信側は承認したメッセージを何度も受信しないで済みます。

メソッドを発行できる条件を次に示します。条件外でメソッドを発行した場合はJMSExceptionが発生します。

• メッセージを同期受信で取得しました。

• メッセージは，トランザクション設定がfalseかつメッセージ承認モードがCLIENT_ACKNOWLEDGEのQueueSessionオブジェクトによって生成されました。

• メッセージが関連づけられているコネクションおよびセッションがクローズされていません。

• トランザクションがトランザクションマネジャによって制御されていません。

• 引数

  ありません。

• 戻り値

  ありません。

• 例外

  例外クラス	説明
  IllegalStateException	トランザクションマネジャでのトランザクションが開始しているときに，メソッドが発行されました。
  	クローズされたセッションに対して，メソッドが発行されました。
  JMSException	トランザクション設定がtrueのときに，メソッドが発行されました。
  	トランザクション設定がfalseかつメッセージ承認モードがAUTO_ACKNOWLEDGEのときに，メソッドが発行されました。
  	トランザクション設定がfalseかつメッセージ承認モードがDUPS_OK_ACKNOWLEDGEのときに，メソッドが発行されました。
  	非同期受信でメッセージを受信したときに，メソッドが発行されました。
  	キューブラウザで取得した閲覧用のメッセージに対して，メソッドが発行されました。
  	内部エラーのためにメソッドの実行に失敗し，Session.recover()メソッドが正常に終了した際と同じ状態になりました。
  	内部エラーのためにJMSプロバイダがメッセージの承認に失敗しました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(b)　clearBodyメソッド

public void clearBody() throws JMSException

BytesMessage，ObjectMessageおよびTextMessageオブジェクトでメソッドを発行した場合，JMSメッセージのペイロード（メッセージ本体）が初期化されます。初期化されたペイロードの値は，メッセージ生成直後のペイロードの値と同じです。Messageオブジェクトでメソッドを発行した場合は無視されます。なお，メソッドを発行してもヘッダとプロパティは初期化されません。

ペイロードが読み取り専用モードの際にメソッドを発行した場合，ペイロードが初期化されるとともにペイロードの書き込みができるようになります。

• 引数

  ありません。

• 戻り値

  ありません。

• 例外

  例外クラス	説明
  JMSException	内部エラーのためにJMSプロバイダがメッセージ本体の初期化に失敗しました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(c)　clearPropertiesメソッド

public void clearProperties() throws JMSException

メッセージのプロパティを初期化します。初期化されたプロパティの値はメッセージ生成直後のプロパティの値と同じです。なお，メソッドを実行してもヘッダとペイロードは初期化されません。

プロパティが読み取り専用モードの際にメソッドを発行した場合，プロパティが初期化されるとともにプロパティの読み取りと書き込みの両方ができるようになります。

• 引数

  ありません。

• 戻り値

  ありません。

• 例外

  例外クラス	説明
  JMSException	内部エラーのためにJMSプロバイダがプロパティの初期化に失敗しました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(d)　getBooleanPropertyメソッド

public boolean getBooleanProperty(java.lang.String name)
  throws JMSException

boolean型のプロパティの値を返します。

• 引数

  引数名	説明
  name	boolean型のプロパティの名前

• 戻り値

  boolean型のプロパティの値です。指定されたname引数に対応するプロパティ値がない場合，falseを返します。

• 例外

  例外クラス	説明
  JMSException	name引数にnullが指定されました。
  	内部エラーのためにJMSプロバイダがプロパティ値の取得に失敗しました。
  MessageFormatException	メッセージ形式不正が原因でプロパティの型変換に失敗しました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(e)　getBytePropertyメソッド

public byte getByteProperty(java.lang.String name) throws JMSException

byte型のプロパティの値を返します。

• 引数

  引数名	説明
  name	byte型のプロパティの名前

• 戻り値

  byte型のプロパティの値です。

• 例外

  例外クラス	説明
  java.lang.NumberFormatException	指定されたname引数に対応するプロパティ値がありません。
  JMSException	name引数にnullが指定されました。
  	内部エラーのためにJMSプロバイダがプロパティ値の取得に失敗しました。
  MessageFormatException	メッセージ形式不正が原因でプロパティの型変換に失敗しました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(f)　getDoublePropertyメソッド

public double getDoubleProperty(java.lang.String name)
  throws JMSException

double型のプロパティの値を返します。

• 引数

  引数名	説明
  name	double型のプロパティの名前

• 戻り値

  double型のプロパティの値です。

• 例外

  例外クラス	説明
  java.lang.NumberFormatException	指定されたname引数に対応するプロパティ値がありません。
  JMSException	name引数にnullが指定されました。
  	内部エラーのためにJMSプロバイダがプロパティ値の取得に失敗しました。
  MessageFormatException	メッセージ形式不正が原因でプロパティの型変換に失敗しました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(g)　getFloatPropertyメソッド

public float getFloatProperty(java.lang.String name)
  throws JMSException

float型のプロパティの値を返します。

• 引数

  引数名	説明
  name	float型のプロパティの名前

• 戻り値

  float型のプロパティの値です。

• 例外

  例外クラス	説明
  java.lang.NumberFormatException	指定されたname引数に対応するプロパティ値がありません。
  JMSException	name引数にnullが指定されました。
  	内部エラーのためにJMSプロバイダがプロパティ値の取得に失敗しました。
  MessageFormatException	メッセージ形式不正が原因でプロパティの型変換に失敗しました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(h)　getIntPropertyメソッド

public int getIntProperty(java.lang.String name) throws JMSException

int型のプロパティの値を返します。

• 引数

  引数名	説明
  name	int型のプロパティの名前

• 戻り値

  int型のプロパティの値です。

• 例外

  例外クラス	説明
  java.lang.NumberFormatException	指定されたname引数に対応するプロパティ値がありません。
  JMSException	name引数にnullが指定されました。
  	内部エラーのためにJMSプロバイダがプロパティ値の取得に失敗しました。
  MessageFormatException	メッセージ形式不正が原因でプロパティの型変換に失敗しました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(i)　getJMSCorrelationIDメソッド

public java.lang.String getJMSCorrelationID() throws JMSException

メッセージに設定されたJMSCorrelationIDヘッダの値をString型で取得します。JMSCorrelationIDヘッダが設定されていない場合，nullを返します。

• 引数

  ありません。

• 戻り値

  メッセージの相関識別子。

• 例外

  例外クラス	説明
  JMSException	内部エラーのためにJMSプロバイダが相関識別子の取得に失敗しました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(j)　getJMSCorrelationIDAsBytesメソッド

public byte[] getJMSCorrelationIDAsBytes() throws JMSException

メッセージに設定されたJMSCorrelationIDヘッダの値をbyte[]で取得します。JMSCorrelationIDヘッダが設定されていない場合，nullを返します。

注意

setJMSCorrelationIDAsBytes(byte[])実行時のJ2EEサーバで有効となるJava VMのデフォルトエンコーディングと，getJMSCorrelationIDAsBytes()実行時のJ2EEサーバで有効となるJava VMのデフォルトエンコーディングは，同じエンコーディングを使用してください。

異なるエンコーディングを使用する場合，setJMSCorrelationIDAsBytes(byte[])の引数の値と，getJMSCorrelationIDAsBytes()で取得される値は異なる場合があります。

キュー間転送を用い，異なるシステム間でJMSCorrelationIDを設定したメッセージの送受信を行う場合に注意してください。

• 引数

  ありません。

• 戻り値

  メッセージの相関識別子。

• 例外

  例外クラス	説明
  JMSException	内部エラーのためにJMSプロバイダが相関識別子の取得に失敗しました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(k)　getJMSDeliveryModeメソッド

public int getJMSDeliveryMode() throws JMSException

メッセージに設定されたJMSDeliveryModeヘッダの値を返します。JMSDeliveryModeヘッダが設定されていない場合，DeliveryMode.PERSISTENTを返します。

• 引数

  ありません。

• 戻り値

  メッセージの管理形態として，次に示すどちらかの値を返します。

  • DeliveryMode.NON_PERSISTENT

  • DeliveryMode.PERSISTENT

• 例外

  例外クラス	説明
  JMSException	内部エラーのためにJMSプロバイダがメッセージの管理形態の取得に失敗しました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(l)　getJMSDestinationメソッド

public Destination getJMSDestination() throws JMSException

メッセージに設定されたJMSDestinationヘッダの値を返します。JMSDestinationヘッダが設定されていない場合，nullを返します。

• 引数

  ありません。

• 戻り値

  メッセージに設定されたJMSDestinationヘッダの値を返します。JMSDestinationヘッダが設定されていない場合，nullを返します。

• 例外

  例外クラス	説明
  JMSException	内部エラーのためにJMSプロバイダがあて先の取得に失敗しました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(m)　getJMSExpirationメソッド

public long getJMSExpiration() throws JMSException

メッセージに設定されたJMSExpirationヘッダの値を返します。JMSExpirationヘッダが設定されていない場合，0を返します。

• 引数

  ありません。

• 戻り値

  メッセージの有効期間値。

• 例外

  例外クラス	説明
  JMSException	内部エラーのためにJMSプロバイダがメッセージの有効期間の取得に失敗しました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(n)　getJMSMessageIDメソッド

public java.lang.String getJMSMessageID() throws JMSException

メッセージに設定されたJMSMessageIDヘッダの値を返します。JMSMessageIDヘッダが設定されていない場合，nullを返します。

• 引数

  ありません。

• 戻り値

  メッセージ識別子。

• 例外

  例外クラス	説明
  JMSException	内部エラーのためにJMSプロバイダがメッセージ識別子の取得に失敗しました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(o)　getJMSPriorityメソッド

public int getJMSPriority() throws JMSException

メッセージに設定されたJMSPriorityヘッダの値を返します。JMSPriorityヘッダが設定されていない場合，javax.jms.Messge.DEFAULT_PRIORITYを返します。

• 引数

  ありません。

• 戻り値

  メッセージの優先度。

• 例外

  例外クラス	説明
  JMSException	内部エラーのためにJMSプロバイダがメッセージ優先度の取得に失敗しました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(p)　getJMSRedeliveredメソッド

public boolean getJMSRedelivered() throws JMSException

メッセージに設定されたJMSRedeliveredヘッダの値を返します。JMSRedeliveredヘッダが設定されていない場合，falseを返します。

• 引数

  ありません。

• 戻り値

  メッセージが再配送中の場合はtrueです。

• 例外

  例外クラス	説明
  JMSException	内部エラーのためにJMSプロバイダが再配送状態の取得に失敗しました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(q)　getJMSReplyToメソッド

public Destination getJMSReplyTo() throws JMSException

メッセージに設定されたJMSReplyToヘッダの値を返します。JMSReplyToヘッダが設定されていない場合，nullを返します。

• 引数

  ありません。

• 戻り値

  メッセージへの応答の送信先であるDestinationオブジェクト。

• 例外

  例外クラス	説明
  JMSException	内部エラーのためにJMSプロバイダがJMSReplyToヘッダの取得に失敗しました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(r)　getJMSTimestampメソッド

public long getJMSTimestamp() throws JMSException

メッセージに設定されたJMSTimestampヘッダの値を返します。JMSTimestampヘッダが設定されていない場合，0を返します。

• 引数

  ありません。

• 戻り値

  メッセージのタイムスタンプ。

• 例外

  例外クラス	説明
  JMSException	内部エラーのためにJMSプロバイダがタイムスタンプの取得に失敗しました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(s)　getJMSTypeメソッド

public java.lang.String getJMSType() throws JMSException

メッセージに設定されたJMSTypeヘッダの値を返します。JMSTypeヘッダが設定されていない場合，nullを返します。

• 引数

  ありません。

• 戻り値

  メッセージ型。

• 例外

  例外クラス	説明
  JMSException	内部エラーのためにJMSプロバイダがメッセージ型の取得に失敗しました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(t)　getLongPropertyメソッド

public long getLongProperty(java.lang.String name) throws JMSException

long型のプロパティの値を返します。

• 引数

  引数名	説明
  name	long型のプロパティの名前

• 戻り値

  指定された名前のlong型のプロパティ値です。

• 例外

  例外クラス	説明
  java.lang.NumberFormatException	指定されたname引数に対応するプロパティ値がありません。
  JMSException	name引数にnullが指定されました。
  	内部エラーのためにJMSプロバイダがプロパティ値の取得に失敗しました。
  MessageFormatException	メッセージ形式不正が原因でプロパティの型変換に失敗しました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(u)　getObjectPropertyメソッド

public java.lang.Object getObjectProperty(java.lang.String name)
  throws JMSException

Object型のプロパティの値を返します。指定された名前に対応するプロパティ値がない場合，nullを返します。

メソッドはBoolean，Byte，Short，Integer，Long，Float，DoubleおよびStringクラスの値だけを返します。

• 引数

  引数名	説明
  name	Javaオブジェクトプロパティの名前

• 戻り値

  指定された名前のJavaオブジェクトプロパティ値のオブジェクト化形式。例えば，プロパティがintとして設定された場合はIntegerを返します。

• 例外

  例外クラス	説明
  JMSException	name引数にnullが指定されました。
  	内部エラーのためにJMSプロバイダがプロパティ値の取得に失敗しました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(v)　getPropertyNamesメソッド

public java.util.Enumeration getPropertyNames() throws JMSException

すべてのプロパティの名前を返します。プロパティがない場合，nullを返します。

メソッドで取得するプロパティ名の順序は保証されません。

• 引数

  ありません。

• 戻り値

  プロパティ値のすべての名前についての列挙。

• 例外

  例外クラス	説明
  JMSException	内部エラーのためにJMSプロバイダがプロパティ値の取得に失敗しました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(w)　getShortPropertyメソッド

public short getShortProperty(java.lang.String name)
  throws JMSException

short型のプロパティの値を返します。

• 引数

  引数名	説明
  name	short型のプロパティの名前

• 戻り値

  指定された名前のshort型のプロパティ値です。

• 例外

  例外クラス	説明
  java.lang.NumberFormatException	指定されたname引数に対応するプロパティ値がありません。
  JMSException	name引数にnullが指定されました。
  	内部エラーのためにJMSプロバイダがプロパティ値の取得に失敗しました。
  MessageFormatException	メッセージ形式不正が原因でプロパティの型変換に失敗しました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(x)　getStringPropertyメソッド

public java.lang.String getStringProperty(java.lang.String name)
  throws JMSException

String型のプロパティの値を返します。指定された名前に対応するプロパティ値がない場合，nullを返します。

• 引数

  引数名	説明
  name	String型のプロパティの名前

• 戻り値

  指定された名前のString型のプロパティ値。

• 例外

  例外クラス	説明
  JMSException	name引数にnullが指定されました。
  	内部エラーのためにJMSプロバイダがプロパティ値の取得に失敗しました。
  MessageFormatException	メッセージ形式不正が原因でプロパティの型変換に失敗しました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(y)　propertyExistsメソッド

public boolean propertyExists(java.lang.String name)
  throws JMSException

指定されたプロパティ名に対応するプロパティがあればtrueを返し，なければfalseを返します。

• 引数

  引数名	説明
  name	存在を判定するプロパティの名前

• 戻り値

  プロパティがある場合はtrue，ない場合はfalseを返します。

• 例外

  例外クラス	説明
  JMSException	name引数にnullが指定されました。
  	内部エラーのためにJMSプロバイダがプロパティの存在確認に失敗しました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(z)　setBooleanPropertyメソッド

public void setBooleanProperty(java.lang.String name, boolean value)
  throws JMSException

boolean型のプロパティの値を設定します。

プロパティ値は上書きできます。引数の文字数制限は半角全角を問いません。

• 引数

  引数名	説明
  name	boolean型のプロパティの名前（64文字以下）
  value	設定するboolean型のプロパティ値

• 戻り値

  ありません。

• 例外

  例外クラス	説明
  JMSException	name引数にnullが指定されました。
  	name引数の文字数が制限値を超えました。
  	内部エラーのためにJMSプロバイダがプロパティ値の取得に失敗しました。
  MessageNotWriteableException	読み取り専用モードのプロパティに情報を書き込もうとしました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(aa)　setBytePropertyメソッド

public void setByteProperty(java.lang.String name, byte value)
  throws JMSException

byte型のプロパティの値を設定します。

プロパティ値は上書きできます。引数の文字数制限は半角全角を問いません。

• 引数

  引数名	説明
  name	byte型のプロパティの名前（64文字以下）
  value	設定するbyte型のプロパティ値

• 戻り値

  ありません。

• 例外

  例外クラス	説明
  JMSException	name引数にnullが指定されました。
  	name引数の文字数が制限値を超えました。
  	内部エラーのためにJMSプロバイダがプロパティ値の取得に失敗しました。
  MessageNotWriteableException	読み取り専用モードのプロパティに情報を書き込もうとしました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(ab)　setDoublePropertyメソッド

public void setDoubleProperty(java.lang.String name, double value)
  throws JMSException

double型のプロパティの値を設定します。

プロパティ値は上書きできます。引数の文字数制限は半角全角を問いません。

• 引数

  引数名	説明
  name	double型のプロパティの名前（64文字以下）
  value	設定するdouble型のプロパティ値

• 戻り値

  ありません。

• 例外

  例外クラス	説明
  JMSException	name引数にnullが指定されました。
  	name引数の文字数が制限値を超えました。
  	内部エラーのためにJMSプロバイダがプロパティ値の取得に失敗しました。
  MessageNotWriteableException	読み取り専用モードのプロパティに情報を書き込もうとしました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(ac)　setFloatPropertyメソッド

public void setFloatProperty(java.lang.String name, float value)
  throws JMSException

float型のプロパティの値を設定します。

プロパティ値は上書きできます。引数の文字数制限は半角全角を問いません。

• 引数

  引数名	説明
  name	float型のプロパティの名前（64文字以下）
  value	設定するfloat型のプロパティ値

• 戻り値

  ありません。

• 例外

  例外クラス	説明
  JMSException	name引数にnullが指定されました。
  	name引数の文字数が制限値を超えました。
  	内部エラーのためにJMSプロバイダがプロパティ値の取得に失敗しました。
  MessageNotWriteableException	読み取り専用モードのプロパティに情報を書き込もうとしました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(ad)　setIntPropertyメソッド

public void setIntProperty(java.lang.String name, int value)
  throws JMSException

int型のプロパティの値を設定します。

プロパティ値は上書きできます。引数の文字数制限は半角全角を問いません。

• 引数

  引数名	説明
  name	int型のプロパティの名前（64文字以下）
  value	設定するint型のプロパティ値

• 戻り値

  ありません。

• 例外

  例外クラス	説明
  JMSException	name引数にnullが指定されました。
  	name引数の文字数が制限値を超えました。
  	内部エラーのためにJMSプロバイダがプロパティ値の取得に失敗しました。
  MessageNotWriteableException	読み取り専用モードのプロパティに情報を書き込もうとしました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(ae)　setJMSCorrelationIDメソッド

public void setJMSCorrelationID(java.lang.String correlationID)
  throws JMSException

メッセージのJMSCorrelationIDヘッダをString型で設定します。

ヘッダ値は上書きできます。引数の文字数制限は半角全角を問いません。

• 引数

  引数名	説明
  correlationID	相関識別子（512文字以下）

• 戻り値

  ありません。

• 例外

  例外クラス	説明
  JMSException	correlationID引数の文字数が制限値を超えました。
  	内部エラーのためにJMSプロバイダが相関識別子の設定に失敗しました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(af)　setJMSCorrelationIDAsBytesメソッド

public void setJMSCorrelationIDAsBytes(byte[] correlationID)
  throws JMSException

メッセージのJMSCorrelationIDヘッダをbyte[]で設定します。

ヘッダ値は上書きできます。引数の文字数制限は半角全角を問いません。

注意

• 引数には，J2EEサーバで有効となるJava VMのデフォルトエンコーディングで正しくStringに変換ができるbyte[]を指定してください。正しく変換できない引数を指定した場合，JMSCorrelationIDに不正なデータが設定されます。

• setJMSCorrelationIDAsBytes(byte[])実行時のJ2EEサーバで有効となるJava VMのデフォルトエンコーディングと，getJMSCorrelationIDAsBytes()実行時のJ2EEサーバで有効となるJava VMのデフォルトエンコーディングは，同じエンコーディングを使用してください。

  異なるエンコーディングを使用する場合，setJMSCorrelationIDAsBytes(byte[])の引数の値と，getJMSCorrelationIDAsBytes()で取得される値は異なる場合があります。

  キュー間転送を用い，異なるシステム間でJMSCorrelationIDを設定したメッセージの送受信を行う場合に注意してください。

• 引数

  引数名	説明
  correlationID	相関識別子（バイト配列）（512文字以下）

• 戻り値

  ありません。

• 例外

  例外クラス	説明
  JMSException	correlationID引数の文字数が制限値を超えました。
  	内部エラーのためにJMSプロバイダが相関識別子の設定に失敗しました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(ag)　setJMSDeliveryModeメソッド

public void setJMSDeliveryMode(int deliveryMode) throws JMSException

このメソッドは未サポートです。

このメソッドで設定した値は実際には使用されません。

• 引数

  引数名	説明
  deliveryMode	メッセージの管理形態として，次に示すどちらかの値を指定できます。 DeliveryMode.NON_PERSISTENT：非永続 DeliveryMode.PERSISTENT：永続

• 戻り値

  ありません。

• 例外

  ありません。

(ah)　setJMSDestinationメソッド

public void setJMSDestination(Destination destination)
  throws JMSException

このメソッドは未サポートです。

このメソッドで設定した値は実際には使用されません。

• 引数

  引数名	説明
  destination	メッセージの送信先

• 戻り値

  ありません。

• 例外

  ありません。

(ai)　setJMSExpirationメソッド

public void setJMSExpiration(long expiration) throws JMSException

このメソッドは未サポートです。

このメソッドで設定した値は実際には使用されません。

• 引数

  引数名	説明
  expiration	メッセージの有効期間

• 戻り値

  ありません。

• 例外

  ありません。

(aj)　setJMSMessageIDメソッド

public void setJMSMessageID(java.lang.String id) throws JMSException

このメソッドは未サポートです。

このメソッドで設定した値は実際には使用されません。

• 引数

  引数名	説明
  id	メッセージ識別子

• 戻り値

  ありません。

• 例外

  ありません。

(ak)　setJMSPriorityメソッド

public void setJMSPriority(int priority) throws JMSException

このメソッドは未サポートです。

このメソッドで設定した値は実際には使用されません。

• 引数

  引数名	説明
  priority	メッセージの優先度

• 戻り値

  ありません。

• 例外

  ありません。

(al)　setJMSRedeliveredメソッド

public void setJMSRedelivered(boolean redelivered) throws JMSException

このメソッドは未サポートです。

このメソッドで設定した値は実際には使用されません。

• 引数

  引数名	説明
  redelivered	メッセージが再配送中であるかどうかを示す値です。値がtrueの場合，再配送中であることを示します。

• 戻り値

  ありません。

• 例外

  ありません。

(am)　setJMSReplyToメソッド

public void setJMSReplyTo(Destination replyTo) throws JMSException

メッセージのJMSReplyToヘッダをDestination型で設定します。

ヘッダ値は上書きできます。

• 引数

  引数名	説明
  replyTo	メッセージへの応答の送信先

• 戻り値

  ありません。

• 例外

  例外クラス	説明
  JMSException	内部エラーのためにJMSプロバイダがJMSReplyToヘッダの設定に失敗しました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(an)　setJMSTimestampメソッド

public void setJMSTimestamp(long timestamp) throws JMSException

このメソッドは未サポートです。

このメソッドで設定した値は実際には使用されません。

• 引数

  引数名	説明
  timestamp	メッセージのタイムスタンプ

• 戻り値

  ありません。

• 例外

  ありません。

(ao)　setJMSTypeメソッド

public void setJMSType(java.lang.String type) throws JMSException

メッセージのJMSTypeヘッダをStringで設定します。

ヘッダ値は上書きできます。引数の文字数制限は半角全角を問いません。

• 引数

  引数名	説明
  type	メッセージ型（512文字以下）

• 戻り値

  ありません。

• 例外

  例外クラス	説明
  JMSException	type引数の文字数が制限値を超えました。
  	内部エラーのためにJMSプロバイダがメッセージ型の設定に失敗しました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(ap)　setLongPropertyメソッド

public void setLongProperty(java.lang.String name, long value)
  throws JMSException

long型のプロパティの値を設定します。

プロパティ値は上書きできます。引数の文字数制限は半角全角を問いません。

• 引数

  引数名	説明
  name	long型のプロパティの名前（64文字以下）
  value	設定するlong型のプロパティ値

• 戻り値

  ありません。

• 例外

  例外クラス	説明
  JMSException	name引数にnullが指定されました。
  	name引数の文字数が制限値を超えました。
  	内部エラーのためにJMSプロバイダがプロパティ値の設定に失敗しました。
  MessageNotWriteableException	読み取り専用モードのプロパティに情報を書き込もうとしました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(aq)　setObjectPropertyメソッド

public void setObjectProperty(java.lang.String name,
  java.lang.Object value) throws JMSException

Object型のプロパティの値を設定します。

• メソッドはBoolean，Byte，Short，Integer，Long，Float，DoubleおよびStringクラスの値を受け付けます。そのほかのクラスを使用すると，JMSExceptionが発生します。

• プロパティ値にはnullを指定できます。

• 引数の文字数制限は半角全角を問いません。

• プロパティ値は上書きできます。

• 引数

  引数名	説明
  name	Javaオブジェクトプロパティの名前（64文字以下）
  value	設定するJavaオブジェクトプロパティ値（String型のプロパティ値の場合は512文字以下）

• 戻り値

  ありません。

• 例外

  例外クラス	説明
  JMSException	name引数にnullが指定されました。
  	name引数の文字数が制限値を超えました。
  	value引数にString型のクラスを指定し，その文字数が制限値を超えました。
  	内部エラーのためにJMSプロバイダがプロパティ値の設定に失敗しました。
  MessageFormatException	引数valueの形式不正が原因でプロパティの型変換に失敗しました。
  MessageNotWriteableException	読み取り専用モードのプロパティに情報を書き込もうとしました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(ar)　setShortPropertyメソッド

public void setShortProperty(java.lang.String name, short value)
  throws JMSException

short型のプロパティの値を設定します。

プロパティ値は上書きできます。引数の文字数制限は半角全角を問いません。

• 引数

  引数名	説明
  name	short型のプロパティの名前（64文字以下）
  value	設定するshort型のプロパティ値

• 戻り値

  ありません。

• 例外

  例外クラス	説明
  JMSException	name引数にnullが指定されました。
  	name引数の文字数が制限値を超えました。
  	内部エラーのためにJMSプロバイダがプロパティの設定に失敗しました。
  MessageNotWriteableException	読み取り専用モードのプロパティに情報を書き込もうとしました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。

(as)　setStringPropertyメソッド

public void setStringProperty(java.lang.String name,
  java.lang.String value) throws JMSException

String型のプロパティの値を設定します。

• プロパティ値にはnullを指定できます。

• 引数の文字数制限は半角全角を問いません。

• プロパティ値は上書きできます。

• 引数

  引数名	説明
  name	String型のプロパティの名前（64文字以下）
  value	設定するString型のプロパティ値（512文字以下）

• 戻り値

  ありません。

• 例外

  例外クラス	説明
  JMSException	name引数にnullが指定されました。
  	name引数の文字数が制限値を超えました。
  	value引数の文字数が制限値を超えました。
  	内部エラーのためにJMSプロバイダがプロパティ値の設定に失敗しました。
  MessageNotWriteableException	読み取り専用モードのプロパティに情報を書き込もうとしました。

  例外クラスには障害コードと障害情報が設定されます。障害コードと対処については，「7.9　障害コードの詳細」を参照してください。