パッケージ jakarta.xml.soap

インターフェース SOAPHeaderElement

  • すべてのスーパーインターフェース:
    ElementSE、Node、NodeSE、SOAPElement
    public interface SOAPHeaderElement
extends SOAPElement
    SOAP エンベロープの SOAP ヘッダー部分の内容を表すオブジェクト。SOAPHeader オブジェクトの直接の子は、SOAPHeaderElement オブジェクトとしてのみ表すことができます。

    SOAPHeaderElement オブジェクトは、その子として他の SOAPElement オブジェクトを持つことができます。

    導入:
    1.6

    • メソッドの詳細

      • setActor

        void setActor​(StringSE actorURI)
        この SOAPHeaderElement オブジェクトに関連付けられているアクターを指定されたアクターに設定します。アクターのデフォルト値は次のとおりです。SOAPConstants.URI_SOAP_ACTOR_NEXT

        この SOAPHeaderElement が SOAP 1.2 をサポートしている場合、この呼び出しは setRole(String) と同等です。

        パラメーター:
        actorURI - 設定するアクターの URI を提供する String 
        例外:
        IllegalArgumentExceptionSE - アクターの設定に問題がある場合。
        関連事項:
        getActor()

      • setRole

        void setRole​(StringSE uri)
      throws SOAPException
        この SOAPHeaderElement オブジェクトに関連付けられている Role を指定された Role に設定します。
        パラメーター:
        uri - Role の URI
        例外:
        SOAPException - ロールの設定にエラーがある場合
        UnsupportedOperationExceptionSE - このメッセージが SOAP 1.2 の障害のロールの概念をサポートしていない場合。
        導入:
        1.6、SAAJ 1.3

      • getActor

        StringSE getActor()
        この SOAPHeaderElement のアクター属性の URI を返します。

        この SOAPHeaderElement が SOAP 1.2 をサポートしている場合、この呼び出しは getRole() と同等です。

        戻り値:
        アクターの URI を提供する String 
        関連事項:
        setActor(java.lang.String)

      • getRole

        StringSE getRole()
        この SOAPHeaderElement の Role 属性の値を返します。
        戻り値:
        Role の URI を与える String 
        例外:
        UnsupportedOperationExceptionSE - このメッセージが SOAP 1.2 の障害のロールの概念をサポートしていない場合。
        導入:
        1.6、SAAJ 1.3

      • setMustUnderstand

        void setMustUnderstand​(boolean mustUnderstand)
        この SOAPHeaderElement オブジェクトの mustUnderstand 属性を true または false に設定します。

        mustUnderstand 属性がオンの場合、SOAPHeaderElement を受信するアクターはそれを正しく処理する必要があります。これにより、たとえば、SOAPHeaderElement オブジェクトがメッセージを変更する場合、メッセージが正しく変更されることが保証されます。

        パラメーター:
        mustUnderstand - true は mustUnderstand 属性を true に設定し、false は false に設定します。
        例外:
        IllegalArgumentExceptionSE - mustUnderstand 属性の設定に問題がある場合
        関連事項:
        getMustUnderstand(), setRelay(boolean)

      • getMustUnderstand

        boolean getMustUnderstand()
        この SOAPHeaderElement の mustUnderstand 属性のブール値を返します。
        戻り値:
        この SOAPHeaderElement オブジェクトの mustUnderstand 属性がオンの場合は true、そうでない場合は false 

      • setRelay

        void setRelay​(boolean relay)
       throws SOAPException
        この SOAPHeaderElement のリレー属性を true または false に設定します。

        SOAP リレー属性は true に設定され、SOAP ヘッダーブロックは、ヘッダーブロックのターゲットであるが実際には処理しない任意のノードによってリレーされる必要があることを示します。この属性は、mustUnderstand 属性が true に設定されているヘッダーブロック、または最終受信者 (デフォルト) をターゲットとするヘッダーブロックでは無視されます。この属性のデフォルト値は false です。

        パラメーター:
        relay - リレー属性の新しい値
        例外:
        SOAPException - リレー属性の設定に問題がある場合。
        UnsupportedOperationExceptionSE - このメッセージがリレー属性の SOAP 1.2 概念をサポートしていない場合。
        導入:
        1.6、SAAJ 1.3
        関連事項:
        setMustUnderstand(boolean), getRelay()

      • getRelay

        boolean getRelay()
        この SOAPHeaderElement のリレー属性のブール値を返します
        戻り値:
        リレー属性がオンの場合は true。それ以外の場合は false 
        例外:
        UnsupportedOperationExceptionSE - このメッセージがリレー属性の SOAP 1.2 概念をサポートしていない場合。
        導入:
        1.6、SAAJ 1.3
        関連事項:
        getMustUnderstand(), setRelay(boolean)