org.apache.axiom.soap.SOAPHeaderBlock Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of axiom-api
The Axiom API
There is a newer version: 2.0.0
/*
 * Copyright 2004,2005 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.axiom.soap;

import org.apache.axiom.om.OMElement;

/**
 * An object representing the contents in the SOAP header part of the SOAP envelope. The
 * immediate children of a  SOAPHeader object can be represented only as 
 * SOAPHeaderBlock objects.
 B SOAPHeaderBlock object can have other
 * OMElement objects as its children.
 */
public interface SOAPHeaderBlock extends OMElement {
    /**
     * Sets the actor associated with this  SOAPHeaderBlock object to the specified
     * actor.
     *
     * @param roleURI a String giving the URI of the actor to set
     * @throws IllegalArgumentException
     *          if there is a problem in setting the actor.
     * @see #getRole() getRole()
     */
    void setRole(String roleURI);

    /**
     * Returns the uri of the actor associated with this  SOAPHeaderBlock object.
     *
     * @return a String giving the URI of the actor
     * @see #setRole(String) setRole(java.lang.String)
     */
    String getRole();

    /**
     * Sets the mustUnderstand attribute for this  SOAPHeaderBlock object to be on or
     * off. If the mustUnderstand attribute is on, the actor who receives the
     * SOAPHeaderBlock must process it correctly. This ensures, for example, that if
     * the  SOAPHeaderBlock object modifies the message, that the message is being
     * modified correctly.
     *
     * @param mustUnderstand true to set the mustUnderstand attribute on;
     *                       false to turn if off
     * @throws IllegalArgumentException
     *          if there is a problem in setting the actor.
     * @see #getMustUnderstand() getMustUnderstand()
     */
    void setMustUnderstand(boolean mustUnderstand);

    void setMustUnderstand(String mustUnderstand) throws SOAPProcessingException;

    /**
     * Returns whether the mustUnderstand attribute for this SOAPHeaderBlock object is
     * turned on.
     *
     * @return true if the mustUnderstand attribute of this
     *         SOAPHeaderBlock object is turned on; false otherwise
     */
    boolean getMustUnderstand() throws SOAPProcessingException;


    boolean isProcessed();

    /**
     * We need to know whether all the mustUnderstand headers have been processed by the node. This
     * will done by a specific validation handler at the end of the execution chain. For this all
     * the handlers who process a particular header block must explicitly say that he processesd the
     * header by calling setProcessed()
     */
    void setProcessed();


    /**
     * Sets the relay attribute for this SOAPHeaderBlock to be either true or false. The SOAP relay
     * attribute is set to true to indicate that the SOAP header block must be relayed by any node
     * that is targeted by the header block but not actually process it.
     *
     * @param relay a boolean giving the value to be set
     */
    void setRelay(boolean relay);

    /**
     * Returns the relay  status associated with this  SOAPHeaderBlock object.
     *
     * @return a boolean giving the relay status
     */
    boolean getRelay();

    /**
     * What SOAP version is this HeaderBlock?
     *
     * @return a SOAPVersion, one of the two singletons.
     */
    SOAPVersion getVersion();
}