org.apache.axis.soap.SOAPConstants Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2002-2004 The Apache Software Foundation.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.axis.soap;

import javax.xml.namespace.QName;
import java.io.Serializable;

/**
 * An interface definining SOAP constants.  This allows various parts of the
 * engine to avoid hardcoding dependence on a particular SOAP version and its
 * associated URIs, etc.
 *
 * This might be fleshed out later to encapsulate factories for behavioral
 * objects which act differently depending on the SOAP version, but for now
 * it just supplies common namespaces + QNames.
 *
 * @author Glen Daniels ([email protected])
 * @author Andras Avar ([email protected])
 */
public interface SOAPConstants extends Serializable {
    /** SOAP 1.1 constants - thread-safe and shared */
    public SOAP11Constants SOAP11_CONSTANTS = new SOAP11Constants();
    /** SOAP 1.2 constants - thread-safe and shared */
    public SOAP12Constants SOAP12_CONSTANTS = new SOAP12Constants();

    /**
     * Obtain the envelope namespace for this version of SOAP
     */
    public String getEnvelopeURI();

    /**
     * Obtain the encoding namespace for this version of SOAP
     */
    public String getEncodingURI();

    /**
     * Obtain the QName for the Fault element
     */
    public QName getFaultQName();

    /**
     * Obtain the QName for the Header element
     */
    public QName getHeaderQName();

    /**
     * Obtain the QName for the Body element
     */
    public QName getBodyQName();

    /**
     * Obtain the QName for the role attribute (actor/role)
     */
    public QName getRoleAttributeQName();

    /**
     * Obtain the MIME content type
     */
    public String getContentType();
    
    /**
     * Obtain the "next" role/actor URI
     */ 
    public String getNextRoleURI();

    /**
     * Obtain the href attribute name
     */
    public String getAttrHref();

    /**
     * Obtain the item type name of an array
     */
    public String getAttrItemType();

    /**
     * Obtain the Qname of VersionMismatch fault code
     */
    public QName getVerMismatchFaultCodeQName();

    /**
     * Obtain the Qname of Mustunderstand fault code
     */
    public QName getMustunderstandFaultQName();

    /**
     * Obtain the QName of the SOAP array type
     */ 
    QName getArrayType();
}