Интерфейс SOAPFault

Элемент в объекте SOAPBody, содержащий информацию об ошибке и/или статусе. Эта информация может относиться к ошибкам в объекте SOAPMessage или к проблемам, не связанным с содержимым самого сообщения. Проблемы, не связанные с самим сообщением, обычно являются ошибками обработки, например, невозможностью связи с сервером вышестоящего уровня.

В зависимости от protocol, указанного при создании экземпляра MessageFactory, объект SOAPFault имеет подэлементы, определенные в спецификации SOAP 1.1/SOAP 1.2.

Методы

setFaultCode

void setFaultCode(Name faultCodeQName)
           throws SOAPException

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);

Параметры:

faultCodeQName - объект Name, задающий устанавливаемый код ошибки. Он должен быть квалифицирован по пространству имён.

Исключения:

SOAPException - если произошла ошибка при добавлении элемента faultcode в базовое XML-дерево.

С момента:

SAAJ 1.2

См. также:

getFaultCodeAsName()

setFaultCode

void setFaultCode(QName faultCodeQName)
           throws SOAPException

Устанавливает для этого объекта SOAPFault заданный код ошибки. Лучше использовать этот метод, чем setFaultCode(Name).

Параметры:

faultCodeQName - объект QName, задающий устанавливаемый код ошибки. Он должен быть квалифицирован по пространству имён.

Исключения:

SOAPException - если произошла ошибка при добавлении элемента faultcode в базовое XML-дерево.

С момента:

SAAJ 1.3

См. также:

getFaultCodeAsQName(), setFaultCode(Name), getFaultCodeAsQName()

setFaultCode

void setFaultCode(String faultCode)
           throws SOAPException

Параметры:

faultCode - String, задающий устанавливаемый код ошибки. Он должен иметь вид "префикс:локальноеИмя", где префикс определен в объявлении пространства имён.

Исключения:

SOAPException - если произошла ошибка при добавлении faultCode в базовое XML-дерево.

См. также:

setFaultCode(Name), getFaultCode(), SOAPElement.addNamespaceDeclaration(java.lang.String, java.lang.String)

getFaultCodeAsName

Name getFaultCodeAsName()

Возвращает обязательный код ошибки SOAP 1.1 для этого объекта SOAPFault как объект SAAJ Name. Спецификация SOAP 1.1 требует, чтобы значение элемента "faultcode" было типа QName. Этот метод возвращает содержимое элемента как QName в виде объекта SAAJ Name. Этот метод следует использовать вместо метода getFaultCode, так как он позволяет приложениям легко получить имя пространства имён без дополнительного анализа.

Возвращает:

объект Name, представляющий faultcode

С момента:

SAAJ 1.2

См. также:

setFaultCode(Name)

getFaultCodeAsQName

QName getFaultCodeAsQName()

Возвращает код ошибки для этого объекта SOAPFault как объект QName.

Возвращает:

объект QName, представляющий faultcode

С момента:

SAAJ 1.3

См. также:

setFaultCode(QName)

getFaultSubcodes

Iterator getFaultSubcodes()

Возвращает подкоды для этого объекта SOAPFault в виде итератора над QNames.

Возвращает:

итератор Iterator, предоставляющий доступ к последовательности QNames. Этот итератор Iterator не должен поддерживать необязательный метод remove. Порядок возвращаемых подкодов отражает иерархию подкодов, присутствующих в ошибке, сверху вниз.

Исключения:

UnsupportedOperationException - если это сообщение не поддерживает концепцию подкода SOAP 1.2.

С момента:

SAAJ 1.3

removeAllFaultSubcodes

void removeAllFaultSubcodes()

Удаляет все подкоды, которые могут содержаться в этом объекте SOAPFault. Последующие вызовы getFaultSubcodes вернут пустой итератор до тех пор, пока не будет выполнен вызов appendFaultSubcode.

Исключения:

UnsupportedOperationException - если это сообщение не поддерживает концепцию подкода SOAP 1.2.

С момента:

SAAJ 1.3

appendFaultSubcode

void appendFaultSubcode(QName subcode)
                 throws SOAPException

Добавляет подкод в конец последовательности подкодов, содержащихся в этом объекте SOAPFault. Подкоды, представленные в SOAP 1.2, представляют собой рекурсивную последовательность дочерних элементов, укоренённых в обязательном элементе Кода ошибки SOAP.

Параметры:

subcode - QName, содержащий значение подкода.

Исключения:

SOAPException - если произошла ошибка при установке подкода

UnsupportedOperationException - если это сообщение не поддерживает концепцию подкода SOAP 1.2.

С момента:

SAAJ 1.3

getFaultCode

String getFaultCode()

Возвращает код ошибки для этого объекта SOAPFault.

Возвращает:

объект String, содержащий код ошибки

См. также:

getFaultCodeAsName(), setFaultCode(javax.xml.soap.Name)

setFaultActor

void setFaultActor(String faultActor)
            throws SOAPException

Параметры:

faultActor - строка, идентифицирующая актера, вызвавшего ошибку в этом объекте SOAPFault

Исключения:

SOAPException - если произошла ошибка при добавлении faultActor в базовое XML-дерево.

См. также:

getFaultActor()

getFaultActor

String getFaultActor()

Возвращает:

строку, обозначающую актера в пути сообщения, вызвавшего ошибку в этом объекте SOAPFault

См. также:

setFaultActor(java.lang.String)

setFaultString

void setFaultString(String faultString)
             throws SOAPException

addFaultReasonText(faultString, Locale.getDefault());

Параметры:

faultString - строка, объясняющая ошибку

Исключения:

SOAPException - если произошла ошибка при добавлении faultString в базовое XML-дерево.

См. также:

getFaultString()

setFaultString

void setFaultString(String faultString,
                    Locale locale)
             throws SOAPException

addFaultReasonText(faultString, locale);

Параметры:

faultString - строка, объясняющая ошибку

locale - объект Locale, указывающий родной язык faultString

Исключения:

SOAPException - если произошла ошибка при добавлении faultString в базовое XML-дерево.

С момента:

SAAJ 1.2

См. также:

getFaultString()

getFaultString

String getFaultString()

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

Возвращает:

строку, объясняющую ошибку

См. также:

setFaultString(String), setFaultString(String, Locale)

getFaultStringLocale

Locale getFaultStringLocale()

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

Возвращает:

объект Locale , указывающий родной язык строки ошибки, или null, если локаль не была задана

С момента:

SAAJ 1.2

См. также:

setFaultString(String, Locale)

hasDetail

boolean hasDetail()

Возвращает true, если у этого объекта SOAPFault есть подэлемент Detail, и false в противном случае. Эквивалентно (getDetail()!=null).

Возвращает:

true, если у этого объекта SOAPFault есть подэлемент Detail, и false в противном случае.

С момента:

SAAJ 1.3

getDetail

Detail getDetail()

Возвращает:

объект Detail с информацией об ошибке, специфичной для приложения, если присутствует; иначе null

addDetail

Detail addDetail()
          throws SOAPException

Возвращает:

новый объект Detail

Выбрасывает:

SOAPException - если этот объект SOAPFault уже содержит допустимый объект Detail

getFaultReasonLocales

Iterator getFaultReasonLocales()
                        throws SOAPException

Возвращает коллекцию Iterator последовательности уникальных Locale для которых существуют связанные элементы Reason Text. Любой из этих Locale может быть использован в вызове метода getFaultReasonText для получения локализованной версии строки Reason Text.

Возвращает:

коллекцию Iterator последовательности объектов Locale для которых существуют связанные элементы Reason Text.

Выбрасывает:

SOAPException - если произошла ошибка при получении локализованных значений Reason.

UnsupportedOperationException - если это сообщение не поддерживает концепцию SOAP 1.2 Reason.

С:

SAAJ 1.3

getFaultReasonTexts

Iterator getFaultReasonTexts()
                      throws SOAPException

Возвращает коллекцию Iterator последовательности объектов String содержащих все элементы Reason Text для этой SOAPFault.

Возвращает:

коллекцию Iterator элементов env:Fault/env:Reason/env:Text.

Выбрасывает:

SOAPException - если произошла ошибка при получении текста Reason.

UnsupportedOperationException - если это сообщение не поддерживает концепцию SOAP 1.2 Reason.

С:

SAAJ 1.3

getFaultReasonText

String getFaultReasonText(Locale locale)
                   throws SOAPException

Возвращает Reason Text, связанный с заданным Locale. Если существует несколько таких Reason Text, возвращается первый соответствующий Text.

Параметры:

locale - -- Locale для которого требуется локализованный Reason Text

Возвращает:

Reason Text, связанный с locale

Выбрасывает:

SOAPException - если произошла ошибка при получении текста Reason для указанной локали.

UnsupportedOperationException - если это сообщение не поддерживает концепцию SOAP 1.2 Reason.

С:

SAAJ 1.3

См. также:

getFaultString()

addFaultReasonText

void addFaultReasonText(String text,
                        Locale locale)
                 throws SOAPException

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

Параметры:

text - -- строка сообщения Reason

locale - -- объект Locale, представляющий локаль сообщения

Выбрасывает:

SOAPException - если произошла ошибка при добавлении текста Reason или переданный locale был null.

UnsupportedOperationException - если это сообщение не поддерживает концепцию SOAP 1.2 Reason.

С:

SAAJ 1.3

getFaultNode

String getFaultNode()

Возвращает необязательное значение элемента Node для этого объекта SOAPFault. Элемент Node является необязательным в SOAP 1.2.

Возвращает:

Содержимое элемента env:Fault/env:Node в виде строки или null, если отсутствует

Выбрасывает:

UnsupportedOperationException - если это сообщение не поддерживает концепцию SOAP 1.2 Node.

С:

SAAJ 1.3

setFaultNode

void setFaultNode(String uri)
           throws SOAPException

Создаёт или заменяет любое существующее значение элемента Node для этого объекта SOAPFault. Элемент Node является необязательным в SOAP 1.2.

Выбрасывает:

SOAPException - если произошла ошибка при установке узла для этого объекта SOAPFault.

UnsupportedOperationException - если это сообщение не поддерживает концепцию SOAP 1.2 Node.

С:

SAAJ 1.3

getFaultRole

String getFaultRole()

Возвращает необязательное значение элемента Role для этого объекта SOAPFault. Элемент Role является необязательным в SOAP 1.2.

Возвращает:

Содержимое элемента env:Fault/env:Role в виде строки или null если отсутствует

Выбрасывает:

UnsupportedOperationException - если это сообщение не поддерживает концепцию SOAP 1.2 Role.

С:

SAAJ 1.3

setFaultRole

void setFaultRole(String uri)
           throws SOAPException

Создаёт или заменяет любое существующее значение элемента Role для этого объекта SOAPFault. Элемент Role является необязательным в SOAP 1.2.

Параметры:

uri - - URI роли

Выбрасывает:

SOAPException - если произошла ошибка при установке роли для этого объекта SOAPFault.

UnsupportedOperationException - если это сообщение не поддерживает концепцию SOAP 1.2 Role.

С:

SAAJ 1.3