JavaTM Platform
Standard Ed. 6

javax.xml.soap
인터페이스 SOAPFault

모든 슈퍼 인터페이스:
Element , Node , SOAPBodyElement , SOAPElement


public interface SOAPFault
extends SOAPBodyElement

에러 정보 또는 상태 정보, 혹은 그 양쪽 모두를 포함하는 SOAPBody 객체내의 요소입니다. 이 정보는,SOAPMessage 객체내의 에러 또는 메세지 자체의 컨텐츠에 관련하지 않는 문제에 관련하고 있는 경우가 있습니다. 메세지 자체에 관련하지 않는 문제는, 일반적으로, 상류의 서버와 통신할 수 없는등의 처리상의 에러입니다.  

MessageFactory 인스턴스의 작성중으로 지정된 protocol 에 따라서는,SOAPFault 가 SOAP 1.1/SOAP 1.2 스펙으로 정의된 서브 요소를 가집니다.


필드의 개요
 
인터페이스 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
 
메소드의 개요
 Detail addDetail ()
          생략 가능한 Detail 객체를 작성해, 그것을 이 SOAPFault 객체의 Detail 객체로서 설정합니다.
 void addFaultReasonText (String  text, Locale  locale)
          지정한 텍스트 메세지 및 locale 로부터 파생한 xml:lang 를 포함한 Reason Text 항목을 추가 또는 치환합니다.
 void appendFaultSubcode (QName  subcode)
          이 SOAPFault 에 의해 포함되는 서브 코드의 순서의 마지막으로, 서브 코드를 추가합니다.
 Detail getDetail ()
          이 SOAPFault 객체의, 생략 가능한 상세 요소를 돌려줍니다.
 String getFaultActor ()
          이 SOAPFault 객체의 fault 엑터를 가져옵니다.
 String getFaultCode ()
          이 SOAPFault 객체의 fault 코드를 가져옵니다.
 Name getFaultCodeAsName ()
          이 SOAPFault 객체의 필수 SOAP 1.1 fault 코드를, SAAJ Name 객체로서 가져옵니다.
 QName getFaultCodeAsQName ()
          이 SOAPFault 의 fault 코드를 QName 객체로서 가져옵니다.
 String getFaultNode ()
          이 SOAPFault 객체의, 생략 가능한 Node 요소를 돌려줍니다.
 Iterator getFaultReasonLocales ()
          관련지을 수 있었던 Reason Text 항목이 있는 Locale 의 다른 순서에 대한 Iterator 를 돌려줍니다.
 String getFaultReasonText (Locale  locale)
          지정한 Locale 와 관련지을 수 있었던 Reason Text 를 돌려줍니다.
 Iterator getFaultReasonTexts ()
          이 SOAPFault 의 Reason Text 항목 모든 것을 포함한 String 객체의 순서에 대한 Iterator 를 돌려줍니다.
 String getFaultRole ()
          이 SOAPFault 객체의, 생략 가능한 Role 요소를 돌려줍니다.
 String getFaultString ()
          이 SOAPFault 객체의 fault 캐릭터 라인을 가져옵니다.
 Locale getFaultStringLocale ()
          이 SOAPFault 객체의 fault 캐릭터 라인의 로케일을 가져옵니다.
 Iterator getFaultSubcodes ()
          이 SOAPFault 의 서브 코드를,QName 의 반복자로서 가져옵니다.
 boolean hasDetail ()
          이 SOAPFaultDetail 서브 요소를 보관 유지하는 경우는 true, 그렇지 않은 경우는 false 를 돌려줍니다.
 void removeAllFaultSubcodes ()
          이 SOAPFault 에 의해 포함되는 서브 코드를 삭제합니다.
 void setFaultActor (String  faultActor)
          지정한 fault 엑터로 SOAPFault 객체를 설정합니다.
 void setFaultCode (Name  faultCodeQName)
          지정한 fault 코드로 SOAPFault 객체를 설정합니다.
 void setFaultCode (QName  faultCodeQName)
          지정한 fault 코드로 SOAPFault 객체를 설정합니다.
 void setFaultCode (String  faultCode)
          지정한 fault 코드로 SOAPFault 객체를 설정합니다.
 void setFaultNode (String  uri)
          이 SOAPFault 객체의 기존의 Node 요소치를 작성 또는 치환합니다.
 void setFaultRole (String  uri)
          이 SOAPFault 객체의 기존의 Role 요소치를 작성 또는 치환합니다.
 void setFaultString (String  faultString)
          지정한 캐릭터 라인에 대해서, 이 SOAPFault 의 fault 캐릭터 라인을 설정합니다.
 void setFaultString (String  faultString, Locale  locale)
          지정한 캐릭터 라인에 대해서, 이 SOAPFault 의 fault 캐릭터 라인을 설정해, 지정한 로케일에 로컬라이즈 합니다.
 
인터페이스 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
 

메소드의 상세

setFaultCode

void setFaultCode(Name  faultCodeQName)
                  throws SOAPException 
지정한 fault 코드로 SOAPFault 객체를 설정합니다.  

fault 코드는 fault에 관한 정보를 제공해, SOAP 1.1 스펙으로 정의되고 있습니다. fault 코드는 필수로,Name 형이 아니면 안됩니다. 이 메소드는, fault 코드를 설정하는 간단한 방법을 제공합니다. 다음에 예를 나타냅니다.

 SOAPEnvelope se = ...;
 // Create a qualified name in the SOAP namespace with a localName
 // of "Client". Note that prefix parameter is optional and is null
 // here which causes the implementation to use an appropriate prefix.
 Name qname = se.createName("Client", null,
                            SOAPConstants.URI_NS_SOAP_ENVELOPE);
 SOAPFault fault = ...;
 fault.setFaultCode(qname);
 
이 메소드를 setFaultCode(String) 에 대해서 사용하는 것이 적절합니다.

파라미터:
faultCodeQName - 설정되는 fault 코드를 나타내는 Name 객체. 이름 공간에서 수식되고 있을 필요가 있습니다.
예외:
SOAPException - faultcode 요소를 기본이 된다 XML 트리에 추가할 경우에, 에러가 발생했을 경우
도입된 버젼:
SAAJ 1.2
관련 항목:
getFaultCodeAsName()

setFaultCode

void setFaultCode(QName  faultCodeQName)
                  throws SOAPException 
지정한 fault 코드로 SOAPFault 객체를 설정합니다. 이 메소드를 setFaultCode(Name) 에 대해서 사용하는 것이 적절합니다.

파라미터:
faultCodeQName - 설정되는 fault 코드를 나타내는 QName 객체. 이름 공간에서 수식되고 있을 필요가 있습니다.
예외:
SOAPException - faultcode 요소를 기본이 된다 XML 트리에 추가할 경우에, 에러가 발생했을 경우
도입된 버젼:
SAAJ 1.3
관련 항목:
getFaultCodeAsQName() , setFaultCode(Name) , getFaultCodeAsQName()

setFaultCode

void setFaultCode(String  faultCode)
                  throws SOAPException 
지정한 fault 코드로 SOAPFault 객체를 설정합니다.  

fault 코드는 fault에 관한 정보를 제공해, SOAP 1.1 스펙으로 정의되고 있습니다. 이 요소는, SOAP 1.1 으로 필수입니다. fault 코드는 QName 일 필요가 있기 (위해)때문에, 이 메소드의 setFaultCode(Name) 를 사용하는 것이 적절합니다.

파라미터:
faultCode - 설정되는 fault 코드를 나타내는 String 접두사가 이름 공간 선언으로 정의되었다 "prefix:localName" 의 형식일 필요가 있습니다.
예외:
SOAPException - faultcode 를 기본이 된다 XML 트리에 추가할 경우에, 에러가 발생했을 경우
관련 항목:
setFaultCode(Name) , getFaultCode() , SOAPElement.addNamespaceDeclaration(java.lang.String, java.lang.String)

getFaultCodeAsName

Name  getFaultCodeAsName()
SOAPFault 객체의 필수 SOAP 1.1 fault 코드를, SAAJ Name 객체로서 가져옵니다. SOAP 1.1 스펙에서는, 「faultcode」요소의 값은 QName 형인 것이 필요합니다. 이 메소드는, 요소의 컨텐츠를 QName 로서 SAAJ Name 객체의 형식에서 돌려줍니다. 이 메소드는, 어플리케이션이 추가의 해석을 실시하는 일 없이 이름 공간명에 용이하게 액세스 할 수 있기 (위해)때문에,getFaultCode 메소드 대신에 사용해야 합니다.

반환값:
fault 코드를 표현하는 Name
도입된 버젼:
SAAJ 1.2
관련 항목:
setFaultCode(Name)

getFaultCodeAsQName

QName  getFaultCodeAsQName()
SOAPFault 의 fault 코드를 QName 객체로서 가져옵니다.

반환값:
fault 코드를 표현하는 QName
도입된 버젼:
SAAJ 1.3
관련 항목:
setFaultCode(QName)

getFaultSubcodes

Iterator  getFaultSubcodes()
SOAPFault 의 서브 코드를,QName 의 반복자로서 가져옵니다.

반환값:
QName 의 순서에 액세스 한다 Iterator. 이 Iterator 는, 생략 가능한 remove 메소드를 지원해야 하지는 않습니다. 서브 코드가 반환되는 순서는, fault에 존재하는 위에서 밑으로의 서브 코드의 계층이 반영됩니다
예외:
UnsupportedOperationException - 이 메세지가, SOAP 1.2 의 서브 코드의 개념을 지원하지 않는 경우
도입된 버젼:
SAAJ 1.3

removeAllFaultSubcodes

void removeAllFaultSubcodes()
SOAPFault 에 의해 포함되는 서브 코드를 삭제합니다. 이후 getFaultSubcodes 를 호출하면(자),appendFaultSubcode 에의 호출을 할 때까지 빈 상태(empty)의 반복자가 돌려주어집니다.

예외:
UnsupportedOperationException - 이 메세지가, SOAP 1.2 의 서브 코드의 개념을 지원하지 않는 경우
도입된 버젼:
SAAJ 1.3

appendFaultSubcode

void appendFaultSubcode(QName  subcode)
                        throws SOAPException 
SOAPFault 에 의해 포함되는 서브 코드의 순서의 마지막으로, 서브 코드를 추가합니다. 서브 코드는 SOAP 1.2 로 도입되었습니다만, SOAP Fault 의 필수 Code 서브 요소를 루트로 하는, 서브 요소의 재귀적인 순서에 의해 표현됩니다.

파라미터:
subcode - 서브 코드의 값을 포함하는 QName
예외:
SOAPException - 서브 코드의 설정시에 에러가 발생했을 경우
UnsupportedOperationException - 이 메세지가, SOAP 1.2 의 서브 코드의 개념을 지원하지 않는 경우
도입된 버젼:
SAAJ 1.3

getFaultCode

String  getFaultCode()
SOAPFault 객체의 fault 코드를 가져옵니다.

반환값:
fault 코드를 포함한 String
관련 항목:
getFaultCodeAsName() , setFaultCode(javax.xml.soap.Name)

setFaultActor

void setFaultActor(String  faultActor)
                   throws SOAPException 
지정한 fault 엑터로 SOAPFault 객체를 설정합니다.  

fault 엑터는, fault를 발생시킨 메세지 패스내에서의 수신자입니다.  

SOAPFault 가 SOAP 1.2 를 지원하는 경우, 이 호출은 setFaultRole(String) 와 동일해집니다.

파라미터:
faultActor - 이 SOAPFault 객체를 발생시켰다 엑터를 식별하는 String
예외:
SOAPException - faultActor 를 기본이 된다 XML 트리에 추가할 경우에, 에러가 발생했을 경우
관련 항목:
getFaultActor()

getFaultActor

String  getFaultActor()
SOAPFault 객체의 fault 엑터를 가져옵니다.  

SOAPFault 가 SOAP 1.2 를 지원하는 경우, 이 호출은 getFaultRole() 와 동일해집니다.

반환값:
SOAPFault 객체를 발생시킨 메세지 패스내에서의 엑터를 나타내는 String
관련 항목:
setFaultActor(java.lang.String)

setFaultString

void setFaultString(String  faultString)
                    throws SOAPException 
지정한 캐릭터 라인에 대해서, 이 SOAPFault 의 fault 캐릭터 라인을 설정합니다.  

SOAPFault 가 SOAP 1.2 를 지원하는 메세지의 일부인 경우, 이 호출은 아래와 같이와 동일해집니다.

      addFaultReasonText(faultString, Locale.getDefault());
 

파라미터:
faultString - fault의 설명을 나타낸다 String
예외:
SOAPException - faultString 를 기본이 된다 XML 트리에 추가할 경우에, 에러가 발생했을 경우
관련 항목:
getFaultString()

setFaultString

void setFaultString(String  faultString,
                    Locale  locale)
                    throws SOAPException 
지정한 캐릭터 라인에 대해서, 이 SOAPFault 의 fault 캐릭터 라인을 설정해, 지정한 로케일에 로컬라이즈 합니다.  

SOAPFault 가 SOAP 1.2 를 지원하는 메세지의 일부인 경우, 이 호출은 아래와 같이와 동일해집니다.

      addFaultReasonText(faultString, locale);
 

파라미터:
faultString - fault의 설명을 나타낸다 String
locale - faultString 의 네이티브 언어를 나타낸다 Locale 객체
예외:
SOAPException - faultString 를 기본이 된다 XML 트리에 추가할 경우에, 에러가 발생했을 경우
도입된 버젼:
SAAJ 1.2
관련 항목:
getFaultString()

getFaultString

String  getFaultString()
SOAPFault 객체의 fault 캐릭터 라인을 가져옵니다.  

SOAPFault 가 SOAP 1.2 를 지원하는 메세지의 일부인 경우, 이 호출은 아래와 같이와 동일해집니다.

    String reason = null;
    try {
        reason = (String) getFaultReasonTexts(). next();
    } catch (SOAPException e) {}
    return reason;
 

반환값:
fault의 설명을 나타낸다 String
관련 항목:
setFaultString(String) , setFaultString(String, Locale)

getFaultStringLocale

Locale  getFaultStringLocale()
SOAPFault 객체의 fault 캐릭터 라인의 로케일을 가져옵니다.  

SOAPFault 가 SOAP 1.2 를 지원하는 메세지의 일부인 경우, 이 호출은 아래와 같이와 동일해집니다.

    Locale locale = null;
    try {
        locale = (Locale) getFaultReasonLocales(). next();
    } catch (SOAPException e) {}
    return locale;
 

반환값:
fault 캐릭터 라인의 네이티브 언어를 나타내는 Locale 객체, 또는 로케일이 지정되지 않는 경우는 null
도입된 버젼:
SAAJ 1.2
관련 항목:
setFaultString(String, Locale)

hasDetail

boolean hasDetail()
SOAPFaultDetail 서브 요소를 보관 유지하는 경우는 true, 그렇지 않은 경우는 false 를 돌려줍니다. (getDetail()! =null) 와 같습니다.

반환값:
SOAPFaultDetail 서브 요소를 보관 유지하는 경우는 true, 그렇지 않은 경우는 false
도입된 버젼:
SAAJ 1.3

getDetail

Detail  getDetail()
SOAPFault 객체의, 생략 가능한 상세 요소를 돌려줍니다.  

Detail 객체는, 어플리케이션 고유의 에러 정보를 전해 에러 정보의 스코프는, 이것이 SOAP 1.1 Fault 의 경우 SOAPBodyElement 내의 fault에 제한됩니다.

반환값:
어플리케이션 고유의 에러 정보가 있는 경우에는 그것을 포함한 Detail 객체, 없는 경우는 null

addDetail

Detail  addDetail()
                 throws SOAPException 
생략 가능한 Detail 객체를 작성해, 그것을 이 SOAPFault 객체의 Detail 객체로서 설정합니다.  

fault에 벌써 Detail 객체가 포함되는 경우는,Detail 객체를 추가하는 것은 부정합니다. 그 때문에, 이 메소드는 기존의 Detail 객체가 삭제된 후에 마셔 호출해야 합니다.

반환값:
새로운 Detail 객체
예외:
SOAPException - 이 SOAPFault 객체에 벌써 유효한 Detail 객체가 포함되는 경우

getFaultReasonLocales

Iterator  getFaultReasonLocales()
                               throws SOAPException 
관련지을 수 있었던 Reason Text 항목이 있는 Locale 의 다른 순서에 대한 Iterator 를 돌려줍니다. 이러한 Locale 는 어떤 것에서도, Reason Text 캐릭터 라인의 로컬라이즈 된 버젼을 취득하기 위해서 getFaultReasonText 에의 호출로 사용할 수 있습니다.

반환값:
관련지을 수 있었던 Reason Text 항목이 있다 Locale 의 순서에 대한 Iterator
예외:
SOAPException - fault Reason 로케일의 취득으로 에러가 발생했을 경우
UnsupportedOperationException - 이 메세지가, SOAP 1.2 의 Fault Reason 의 개념을 지원하지 않는 경우
도입된 버젼:
SAAJ 1.3

getFaultReasonTexts

Iterator  getFaultReasonTexts()
                             throws SOAPException 
SOAPFault 의 Reason Text 항목 모든 것을 포함한 String 객체의 순서에 대한 Iterator 를 돌려줍니다.

반환값:
env:Fault/env:Reason/env:Text 항목에 대한 Iterator
예외:
SOAPException - fault Reason 텍스트의 취득으로 에러가 발생했을 경우
UnsupportedOperationException - 이 메세지가, SOAP 1.2 의 Fault Reason 의 개념을 지원하지 않는 경우
도입된 버젼:
SAAJ 1.3

getFaultReasonText

String  getFaultReasonText(Locale  locale)
                          throws SOAPException 
지정한 Locale 와 관련지을 수 있었던 Reason Text 를 돌려줍니다. 그러한 Reason Text 가 복수 존재하는 경우, 최초로 일치하는 Text 가 돌려주어집니다.

파라미터:
locale - -- 로컬라이즈 된 Reason Text 가 요구되고 있다 Locale
반환값:
locale 와 관련지을 수 있었던 Reason Text
예외:
SOAPException - 지정한 로케일의 fault Reason 텍스트의 취득으로 에러가 발생했을 경우
UnsupportedOperationException - 이 메세지가, SOAP 1.2 의 Fault Reason 의 개념을 지원하지 않는 경우
도입된 버젼:
SAAJ 1.3
관련 항목:
getFaultString()

addFaultReasonText

void addFaultReasonText(String  text,
                        Locale  locale)
                        throws SOAPException 
지정한 텍스트 메세지 및 locale 로부터 파생한 xml:lang 를 포함한 Reason Text 항목을 추가 또는 치환합니다. xml:lang 를 포함한 Reason Text 항목이 벌써 존재하는 경우, 텍스트의 값은 text 로 치환됩니다. locale 파라미터는,null 에 해야 하지는 않습니다.  

코드예:

 SOAPFault fault = ...;
 fault.addFaultReasonText("Version Mismatch", Locale.ENGLISH);
 

파라미터:
text - -- 이유 메세지의 캐릭터 라인
locale - -- 메세지의 로케일을 표현하는 Locale 객체
예외:
SOAPException - Reason 텍스트의 추가로 에러가 발생했을 경우 또는 건네받은Localenull 의 경우
UnsupportedOperationException - 이 메세지가, SOAP 1.2 의 Fault Reason 의 개념을 지원하지 않는 경우
도입된 버젼:
SAAJ 1.3

getFaultNode

String  getFaultNode()
SOAPFault 객체의, 생략 가능한 Node 요소를 돌려줍니다. Node 요소는, SOAP 1.2 에서는 생략 가능합니다.

반환값:
String 로서의 env:Fault/env:Node 의 컨텐츠 없는 경우는 null
예외:
UnsupportedOperationException - 이 메세지가, SOAP 1.2 의 Fault Node 의 개념을 지원하지 않는 경우
도입된 버젼:
SAAJ 1.3

setFaultNode

void setFaultNode(String  uri)
                  throws SOAPException 
SOAPFault 객체의 기존의 Node 요소치를 작성 또는 치환합니다. Node 요소는, SOAP 1.2 에서는 생략 가능합니다.

예외:
SOAPException - 이 SOAPFault 객체의 Node 의 설정시에 에러가 발생했을 경우
UnsupportedOperationException - 이 메세지가, SOAP 1.2 의 Fault Node 의 개념을 지원하지 않는 경우
도입된 버젼:
SAAJ 1.3

getFaultRole

String  getFaultRole()
SOAPFault 객체의, 생략 가능한 Role 요소를 돌려줍니다. Role 요소는, SOAP 1.2 에서는 생략 가능합니다.

반환값:
String 로서의 env:Fault/env:Role 의 컨텐츠 없는 경우는 null
예외:
UnsupportedOperationException - 이 메세지가, SOAP 1.2 의 Fault Role 의 개념을 지원하지 않는 경우
도입된 버젼:
SAAJ 1.3

setFaultRole

void setFaultRole(String  uri)
                  throws SOAPException 
SOAPFault 객체의 기존의 Role 요소치를 작성 또는 치환합니다. Role 요소는, SOAP 1.2 에서는 생략 가능합니다.

파라미터:
uri - - Role 의 URI
예외:
SOAPException - 이 SOAPFault 객체의 Role 의 설정시에 에러가 발생했을 경우
UnsupportedOperationException - 이 메세지가, SOAP 1.2 의 Fault Role 의 개념을 지원하지 않는 경우
도입된 버젼:
SAAJ 1.3

JavaTM Platform
Standard Ed. 6

버그의 보고와 기능의 요청
한층 더 자세한 API 레퍼런스 및 개발자 문서에 대해서는,Java SE 개발자용 문서를 참조해 주세요. 개발자전용의 상세한 해설, 개념의 개요, 용어의 정의, 버그의 회피책, 및 코드 실례가 포함되어 있습니다.

Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms . Documentation Redistribution Policy 도 참조해 주세요.