-
- すべてのスーパー・インタフェース:
Element
,Node
,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);
- 導入されたバージョン:
- 1.6
- 関連項目:
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(QName qname)
指定のqnameで初期化されたSOAPHeaderElement
オブジェクトを新しく作成し、このSOAPHeader
オブジェクトに追加します。SOAPHeaderElement
addHeaderElement(Name name)
指定の名前で初期化したSOAPHeaderElement
オブジェクトを新しく作成し、このSOAPHeader
オブジェクトに追加します。SOAPHeaderElement
addNotUnderstoodHeaderElement(QName name)
指定の名前で初期化されたNotUnderstoodSOAPHeaderElement
オブジェクトを新しく作成し、このSOAPHeader
オブジェクトに追加します。SOAPHeaderElement
addUpgradeHeaderElement(String supportedSoapUri)
指定されたサポートされるSOAP URIで初期化されたUpgradeSOAPHeaderElement
オブジェクトを新しく作成し、それをこのSOAPHeader
オブジェクトに追加します。SOAPHeaderElement
addUpgradeHeaderElement(String[] supportedSoapUris)
指定されたサポートされるSOAP URIの配列で初期化されたUpgradeSOAPHeaderElement
オブジェクトを新しく作成し、それをこのSOAPHeader
オブジェクトに追加します。SOAPHeaderElement
addUpgradeHeaderElement(Iterator<String> supportedSOAPURIs)
サポートされているSOAP URIの指定されたString Iteratorで初期化された新しいUpgradeSOAPHeaderElement
オブジェクトを作成し、このSOAPHeader
オブジェクトに追加します。Iterator<SOAPHeaderElement>
examineAllHeaderElements()
このSOAPHeader
オブジェクト内のすべての属性SOAPHeaderElement
オブジェクトについてのIterator
を返します。Iterator<SOAPHeaderElement>
examineHeaderElements(String actor)
指定されたactorを持つこのSOAPHeader
オブジェクト内のすべてのSOAPHeaderElement
オブジェクトについてのIterator
を返します。Iterator<SOAPHeaderElement>
examineMustUnderstandHeaderElements(String actor)
指定されたactorを持ち、MustUnderstand属性の値がtrue
と同じものを持つSOAPHeader
オブジェクト内のすべてのSOAPHeaderElement
オブジェクトについてのIterator
を返します。Iterator<SOAPHeaderElement>
extractAllHeaderElements()
SOAPHeader
オブジェクト内のすべてのSOAPHeaderElement
オブジェクトについてのIterator
を返し、このSOAPHeader
オブジェクトから切り離します。Iterator<SOAPHeaderElement>
extractHeaderElements(String actor)
指定されたactorを持つこのSOAPHeader
オブジェクト内のすべてのSOAPHeaderElement
オブジェクトについてのIterator
を返し、それらをこのSOAPHeader
オブジェクトから切り離します。-
インタフェース org.w3c.dom.Elementから継承されたメソッド
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS
-
インタフェース javax.xml.soap.Nodeから継承されたメソッド
detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue
-
インタフェース 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
-
インタフェース 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
-
-
-
-
メソッドの詳細
-
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エラーが発生した場合- 導入されたバージョン:
- 1.6, SAAJ 1.3
- 関連項目:
addHeaderElement(Name)
-
examineMustUnderstandHeaderElements
Iterator<SOAPHeaderElement> 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
オブジェクト - 導入されたバージョン:
- 1.6, SAAJ 1.2
- 関連項目:
examineHeaderElements(java.lang.String)
,extractHeaderElements(java.lang.String)
,SOAPConstants.URI_SOAP_ACTOR_NEXT
-
examineHeaderElements
Iterator<SOAPHeaderElement> 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<SOAPHeaderElement> 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
指定の名前で初期化されたNotUnderstoodSOAPHeaderElement
オブジェクトを新しく作成し、このSOAPHeader
オブジェクトに追加します。 この操作は、SOAP 1.2でのみサポートされます。- パラメータ:
name
- 認識されなかったSOAPHeaderElement
オブジェクトの名前を持つQName
オブジェクト。- 戻り値:
- この
SOAPHeader
オブジェクトに挿入された新しいSOAPHeaderElement
オブジェクト - 例外:
SOAPException
- SOAPエラーが発生した場合。UnsupportedOperationException
- これがSOAP 1.1 Headerの場合。- 導入されたバージョン:
- 1.6, SAAJ 1.3
-
addUpgradeHeaderElement
SOAPHeaderElement addUpgradeHeaderElement(Iterator<String> supportedSOAPURIs) throws SOAPException
サポートされているSOAP URIの指定されたString Iteratorで初期化された新しいUpgradeSOAPHeaderElement
オブジェクトを作成し、このSOAPHeader
オブジェクトに追加します。 この操作は、SOAP 1.1ヘッダーとSOAP 1.2ヘッダーの両方でサポートされます。- パラメータ:
supportedSOAPURIs
- SOAPバージョンのURI文字列Iterator
がサポートされています。- 戻り値:
- この
SOAPHeader
オブジェクトに挿入された新しいSOAPHeaderElement
オブジェクト - 例外:
SOAPException
- SOAPエラーが発生した場合。- 導入されたバージョン:
- 1.6, SAAJ 1.3
-
addUpgradeHeaderElement
SOAPHeaderElement addUpgradeHeaderElement(String[] supportedSoapUris) throws SOAPException
指定されたサポートされるSOAP URIの配列で初期化されたUpgradeSOAPHeaderElement
オブジェクトを新しく作成し、それをこのSOAPHeader
オブジェクトに追加します。 この操作は、SOAP 1.1ヘッダーとSOAP 1.2ヘッダーの両方でサポートされます。- パラメータ:
supportedSoapUris
- サポートされるSOAPバージョンのURIの配列。- 戻り値:
- この
SOAPHeader
オブジェクトに挿入された新しいSOAPHeaderElement
オブジェクト - 例外:
SOAPException
- SOAPエラーが発生した場合。- 導入されたバージョン:
- 1.6, SAAJ 1.3
-
addUpgradeHeaderElement
SOAPHeaderElement addUpgradeHeaderElement(String supportedSoapUri) throws SOAPException
指定されたサポートされるSOAP URIで初期化されたUpgradeSOAPHeaderElement
オブジェクトを新しく作成し、それをこのSOAPHeader
オブジェクトに追加します。 この操作は、SOAP 1.1ヘッダーとSOAP 1.2ヘッダーの両方でサポートされます。- パラメータ:
supportedSoapUri
- サポートされるSOAPバージョンのURI。- 戻り値:
- この
SOAPHeader
オブジェクトに挿入された新しいSOAPHeaderElement
オブジェクト - 例外:
SOAPException
- SOAPエラーが発生した場合。- 導入されたバージョン:
- 1.6, SAAJ 1.3
-
examineAllHeaderElements
Iterator<SOAPHeaderElement> examineAllHeaderElements()
このSOAPHeader
オブジェクト内のすべての属性SOAPHeaderElement
オブジェクトについてのIterator
を返します。- 戻り値:
- この
SOAPHeader
に含まれているすべてのSOAPHeaderElement
オブジェクトのIterator
オブジェクト - 導入されたバージョン:
- 1.6, SAAJ 1.2
- 関連項目:
extractAllHeaderElements()
-
extractAllHeaderElements
Iterator<SOAPHeaderElement> extractAllHeaderElements()
SOAPHeader
オブジェクト内のすべてのSOAPHeaderElement
オブジェクトについてのIterator
を返し、このSOAPHeader
オブジェクトから切り離します。- 戻り値:
- この
SOAPHeader
に含まれているすべてのSOAPHeaderElement
オブジェクトのIterator
オブジェクト - 導入されたバージョン:
- 1.6, SAAJ 1.2
- 関連項目:
examineAllHeaderElements()
-
-