javax.xml.soap

インタフェース SOAPHeaderElement

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

Element, Node, SOAPElement

public interface SOAPHeaderElement
extends SOAPElement

SOAP エンベロープの SOAP ヘッダー部のコンテンツを表現するオブジェクトです。SOAPHeader オブジェクトの直接の子は、SOAPHeaderElement オブジェクトとしてのみ表現できます。

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

フィールドのサマリー

インタフェース 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

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
String	getActor() この SOAPHeaderElement の actor 属性の URI を返します。
boolean	getMustUnderstand() この SOAPHeaderElement の mustUnderstand 属性の boolean 値を返します。
boolean	getRelay() この SOAPHeaderElement の relay 属性の boolean 値を返します。
String	getRole() この SOAPHeaderElement の Role 属性の値を返します。
void	setActor(String actorURI) この SOAPHeaderElement オブジェクトと関連付けられたアクターを指定されたアクターに設定します。
void	setMustUnderstand(boolean mustUnderstand) この SOAPHeaderElement オブジェクトの mustUnderstand 属性を、true か false のいずれかに設定します。
void	setRelay(boolean relay) この SOAPHeaderElement の relay 属性を、true か false のいずれかに設定します。
void	setRole(String uri) この SOAPHeaderElement オブジェクトと関連付けられた Role を指定された Role に設定します。

インタフェース 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

メソッドの詳細

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 の概念をサポートしない場合。

導入されたバージョン:

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 の概念をサポートしない場合。

導入されたバージョン:

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 属性の概念をサポートしない場合。

導入されたバージョン:

SAAJ 1.3

関連項目:

setMustUnderstand(boolean), getRelay()

getRelay

boolean getRelay()

この SOAPHeaderElement の relay 属性の boolean 値を返します。

戻り値:

relay 属性がオンになっている場合は true、そうでない場合は false

例外:

UnsupportedOperationException - このメッセージが、SOAP 1.2 の Relay 属性の概念をサポートしない場合。

導入されたバージョン:

SAAJ 1.3

関連項目:

getMustUnderstand(), setRelay(boolean)