Appendix A. SAAJ 1.1 API

SAAJ 1.1 API

SAAJ Interfaces

package javax.xml.soap;

public interface Node extends org.w3c.dom.Node {

    public abstract String getValue();

    public abstract void setParentElement(SOAPElement parent)
        throws SOAPException;

    public abstract SOAPElement getParentElement();

    public abstract void detachNode();

    public abstract void recycleNode();

    public abstract void setValue(String value);
}		
					

package javax.xml.soap;

public interface Text extends Node, org.w3c.dom.Text {

    public abstract boolean isComment();
}
					

package javax.xml.soap;

import java.util.Iterator;

public interface SOAPElement extends Node, org.w3c.dom.Element {

    public abstract SOAPElement addChildElement(Name name) throws SOAPException;

    public abstract SOAPElement addChildElement(String localName)
        throws SOAPException;

    public abstract SOAPElement addChildElement(String localName, String prefix)
        throws SOAPException;

    public abstract SOAPElement addChildElement(
        String localName, String prefix, String uri) throws SOAPException;

    public abstract SOAPElement addChildElement(SOAPElement element)
        throws SOAPException;

    public abstract SOAPElement addTextNode(String text) throws SOAPException;

    public abstract SOAPElement addAttribute(Name name, String value)
        throws SOAPException;

    public abstract SOAPElement addNamespaceDeclaration(
        String prefix, String uri) throws SOAPException;

    public abstract String getAttributeValue(Name name);

    public abstract Iterator getAllAttributes();

    public abstract String getNamespaceURI(String prefix);

    public abstract Iterator getNamespacePrefixes();

    public abstract Name getElementName();

    public abstract boolean removeAttribute(Name name);

    public abstract boolean removeNamespaceDeclaration(String prefix);

    public abstract Iterator getChildElements();

    public abstract Iterator getChildElements(Name name);

    public abstract void setEncodingStyle(String encodingStyle)
        throws SOAPException;

    public abstract String getEncodingStyle();

    public abstract void removeContents();

    public abstract Iterator getVisibleNamespacePrefixes();
}
					

package javax.xml.soap;

import org.w3c.dom.Document;

import java.util.Locale;

public interface SOAPBody extends SOAPElement {

    public abstract SOAPFault addFault() throws SOAPException;

    public abstract boolean hasFault();

    public abstract SOAPFault getFault();

    public abstract SOAPBodyElement addBodyElement(Name name)
        throws SOAPException;

    public abstract SOAPFault addFault(Name faultCode,
                                       String faultString,
                                       Locale locale) throws SOAPException;

    public abstract SOAPFault addFault(Name faultCode, String faultString) throws SOAPException;

    public abstract SOAPBodyElement addDocument(Document document) throws SOAPException;
}
					

package javax.xml.soap;

public interface SOAPBodyElement extends SOAPElement {}
					

package javax.xml.soap;

import java.util.Locale;

public interface SOAPFault extends SOAPBodyElement {

    public abstract void setFaultCode(String faultCode) throws SOAPException;

    public abstract String getFaultCode();

    public abstract void setFaultActor(String faultActor) throws SOAPException;

    public abstract String getFaultActor();

    public abstract void setFaultString(String faultString)
        throws SOAPException;

    public abstract String getFaultString();

    public abstract Detail getDetail();

    public abstract Detail addDetail() throws SOAPException;

    public abstract void setFaultCode(Name name) throws SOAPException;

    public abstract Name getFaultCodeAsName();

    public abstract void setFaultString(String faultString, Locale locale) throws SOAPException;

    public abstract Locale getFaultStringLocale();
}
					

package javax.xml.soap;

public interface SOAPEnvelope extends SOAPElement {

    public abstract Name createName(String localName, String prefix, String uri)
        throws SOAPException;

    public abstract Name createName(String localName) throws SOAPException;

    public abstract SOAPHeader getHeader() throws SOAPException;

    public abstract SOAPBody getBody() throws SOAPException;

    public abstract SOAPHeader addHeader() throws SOAPException;

    public abstract SOAPBody addBody() throws SOAPException;
}
					
					

package javax.xml.soap;

import java.util.Iterator;

public interface SOAPHeader extends SOAPElement {

    public abstract SOAPHeaderElement addHeaderElement(Name name)
        throws SOAPException;

    // does not detach headers
    public abstract Iterator examineHeaderElements(String actor);

    // detaches headers
    public abstract Iterator extractHeaderElements(String actor);

    public abstract Iterator examineMustUnderstandHeaderElements(String actor);

    public abstract Iterator examineAllHeaderElements();

    public abstract Iterator extractAllHeaderElements();
}
					

package javax.xml.soap;

public interface SOAPHeaderElement extends SOAPElement {

    public abstract void setActor(String actorURI);

    public abstract String getActor();

    public abstract void setMustUnderstand(boolean mustUnderstand);

    public abstract boolean getMustUnderstand();
}
					

SAAJ API Classes.

package javax.xml.soap;

import java.io.IOException;
import java.io.InputStream;

public abstract class MessageFactory {

    protected MessageFactory() {}

    public static MessageFactory newInstance() throws SOAPException {
        ...
    }

    public abstract SOAPMessage createMessage() throws SOAPException;

    public abstract SOAPMessage createMessage(
        MimeHeaders mimeheaders, InputStream inputstream)
            throws IOException, SOAPException;
    ...
}
					

package javax.xml.soap;

import javax.activation.DataHandler;
import java.io.IOException;
import java.io.OutputStream;
import java.util.Iterator;

public abstract class SOAPMessage {

    public SOAPMessage() {}
    public abstract String getContentDescription();
    public abstract void setContentDescription(String description);
    public abstract SOAPPart getSOAPPart();
    public abstract void removeAllAttachments();
    public abstract int countAttachments();
    public abstract Iterator getAttachments();
    public abstract Iterator getAttachments(MimeHeaders headers);
    public abstract void addAttachmentPart(AttachmentPart attachmentpart);
    public abstract AttachmentPart createAttachmentPart();
    public AttachmentPart createAttachmentPart(DataHandler datahandler) { ... }
    public abstract MimeHeaders getMimeHeaders();
    public AttachmentPart createAttachmentPart(Object content, String contentType) {
        ...    
    }
    public abstract void saveChanges() throws SOAPException;
    public abstract boolean saveRequired();
    public abstract void writeTo(OutputStream out) throws SOAPException, IOException;
    public SOAPBody getSOAPBody() throws SOAPException {
        ...
    }
    public SOAPHeader getSOAPHeader() throws SOAPException {
        ...
    }
    public void setProperty(String property, Object value) throws SOAPException  {
        ...
    }
    public Object getProperty(String property) throws SOAPException {
        ...
    }    
}
					

package javax.xml.soap;

import javax.xml.transform.Source;
import java.util.Iterator;

public abstract class SOAPPart implements org.w3c.dom.Document {

    public SOAPPart() {}
    public abstract SOAPEnvelope getEnvelope() throws SOAPException;
    public String getContentId() {
        ...
    }
    public String getContentLocation() {
        ...    
    }
    public void setContentId(String contentId) {
        ...
    }
    public void setContentLocation(String contentLocation) {
        ...
    }
    public abstract void removeMimeHeader(String header);
    public abstract void removeAllMimeHeaders();
    public abstract String[] getMimeHeader(String name);
    public abstract void setMimeHeader(String name, String value);
    public abstract void addMimeHeader(String name, String value);
    public abstract Iterator getAllMimeHeaders();
    public abstract Iterator getMatchingMimeHeaders(String names[]);
    public abstract Iterator getNonMatchingMimeHeaders(String names[]);
    public abstract void setContent(Source source) throws SOAPException;
    public abstract Source getContent() throws SOAPException;
}
					

package javax.xml.soap;

import java.util.Locale;

public interface SOAPFault extends SOAPBodyElement {

    public abstract void setFaultCode(String faultCode) throws SOAPException;
    public abstract String getFaultCode();
    public abstract void setFaultActor(String faultActor) throws SOAPException;
    public abstract String getFaultActor();
    public abstract void setFaultString(String faultString)
    public abstract String getFaultString();
    public abstract Detail getDetail();
    public abstract Detail addDetail() throws SOAPException;
    public abstract void setFaultCode(Name name) throws SOAPException;
    public abstract Name getFaultCodeAsName();
    public abstract void setFaultString(String faultString, Locale locale) throws SOAPException;
    public abstract Locale getFaultStringLocale();
}
					

Professional hosting     Belorussian informational portal         Free SCWCD 1.4 Study Guide     Free SCDJWS 1.4 Study Guide     SCDJWS 1.4 Quiz     Free IBM Certified Associate Developer Study Guide     IBM Test 000-287. Enterprise Application Development with IBM WebSphere Studio, V5.0 Study Guide     SCDJWS 5.0 Quiz