org.jibx.soap
Class SOAPFault

java.lang.Object
  org.jibx.soap.SOAPFault

public class SOAPFault

extends java.lang.Object

SOAP fault object class. This is used for both send and receive fault handling. Note that this uses an unconventional approach to marshalling and unmarshalling, where appropriate methods are defined directly by the class. This is done for convenience, since marshalling and unmarshalling of instances takes place only under the control of the SOAPContext class.

Version:

1.0

Author:

Dennis M. Sosnoski

Constructor Summary

SOAPFault(java.lang.String code, java.lang.String string)
Constructor with no details or actor.

SOAPFault(java.lang.String code, java.lang.String string, java.lang.String actor)
Constructor with no details.

SOAPFault(java.lang.String code, java.lang.String string, java.lang.String actor, java.util.ArrayList details)
Constructor.

Method Summary

void	addFaultDetail(java.lang.Object detail) Add fault detail.
java.lang.String	getFaultActor() Get fault action.
java.lang.String	getFaultCode() Get fault code.
java.util.ArrayList	getFaultDetails() Get fault details.
java.lang.String	getFaultString() Get fault string.
void	marshal(int nsi, org.jibx.runtime.IMarshallingContext ictx) Marshal directly to context.
static SOAPFault	unmarshal(org.jibx.runtime.IUnmarshallingContext ictx) Unmarshal instance directly from context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SOAPFault

public SOAPFault(java.lang.String code,
                 java.lang.String string,
                 java.lang.String actor,
                 java.util.ArrayList details)

Constructor.

Parameters:

code - fault type code

string - readable description of fault

actor - URI for fault source (optional, may be null)

details - detail items for a body-related fault condition (optional, may be null)

SOAPFault

public SOAPFault(java.lang.String code,
                 java.lang.String string,
                 java.lang.String actor)

Constructor with no details.

Parameters:

code - fault type code

string - readable description of fault

actor - URI for fault source (optional, may be null)

SOAPFault

public SOAPFault(java.lang.String code,
                 java.lang.String string)

Constructor with no details or actor.

Parameters:

code - fault type code

string - readable description of fault

Method Detail

getFaultCode

public java.lang.String getFaultCode()

Get fault code.

Returns:

fault code

getFaultString

public java.lang.String getFaultString()

Get fault string.

Returns:

fault string

getFaultActor

public java.lang.String getFaultActor()

Get fault action.

Returns:

fault action (may be null)

getFaultDetails

public java.util.ArrayList getFaultDetails()

Get fault details.

Returns:

fault details

addFaultDetail

public void addFaultDetail(java.lang.Object detail)

Add fault detail.

Parameters:

detail - fault detail item (must be marshallable)

marshal

public void marshal(int nsi,
                    org.jibx.runtime.IMarshallingContext ictx)
             throws org.jibx.runtime.JiBXException

Marshal directly to context.

Parameters:

nsi - SOAP namespace index

ictx - marshalling context

Throws:

org.jibx.runtime.JiBXException

unmarshal

public static SOAPFault unmarshal(org.jibx.runtime.IUnmarshallingContext ictx)
                           throws org.jibx.runtime.JiBXException

Unmarshal instance directly from context.

Parameters:

ictx - unmarshalling context

Throws:

org.jibx.runtime.JiBXException