モジュール java.xml.ws
パッケージ javax.xml.soap

インタフェースSOAPHeaderElement

  • すべてのスーパー・インタフェース:
    Element, Node, Node, SOAPElement
    public interface SOAPHeaderElement
extends SOAPElement
    SOAPエンベロープのSOAPヘッダー部のコンテンツを表現するオブジェクトです。 SOAPHeaderオブジェクトの直接の子は、SOAPHeaderElementオブジェクトとしてのみ表現できます。

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

    導入されたバージョン:
    1.6

    • メソッドの詳細

      • setActor

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

        このSOAPHeaderElementがSOAP 1.2をサポートする場合、この呼出しはsetRole(String)と等しくなります

        パラメータ:
        actorURI - 設定するアクターのURIを示すString
        例外:
        IllegalArgumentException - アクターの設定時に問題が発生した場合。
        関連項目:
        getActor()

      • setRole

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

      • getActor

        String getActor()
        このSOAPHeaderElementのactor属性のURIを返します。

        このSOAPHeaderElementがSOAP 1.2をサポートする場合、この呼出しはgetRole()と等しくなります

        戻り値:
        アクターのURIを示すString
        関連項目:
        setActor(java.lang.String)

      • getRole

        String getRole()
        このSOAPHeaderElementのRole属性の値を返します。
        戻り値:
        RoleのURIを示すString
        例外:
        UnsupportedOperationException - このメッセージが、SOAP 1.2のFault Roleの概念をサポートしない場合。
        導入されたバージョン:
        1.6, SAAJ 1.3

      • setMustUnderstand

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

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

        パラメータ:
        mustUnderstand - mustUnderstand属性をtrueに設定する場合はtrue、falseに設定する場合はfalse
        例外:
        IllegalArgumentException - mustUnderstand属性の設定時に問題が発生した場合
        関連項目:
        getMustUnderstand(), setRelay(boolean)

      • getMustUnderstand

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

      • setRelay

        void setRelay​(boolean relay)
       throws SOAPException
        このSOAPHeaderElementのrelay属性を、trueかfalseのいずれかに設定します。

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

        パラメータ:
        relay - relay属性の新しい値
        例外:
        SOAPException - relay属性の設定時に問題が発生した場合。
        UnsupportedOperationException - このメッセージが、SOAP 1.2のRelay属性の概念をサポートしない場合。
        導入されたバージョン:
        1.6, SAAJ 1.3
        関連項目:
        setMustUnderstand(boolean), getRelay()

      • getRelay

        boolean getRelay()
        このSOAPHeaderElementのrelay属性のboolean値を返します。
        戻り値:
        relay属性がオンになっている場合はtrue、そうでない場合はfalse
        例外:
        UnsupportedOperationException - このメッセージが、SOAP 1.2のRelay属性の概念をサポートしない場合。
        導入されたバージョン:
        1.6, SAAJ 1.3
        関連項目:
        getMustUnderstand(), setRelay(boolean)