org.idoox.xmlrpc
Interface Fault

public interface Fault

interface representing XML Protocol fault.

Since:

4.0

Component:

Core

Method Summary

void	addFaultSubcode(QName subcode) adds fault subcodes (new in SOAP 1.2, ignored in SOAP 1.1 faults)
void	clearFaultSubcodes() clears the list of fault subcodes
Tokenizer	getDetailTokenizer() returns detail tokenizer, standing at the beginning of the first element
TokenWriter	getDetailTokenWriter() returns detail token writer
java.lang.String	getFaultActor() returns actor
QName	getFaultCode() returns fault code
java.lang.String	getFaultNode() returns fault node (this is new in SOAP 1.2, it identifies the faulting node; this is null in SOAP 1.1 faults)
java.lang.String	getFaultReason() returns fault reason (this is SOAP 1.2 equivalent for faultstring, the faultstring accessor methods will be deprecated when SOAP 1.1 is widely replaced by SOAP 1.2)
java.lang.String	getFaultRole() returns role (this is SOAP 1.2 equivalent for actor, the actor accessor methods will be deprecated when SOAP 1.1 is widely replaced by SOAP 1.2)
java.lang.String	getFaultString() returns fault string
java.util.List	getFaultSubcodes() returns fault subcodes (new in SOAP 1.2, always empty in SOAP 1.1)
void	send() Sends the content of the Fault over the transport connection and flushes buffered content.
void	setFaultActor(java.lang.String actor) sets actor
void	setFaultCode(QName faultCode) sets fault code
void	setFaultNode(java.lang.String node) sets fault node (this is new in SOAP 1.2, it identifies the faulting node; this is ignored in SOAP 1.1 faults)
void	setFaultReason(java.lang.String faultReason) sets fault reason (this is SOAP 1.2 equivalent for faultstring, the faultstring accessor methods will be deprecated when SOAP 1.1 is widely replaced by SOAP 1.2)
void	setFaultRole(java.lang.String role) sets role (this is SOAP 1.2 equivalent for actor, the actor accessor methods will be deprecated when SOAP 1.1 is widely replaced by SOAP 1.2)
void	setFaultString(java.lang.String faultString) sets fault string

Method Detail

getFaultCode

public QName getFaultCode()

returns fault code

Returns:

fault code

setFaultCode

public void setFaultCode(QName faultCode)

sets fault code

Parameters:

faultCode - the fault code

getFaultSubcodes

public java.util.List getFaultSubcodes()

returns fault subcodes (new in SOAP 1.2, always empty in SOAP 1.1)

Returns:

the list of the subcodes, starting from the outermost; empty list when no subcode is present

addFaultSubcode

public void addFaultSubcode(QName subcode)

adds fault subcodes (new in SOAP 1.2, ignored in SOAP 1.1 faults)

Parameters:

subcode - the subcode

clearFaultSubcodes

public void clearFaultSubcodes()

clears the list of fault subcodes

getFaultString

public java.lang.String getFaultString()

returns fault string

Returns:

the fault string

setFaultString

public void setFaultString(java.lang.String faultString)

sets fault string

Parameters:

faultString - the fault string to be set

getFaultReason

public java.lang.String getFaultReason()

returns fault reason (this is SOAP 1.2 equivalent for faultstring, the faultstring accessor methods will be deprecated when SOAP 1.1 is widely replaced by SOAP 1.2)

Returns:

the fault reason

setFaultReason

public void setFaultReason(java.lang.String faultReason)

sets fault reason (this is SOAP 1.2 equivalent for faultstring, the faultstring accessor methods will be deprecated when SOAP 1.1 is widely replaced by SOAP 1.2)

Parameters:

faultReason - the fault string to be set

getFaultActor

public java.lang.String getFaultActor()

returns actor

Returns:

the fault actor

setFaultActor

public void setFaultActor(java.lang.String actor)

sets actor

Parameters:

actor - the actor to be set up

getFaultRole

public java.lang.String getFaultRole()

returns role (this is SOAP 1.2 equivalent for actor, the actor accessor methods will be deprecated when SOAP 1.1 is widely replaced by SOAP 1.2)

Returns:

the fault role

setFaultRole

public void setFaultRole(java.lang.String role)

sets role (this is SOAP 1.2 equivalent for actor, the actor accessor methods will be deprecated when SOAP 1.1 is widely replaced by SOAP 1.2)

Parameters:

role - the role to be set up

getFaultNode

public java.lang.String getFaultNode()

returns fault node (this is new in SOAP 1.2, it identifies the faulting node; this is null in SOAP 1.1 faults)

Returns:

the fault node

setFaultNode

public void setFaultNode(java.lang.String node)

sets fault node (this is new in SOAP 1.2, it identifies the faulting node; this is ignored in SOAP 1.1 faults)

Parameters:

node - the node name (URI)

getDetailTokenizer

public Tokenizer getDetailTokenizer()
                             throws java.io.IOException

returns detail tokenizer, standing at the beginning of the first element

Returns:

tokenizer of the fault's section containing detail

Throws:

java.io.IOException - if there is an io error

getDetailTokenWriter

public TokenWriter getDetailTokenWriter()
                                 throws java.io.IOException

returns detail token writer

Returns:

token writer of the detail

Throws:

java.io.IOException - if there is an io error

send

public void send()
          throws java.io.IOException

Sends the content of the Fault over the transport connection and flushes buffered content.

Throws:

java.io.IOException - if there is an io error