javax.xml.soap
인터페이스 SOAPBody

모든 슈퍼 인터페이스:

Element , Node , SOAPElement

public interface SOAPBody
extends SOAPElement 

SOAP 메세지내의 SOAP 본체 요소의 컨텐츠를 나타내는 객체입니다. SOAP 본체 요소는 XML 데이터로 구성되어 있어 어플리케이션 고유의 컨텐츠의 처리 방법으로 영향을 줍니다.

SOAPBody 객체에는, SOAP 본체의 컨텐츠를 가지는 SOAPBodyElement 객체가 포함되어 있습니다. 상태나 에러 정보를 옮기는 SOAPFault 객체는,SOAPBodyElement 객체의 일례입니다.

관련 항목:

SOAPFault

필드의 개요

인터페이스 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

메소드의 개요

SOAPBodyElement	addBodyElement (Name name) 지정의 이름으로 SOAPBodyElement 객체를 새롭게 작성해, 이 SOAPBody 객체에 추가합니다.
SOAPBodyElement	addBodyElement (QName qname) 지정의 QName 로 SOAPBodyElement 객체를 새롭게 작성해, 이 SOAPBody 객체에 추가합니다.
SOAPBodyElement	addDocument (Document document) DOM Document 의 루트 노드를, 이 SOAPBody 객체에 추가합니다.
SOAPFault	addFault () SOAPFault 객체를 새롭게 작성해, 이 SOAPBody 객체에 추가합니다.
SOAPFault	addFault (Name faultCode, String faultString) SOAPFault 객체를 새롭게 작성해, 이 SOAPBody 객체에 추가합니다.
SOAPFault	addFault (Name faultCode, String faultString, Locale locale) SOAPFault 객체를 새롭게 작성해, 이 SOAPBody 객체에 추가합니다.
SOAPFault	addFault (QName faultCode, String faultString) SOAPFault 객체를 새롭게 작성해, 이 SOAPBody 객체에 추가합니다.
SOAPFault	addFault (QName faultCode, String faultString, Locale locale) SOAPFault 객체를 새롭게 작성해, 이 SOAPBody 객체에 추가합니다.
Document	extractContentAsDocument () DOM Document 를 새롭게 작성해, 이 SOAPBody 의 최초의 아이를 문서 요소로서 설정합니다.
SOAPFault	getFault () 이 SOAPBody 객체의 SOAPFault 객체를 돌려줍니다.
boolean	hasFault () 이 SOAPBody 객체내에 SOAPFault 객체가 존재할지 어떨지를 나타냅니다.

인터페이스 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

메소드의 상세

addFault

SOAPFault  addFault()
                   throws SOAPException 

SOAPFault 객체를 새롭게 작성해, 이 SOAPBody 객체에 추가합니다. 새로운 SOAPFault 의 디폴트 값에는, 아이의 요소가 강제적으로 설정됩니다. SOAPFault 의 타입은,MessageFactory 인스턴스의 작성중으로 지정되는 protocol 에 의해 SOAP 1.1 또는 SOAP 1.2 의 SOAPFault 로 나누어집니다.

SOAPBody 는,SOAPFault 의 아이의 요소를 최대 1 개(살) 보유할 수 있습니다.

반환값:

새로운 SOAPFault 객체

예외:

SOAPException - SOAP 에러가 발생했을 경우

addFault

SOAPFault  addFault(Name  faultCode,
                   String  faultString,
                   Locale  locale)
                   throws SOAPException 

SOAPFault 객체를 새롭게 작성해, 이 SOAPBody 객체에 추가합니다. SOAPFault 의 타입은,MessageFactory 인스턴스의 작성중으로 지정되는 protocol 에 의해 SOAP 1.1 또는 SOAP 1.2 의 SOAPFault 로 나누어집니다.

SOAP 1.2 의 경우,faultCode 파라미터는 Fault/Code/Value 요소의 값으로,faultString 파라미터는 Fault/Reason/Text 요소의 값입니다. SOAP 1.1 의 경우,faultCode 파라미터는 faultcode 요소의 값으로,faultString 파라미터는 faultstring 요소의 값입니다.

SOAPBody 는,SOAPFault 의 아이의 요소를 최대 1 개(살) 보유할 수 있습니다.

파라미터:

faultCode - 설정하는 에러 코드를 제공하는 Name 객체 (사용중의 SOAP 스펙의 버젼에 정의되고 있는 에러 코드의 1 개(살)일 필요가 있다)

faultString - 에러의 설명을 제공한다 String

locale - faultString 의 네이티브 언어를 나타낸다 Locale 객체

반환값:

새로운 SOAPFault 객체

예외:

SOAPException - SOAP 에러가 발생했을 경우

도입된 버젼:

SAAJ 1.2

관련 항목:

SOAPFault.setFaultCode(javax.xml.soap.Name) , SOAPFault.setFaultString(java.lang.String)

addFault

SOAPFault  addFault(QName  faultCode,
                   String  faultString,
                   Locale  locale)
                   throws SOAPException 

SOAPFault 객체를 새롭게 작성해, 이 SOAPBody 객체에 추가합니다. SOAPFault 의 타입은,MessageFactory 인스턴스의 작성중으로 지정되는 protocol 에 의해 SOAP 1.1 또는 SOAP 1.2 의 SOAPFault 로 나누어집니다.

SOAP 1.2 의 경우,faultCode 파라미터는 Fault/Code/Value 요소의 값으로,faultString 파라미터는 Fault/Reason/Text 요소의 값입니다. SOAP 1.1 의 경우,faultCode 파라미터는 faultcode 요소의 값으로,faultString 파라미터는 faultstring 요소의 값입니다.

SOAPBody 는,SOAPFault 의 아이의 요소를 최대 1 개(살) 보유할 수 있습니다.

파라미터:

faultCode - 설정하는 에러 코드를 제공하는 QName 객체 (사용중의 SOAP 스펙의 버젼에 정의되고 있는 에러 코드의 1 개(살)일 필요가 있다)

faultString - 에러의 설명을 제공하는 String

locale - faultString 의 네이티브 언어를 나타낸다 Locale 객체

반환값:

새로운 SOAPFault 객체

예외:

SOAPException - SOAP 에러가 발생했을 경우

도입된 버젼:

SAAJ 1.3

관련 항목:

SOAPFault.setFaultCode(javax.xml.soap.Name) , SOAPFault.setFaultString(java.lang.String) , addFault(Name faultCode, String faultString, Locale locale)

addFault

SOAPFault  addFault(Name  faultCode,
                   String  faultString)
                   throws SOAPException 

SOAPFault 객체를 새롭게 작성해, 이 SOAPBody 객체에 추가합니다. SOAPFault 의 타입은,MessageFactory 인스턴스의 작성중으로 지정되는 protocol 에 의해 SOAP 1.1 또는 SOAP 1.2 의 SOAPFault 로 나누어집니다.

SOAP 1.2 의 경우,faultCode 파라미터는 Fault/Code/Value 요소의 값으로,faultString 파라미터는 Fault/Reason/Text 요소의 값입니다. SOAP 1.1 의 경우,faultCode 파라미터는 faultcode 요소의 값으로,faultString 파라미터는 faultstring 요소의 값입니다.

SOAP 1.2 가 실패했을 경우,Fault/Reason/Text 요소로 필수의 xml:lang 속성의 디폴트 값가 java.util.Locale.getDefault() 로 설정됩니다.

SOAPBody 는,SOAPFault 의 아이의 요소를 최대 1 개(살) 보유할 수 있습니다.

파라미터:

faultCode - 설정하는 에러 코드를 제공하는 Name 객체 (사용중의 SOAP 스펙의 버젼에 정의되고 있는 에러 코드의 1 개(살)일 필요가 있다)

faultString - 에러의 설명을 제공하는 String

반환값:

새로운 SOAPFault 객체

예외:

SOAPException - SOAP 에러가 발생했을 경우

도입된 버젼:

SAAJ 1.2

관련 항목:

SOAPFault.setFaultCode(javax.xml.soap.Name) , SOAPFault.setFaultString(java.lang.String)

addFault

SOAPFault  addFault(QName  faultCode,
                   String  faultString)
                   throws SOAPException 

SOAPFault 객체를 새롭게 작성해, 이 SOAPBody 객체에 추가합니다. SOAPFault 의 타입은,MessageFactory 인스턴스의 작성중으로 지정되는 protocol 에 의해 SOAP 1.1 또는 SOAP 1.2 의 SOAPFault 로 나누어집니다.

SOAP 1.2 의 경우,faultCode 파라미터는 Fault/Code/Value 요소의 값으로,faultString 파라미터는 Fault/Reason/Text 요소의 값입니다. SOAP 1.1 의 경우,faultCode 파라미터는 faultcode 요소의 값으로,faultString 파라미터는 faultstring 요소의 값입니다.

SOAP 1.2 가 실패했을 경우,Fault/Reason/Text 요소로 필수의 xml:lang 속성의 디폴트 값가 java.util.Locale.getDefault() 로 설정됩니다.

SOAPBody 는,SOAPFault 의 아이의 요소를 최대 1 개(살) 보유할 수 있습니다.

파라미터:

faultCode - 설정하는 에러 코드를 제공하는 QName 객체 (사용중의 SOAP 스펙의 버젼에 정의되고 있는 에러 코드의 1 개(살)일 필요가 있다)

faultString - 에러의 설명을 제공하는 String

반환값:

새로운 SOAPFault 객체

예외:

SOAPException - SOAP 에러가 발생했을 경우

도입된 버젼:

SAAJ 1.3

관련 항목:

SOAPFault.setFaultCode(javax.xml.soap.Name) , SOAPFault.setFaultString(java.lang.String) , addFault(Name faultCode, String faultString)

hasFault

boolean hasFault()

이 SOAPBody 객체내에 SOAPFault 객체가 존재할지 어떨지를 나타냅니다.

반환값:

이 SOAPBody 객체내에 SOAPFault 객체가 존재하는 경우 true, 그 이외의 경우는 false

getFault

SOAPFault  getFault()

이 SOAPBody 객체의 SOAPFault 객체를 돌려줍니다.

반환값:

존재하는 경우, 이 SOAPBody 객체의 SOAPFault 객체, 그 이외의 경우는 null

addBodyElement

SOAPBodyElement  addBodyElement(Name  name)
                               throws SOAPException 

지정의 이름으로 SOAPBodyElement 객체를 새롭게 작성해, 이 SOAPBody 객체에 추가합니다.

파라미터:

name - 새로운 SOAPBodyElement 객체의 이름의 Name 객체

반환값:

새로운 SOAPBodyElement 객체

예외:

SOAPException - SOAP 에러가 발생했을 경우

관련 항목:

addBodyElement(javax.xml.namespace.QName)

addBodyElement

SOAPBodyElement  addBodyElement(QName  qname)
                               throws SOAPException 

지정의 QName 로 SOAPBodyElement 객체를 새롭게 작성해, 이 SOAPBody 객체에 추가합니다.

파라미터:

qname - 새로운 SOAPBodyElement 객체의 QName 의 QName 객체

반환값:

새로운 SOAPBodyElement 객체

예외:

SOAPException - SOAP 에러가 발생했을 경우

도입된 버젼:

SAAJ 1.3

관련 항목:

addBodyElement(Name)

addDocument

SOAPBodyElement  addDocument(Document  document)
                            throws SOAPException 

DOM Document 의 루트 노드를, 이 SOAPBody 객체에 추가합니다.

이 메소드를 호출하면(자),document 파라미터가 무효가 됩니다. 클라이언트 어플리케이션은,addDocument 의 호출시에, 이 Document 와 그 컨텐츠에 대한 모든 참조를 파기합니다. 계속해 이러한 참조를 사용하는 어플리케이션의 동작은, 정의되고 있지 않습니다.

파라미터:

document - 이 SOAPBody 에 추가되는 루트 노드의 Document 객체

반환값:

추가된 루트 노드를 나타낸다 SOAPBodyElement

예외:

SOAPException - Document 를 추가할 수 없는 경우

도입된 버젼:

SAAJ 1.2

extractContentAsDocument

Document  extractContentAsDocument()
                                  throws SOAPException 

DOM Document 를 새롭게 작성해, 이 SOAPBody 의 최초의 아이를 문서 요소로서 설정합니다. 아이의 SOAPElement 는, 처리의 과정에서 삭제됩니다.

반환값:

SOAPBody 컨텐츠를 나타낸다 Document

예외:

SOAPException - SOAPBody 의 아이의 SOAPElement 가 1 개가 아닌 경우

도입된 버젼:

SAAJ 1.3