/*
* The Apache Software License, Version 1.1
*
*
* Copyright (c) 2001 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Axis" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.axis.message;
import org.apache.axis.AxisFault;
import org.apache.axis.Constants;
import org.apache.axis.encoding.DeserializationContext;
import org.apache.axis.encoding.Deserializer;
import org.apache.axis.encoding.SOAPTypeMappingRegistry;
import org.apache.axis.encoding.ValueReceiver;
import org.apache.axis.utils.QFault;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.w3c.dom.Element;
import org.w3c.dom.Text;
import javax.xml.rpc.namespace.QName;
import java.util.HashMap;
import java.util.ArrayList;
import java.util.Iterator;
/**
* Build a Fault body element.
*
* @author Sam Ruby (rubys@us.ibm.com)
* @author Glen Daniels (gdaniels@macromedia.com)
* @author Tom Jordahl (tomj@macromedia.com)
*/
public class SOAPFaultBuilder extends SOAPHandler implements ValueReceiver
{
protected SOAPFaultElement element;
protected DeserializationContext context;
static HashMap fields = new HashMap();
// Fault data
protected String faultClassName = null;
protected QFault faultCode = null;
protected String faultString = null;
protected String faultActor = null;
protected Element[] faultDetails;
static {
fields.put(Constants.ELEM_FAULT_CODE, SOAPTypeMappingRegistry.XSD_STRING);
fields.put(Constants.ELEM_FAULT_STRING, SOAPTypeMappingRegistry.XSD_STRING);
fields.put(Constants.ELEM_FAULT_ACTOR, SOAPTypeMappingRegistry.XSD_STRING);
fields.put(Constants.ELEM_FAULT_DETAIL, null);
}
public SOAPFaultBuilder(SOAPFaultElement element,
DeserializationContext context) {
this.element = element;
this.context = context;
}
/**
* Final call back where we can populate the exception with data.
*/
public void endElement(String namespace, String localName,
DeserializationContext context)
throws SAXException {
super.endElement(namespace, localName, context);
AxisFault f = null;
if (faultClassName != null) {
try {
Class exClass = Class.forName(faultClassName);
if (AxisFault.class.isAssignableFrom(exClass)) {
f = (AxisFault) exClass.newInstance();
f.setFaultCode(faultCode);
f.setFaultString(faultString);
f.setFaultActor(faultActor);
f.setFaultDetail(faultDetails);
}
}
catch (Exception e) {
// Don't do anything here, since a problem above means
// we'll just fall through and use a plain AxisFault.
}
}
if (f == null) {
f = new AxisFault(faultCode,
faultString,
faultActor,
faultDetails);
}
element.setFault(f);
}
public SOAPHandler onStartChild(String namespace,
String name,
String prefix,
Attributes attributes,
DeserializationContext context)
throws SAXException
{
Deserializer currentDeser = null;
QName qName = (QName)fields.get(name);
if (qName != null) {
currentDeser = context.getTypeMappingRegistry().
getDeserializer(qName);
currentDeser.registerCallback(this, name);
}
return currentDeser;
}
public void onEndChild(String namespace, String localName,
DeserializationContext context)
throws SAXException {
if (Constants.ELEM_FAULT_DETAIL.equals(localName)) {
MessageElement el = context.getCurElement();
ArrayList children = el.getChildren();
if (children != null) {
Element [] elements = new Element [children.size()];
for (int i = 0; i < elements.length; i++) {
try {
elements[i] = ((MessageElement)children.get(i)).
getAsDOM();
if (elements[i].getLocalName().equals("exceptionName")) {
Text text = (Text)elements[i].getFirstChild();
faultClassName = text.getData();
}
} catch (Exception e) {
throw new SAXException(e);
}
}
faultDetails = elements;
}
}
}
public void valueReady(Object value, Object hint)
{
String name = (String)hint;
if (name.equals(Constants.ELEM_FAULT_CODE)) {
QName qname = context.getQNameFromString((String)value);
if (qname != null) {
//??when would QName make sense, this would be app specific
faultCode = new QFault(qname);
} else {
//?? Where would namespace come from
faultCode = new QFault("",(String) value);
}
} else if (name.equals(Constants.ELEM_FAULT_STRING)) {
faultString = (String) value;
} else if (name.equals(Constants.ELEM_FAULT_ACTOR)) {
faultActor = (String) value;
}
}
}