javax.xml.soap
インタフェース SOAPHeader

すべてのスーパーインタフェース:

Element, Node, SOAPElement

public interface SOAPHeader
extends SOAPElement

SOAP ヘッダー要素の表現です。SOAP ヘッダー要素は、アプリケーション固有のコンテンツがメッセージプロバイダによって処理される方法に影響する XML データで構成されます。たとえば、トランザクションセマンティクス、認証情報などは、SOAPHeader オブジェクトのコンテンツとして指定できます。

SOAPEnvelope オブジェクトには、デフォルトで空の SOAPHeader オブジェクトが含まれます。省略可能である SOAPHeader オブジェクトが必要でない場合、次のコードにより取得および削除できます。変数 se は SOAPEnvelope オブジェクトです。

      se.getHeader().detachNode();
 

SOAPHeader オブジェクトは、SOAPEnvelope メソッド addHeader で作成されます。このメソッドは、新しいヘッダーを作成してエンベロープに追加し、既存のヘッダーが削除されたあとにのみ呼び出されます。

      se.getHeader().detachNode();
      SOAPHeader sh = se.addHeader();
 

SOAPHeader オブジェクトは、直接の子として SOAPHeaderElement だけを持つことができます。addHeaderElement メソッドは新しい HeaderElement オブジェクトを作成し、それを SOAPHeader オブジェクトに追加します。次のコードでは、addHeaderElement メソッドへの引数は、新しい HeaderElement オブジェクトの名前である Name オブジェクトです。

      SOAPHeaderElement shElement = sh.addHeaderElement(name);
 

関連項目:

SOAPHeaderElement

フィールドの概要

インタフェース org.w3c.dom.Node から継承されたフィールド

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

メソッドの概要

SOAPHeaderElement	addHeaderElement(Name name) 指定された名前で初期化された新しい SOAPHeaderElement オブジェクトを作成し、それをこの SOAPHeader オブジェクトに追加します。
SOAPHeaderElement	addHeaderElement(QName qname) 指定された qname で初期化された新しい SOAPHeaderElement オブジェクトを作成し、それをこの SOAPHeader オブジェクトに追加します。
SOAPHeaderElement	addNotUnderstoodHeaderElement(QName name) 指定された名前で初期化された新しい NotUnderstood SOAPHeaderElement オブジェクトを作成し、それをこの SOAPHeader オブジェクトに追加します。
SOAPHeaderElement	addUpgradeHeaderElement(Iterator supportedSOAPURIs) 指定されたサポートされる SOAP URI のリストで初期化された新しい Upgrade SOAPHeaderElement オブジェクトを作成し、それをこの SOAPHeader オブジェクトに追加します。
SOAPHeaderElement	addUpgradeHeaderElement(String supportedSoapUri) 指定されたサポートされる SOAP URI で初期化された新しい Upgrade SOAPHeaderElement オブジェクトを作成し、それをこの SOAPHeader オブジェクトに追加します。
SOAPHeaderElement	addUpgradeHeaderElement(String[] supportedSoapUris) 指定されたサポートされる SOAP URI の配列で初期化された新しい Upgrade SOAPHeaderElement オブジェクトを作成し、それをこの SOAPHeader オブジェクトに追加します。
Iterator	examineAllHeaderElements() この SOAPHeader オブジェクト内のすべての SOAPHeaderElement についての Iterator を返します。
Iterator	examineHeaderElements(String actor) 指定された actor を持つ SOAPHeader オブジェクト内のすべての SOAPHeaderElement についての Iterator を返します。
Iterator	examineMustUnderstandHeaderElements(String actor) 指定された actor を持ち、MustUnderstand 属性の値が true と同じものを持つ SOAPHeader オブジェクト内のすべての SOAPHeaderElement オブジェクトについての Iterator を返します。
Iterator	extractAllHeaderElements() SOAPHeader オブジェクト内のすべての SOAPHeaderElement についての Iterator を返し、SOAPHeader オブジェクトから切り離します。
Iterator	extractHeaderElements(String actor) 指定された actor を持つ SOAPHeader オブジェクト内のすべての SOAPHeaderElement についての Iterator を返し、それらをこの SOAPHeader オブジェクトから切り離します。

インタフェース javax.xml.soap.SOAPElement から継承されたメソッド

addAttribute, addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addTextNode, createQName, getAllAttributes, getAllAttributesAsQNames, getAttributeValue, getAttributeValue, getChildElements, getChildElements, getChildElements, getElementName, getElementQName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, getVisibleNamespacePrefixes, removeAttribute, removeAttribute, removeContents, removeNamespaceDeclaration, setElementQName, setEncodingStyle

インタフェース javax.xml.soap.Node から継承されたメソッド

detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue

インタフェース org.w3c.dom.Element から継承されたメソッド

getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS

インタフェース org.w3c.dom.Node から継承されたメソッド

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

メソッドの詳細

addHeaderElement

SOAPHeaderElement addHeaderElement(Name name)
                                   throws SOAPException

指定された名前で初期化された新しい SOAPHeaderElement オブジェクトを作成し、それをこの SOAPHeader オブジェクトに追加します。

パラメータ:

name - 新しい SOAPHeaderElement オブジェクトの名前を持つ Name オブジェクト

戻り値:

この SOAPHeader オブジェクトに挿入された新しい SOAPHeaderElement オブジェクト

例外:

SOAPException - SOAP エラーが発生した場合

関連項目:

addHeaderElement(javax.xml.namespace.QName)

addHeaderElement

SOAPHeaderElement addHeaderElement(QName qname)
                                   throws SOAPException

指定された qname で初期化された新しい SOAPHeaderElement オブジェクトを作成し、それをこの SOAPHeader オブジェクトに追加します。

パラメータ:

qname - 新しい SOAPHeaderElement オブジェクトの qname を持つ QName オブジェクト

戻り値:

この SOAPHeader オブジェクトに挿入された新しい SOAPHeaderElement オブジェクト

例外:

SOAPException - SOAP エラーが発生した場合

導入されたバージョン:

SAAJ 1.3

関連項目:

addHeaderElement(Name)

examineMustUnderstandHeaderElements

Iterator examineMustUnderstandHeaderElements(String actor)

指定された actor を持ち、MustUnderstand 属性の値が true と同じものを持つ SOAPHeader オブジェクト内のすべての SOAPHeaderElement オブジェクトについての Iterator を返します。

SOAP 1.2 では、env:actor は env:role に置換されましたが、実質的には同じセマンティクスです。

パラメータ:

actor - 検索する actor / role の URI を示す String

戻り値:

指定の actor / role を含み MustUnderstand とマークされている、すべての SOAPHeaderElement オブジェクトの Iterator オブジェクト

導入されたバージョン:

SAAJ 1.2

関連項目:

examineHeaderElements(java.lang.String), extractHeaderElements(java.lang.String), SOAPConstants.URI_SOAP_ACTOR_NEXT

examineHeaderElements

Iterator examineHeaderElements(String actor)

指定された actor を持つ SOAPHeader オブジェクト内のすべての SOAPHeaderElement についての Iterator を返します。 actor 属性は、メッセージが最終的な受信者に届く前に処理する必要のある中間の相手を示す、グローバル属性です。アクターはメッセージを受信し、次のアクターに送信する前にメッセージを処理します。デフォルトのアクターはメッセージの意図された最終的な受信者であり、アクター属性が SOAPHeader オブジェクトに含まれていない場合、最終的な受信者にメッセージ本体とともに送信されます。

SOAP 1.2 では、env:actor は env:role に置換されましたが、実質的には同じセマンティクスです。

パラメータ:

actor - 検索する actor / role の URI を示す String

戻り値:

指定の actor / role を含んでいるすべての SOAPHeaderElement オブジェクトの Iterator オブジェクト

関連項目:

extractHeaderElements(java.lang.String), SOAPConstants.URI_SOAP_ACTOR_NEXT

extractHeaderElements

Iterator extractHeaderElements(String actor)

指定された actor を持つ SOAPHeader オブジェクト内のすべての SOAPHeaderElement についての Iterator を返し、それらをこの SOAPHeader オブジェクトから切り離します。

このメソッドは、アクターが該当する SOAPHeader オブジェクトの一部を処理し、次のアクターにメッセージを渡す前に削除できるようにします。

SOAP 1.2 では、env:actor は env:role に置換されましたが、実質的には同じセマンティクスです。

パラメータ:

actor - 検索する actor / role の URI を示す String

戻り値:

指定の actor / role を含んでいるすべての SOAPHeaderElement オブジェクトの Iterator オブジェクト

関連項目:

examineHeaderElements(java.lang.String), SOAPConstants.URI_SOAP_ACTOR_NEXT

addNotUnderstoodHeaderElement

SOAPHeaderElement addNotUnderstoodHeaderElement(QName name)
                                                throws SOAPException

指定された名前で初期化された新しい NotUnderstood SOAPHeaderElement オブジェクトを作成し、それをこの SOAPHeader オブジェクトに追加します。この操作は、SOAP 1.2 でのみサポートされます。

パラメータ:

name - 認識されなかった SOAPHeaderElement オブジェクトの名前を持つ QName オブジェクト

戻り値:

この SOAPHeader オブジェクトに挿入された新しい SOAPHeaderElement オブジェクト

例外:

SOAPException - SOAP エラーが発生した場合

UnsupportedOperationException - これが SOAP 1.1 Header の場合

導入されたバージョン:

SAAJ 1.3

addUpgradeHeaderElement

SOAPHeaderElement addUpgradeHeaderElement(Iterator supportedSOAPURIs)
                                          throws SOAPException

指定されたサポートされる SOAP URI のリストで初期化された新しい Upgrade SOAPHeaderElement オブジェクトを作成し、それをこの SOAPHeader オブジェクトに追加します。この操作は、SOAP 1.1 ヘッダーと SOAP 1.2 ヘッダーの両方でサポートされます。

パラメータ:

supportedSOAPURIs - サポートされる SOAP バージョンの URI を含む Iterator オブジェクト

戻り値:

この SOAPHeader オブジェクトに挿入された新しい SOAPHeaderElement オブジェクト

例外:

SOAPException - SOAP エラーが発生した場合

導入されたバージョン:

SAAJ 1.3

addUpgradeHeaderElement

SOAPHeaderElement addUpgradeHeaderElement(String[] supportedSoapUris)
                                          throws SOAPException

指定されたサポートされる SOAP URI の配列で初期化された新しい Upgrade SOAPHeaderElement オブジェクトを作成し、それをこの SOAPHeader オブジェクトに追加します。この操作は、SOAP 1.1 ヘッダーと SOAP 1.2 ヘッダーの両方でサポートされます。

パラメータ:

supportedSoapUris - サポートされる SOAP バージョンの URI の配列

戻り値:

この SOAPHeader オブジェクトに挿入された新しい SOAPHeaderElement オブジェクト

例外:

SOAPException - SOAP エラーが発生した場合

導入されたバージョン:

SAAJ 1.3

addUpgradeHeaderElement

SOAPHeaderElement addUpgradeHeaderElement(String supportedSoapUri)
                                          throws SOAPException

指定されたサポートされる SOAP URI で初期化された新しい Upgrade SOAPHeaderElement オブジェクトを作成し、それをこの SOAPHeader オブジェクトに追加します。この操作は、SOAP 1.1 ヘッダーと SOAP 1.2 ヘッダーの両方でサポートされます。

パラメータ:

supportedSoapUri - サポートされるバージョンの SOAP の URI

戻り値:

この SOAPHeader オブジェクトに挿入された新しい SOAPHeaderElement オブジェクト

例外:

SOAPException - SOAP エラーが発生した場合

導入されたバージョン:

SAAJ 1.3

examineAllHeaderElements

Iterator examineAllHeaderElements()

この SOAPHeader オブジェクト内のすべての SOAPHeaderElement についての Iterator を返します。

戻り値:

この SOAPHeader オブジェクトに含まれているすべての SOAPHeaderElement オブジェクトの Iterator オブジェクト

導入されたバージョン:

SAAJ 1.2

関連項目:

extractAllHeaderElements()

extractAllHeaderElements

Iterator extractAllHeaderElements()

SOAPHeader オブジェクト内のすべての SOAPHeaderElement についての Iterator を返し、SOAPHeader オブジェクトから切り離します。

戻り値:

この SOAPHeader オブジェクトに含まれているすべての SOAPHeaderElement オブジェクトの Iterator オブジェクト

導入されたバージョン:

SAAJ 1.2

関連項目:

examineAllHeaderElements()