javax.xml.soap
인터페이스 SOAPHeader

모든 슈퍼 인터페이스:

Element , Node , SOAPElement

public interface SOAPHeader
extends SOAPElement 

SOAP 헤더 요소의 표현입니다. SOAP 헤더 요소는, 어플리케이션 고유의 컨텐츠가 메세지 프로바이더에 의해 처리되는 방법으로 영향을 주는 XML 데이터로 구성됩니다. 예를 들어, 트랜잭션(transaction) 시멘틱스, 인증 정보 등은,SOAPHeader 객체의 컨텐츠로서 지정할 수 있습니다.

SOAPEnvelope 객체에는, 디폴트로 빈 상태(empty)의 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()