public interface SOAPFault extends SOAPBodyElement
SOAPBody
объект, который содержит ошибку и/или информацию о статусе. Эта информация может коснуться ошибок в SOAPMessage
возразите или против проблем, которые не связываются с контентом в сообщении непосредственно. Проблемами, не связанными с самим сообщением, являются обычно ошибки в обработке, такие как неспособность связаться с вышестоящим сервером. В зависимости от protocol
определенный, создавая MessageFactory
экземпляр, a SOAPFault
имеет подэлементы как определено в SOAP 1.1/SOAP 1.2 спецификации.
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
Модификатор и Тип | Метод и Описание |
---|---|
Деталь |
addDetail()
Создает дополнительное
Detail объект и наборы это как Detail объект для этого SOAPFault объект. |
void |
addFaultReasonText(String text, Locale locale)
Добавляет или заменяет Причину текстовый элемент, содержащий указанное текстовое сообщение и xml:lang, полученный из
locale . |
void |
appendFaultSubcode(QName subcode)
Добавляет Подкод до конца последовательности Подкодов, содержавших этим
SOAPFault . |
Деталь |
getDetail()
Возвращает дополнительный элемент детали для этого
SOAPFault объект. |
Строка |
getFaultActor()
Получает агента отказа для этого
SOAPFault объект. |
Строка |
getFaultCode()
Получает код отказа для этого
SOAPFault объект. |
Имя |
getFaultCodeAsName()
Получает обязательный SOAP 1.1 кода отказа для этого
SOAPFault возразите как SAAJ Name объект. |
QName |
getFaultCodeAsQName()
Получает код отказа для этого
SOAPFault возразите как a QName объект. |
Строка |
getFaultNode()
Возвращает дополнительное значение элемента Узла для этого
SOAPFault объект. |
Iterator |
getFaultReasonLocales()
Возвраты
Iterator по отличной последовательности Locale s, для которого там связываются Причина текстовые элементы. |
Строка |
getFaultReasonText(Locale locale)
Возвращает Причину текст, связанный с данным
Locale . |
Iterator |
getFaultReasonTexts()
Возвраты
Iterator по последовательности String объекты, содержащие всю Причину текстовые элементы для этого SOAPFault . |
Строка |
getFaultRole()
Возвращает дополнительное Ролевое значение элемента для этого
SOAPFault объект. |
Строка |
getFaultString()
Получает строку отказа для этого
SOAPFault объект. |
Локаль |
getFaultStringLocale()
Получает локаль строки отказа для этого
SOAPFault объект. |
Iterator |
getFaultSubcodes()
Получает Подкоды для этого
SOAPFault как iterator QNames . |
boolean |
hasDetail()
Возвращает true если это
SOAPFault имеет a Detail подэлемент и ложь иначе. |
void |
removeAllFaultSubcodes()
Удаляет любые Подкоды, которые могут содержаться этим
SOAPFault . |
void |
setFaultActor(String faultActor)
Наборы это
SOAPFault объект с данным агентом отказа. |
void |
setFaultCode(Name faultCodeQName)
Наборы это
SOAPFault объект с данным кодом отказа. |
void |
setFaultCode(QName faultCodeQName)
Наборы это
SOAPFault объект с данным кодом отказа. |
void |
setFaultCode(String faultCode)
Наборы это
SOAPFault объект с дать кодом отказа. |
void |
setFaultNode(String uri)
Создает или заменяет любое существующее значение элемента Узла для этого
SOAPFault объект. |
void |
setFaultRole(String uri)
Создает или заменяет любое существующее Ролевое значение элемента для этого
SOAPFault объект. |
void |
setFaultString(String faultString)
Устанавливает строку отказа для этого
SOAPFault возразите против данной строки. |
void |
setFaultString(String faultString, Locale locale)
Устанавливает строку отказа для этого
SOAPFault возразите против данной строки и локализованный к данной локали. |
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
detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS
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
void setFaultCode(Name faultCodeQName) throws SOAPException
SOAPFault
объект с данным кодом отказа. Коды отказа, которые дают информацию об отказе, определяются в SOAP 1.1 спецификации. Код отказа обязателен и должен иметь тип Name
. Этот метод обеспечивает удобный способ установить код отказа. Например,
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
- a Name
объект, дающий отказ, кодирует, чтобы быть установленным. Это должно быть квалифицированное пространство имен.SOAPException
- если была ошибка в добавлении faultcode элемента к базовому дереву XML.getFaultCodeAsName()
void setFaultCode(QName faultCodeQName) throws SOAPException
SOAPFault
объект с данным кодом отказа. Предпочтительно использовать этот метод setFaultCode(Name)
.faultCodeQName
- a QName
объект, дающий отказ, кодирует, чтобы быть установленным. Это должно быть квалифицированное пространство имен.SOAPException
- если была ошибка в добавлении faultcode
элемент к базовому дереву XML.getFaultCodeAsQName()
, setFaultCode(Name)
, getFaultCodeAsQName()
void setFaultCode(String faultCode) throws SOAPException
SOAPFault
объект с дать кодом отказа. Коды отказа, который данный информацию об отказе, определяются в SOAP 1.1 спецификации. Этот элемент обязателен в SOAP 1.1. Поскольку код отказа обязан быть QName, предпочтительно использовать setFaultCode(Name)
форма этого метода.
faultCode
- a String
предоставление отказа кодирует, чтобы быть установленным. Это должно иметь форму "prefix:localName", где префикс был определен в объявлении пространства имен.SOAPException
- если была ошибка в добавлении faultCode
к базовому дереву XML.setFaultCode(Name)
, getFaultCode()
, SOAPElement.addNamespaceDeclaration(java.lang.String, java.lang.String)
Name getFaultCodeAsName()
SOAPFault
возразите как SAAJ Name
объект. SOAP 1.1 спецификации требует, чтобы значение "faultcode" элемента имело тип QName. Этот метод возвращает контент элемента как QName в форме объекта Имени SAAJ. Этот метод должен использоваться вместо getFaultCode
метод, так как это позволяет приложениям легко получать доступ к имени пространства имен без дополнительного парсинга.Name
представление faultcodesetFaultCode(Name)
QName getFaultCodeAsQName()
SOAPFault
возразите как a QName
объект.QName
представление faultcodesetFaultCode(QName)
Iterator getFaultSubcodes()
SOAPFault
как iterator QNames
.Iterator
это получает доступ к последовательности QNames
. Это Iterator
не должен поддерживать дополнительное remove
метод. Порядок, в котором возвращаются Подкоды, отражает иерархию Подкодов, существующих в отказе сверху донизу.UnsupportedOperationException
- если это сообщение не поддерживает SOAP 1.2 понятия Подкода.void removeAllFaultSubcodes()
SOAPFault
. Последующие звонки getFaultSubcodes
возвратит пустой iterator до звонка appendFaultSubcode
делается.UnsupportedOperationException
- если это сообщение не поддерживает SOAP 1.2 понятия Подкода.void appendFaultSubcode(QName subcode) throws SOAPException
SOAPFault
. Подкоды, которые были представлены в SOAP 1.2, представляются рекурсивной последовательностью подэлементов, базированных в обязательном подэлементе Кода Отказа SOAP.subcode
- QName, содержащий Значение Подкода.SOAPException
- если была ошибка в установке ПодкодаUnsupportedOperationException
- если это сообщение не поддерживает SOAP 1.2 понятия Подкода.String getFaultCode()
SOAPFault
объект.String
с кодом отказаgetFaultCodeAsName()
, setFaultCode(javax.xml.soap.Name)
void setFaultActor(String faultActor) throws SOAPException
SOAPFault
объект с данным агентом отказа. Агент отказа является получателем в пути сообщения, который заставил отказ происходить.
Если это SOAPFault
поддерживает SOAP, которому 1.2 тогда этих вызова эквивалентны setFaultRole(String)
faultActor
- a String
идентификация агента, который вызвал это SOAPFault
объектSOAPException
- если была ошибка в добавлении faultActor
к базовому дереву XML.getFaultActor()
String getFaultActor()
SOAPFault
объект. Если это SOAPFault
поддерживает SOAP, которому 1.2 тогда этих вызова эквивалентны getFaultRole()
String
предоставление агента в пути сообщения, который вызвал это SOAPFault
объектsetFaultActor(java.lang.String)
void setFaultString(String faultString) throws SOAPException
SOAPFault
возразите против данной строки. Если это SOAPFault
часть сообщения, которое поддерживает SOAP, которому 1.2 тогда этих вызова эквивалентны:
addFaultReasonText(faultString, Locale.getDefault());
faultString
- a String
предоставление объяснения отказаSOAPException
- если была ошибка в добавлении faultString
к базовому дереву XML.getFaultString()
void setFaultString(String faultString, Locale locale) throws SOAPException
SOAPFault
возразите против данной строки и локализованный к данной локали. Если это SOAPFault
часть сообщения, которое поддерживает SOAP, которому 1.2 тогда этих вызова эквивалентны:
addFaultReasonText(faultString, locale);
faultString
- a String
предоставление объяснения отказаlocale
- a Locale
объект, указывающий на родной язык faultString
SOAPException
- если была ошибка в добавлении faultString
к базовому дереву XML.getFaultString()
String getFaultString()
SOAPFault
объект. Если это SOAPFault
часть сообщения, которое поддерживает SOAP, которому 1.2 тогда этих вызова эквивалентны:
String reason = null; try { reason = (String) getFaultReasonTexts().next(); } catch (SOAPException e) {} return reason;
String
предоставление объяснения отказаsetFaultString(String)
, setFaultString(String, Locale)
Locale getFaultStringLocale()
SOAPFault
объект. Если это SOAPFault
часть сообщения, которое поддерживает SOAP, которому 1.2 тогда этих вызова эквивалентны:
Locale locale = null; try { locale = (Locale) getFaultReasonLocales().next(); } catch (SOAPException e) {} return locale;
Locale
объект, указывающий на родной язык строки отказа или null
если никакая локаль не была определенаsetFaultString(String, Locale)
boolean hasDetail()
SOAPFault
имеет a Detail
подэлемент и ложь иначе. Эквивалентный (getDetail()!=null)
.SOAPFault
имеет a Detail
подэлемент и ложь иначе.Detail getDetail()
SOAPFault
объект. A Detail
возразите переносит специализированную информацию об ошибке, контекст информации об ошибке ограничивается отказам в SOAPBodyElement
объекты, если это - SOAP 1.1 Отказа.
Detail
объект со специализированной информацией об ошибке, если существующий, нулевой иначеDetail addDetail() throws SOAPException
Detail
объект и наборы это как Detail
объект для этого SOAPFault
объект. Это недопустимо, чтобы добавить деталь, когда отказ уже содержит деталь. Поэтому, этот метод нужно вызвать только после того, как существующая деталь была удалена.
Detail
объектSOAPException
- если это SOAPFault
объект уже содержит допустимое Detail
объектIterator getFaultReasonLocales() throws SOAPException
Iterator
по отличной последовательности Locale
s, для которого там связываются Причина текстовые элементы. Любой из них Locale
s может использоваться в звонке getFaultReasonText
чтобы получить локализованную версию Причины Текстовая строка.Iterator
по последовательности Locale
объекты, для которых там связываются Причина текстовые элементы.SOAPException
- если была ошибка в получении Причины отказа локали.UnsupportedOperationException
- если это сообщение не поддерживает SOAP 1.2 понятия Причины Отказа.Iterator getFaultReasonTexts() throws SOAPException
Iterator
по последовательности String
объекты, содержащие всю Причину текстовые элементы для этого SOAPFault
.Iterator
по env:Fault/env:Reason/env:Text элементам.SOAPException
- если была ошибка в получении Причины отказа тексты.UnsupportedOperationException
- если это сообщение не поддерживает SOAP 1.2 понятия Причины Отказа.String getFaultReasonText(Locale locale) throws SOAPException
Locale
. Если больше чем одна такая Причина, текст существует первый текст соответствия, возвращаетсяlocale
- Locale
для которого локализованная Причина требуется текстlocale
SOAPException
- если была ошибка в получении Причины отказа текст для указанной локали.UnsupportedOperationException
- если это сообщение не поддерживает SOAP 1.2 понятия Причины Отказа.getFaultString()
void addFaultReasonText(String text, Locale locale) throws SOAPException
locale
. Если Причина, текстовый элемент с этим xml:lang уже существует свое текстовое значение, будет заменена text
. locale
параметр не должен быть null
Пример кода:
SOAPFault fault = ...; fault.addFaultReasonText("Version Mismatch", Locale.ENGLISH);
text
- рассуждают строка сообщенияlocale
- Объект Локали представление локали сообщенияSOAPException
- если была ошибка в добавлении Причины текст или locale
переданный был null
.UnsupportedOperationException
- если это сообщение не поддерживает SOAP 1.2 понятия Причины Отказа.String getFaultNode()
SOAPFault
объект. Элемент Узла является дополнительным в SOAP 1.2.null
если ни одинUnsupportedOperationException
- если это сообщение не поддерживает SOAP 1.2 понятия Узла Отказа.void setFaultNode(String uri) throws SOAPException
SOAPFault
объект. Элемент Узла является дополнительным в SOAP 1.2.SOAPException
- если была ошибка в установке Узла для этого SOAPFault
объект.UnsupportedOperationException
- если это сообщение не поддерживает SOAP 1.2 понятия Узла Отказа.String getFaultRole()
SOAPFault
объект. Ролевой элемент является дополнительным в SOAP 1.2.null
если ни одинUnsupportedOperationException
- если это сообщение не поддерживает SOAP 1.2 понятия Роли Отказа.void setFaultRole(String uri) throws SOAPException
SOAPFault
объект. Ролевой элемент является дополнительным в SOAP 1.2.uri
- URI РолиSOAPException
- если была ошибка в установке Роли для этого SOAPFault
объект.UnsupportedOperationException
- если это сообщение не поддерживает SOAP 1.2 понятия Роли Отказа.
Для дальнейшей ссылки API и документации разработчика, см. Java Документация SE. Та документация содержит более подробные, предназначенные разработчиком описания, с концептуальными краткими обзорами, определениями сроков, обходных решений, и рабочих примеров кода.
Авторское право © 1993, 2013, Oracle и/или его филиалы. Все права защищены.
Проект сборка-b92