< prev index next >

src/java.xml.ws/share/classes/javax/xml/soap/SOAPHeaderElement.java

Print this page


   1 /*
   2  * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  43      * object to the specified actor. The default value of an actor is:
  44      *          {@code SOAPConstants.URI_SOAP_ACTOR_NEXT}
  45      * <P>
  46      * If this {@code SOAPHeaderElement} supports SOAP 1.2 then this call is
  47      * equivalent to {@link #setRole(String)}
  48      *
  49      * @param  actorURI a {@code String} giving the URI of the actor
  50      *           to set
  51      *
  52      * @exception IllegalArgumentException if there is a problem in
  53      * setting the actor.
  54      *
  55      * @see #getActor
  56      */
  57     public void setActor(String actorURI);
  58 
  59     /**
  60      * Sets the {@code Role} associated with this {@code SOAPHeaderElement}
  61      * object to the specified {@code Role}.
  62      *
  63      * @param uri - the URI of the {@code Role}
  64      *
  65      * @throws SOAPException if there is an error in setting the role
  66      *
  67      * @exception UnsupportedOperationException if this message does not
  68      *      support the SOAP 1.2 concept of Fault Role.
  69      *
  70      * @since 1.6, SAAJ 1.3
  71      */
  72     public void setRole(String uri) throws SOAPException;
  73 
  74     /**
  75      * Returns the uri of the <i>actor</i> attribute of this
  76      * {@code SOAPHeaderElement}.
  77      *<P>
  78      * If this {@code SOAPHeaderElement} supports SOAP 1.2 then this call is
  79      * equivalent to {@link #getRole()}
  80      * @return  a {@code String} giving the URI of the actor
  81      * @see #setActor
  82      */
  83     public String getActor();


   1 /*
   2  * Copyright (c) 2004, 2017, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  43      * object to the specified actor. The default value of an actor is:
  44      *          {@code SOAPConstants.URI_SOAP_ACTOR_NEXT}
  45      * <P>
  46      * If this {@code SOAPHeaderElement} supports SOAP 1.2 then this call is
  47      * equivalent to {@link #setRole(String)}
  48      *
  49      * @param  actorURI a {@code String} giving the URI of the actor
  50      *           to set
  51      *
  52      * @exception IllegalArgumentException if there is a problem in
  53      * setting the actor.
  54      *
  55      * @see #getActor
  56      */
  57     public void setActor(String actorURI);
  58 
  59     /**
  60      * Sets the {@code Role} associated with this {@code SOAPHeaderElement}
  61      * object to the specified {@code Role}.
  62      *
  63      * @param uri the URI of the {@code Role}
  64      *
  65      * @throws SOAPException if there is an error in setting the role
  66      *
  67      * @exception UnsupportedOperationException if this message does not
  68      *      support the SOAP 1.2 concept of Fault Role.
  69      *
  70      * @since 1.6, SAAJ 1.3
  71      */
  72     public void setRole(String uri) throws SOAPException;
  73 
  74     /**
  75      * Returns the uri of the <i>actor</i> attribute of this
  76      * {@code SOAPHeaderElement}.
  77      *<P>
  78      * If this {@code SOAPHeaderElement} supports SOAP 1.2 then this call is
  79      * equivalent to {@link #getRole()}
  80      * @return  a {@code String} giving the URI of the actor
  81      * @see #setActor
  82      */
  83     public String getActor();


< prev index next >