/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you 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 javax.xml.soap; /** *
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
* SOAPHeaderElement
objects.
A SOAPHeaderElement
object can have other SOAPElement
objects as its
* children.
SOAPHeaderElement
object to the specified
* actor. The default value of an actor is: SOAPConstants.URI_SOAP_ACTOR_NEXT
*
* @param actorURI a String
giving the URI of the actor to set
* @throws IllegalArgumentException
* if there is a problem in setting the actor.
* @see #getActor() getActor()
*/
public abstract void setActor(String actorURI);
/**
* Returns the uri of the actor associated with this SOAPHeaderElement
object.
*
* @return a String
giving the URI of the actor
* @see #setActor(String) setActor(java.lang.String)
*/
public abstract String getActor();
/**
* Sets the mustUnderstand attribute for this SOAPHeaderElement
object to be on or
* off.
*
* If the mustUnderstand attribute is on, the actor who receives the
* SOAPHeaderElement
must process it correctly. This ensures, for example, that if
* the SOAPHeaderElement
object modifies the message, that the message is being
* modified correctly.
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()
*/
public abstract void setMustUnderstand(boolean mustUnderstand);
/**
* Returns whether the mustUnderstand attribute for this SOAPHeaderElement
object
* is turned on.
*
* @return true
if the mustUnderstand attribute of this
* SOAPHeaderElement
object is turned on; false
otherwise
*/
public abstract boolean getMustUnderstand();
public abstract void setRole(String s)
throws SOAPException;
public abstract String getRole();
public abstract void setRelay(boolean flag)
throws SOAPException;
public abstract boolean getRelay();
}