-
- すべてのスーパー・インタフェース:
Element
,Node
,Node
,SOAPElement
public interface SOAPHeaderElement extends SOAPElement
SOAPエンベロープのSOAPヘッダー部のコンテンツを表現するオブジェクトです。SOAPHeader
オブジェクトの直接の子は、SOAPHeaderElement
オブジェクトとしてのみ表現できます。SOAPHeaderElement
オブジェクトは、子としてほかのSOAPElement
オブジェクトを持つことができます。- 導入されたバージョン:
- 1.6
-
-
フィールドのサマリー
-
インタフェース 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
に設定します。-
インタフェース 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
-
-
-
-
メソッドの詳細
-
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)
-
-