archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-09-18 01:54:47 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

8130753: Sync-up javadoc changes in jax-ws area - includes JAX-B API, JAX-WS API, SAAJ-API

Browse source 
Reviewed-by: joehw
This commit is contained in:
Miroslav Kos 2015-07-10 11:42:59 +02:00
parent 7c256783a5
commit 4807976fb7
73 changed files with 1540 additions and 1540 deletions
Download patch file Download diff file Expand all files Collapse all files

3
jaxws/src/java.annotations.common/share/classes/javax/annotation/PostConstruct.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -39,6 +39,7 @@ import static java.lang.annotation.RetentionPolicy.*;
* method can be annotated with this annotation. The method on which the * method can be annotated with this annotation. The method on which the
* PostConstruct annotation is applied MUST fulfill all of the following * PostConstruct annotation is applied MUST fulfill all of the following
* criteria: * criteria:
* <p>
* <ul> * <ul>
* <li>The method MUST NOT have any parameters except in the case of * <li>The method MUST NOT have any parameters except in the case of
* interceptors in which case it takes an InvocationContext object as * interceptors in which case it takes an InvocationContext object as

3
jaxws/src/java.annotations.common/share/classes/javax/annotation/PreDestroy.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -38,6 +38,7 @@ import static java.lang.annotation.RetentionPolicy.*;
* except the application client container in Java EE 5. The method on which * except the application client container in Java EE 5. The method on which
* the PreDestroy annotation is applied MUST fulfill all of the following * the PreDestroy annotation is applied MUST fulfill all of the following
* criteria: * criteria:
* <p>
* <ul> * <ul>
* <li>The method MUST NOT have any parameters except in the case of * <li>The method MUST NOT have any parameters except in the case of
* interceptors in which case it takes an InvocationContext object as * interceptors in which case it takes an InvocationContext object as

4
jaxws/src/java.xml.bind/share/classes/javax/xml/bind/DatatypeConverterImpl.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2007, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2007, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -124,7 +124,7 @@ final class DatatypeConverterImpl implements DatatypeConverterInterface {
} }
public static long _parseLong(CharSequence s) { public static long _parseLong(CharSequence s) {
return Long.valueOf(removeOptionalPlus(WhiteSpaceProcessor.trim(s)).toString()); return Long.parseLong(removeOptionalPlus(WhiteSpaceProcessor.trim(s)).toString());
} }
public short parseShort(String lexicalXSDShort) { public short parseShort(String lexicalXSDShort) {

2
jaxws/src/java.xml.ws/share/classes/javax/xml/soap/AttachmentPart.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it

58
jaxws/src/java.xml.ws/share/classes/javax/xml/soap/Detail.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -30,43 +30,43 @@ import java.util.Iterator;
import javax.xml.namespace.QName; import javax.xml.namespace.QName;
/** /**
* A container for <code>DetailEntry</code> objects. <code>DetailEntry</code> * A container for {@code DetailEntry} objects. {@code DetailEntry}
* objects give detailed error information that is application-specific and * objects give detailed error information that is application-specific and
* related to the <code>SOAPBody</code> object that contains it. * related to the {@code SOAPBody} object that contains it.
*<P> *<P>
* A <code>Detail</code> object, which is part of a <code>SOAPFault</code> * A {@code Detail} object, which is part of a {@code SOAPFault}
* object, can be retrieved using the method <code>SOAPFault.getDetail</code>. * object, can be retrieved using the method {@code SOAPFault.getDetail}.
* The <code>Detail</code> interface provides two methods. One creates a new * The {@code Detail} interface provides two methods. One creates a new
* <code>DetailEntry</code> object and also automatically adds it to * {@code DetailEntry} object and also automatically adds it to
* the <code>Detail</code> object. The second method gets a list of the * the {@code Detail} object. The second method gets a list of the
* <code>DetailEntry</code> objects contained in a <code>Detail</code> * {@code DetailEntry} objects contained in a {@code Detail}
* object. * object.
* <P> * <P>
* The following code fragment, in which <i>sf</i> is a <code>SOAPFault</code> * The following code fragment, in which <i>sf</i> is a {@code SOAPFault}
* object, gets its <code>Detail</code> object (<i>d</i>), adds a new * object, gets its {@code Detail} object (<i>d</i>), adds a new
* <code>DetailEntry</code> object to <i>d</i>, and then gets a list of all the * {@code DetailEntry} object to <i>d</i>, and then gets a list of all the
* <code>DetailEntry</code> objects in <i>d</i>. The code also creates a * {@code DetailEntry} objects in <i>d</i>. The code also creates a
* <code>Name</code> object to pass to the method <code>addDetailEntry</code>. * {@code Name} object to pass to the method {@code addDetailEntry}.
* The variable <i>se</i>, used to create the <code>Name</code> object, * The variable <i>se</i>, used to create the {@code Name} object,
* is a <code>SOAPEnvelope</code> object. * is a {@code SOAPEnvelope} object.
* <PRE> * <pre>{@code
* Detail d = sf.getDetail(); * Detail d = sf.getDetail();
* Name name = se.createName("GetLastTradePrice", "WOMBAT", * Name name = se.createName("GetLastTradePrice", "WOMBAT",
* "http://www.wombat.org/trader"); * "http://www.wombat.org/trader");
* d.addDetailEntry(name); * d.addDetailEntry(name);
* Iterator it = d.getDetailEntries(); * Iterator it = d.getDetailEntries();
* </PRE> * }</pre>
* *
* @since 1.6 * @since 1.6
*/ */
public interface Detail extends SOAPFaultElement { public interface Detail extends SOAPFaultElement {
/** /**
* Creates a new <code>DetailEntry</code> object with the given * Creates a new {@code DetailEntry} object with the given
* name and adds it to this <code>Detail</code> object. * name and adds it to this {@code Detail} object.
* *
* @param name a <code>Name</code> object identifying the * @param name a {@code Name} object identifying the
* new <code>DetailEntry</code> object * new {@code DetailEntry} object
* *
* @exception SOAPException thrown when there is a problem in adding a * @exception SOAPException thrown when there is a problem in adding a
* DetailEntry object to this Detail object. * DetailEntry object to this Detail object.
@ -76,12 +76,12 @@ public interface Detail extends SOAPFaultElement {
public DetailEntry addDetailEntry(Name name) throws SOAPException; public DetailEntry addDetailEntry(Name name) throws SOAPException;
/** /**
* Creates a new <code>DetailEntry</code> object with the given * Creates a new {@code DetailEntry} object with the given
* QName and adds it to this <code>Detail</code> object. This method * QName and adds it to this {@code Detail} object. This method
* is the preferred over the one using Name. * is the preferred over the one using Name.
* *
* @param qname a <code>QName</code> object identifying the * @param qname a {@code QName} object identifying the
* new <code>DetailEntry</code> object * new {@code DetailEntry} object
* *
* @exception SOAPException thrown when there is a problem in adding a * @exception SOAPException thrown when there is a problem in adding a
* DetailEntry object to this Detail object. * DetailEntry object to this Detail object.
@ -92,10 +92,10 @@ public interface Detail extends SOAPFaultElement {
public DetailEntry addDetailEntry(QName qname) throws SOAPException; public DetailEntry addDetailEntry(QName qname) throws SOAPException;
/** /**
* Gets an Iterator over all of the <code>DetailEntry</code>s in this <code>Detail</code> object. * Gets an Iterator over all of the {@code DetailEntry}s in this {@code Detail} object.
* *
* @return an <code>Iterator</code> object over the <code>DetailEntry</code> * @return an {@code Iterator} object over the {@code DetailEntry}
* objects in this <code>Detail</code> object * objects in this {@code Detail} object
*/ */
public Iterator getDetailEntries(); public Iterator getDetailEntries();
} }

8
jaxws/src/java.xml.ws/share/classes/javax/xml/soap/DetailEntry.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -26,9 +26,9 @@
package javax.xml.soap; package javax.xml.soap;
/** /**
* The content for a <code>Detail</code> object, giving details for * The content for a {@code Detail} object, giving details for
* a <code>SOAPFault</code> object. A <code>DetailEntry</code> object, * a {@code SOAPFault} object. A {@code DetailEntry} object,
* which carries information about errors related to the <code>SOAPBody</code> * which carries information about errors related to the {@code SOAPBody}
* object that contains it, is application-specific. * object that contains it, is application-specific.
* *
* @since 1.6 * @since 1.6

34
jaxws/src/java.xml.ws/share/classes/javax/xml/soap/FactoryFinder.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -33,7 +33,7 @@ class FactoryFinder {
/** /**
* Creates an instance of the specified class using the specified * Creates an instance of the specified class using the specified
* <code>ClassLoader</code> object. * {@code ClassLoader} object.
* *
* @exception SOAPException if the given class could not be found * @exception SOAPException if the given class could not be found
* or could not be instantiated * or could not be instantiated
@ -54,13 +54,13 @@ class FactoryFinder {
} }
/** /**
* Finds the implementation <code>Class</code> object for the given * Finds the implementation {@code Class} object for the given
* factory name, or null if that fails. * factory name, or null if that fails.
* <P> * <P>
* This method is package private so that this code can be shared. * This method is package private so that this code can be shared.
* *
* @return the <code>Class</code> object of the specified message factory; * @return the {@code Class} object of the specified message factory;
* or <code>null</code> * or {@code null}
* *
* @param factoryId the name of the factory to find, which is * @param factoryId the name of the factory to find, which is
* a system property * a system property
@ -73,22 +73,22 @@ class FactoryFinder {
} }
/** /**
* Finds the implementation <code>Class</code> object for the given * Finds the implementation {@code Class} object for the given
* factory name, or if that fails, finds the <code>Class</code> object * factory name, or if that fails, finds the {@code Class} object
* for the given fallback class name. The arguments supplied must be * for the given fallback class name. The arguments supplied must be
* used in order. If using the first argument is successful, the second * used in order. If using the first argument is successful, the second
* one will not be used. * one will not be used.
* <P> * <P>
* This method is package private so that this code can be shared. * This method is package private so that this code can be shared.
* *
* @return the <code>Class</code> object of the specified message factory; * @return the {@code Class} object of the specified message factory;
* may be <code>null</code> * may be {@code null}
* *
* @param factoryId the name of the factory to find, which is * @param factoryId the name of the factory to find, which is
* a system property * a system property
* @param fallbackClassName the implementation class name, which is * @param fallbackClassName the implementation class name, which is
* to be used only if nothing else * to be used only if nothing else
* is found; <code>null</code> to indicate that * is found; {@code null} to indicate that
* there is no fallback class name * there is no fallback class name
* @exception SOAPException if there is a SOAP error * @exception SOAPException if there is a SOAP error
*/ */
@ -99,24 +99,24 @@ class FactoryFinder {
} }
/** /**
* Finds the implementation <code>Class</code> object for the given * Finds the implementation {@code Class} object for the given
* factory name, or if that fails, finds the <code>Class</code> object * factory name, or if that fails, finds the {@code Class} object
* for the given default class name, but only if <code>tryFallback</code> * for the given default class name, but only if {@code tryFallback}
* is <code>true</code>. The arguments supplied must be used in order * is {@code true}. The arguments supplied must be used in order
* If using the first argument is successful, the second one will not * If using the first argument is successful, the second one will not
* be used. Note the default class name may be needed even if fallback * be used. Note the default class name may be needed even if fallback
* is not to be attempted, so certain error conditions can be handled. * is not to be attempted, so certain error conditions can be handled.
* <P> * <P>
* This method is package private so that this code can be shared. * This method is package private so that this code can be shared.
* *
* @return the <code>Class</code> object of the specified message factory; * @return the {@code Class} object of the specified message factory;
* may not be <code>null</code> * may not be {@code null}
* *
* @param factoryId the name of the factory to find, which is * @param factoryId the name of the factory to find, which is
* a system property * a system property
* @param defaultClassName the implementation class name, which is * @param defaultClassName the implementation class name, which is
* to be used only if nothing else * to be used only if nothing else
* is found; <code>null</code> to indicate * is found; {@code null} to indicate
* that there is no default class name * that there is no default class name
* @param tryFallback whether to try the default class as a * @param tryFallback whether to try the default class as a
* fallback * fallback

104
jaxws/src/java.xml.ws/share/classes/javax/xml/soap/MessageFactory.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -30,36 +30,36 @@ import java.io.IOException;
import java.io.InputStream; import java.io.InputStream;
/** /**
* A factory for creating <code>SOAPMessage</code> objects. * A factory for creating {@code SOAPMessage} objects.
* <P> * <P>
* A SAAJ client can create a <code>MessageFactory</code> object * A SAAJ client can create a {@code MessageFactory} object
* using the method <code>newInstance</code>, as shown in the following * using the method {@code newInstance}, as shown in the following
* lines of code. * lines of code.
* <PRE> * <pre>{@code
* MessageFactory mf = MessageFactory.newInstance(); * MessageFactory mf = MessageFactory.newInstance();
* MessageFactory mf12 = MessageFactory.newInstance(SOAPConstants.SOAP_1_2_PROTOCOL); * MessageFactory mf12 = MessageFactory.newInstance(SOAPConstants.SOAP_1_2_PROTOCOL);
* </PRE> * }</pre>
* <P> * <P>
* All <code>MessageFactory</code> objects, regardless of how they are * All {@code MessageFactory} objects, regardless of how they are
* created, will produce <code>SOAPMessage</code> objects that * created, will produce {@code SOAPMessage} objects that
* have the following elements by default: * have the following elements by default:
* <UL> * <UL>
* <LI>A <code>SOAPPart</code> object * <LI>A {@code SOAPPart} object
* <LI>A <code>SOAPEnvelope</code> object * <LI>A {@code SOAPEnvelope} object
* <LI>A <code>SOAPBody</code> object * <LI>A {@code SOAPBody} object
* <LI>A <code>SOAPHeader</code> object * <LI>A {@code SOAPHeader} object
* </UL> * </UL>
* In some cases, specialized MessageFactory objects may be obtained that produce messages * In some cases, specialized MessageFactory objects may be obtained that produce messages
* prepopulated with additional entries in the <code>SOAPHeader</code> object and the * prepopulated with additional entries in the {@code SOAPHeader} object and the
* <code>SOAPBody</code> object. * {@code SOAPBody} object.
* The content of a new <code>SOAPMessage</code> object depends on which of the two * The content of a new {@code SOAPMessage} object depends on which of the two
* <code>MessageFactory</code> methods is used to create it. * {@code MessageFactory} methods is used to create it.
* <UL> * <UL>
* <LI><code>createMessage()</code> <BR> * <LI>{@code createMessage()} <BR>
* This is the method clients would normally use to create a request message. * This is the method clients would normally use to create a request message.
* <LI><code>createMessage(MimeHeaders, java.io.InputStream)</code> -- message has * <LI>{@code createMessage(MimeHeaders, java.io.InputStream)} -- message has
* content from the <code>InputStream</code> object and headers from the * content from the {@code InputStream} object and headers from the
* <code>MimeHeaders</code> object <BR> * {@code MimeHeaders} object <BR>
* This method can be used internally by a service implementation to * This method can be used internally by a service implementation to
* create a message that is a response to a request. * create a message that is a response to a request.
* </UL> * </UL>
@ -75,7 +75,7 @@ public abstract class MessageFactory {
= "javax.xml.soap.MessageFactory"; = "javax.xml.soap.MessageFactory";
/** /**
* Creates a new <code>MessageFactory</code> object that is an instance * Creates a new {@code MessageFactory} object that is an instance
* of the default implementation (SOAP 1.1), * of the default implementation (SOAP 1.1),
* *
* This method uses the following ordered lookup procedure to determine the MessageFactory implementation class to load: * This method uses the following ordered lookup procedure to determine the MessageFactory implementation class to load:
@ -90,11 +90,11 @@ public abstract class MessageFactory {
* </UL> * </UL>
* *
* @return a new instance of a <code>MessageFactory</code> * @return a new instance of a {@code MessageFactory}
* *
* @exception SOAPException if there was an error in creating the * @exception SOAPException if there was an error in creating the
* default implementation of the * default implementation of the
* <code>MessageFactory</code>. * {@code MessageFactory}.
* @see SAAJMetaFactory * @see SAAJMetaFactory
*/ */
@ -121,26 +121,26 @@ public abstract class MessageFactory {
} }
/** /**
* Creates a new <code>MessageFactory</code> object that is an instance * Creates a new {@code MessageFactory} object that is an instance
* of the specified implementation. May be a dynamic message factory, * of the specified implementation. May be a dynamic message factory,
* a SOAP 1.1 message factory, or a SOAP 1.2 message factory. A dynamic * a SOAP 1.1 message factory, or a SOAP 1.2 message factory. A dynamic
* message factory creates messages based on the MIME headers specified * message factory creates messages based on the MIME headers specified
* as arguments to the <code>createMessage</code> method. * as arguments to the {@code createMessage} method.
* *
* This method uses the SAAJMetaFactory to locate the implementation class * This method uses the SAAJMetaFactory to locate the implementation class
* and create the MessageFactory instance. * and create the MessageFactory instance.
* *
* @return a new instance of a <code>MessageFactory</code> * @return a new instance of a {@code MessageFactory}
* *
* @param protocol a string constant representing the class of the * @param protocol a string constant representing the class of the
* specified message factory implementation. May be * specified message factory implementation. May be
* either <code>DYNAMIC_SOAP_PROTOCOL</code>, * either {@code DYNAMIC_SOAP_PROTOCOL},
* <code>DEFAULT_SOAP_PROTOCOL</code> (which is the same * {@code DEFAULT_SOAP_PROTOCOL} (which is the same
* as) <code>SOAP_1_1_PROTOCOL</code>, or * as) {@code SOAP_1_1_PROTOCOL}, or
* <code>SOAP_1_2_PROTOCOL</code>. * {@code SOAP_1_2_PROTOCOL}.
* *
* @exception SOAPException if there was an error in creating the * @exception SOAPException if there was an error in creating the
* specified implementation of <code>MessageFactory</code>. * specified implementation of {@code MessageFactory}.
* @see SAAJMetaFactory * @see SAAJMetaFactory
* @since 1.6, SAAJ 1.3 * @since 1.6, SAAJ 1.3
*/ */
@ -149,52 +149,52 @@ public abstract class MessageFactory {
} }
/** /**
* Creates a new <code>SOAPMessage</code> object with the default * Creates a new {@code SOAPMessage} object with the default
* <code>SOAPPart</code>, <code>SOAPEnvelope</code>, <code>SOAPBody</code>, * {@code SOAPPart}, {@code SOAPEnvelope}, {@code SOAPBody},
* and <code>SOAPHeader</code> objects. Profile-specific message factories * and {@code SOAPHeader} objects. Profile-specific message factories
* can choose to prepopulate the <code>SOAPMessage</code> object with * can choose to prepopulate the {@code SOAPMessage} object with
* profile-specific headers. * profile-specific headers.
* <P> * <P>
* Content can be added to this message's <code>SOAPPart</code> object, and * Content can be added to this message's {@code SOAPPart} object, and
* the message can be sent "as is" when a message containing only a SOAP part * the message can be sent "as is" when a message containing only a SOAP part
* is sufficient. Otherwise, the <code>SOAPMessage</code> object needs * is sufficient. Otherwise, the {@code SOAPMessage} object needs
* to create one or more <code>AttachmentPart</code> objects and * to create one or more {@code AttachmentPart} objects and
* add them to itself. Any content that is not in XML format must be * add them to itself. Any content that is not in XML format must be
* in an <code>AttachmentPart</code> object. * in an {@code AttachmentPart} object.
* *
* @return a new <code>SOAPMessage</code> object * @return a new {@code SOAPMessage} object
* @exception SOAPException if a SOAP error occurs * @exception SOAPException if a SOAP error occurs
* @exception UnsupportedOperationException if the protocol of this * @exception UnsupportedOperationException if the protocol of this
* <code>MessageFactory</code> instance is <code>DYNAMIC_SOAP_PROTOCOL</code> * {@code MessageFactory} instance is {@code DYNAMIC_SOAP_PROTOCOL}
*/ */
public abstract SOAPMessage createMessage() public abstract SOAPMessage createMessage()
throws SOAPException; throws SOAPException;
/** /**
* Internalizes the contents of the given <code>InputStream</code> object into a * Internalizes the contents of the given {@code InputStream} object into a
* new <code>SOAPMessage</code> object and returns the <code>SOAPMessage</code> * new {@code SOAPMessage} object and returns the {@code SOAPMessage}
* object. * object.
* *
* @param in the <code>InputStream</code> object that contains the data * @param in the {@code InputStream} object that contains the data
* for a message * for a message
* @param headers the transport-specific headers passed to the * @param headers the transport-specific headers passed to the
* message in a transport-independent fashion for creation of the * message in a transport-independent fashion for creation of the
* message * message
* @return a new <code>SOAPMessage</code> object containing the data from * @return a new {@code SOAPMessage} object containing the data from
* the given <code>InputStream</code> object * the given {@code InputStream} object
* *
* @exception IOException if there is a problem in reading data from * @exception IOException if there is a problem in reading data from
* the input stream * the input stream
* *
* @exception SOAPException may be thrown if the message is invalid * @exception SOAPException may be thrown if the message is invalid
* *
* @exception IllegalArgumentException if the <code>MessageFactory</code> * @exception IllegalArgumentException if the {@code MessageFactory}
* requires one or more MIME headers to be present in the * requires one or more MIME headers to be present in the
* <code>headers</code> parameter and they are missing. * {@code headers} parameter and they are missing.
* <code>MessageFactory</code> implementations for * {@code MessageFactory} implementations for
* <code>SOAP_1_1_PROTOCOL</code> or * {@code SOAP_1_1_PROTOCOL} or
* <code>SOAP_1_2_PROTOCOL</code> must not throw * {@code SOAP_1_2_PROTOCOL} must not throw
* <code>IllegalArgumentException</code> for this reason. * {@code IllegalArgumentException} for this reason.
*/ */
public abstract SOAPMessage createMessage(MimeHeaders headers, public abstract SOAPMessage createMessage(MimeHeaders headers,
InputStream in) InputStream in)

18
jaxws/src/java.xml.ws/share/classes/javax/xml/soap/MimeHeader.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -28,7 +28,7 @@ package javax.xml.soap;
/** /**
* An object that stores a MIME header name and its value. One or more * An object that stores a MIME header name and its value. One or more
* <code>MimeHeader</code> objects may be contained in a <code>MimeHeaders</code> * {@code MimeHeader} objects may be contained in a {@code MimeHeaders}
* object. * object.
* *
* @see MimeHeaders * @see MimeHeaders
@ -40,11 +40,11 @@ public class MimeHeader {
private String value; private String value;
/** /**
* Constructs a <code>MimeHeader</code> object initialized with the given * Constructs a {@code MimeHeader} object initialized with the given
* name and value. * name and value.
* *
* @param name a <code>String</code> giving the name of the header * @param name a {@code String} giving the name of the header
* @param value a <code>String</code> giving the value of the header * @param value a {@code String} giving the value of the header
*/ */
public MimeHeader(String name, String value) { public MimeHeader(String name, String value) {
this.name = name; this.name = name;
@ -52,18 +52,18 @@ public class MimeHeader {
} }
/** /**
* Returns the name of this <code>MimeHeader</code> object. * Returns the name of this {@code MimeHeader} object.
* *
* @return the name of the header as a <code>String</code> * @return the name of the header as a {@code String}
*/ */
public String getName() { public String getName() {
return name; return name;
} }
/** /**
* Returns the value of this <code>MimeHeader</code> object. * Returns the value of this {@code MimeHeader} object.
* *
* @return the value of the header as a <code>String</code> * @return the value of the header as a {@code String}
*/ */
public String getValue() { public String getValue() {
return value; return value;

50
jaxws/src/java.xml.ws/share/classes/javax/xml/soap/MimeHeaders.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -29,13 +29,13 @@ import java.util.Iterator;
import java.util.Vector; import java.util.Vector;
/** /**
* A container for <code>MimeHeader</code> objects, which represent * A container for {@code MimeHeader} objects, which represent
* the MIME headers present in a MIME part of a message. * the MIME headers present in a MIME part of a message.
* *
* <p>This class is used primarily when an application wants to * <p>This class is used primarily when an application wants to
* retrieve specific attachments based on certain MIME headers and * retrieve specific attachments based on certain MIME headers and
* values. This class will most likely be used by implementations of * values. This class will most likely be used by implementations of
* <code>AttachmentPart</code> and other MIME dependent parts of the SAAJ * {@code AttachmentPart} and other MIME dependent parts of the SAAJ
* API. * API.
* @see SOAPMessage#getAttachments * @see SOAPMessage#getAttachments
* @see AttachmentPart * @see AttachmentPart
@ -45,8 +45,8 @@ public class MimeHeaders {
private Vector headers; private Vector headers;
/** /**
* Constructs a default <code>MimeHeaders</code> object initialized with * Constructs a default {@code MimeHeaders} object initialized with
* an empty <code>Vector</code> object. * an empty {@code Vector} object.
*/ */
public MimeHeaders() { public MimeHeaders() {
headers = new Vector(); headers = new Vector();
@ -54,10 +54,10 @@ public class MimeHeaders {
/** /**
* Returns all of the values for the specified header as an array of * Returns all of the values for the specified header as an array of
* <code>String</code> objects. * {@code String} objects.
* *
* @param name the name of the header for which values will be returned * @param name the name of the header for which values will be returned
* @return a <code>String</code> array with all of the values for the * @return a {@code String} array with all of the values for the
* specified header * specified header
* @see #setHeader * @see #setHeader
*/ */
@ -86,9 +86,9 @@ public class MimeHeaders {
* <P> * <P>
* Note that RFC822 headers can contain only US-ASCII characters. * Note that RFC822 headers can contain only US-ASCII characters.
* *
* @param name a <code>String</code> with the name of the header for * @param name a {@code String} with the name of the header for
* which to search * which to search
* @param value a <code>String</code> with the value that will replace the * @param value a {@code String} with the value that will replace the
* current value of the specified header * current value of the specified header
* *
* @exception IllegalArgumentException if there was a problem in the * @exception IllegalArgumentException if there was a problem in the
@ -120,14 +120,14 @@ public class MimeHeaders {
} }
/** /**
* Adds a <code>MimeHeader</code> object with the specified name and value * Adds a {@code MimeHeader} object with the specified name and value
* to this <code>MimeHeaders</code> object's list of headers. * to this {@code MimeHeaders} object's list of headers.
* <P> * <P>
* Note that RFC822 headers can contain only US-ASCII characters. * Note that RFC822 headers can contain only US-ASCII characters.
* *
* @param name a <code>String</code> with the name of the header to * @param name a {@code String} with the name of the header to
* be added * be added
* @param value a <code>String</code> with the value of the header to * @param value a {@code String} with the value of the header to
* be added * be added
* *
* @exception IllegalArgumentException if there was a problem in the * @exception IllegalArgumentException if there was a problem in the
@ -152,10 +152,10 @@ public class MimeHeaders {
} }
/** /**
* Remove all <code>MimeHeader</code> objects whose name matches the * Remove all {@code MimeHeader} objects whose name matches the
* given name. * given name.
* *
* @param name a <code>String</code> with the name of the header for * @param name a {@code String} with the name of the header for
* which to search * which to search
*/ */
public void removeHeader(String name) { public void removeHeader(String name) {
@ -167,7 +167,7 @@ public class MimeHeaders {
} }
/** /**
* Removes all the header entries from this <code>MimeHeaders</code> object. * Removes all the header entries from this {@code MimeHeaders} object.
*/ */
public void removeAllHeaders() { public void removeAllHeaders() {
headers.removeAllElements(); headers.removeAllElements();
@ -175,10 +175,10 @@ public class MimeHeaders {
/** /**
* Returns all the <code>MimeHeader</code>s in this <code>MimeHeaders</code> object. * Returns all the {@code MimeHeader}s in this {@code MimeHeaders} object.
* *
* @return an <code>Iterator</code> object over this <code>MimeHeaders</code> * @return an {@code Iterator} object over this {@code MimeHeaders}
* object's list of <code>MimeHeader</code> objects * object's list of {@code MimeHeader} objects
*/ */
public Iterator getAllHeaders() { public Iterator getAllHeaders() {
return headers.iterator(); return headers.iterator();
@ -243,12 +243,12 @@ public class MimeHeaders {
/** /**
* Returns all the <code>MimeHeader</code> objects whose name matches * Returns all the {@code MimeHeader} objects whose name matches
* a name in the given array of names. * a name in the given array of names.
* *
* @param names an array of <code>String</code> objects with the names * @param names an array of {@code String} objects with the names
* for which to search * for which to search
* @return an <code>Iterator</code> object over the <code>MimeHeader</code> * @return an {@code Iterator} object over the {@code MimeHeader}
* objects whose name matches one of the names in the given list * objects whose name matches one of the names in the given list
*/ */
public Iterator getMatchingHeaders(String[] names) { public Iterator getMatchingHeaders(String[] names) {
@ -256,12 +256,12 @@ public class MimeHeaders {
} }
/** /**
* Returns all of the <code>MimeHeader</code> objects whose name does not * Returns all of the {@code MimeHeader} objects whose name does not
* match a name in the given array of names. * match a name in the given array of names.
* *
* @param names an array of <code>String</code> objects with the names * @param names an array of {@code String} objects with the names
* for which to search * for which to search
* @return an <code>Iterator</code> object over the <code>MimeHeader</code> * @return an {@code Iterator} object over the {@code MimeHeader}
* objects whose name does not match one of the names in the given list * objects whose name does not match one of the names in the given list
*/ */
public Iterator getNonMatchingHeaders(String[] names) { public Iterator getNonMatchingHeaders(String[] names) {

10
jaxws/src/java.xml.ws/share/classes/javax/xml/soap/Name.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -55,17 +55,17 @@ package javax.xml.soap;
* The following line of * The following line of
* code, in which <i>se</i> is a {@code SOAPEnvelope} object, creates a new * code, in which <i>se</i> is a {@code SOAPEnvelope} object, creates a new
* {@code Name} object with all three. * {@code Name} object with all three.
* <PRE> * <pre>{@code
* Name name = se.createName("GetLastTradePrice", "WOMBAT", * Name name = se.createName("GetLastTradePrice", "WOMBAT",
* "http://www.wombat.org/trader"); * "http://www.wombat.org/trader");
* </PRE> * }</pre>
* The following line of code gives an example of how a {@code Name} object * The following line of code gives an example of how a {@code Name} object
* can be used. The variable <i>element</i> is a {@code SOAPElement} object. * can be used. The variable <i>element</i> is a {@code SOAPElement} object.
* This code creates a new {@code SOAPElement} object with the given name and * This code creates a new {@code SOAPElement} object with the given name and
* adds it to <i>element</i>. * adds it to <i>element</i>.
* <PRE> * <pre>{@code
* element.addChildElement(name); * element.addChildElement(name);
* </PRE> * }</pre>
* <P> * <P>
* The {@code Name} interface may be deprecated in a future release of SAAJ * The {@code Name} interface may be deprecated in a future release of SAAJ
* in favor of {@code javax.xml.namespace.QName} * in favor of {@code javax.xml.namespace.QName}

58
jaxws/src/java.xml.ws/share/classes/javax/xml/soap/Node.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -35,19 +35,19 @@ package javax.xml.soap;
*/ */
public interface Node extends org.w3c.dom.Node { public interface Node extends org.w3c.dom.Node {
/** /**
* Returns the value of this node if this is a <code>Text</code> node or the * Returns the value of this node if this is a {@code Text} node or the
* value of the immediate child of this node otherwise. * value of the immediate child of this node otherwise.
* If there is an immediate child of this <code>Node</code> that it is a * If there is an immediate child of this {@code Node} that it is a
* <code>Text</code> node then it's value will be returned. If there is * {@code Text} node then it's value will be returned. If there is
* more than one <code>Text</code> node then the value of the first * more than one {@code Text} node then the value of the first
* <code>Text</code> Node will be returned. * {@code Text} Node will be returned.
* Otherwise <code>null</code> is returned. * Otherwise {@code null} is returned.
* *
* @return a <code>String</code> with the text of this node if this is a * @return a {@code String} with the text of this node if this is a
* <code>Text</code> node or the text contained by the first * {@code Text} node or the text contained by the first
* immediate child of this <code>Node</code> object that is a * immediate child of this {@code Node} object that is a
* <code>Text</code> object if such a child exists; * {@code Text} object if such a child exists;
* <code>null</code> otherwise. * {@code null} otherwise.
*/ */
public String getValue(); public String getValue();
@ -55,24 +55,24 @@ public interface Node extends org.w3c.dom.Node {
* If this is a Text node then this method will set its value, * If this is a Text node then this method will set its value,
* otherwise it sets the value of the immediate (Text) child of this node. * otherwise it sets the value of the immediate (Text) child of this node.
* The value of the immediate child of this node can be set only if, there is * The value of the immediate child of this node can be set only if, there is
* one child node and that node is a <code>Text</code> node, or if * one child node and that node is a {@code Text} node, or if
* there are no children in which case a child <code>Text</code> node will be * there are no children in which case a child {@code Text} node will be
* created. * created.
* *
* @exception IllegalStateException if the node is not a <code>Text</code> * @exception IllegalStateException if the node is not a {@code Text}
* node and either has more than one child node or has a child * node and either has more than one child node or has a child
* node that is not a <code>Text</code> node. * node that is not a {@code Text} node.
* *
* @since 1.6, SAAJ 1.2 * @since 1.6, SAAJ 1.2
*/ */
public void setValue(String value); public void setValue(String value);
/** /**
* Sets the parent of this <code>Node</code> object to the given * Sets the parent of this {@code Node} object to the given
* <code>SOAPElement</code> object. * {@code SOAPElement} object.
* *
* @param parent the <code>SOAPElement</code> object to be set as * @param parent the {@code SOAPElement} object to be set as
* the parent of this <code>Node</code> object * the parent of this {@code Node} object
* *
* @exception SOAPException if there is a problem in setting the * @exception SOAPException if there is a problem in setting the
* parent to the given element * parent to the given element
@ -81,13 +81,13 @@ public interface Node extends org.w3c.dom.Node {
public void setParentElement(SOAPElement parent) throws SOAPException; public void setParentElement(SOAPElement parent) throws SOAPException;
/** /**
* Returns the parent element of this <code>Node</code> object. * Returns the parent element of this {@code Node} object.
* This method can throw an <code>UnsupportedOperationException</code> * This method can throw an {@code UnsupportedOperationException}
* if the tree is not kept in memory. * if the tree is not kept in memory.
* *
* @return the <code>SOAPElement</code> object that is the parent of * @return the {@code SOAPElement} object that is the parent of
* this <code>Node</code> object or <code>null</code> if this * this {@code Node} object or {@code null} if this
* <code>Node</code> object is root * {@code Node} object is root
* *
* @exception UnsupportedOperationException if the whole tree is not * @exception UnsupportedOperationException if the whole tree is not
* kept in memory * kept in memory
@ -96,18 +96,18 @@ public interface Node extends org.w3c.dom.Node {
public SOAPElement getParentElement(); public SOAPElement getParentElement();
/** /**
* Removes this <code>Node</code> object from the tree. * Removes this {@code Node} object from the tree.
*/ */
public void detachNode(); public void detachNode();
/** /**
* Notifies the implementation that this <code>Node</code> * Notifies the implementation that this {@code Node}
* object is no longer being used by the application and that the * object is no longer being used by the application and that the
* implementation is free to reuse this object for nodes that may * implementation is free to reuse this object for nodes that may
* be created later. * be created later.
* <P> * <P>
* Calling the method <code>recycleNode</code> implies that the method * Calling the method {@code recycleNode} implies that the method
* <code>detachNode</code> has been called previously. * {@code detachNode} has been called previously.
*/ */
public void recycleNode(); public void recycleNode();

26
jaxws/src/java.xml.ws/share/classes/javax/xml/soap/SAAJMetaFactory.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -27,9 +27,9 @@ package javax.xml.soap;
/** /**
* The access point for the implementation classes of the factories defined in the * The access point for the implementation classes of the factories defined in the
* SAAJ API. All of the <code>newInstance</code> methods defined on factories in * SAAJ API. All of the {@code newInstance} methods defined on factories in
* SAAJ 1.3 defer to instances of this class to do the actual object creation. * SAAJ 1.3 defer to instances of this class to do the actual object creation.
* The implementations of <code>newInstance()</code> methods (in SOAPFactory and MessageFactory) * The implementations of {@code newInstance()} methods (in SOAPFactory and MessageFactory)
* that existed in SAAJ 1.2 have been updated to also delegate to the SAAJMetaFactory when the SAAJ 1.2 * that existed in SAAJ 1.2 have been updated to also delegate to the SAAJMetaFactory when the SAAJ 1.2
* defined lookup fails to locate the Factory implementation class name. * defined lookup fails to locate the Factory implementation class name.
* *
@ -48,10 +48,10 @@ public abstract class SAAJMetaFactory {
"com.sun.xml.internal.messaging.saaj.soap.SAAJMetaFactoryImpl"; "com.sun.xml.internal.messaging.saaj.soap.SAAJMetaFactoryImpl";
/** /**
* Creates a new instance of a concrete <code>SAAJMetaFactory</code> object. * Creates a new instance of a concrete {@code SAAJMetaFactory} object.
* The SAAJMetaFactory is an SPI, it pulls the creation of the other factories together into a * The SAAJMetaFactory is an SPI, it pulls the creation of the other factories together into a
* single place. Changing out the SAAJMetaFactory has the effect of changing out the entire SAAJ * single place. Changing out the SAAJMetaFactory has the effect of changing out the entire SAAJ
* implementation. Service providers provide the name of their <code>SAAJMetaFactory</code> * implementation. Service providers provide the name of their {@code SAAJMetaFactory}
* implementation. * implementation.
* *
* This method uses the following ordered lookup procedure to determine the SAAJMetaFactory implementation class to load: * This method uses the following ordered lookup procedure to determine the SAAJMetaFactory implementation class to load:
@ -65,8 +65,8 @@ public abstract class SAAJMetaFactory {
* <LI> Default to com.sun.xml.internal.messaging.saaj.soap.SAAJMetaFactoryImpl. * <LI> Default to com.sun.xml.internal.messaging.saaj.soap.SAAJMetaFactoryImpl.
* </UL> * </UL>
* *
* @return a concrete <code>SAAJMetaFactory</code> object * @return a concrete {@code SAAJMetaFactory} object
* @exception SOAPException if there is an error in creating the <code>SAAJMetaFactory</code> * @exception SOAPException if there is an error in creating the {@code SAAJMetaFactory}
*/ */
static SAAJMetaFactory getInstance() throws SOAPException { static SAAJMetaFactory getInstance() throws SOAPException {
try { try {
@ -84,10 +84,10 @@ public abstract class SAAJMetaFactory {
protected SAAJMetaFactory() { } protected SAAJMetaFactory() { }
/** /**
* Creates a <code>MessageFactory</code> object for * Creates a {@code MessageFactory} object for
* the given <code>String</code> protocol. * the given {@code String} protocol.
* *
* @param protocol a <code>String</code> indicating the protocol * @param protocol a {@code String} indicating the protocol
* @exception SOAPException if there is an error in creating the * @exception SOAPException if there is an error in creating the
* MessageFactory * MessageFactory
* @see SOAPConstants#SOAP_1_1_PROTOCOL * @see SOAPConstants#SOAP_1_1_PROTOCOL
@ -98,10 +98,10 @@ public abstract class SAAJMetaFactory {
throws SOAPException; throws SOAPException;
/** /**
* Creates a <code>SOAPFactory</code> object for * Creates a {@code SOAPFactory} object for
* the given <code>String</code> protocol. * the given {@code String} protocol.
* *
* @param protocol a <code>String</code> indicating the protocol * @param protocol a {@code String} indicating the protocol
* @exception SOAPException if there is an error in creating the * @exception SOAPException if there is an error in creating the
* SOAPFactory * SOAPFactory
* @see SOAPConstants#SOAP_1_1_PROTOCOL * @see SOAPConstants#SOAP_1_1_PROTOCOL

46
jaxws/src/java.xml.ws/share/classes/javax/xml/soap/SAAJResult.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -40,18 +40,18 @@ import javax.xml.transform.dom.DOMResult;
public class SAAJResult extends DOMResult { public class SAAJResult extends DOMResult {
/** /**
* Creates a <code>SAAJResult</code> that will present results in the form * Creates a {@code SAAJResult} that will present results in the form
* of a SAAJ tree that supports the default (SOAP 1.1) protocol. * of a SAAJ tree that supports the default (SOAP 1.1) protocol.
* <p> * <p>
* This kind of <code>SAAJResult</code> is meant for use in situations where the * This kind of {@code SAAJResult} is meant for use in situations where the
* results will be used as a parameter to a method that takes a parameter * results will be used as a parameter to a method that takes a parameter
* whose type, such as <code>SOAPElement</code>, is drawn from the SAAJ * whose type, such as {@code SOAPElement}, is drawn from the SAAJ
* API. When used in a transformation, the results are populated into the * API. When used in a transformation, the results are populated into the
* <code>SOAPPart</code> of a <code>SOAPMessage</code> that is created internally. * {@code SOAPPart} of a {@code SOAPMessage} that is created internally.
* The <code>SOAPPart</code> returned by {@link DOMResult#getNode()} * The {@code SOAPPart} returned by {@link DOMResult#getNode()}
* is not guaranteed to be well-formed. * is not guaranteed to be well-formed.
* *
* @throws SOAPException if there is a problem creating a <code>SOAPMessage</code> * @throws SOAPException if there is a problem creating a {@code SOAPMessage}
* *
* @since 1.6, SAAJ 1.3 * @since 1.6, SAAJ 1.3
*/ */
@ -60,23 +60,23 @@ public class SAAJResult extends DOMResult {
} }
/** /**
* Creates a <code>SAAJResult</code> that will present results in the form * Creates a {@code SAAJResult} that will present results in the form
* of a SAAJ tree that supports the specified protocol. The * of a SAAJ tree that supports the specified protocol. The
* <code>DYNAMIC_SOAP_PROTOCOL</code> is ambiguous in this context and will * {@code DYNAMIC_SOAP_PROTOCOL} is ambiguous in this context and will
* cause this constructor to throw an <code>UnsupportedOperationException</code>. * cause this constructor to throw an {@code UnsupportedOperationException}.
* <p> * <p>
* This kind of <code>SAAJResult</code> is meant for use in situations where the * This kind of {@code SAAJResult} is meant for use in situations where the
* results will be used as a parameter to a method that takes a parameter * results will be used as a parameter to a method that takes a parameter
* whose type, such as <code>SOAPElement</code>, is drawn from the SAAJ * whose type, such as {@code SOAPElement}, is drawn from the SAAJ
* API. When used in a transformation the results are populated into the * API. When used in a transformation the results are populated into the
* <code>SOAPPart</code> of a <code>SOAPMessage</code> that is created * {@code SOAPPart} of a {@code SOAPMessage} that is created
* internally. The <code>SOAPPart</code> returned by {@link DOMResult#getNode()} * internally. The {@code SOAPPart} returned by {@link DOMResult#getNode()}
* is not guaranteed to be well-formed. * is not guaranteed to be well-formed.
* *
* @param protocol - the name of the SOAP protocol that the resulting SAAJ * @param protocol - the name of the SOAP protocol that the resulting SAAJ
* tree should support * tree should support
* *
* @throws SOAPException if a <code>SOAPMessage</code> supporting the * @throws SOAPException if a {@code SOAPMessage} supporting the
* specified protocol cannot be created * specified protocol cannot be created
* *
* @since 1.6, SAAJ 1.3 * @since 1.6, SAAJ 1.3
@ -86,16 +86,16 @@ public class SAAJResult extends DOMResult {
} }
/** /**
* Creates a <code>SAAJResult</code> that will write the results into the * Creates a {@code SAAJResult} that will write the results into the
* <code>SOAPPart</code> of the supplied <code>SOAPMessage</code>. * {@code SOAPPart} of the supplied {@code SOAPMessage}.
* In the normal case these results will be written using DOM APIs and, * In the normal case these results will be written using DOM APIs and,
* as a result, the finished <code>SOAPPart</code> will not be guaranteed * as a result, the finished {@code SOAPPart} will not be guaranteed
* to be well-formed unless the data used to create it is also well formed. * to be well-formed unless the data used to create it is also well formed.
* When used in a transformation the validity of the <code>SOAPMessage</code> * When used in a transformation the validity of the {@code SOAPMessage}
* after the transformation can be guaranteed only by means outside SAAJ * after the transformation can be guaranteed only by means outside SAAJ
* specification. * specification.
* *
* @param message - the message whose <code>SOAPPart</code> will be * @param message - the message whose {@code SOAPPart} will be
* populated as a result of some transformation or * populated as a result of some transformation or
* marshalling operation * marshalling operation
* *
@ -106,11 +106,11 @@ public class SAAJResult extends DOMResult {
} }
/** /**
* Creates a <code>SAAJResult</code> that will write the results as a * Creates a {@code SAAJResult} that will write the results as a
* child node of the <code>SOAPElement</code> specified. In the normal * child node of the {@code SOAPElement} specified. In the normal
* case these results will be written using DOM APIs and as a result may * case these results will be written using DOM APIs and as a result may
* invalidate the structure of the SAAJ tree. This kind of * invalidate the structure of the SAAJ tree. This kind of
* <code>SAAJResult</code> should only be used when the validity of the * {@code SAAJResult} should only be used when the validity of the
* incoming data can be guaranteed by means outside of the SAAJ * incoming data can be guaranteed by means outside of the SAAJ
* specification. * specification.
* *

8
jaxws/src/java.xml.ws/share/classes/javax/xml/soap/SOAPBody.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -258,7 +258,7 @@ public interface SOAPBody extends SOAPElement {
public SOAPBodyElement addBodyElement(QName qname) throws SOAPException; public SOAPBodyElement addBodyElement(QName qname) throws SOAPException;
/** /**
* Adds the root node of the DOM <code>{@link org.w3c.dom.Document}</code> * Adds the root node of the DOM {@link org.w3c.dom.Document}
* to this {@code SOAPBody} object. * to this {@code SOAPBody} object.
* <p> * <p>
* Calling this method invalidates the {@code document} parameter. * Calling this method invalidates the {@code document} parameter.
@ -279,12 +279,12 @@ public interface SOAPBody extends SOAPElement {
throws SOAPException; throws SOAPException;
/** /**
* Creates a new DOM <code>{@link org.w3c.dom.Document}</code> and sets * Creates a new DOM {@link org.w3c.dom.Document} and sets
* the first child of this {@code SOAPBody} as it's document * the first child of this {@code SOAPBody} as it's document
* element. The child {@code SOAPElement} is removed as part of the * element. The child {@code SOAPElement} is removed as part of the
* process. * process.
* *
* @return the <code>{@link org.w3c.dom.Document}</code> representation * @return the {@link org.w3c.dom.Document} representation
* of the {@code SOAPBody} content. * of the {@code SOAPBody} content.
* *
* @exception SOAPException * @exception SOAPException

22
jaxws/src/java.xml.ws/share/classes/javax/xml/soap/SOAPBodyElement.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -26,18 +26,18 @@
package javax.xml.soap; package javax.xml.soap;
/** /**
* A <code>SOAPBodyElement</code> object represents the contents in * A {@code SOAPBodyElement} object represents the contents in
* a <code>SOAPBody</code> object. The <code>SOAPFault</code> interface * a {@code SOAPBody} object. The {@code SOAPFault} interface
* is a <code>SOAPBodyElement</code> object that has been defined. * is a {@code SOAPBodyElement} object that has been defined.
* <P> * <P>
* A new <code>SOAPBodyElement</code> object can be created and added * A new {@code SOAPBodyElement} object can be created and added
* to a <code>SOAPBody</code> object with the <code>SOAPBody</code> * to a {@code SOAPBody} object with the {@code SOAPBody}
* method <code>addBodyElement</code>. In the following line of code, * method {@code addBodyElement}. In the following line of code,
* <code>sb</code> is a <code>SOAPBody</code> object, and * {@code sb} is a {@code SOAPBody} object, and
* <code>myName</code> is a <code>Name</code> object. * {@code myName} is a {@code Name} object.
* <PRE> * <pre>{@code
* SOAPBodyElement sbe = sb.addBodyElement(myName); * SOAPBodyElement sbe = sb.addBodyElement(myName);
* </PRE> * }</pre>
* *
* @since 1.6 * @since 1.6
*/ */

38
jaxws/src/java.xml.ws/share/classes/javax/xml/soap/SOAPConnection.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -32,18 +32,18 @@ package javax.xml.soap;
* <p> * <p>
* The SOAPConnection class is optional. Some implementations may * The SOAPConnection class is optional. Some implementations may
* not implement this interface in which case the call to * not implement this interface in which case the call to
* <code>SOAPConnectionFactory.newInstance()</code> (see below) will * {@code SOAPConnectionFactory.newInstance()} (see below) will
* throw an <code>UnsupportedOperationException</code>. * throw an {@code UnsupportedOperationException}.
* <p> * <p>
* A client can obtain a <code>SOAPConnection</code> object using a * A client can obtain a {@code SOAPConnection} object using a
* {@link SOAPConnectionFactory} object as in the following example: * {@link SOAPConnectionFactory} object as in the following example:
* <PRE> * <pre>{@code
* SOAPConnectionFactory factory = SOAPConnectionFactory.newInstance(); * SOAPConnectionFactory factory = SOAPConnectionFactory.newInstance();
* SOAPConnection con = factory.createConnection(); * SOAPConnection con = factory.createConnection();
* </PRE> * }</pre>
* A <code>SOAPConnection</code> object can be used to send messages * A {@code SOAPConnection} object can be used to send messages
* directly to a URL following the request/response paradigm. That is, * directly to a URL following the request/response paradigm. That is,
* messages are sent using the method <code>call</code>, which sends the * messages are sent using the method {@code call}, which sends the
* message and then waits until it gets a reply. * message and then waits until it gets a reply.
* *
* @since 1.6 * @since 1.6
@ -54,15 +54,15 @@ public abstract class SOAPConnection {
* Sends the given message to the specified endpoint and blocks until * Sends the given message to the specified endpoint and blocks until
* it has returned the response. * it has returned the response.
* *
* @param request the <code>SOAPMessage</code> object to be sent * @param request the {@code SOAPMessage} object to be sent
* @param to an <code>Object</code> that identifies * @param to an {@code Object} that identifies
* where the message should be sent. It is required to * where the message should be sent. It is required to
* support Objects of type * support Objects of type
* <code>java.lang.String</code>, * {@code java.lang.String},
* <code>java.net.URL</code>, and when JAXM is present * {@code java.net.URL}, and when JAXM is present
* <code>javax.xml.messaging.URLEndpoint</code> * {@code javax.xml.messaging.URLEndpoint}
* *
* @return the <code>SOAPMessage</code> object that is the response to the * @return the {@code SOAPMessage} object that is the response to the
* message that was sent * message that was sent
* @throws SOAPException if there is a SOAP error * @throws SOAPException if there is a SOAP error
*/ */
@ -72,12 +72,12 @@ public abstract class SOAPConnection {
/** /**
* Gets a message from a specific endpoint and blocks until it receives, * Gets a message from a specific endpoint and blocks until it receives,
* *
* @param to an <code>Object</code> that identifies where * @param to an {@code Object} that identifies where
* the request should be sent. Objects of type * the request should be sent. Objects of type
* <code>java.lang.String</code> and * {@code java.lang.String} and
* <code>java.net.URL</code> must be supported. * {@code java.net.URL} must be supported.
* *
* @return the <code>SOAPMessage</code> object that is the response to the * @return the {@code SOAPMessage} object that is the response to the
* get message request * get message request
* @throws SOAPException if there is a SOAP error * @throws SOAPException if there is a SOAP error
* @since 1.6, SAAJ 1.3 * @since 1.6, SAAJ 1.3
@ -88,7 +88,7 @@ public abstract class SOAPConnection {
} }
/** /**
* Closes this <code>SOAPConnection</code> object. * Closes this {@code SOAPConnection} object.
* *
* @throws SOAPException if there is a SOAP error * @throws SOAPException if there is a SOAP error
*/ */

26
jaxws/src/java.xml.ws/share/classes/javax/xml/soap/SOAPConnectionFactory.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -26,38 +26,38 @@
package javax.xml.soap; package javax.xml.soap;
/** /**
* A factory for creating <code>SOAPConnection</code> objects. Implementation of this class * A factory for creating {@code SOAPConnection} objects. Implementation of this class
* is optional. If <code>SOAPConnectionFactory.newInstance()</code> throws an * is optional. If {@code SOAPConnectionFactory.newInstance()} throws an
* UnsupportedOperationException then the implementation does not support the * UnsupportedOperationException then the implementation does not support the
* SAAJ communication infrastructure. Otherwise {@link SOAPConnection} objects * SAAJ communication infrastructure. Otherwise {@link SOAPConnection} objects
* can be created by calling <code>createConnection()</code> on the newly * can be created by calling {@code createConnection()} on the newly
* created <code>SOAPConnectionFactory</code> object. * created {@code SOAPConnectionFactory} object.
* *
* @since 1.6 * @since 1.6
*/ */
public abstract class SOAPConnectionFactory { public abstract class SOAPConnectionFactory {
/** /**
* A constant representing the default value for a <code>SOAPConnection</code> * A constant representing the default value for a {@code SOAPConnection}
* object. The default is the point-to-point SOAP connection. * object. The default is the point-to-point SOAP connection.
*/ */
static final String DEFAULT_SOAP_CONNECTION_FACTORY static final String DEFAULT_SOAP_CONNECTION_FACTORY
= "com.sun.xml.internal.messaging.saaj.client.p2p.HttpSOAPConnectionFactory"; = "com.sun.xml.internal.messaging.saaj.client.p2p.HttpSOAPConnectionFactory";
/** /**
* A constant representing the <code>SOAPConnection</code> class. * A constant representing the {@code SOAPConnection} class.
*/ */
static private final String SF_PROPERTY static private final String SF_PROPERTY
= "javax.xml.soap.SOAPConnectionFactory"; = "javax.xml.soap.SOAPConnectionFactory";
/** /**
* Creates an instance of the default * Creates an instance of the default
* <code>SOAPConnectionFactory</code> object. * {@code SOAPConnectionFactory} object.
* *
* @return a new instance of a default * @return a new instance of a default
* <code>SOAPConnectionFactory</code> object * {@code SOAPConnectionFactory} object
* *
* @exception SOAPException if there was an error creating the * @exception SOAPException if there was an error creating the
* <code>SOAPConnectionFactory</code> * {@code SOAPConnectionFactory}
* *
* @exception UnsupportedOperationException if newInstance is not * @exception UnsupportedOperationException if newInstance is not
* supported. * supported.
@ -76,12 +76,12 @@ public abstract class SOAPConnectionFactory {
} }
/** /**
* Create a new <code>SOAPConnection</code>. * Create a new {@code SOAPConnection}.
* *
* @return the new <code>SOAPConnection</code> object. * @return the new {@code SOAPConnection} object.
* *
* @exception SOAPException if there was an exception creating the * @exception SOAPException if there was an exception creating the
* <code>SOAPConnection</code> object. * {@code SOAPConnection} object.
*/ */
public abstract SOAPConnection createConnection() public abstract SOAPConnection createConnection()
throws SOAPException; throws SOAPException;

36
jaxws/src/java.xml.ws/share/classes/javax/xml/soap/SOAPConstants.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -34,30 +34,30 @@ import javax.xml.namespace.QName;
*/ */
public interface SOAPConstants { public interface SOAPConstants {
/** /**
* Used to create <code>MessageFactory</code> instances that create * Used to create {@code MessageFactory} instances that create
* <code>SOAPMessages</code> whose concrete type is based on the * {@code SOAPMessages} whose concrete type is based on the
* <code>Content-Type</code> MIME header passed to the * {@code Content-Type} MIME header passed to the
* <code>createMessage</code> method. If no <code>Content-Type</code> * {@code createMessage} method. If no {@code Content-Type}
* header is passed then the <code>createMessage</code> may throw an * header is passed then the {@code createMessage} may throw an
* <code>IllegalArgumentException</code> or, in the case of the no * {@code IllegalArgumentException} or, in the case of the no
* argument version of <code>createMessage</code>, an * argument version of {@code createMessage}, an
* <code>UnsupportedOperationException</code>. * {@code UnsupportedOperationException}.
* *
* @since 1.6, SAAJ 1.3 * @since 1.6, SAAJ 1.3
*/ */
public static final String DYNAMIC_SOAP_PROTOCOL = "Dynamic Protocol"; public static final String DYNAMIC_SOAP_PROTOCOL = "Dynamic Protocol";
/** /**
* Used to create <code>MessageFactory</code> instances that create * Used to create {@code MessageFactory} instances that create
* <code>SOAPMessages</code> whose behavior supports the SOAP 1.1 specification. * {@code SOAPMessages} whose behavior supports the SOAP 1.1 specification.
* *
* @since 1.6, SAAJ 1.3 * @since 1.6, SAAJ 1.3
*/ */
public static final String SOAP_1_1_PROTOCOL = "SOAP 1.1 Protocol"; public static final String SOAP_1_1_PROTOCOL = "SOAP 1.1 Protocol";
/** /**
* Used to create <code>MessageFactory</code> instances that create * Used to create {@code MessageFactory} instances that create
* <code>SOAPMessages</code> whose behavior supports the SOAP 1.2 * {@code SOAPMessages} whose behavior supports the SOAP 1.2
* specification * specification
* *
* @since 1.6, SAAJ 1.3 * @since 1.6, SAAJ 1.3
@ -93,9 +93,9 @@ public interface SOAPConstants {
/** /**
* The namespace identifier for the SOAP 1.1 encoding. * The namespace identifier for the SOAP 1.1 encoding.
* An attribute named <code>encodingStyle</code> in the * An attribute named {@code encodingStyle} in the
* <code>URI_NS_SOAP_ENVELOPE</code> namespace and set to the value * {@code URI_NS_SOAP_ENVELOPE} namespace and set to the value
* <code>URI_NS_SOAP_ENCODING</code> can be added to an element to indicate * {@code URI_NS_SOAP_ENCODING} can be added to an element to indicate
* that it is encoded using the rules in section 5 of the SOAP 1.1 * that it is encoded using the rules in section 5 of the SOAP 1.1
* specification. * specification.
*/ */
@ -110,14 +110,14 @@ public interface SOAPConstants {
URI_NS_SOAP_1_2_ENCODING = "http://www.w3.org/2003/05/soap-encoding"; URI_NS_SOAP_1_2_ENCODING = "http://www.w3.org/2003/05/soap-encoding";
/** /**
* The media type of the <code>Content-Type</code> MIME header in SOAP 1.1. * The media type of the {@code Content-Type} MIME header in SOAP 1.1.
* @since 1.6, SAAJ 1.3 * @since 1.6, SAAJ 1.3
*/ */
public static final String public static final String
SOAP_1_1_CONTENT_TYPE = "text/xml"; SOAP_1_1_CONTENT_TYPE = "text/xml";
/** /**
* The media type of the <code>Content-Type</code> MIME header in SOAP 1.2. * The media type of the {@code Content-Type} MIME header in SOAP 1.2.
* @since 1.6, SAAJ 1.3 * @since 1.6, SAAJ 1.3
*/ */
public static final String public static final String

13
jaxws/src/java.xml.ws/share/classes/javax/xml/soap/SOAPElement.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -38,8 +38,7 @@ import javax.xml.namespace.QName;
* Methods in this interface that are required to return SAAJ specific objects * Methods in this interface that are required to return SAAJ specific objects
* may "silently" replace nodes in the tree as required to successfully return * may "silently" replace nodes in the tree as required to successfully return
* objects of the correct type. See {@link #getChildElements()} and * objects of the correct type. See {@link #getChildElements()} and
* {@link <a HREF="package-summary.html#package_description">javax.xml.soap</a>} * {@link javax.xml.soap} for details.
* for details.
* *
* @since 1.6 * @since 1.6
*/ */
@ -345,7 +344,7 @@ public interface SOAPElement extends Node, org.w3c.dom.Element {
* with the {@code prefix} in the context of this * with the {@code prefix} in the context of this
* {@code SOAPElement}. This namespace will be the same as * {@code SOAPElement}. This namespace will be the same as
* the one that would be returned by * the one that would be returned by
* <code>{@link #getNamespaceURI(String)}</code> if it were given * {@link #getNamespaceURI(String)} if it were given
* {@code prefix} as it's parameter. * {@code prefix} as it's parameter.
* *
* @exception SOAPException if the {@code QName} cannot be created. * @exception SOAPException if the {@code QName} cannot be created.
@ -439,7 +438,7 @@ public interface SOAPElement extends Node, org.w3c.dom.Element {
* have been obtained through DOM APIs as invalid and either discard them or * have been obtained through DOM APIs as invalid and either discard them or
* refresh them with the values returned by this {@code Iterator}. This * refresh them with the values returned by this {@code Iterator}. This
* behavior can be avoided by calling the equivalent DOM APIs. See * behavior can be avoided by calling the equivalent DOM APIs. See
* {@link <a HREF="package-summary.html#package_description">javax.xml.soap</a>} * {@link javax.xml.soap}
* for more details. * for more details.
* *
* @return an iterator with the content of this {@code SOAPElement} * @return an iterator with the content of this {@code SOAPElement}
@ -461,7 +460,7 @@ public interface SOAPElement extends Node, org.w3c.dom.Element {
* have been obtained through DOM APIs as invalid and either discard them or * have been obtained through DOM APIs as invalid and either discard them or
* refresh them with the values returned by this {@code Iterator}. This * refresh them with the values returned by this {@code Iterator}. This
* behavior can be avoided by calling the equivalent DOM APIs. See * behavior can be avoided by calling the equivalent DOM APIs. See
* {@link <a HREF="package-summary.html#package_description">javax.xml.soap</a>} * {@link javax.xml.soap}
* for more details. * for more details.
* *
* @param name a {@code Name} object with the name of the child * @param name a {@code Name} object with the name of the child
@ -488,7 +487,7 @@ public interface SOAPElement extends Node, org.w3c.dom.Element {
* have been obtained through DOM APIs as invalid and either discard them or * have been obtained through DOM APIs as invalid and either discard them or
* refresh them with the values returned by this {@code Iterator}. This * refresh them with the values returned by this {@code Iterator}. This
* behavior can be avoided by calling the equivalent DOM APIs. See * behavior can be avoided by calling the equivalent DOM APIs. See
* {@link <a HREF="package-summary.html#package_description">javax.xml.soap</a>} * {@link javax.xml.soap}
* for more details. * for more details.
* *
* @param qname a {@code QName} object with the qname of the child * @param qname a {@code QName} object with the qname of the child

44
jaxws/src/java.xml.ws/share/classes/javax/xml/soap/SOAPElementFactory.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -26,16 +26,16 @@
package javax.xml.soap; package javax.xml.soap;
/** /**
* <code>SOAPElementFactory</code> is a factory for XML fragments that * {@code SOAPElementFactory} is a factory for XML fragments that
* will eventually end up in the SOAP part. These fragments * will eventually end up in the SOAP part. These fragments
* can be inserted as children of the <code>SOAPHeader</code> or * can be inserted as children of the {@code SOAPHeader} or
* <code>SOAPBody</code> or <code>SOAPEnvelope</code>. * {@code SOAPBody} or {@code SOAPEnvelope}.
* *
* <p>Elements created using this factory do not have the properties * <p>Elements created using this factory do not have the properties
* of an element that lives inside a SOAP header document. These * of an element that lives inside a SOAP header document. These
* elements are copied into the XML document tree when they are * elements are copied into the XML document tree when they are
* inserted. * inserted.
* @deprecated - Use <code>javax.xml.soap.SOAPFactory</code> for creating SOAPElements. * @deprecated - Use {@code javax.xml.soap.SOAPFactory} for creating SOAPElements.
* @see javax.xml.soap.SOAPFactory * @see javax.xml.soap.SOAPFactory
* @since 1.6 * @since 1.6
*/ */
@ -48,17 +48,17 @@ public class SOAPElementFactory {
} }
/** /**
* Create a <code>SOAPElement</code> object initialized with the * Create a {@code SOAPElement} object initialized with the
* given <code>Name</code> object. * given {@code Name} object.
* *
* @param name a <code>Name</code> object with the XML name for * @param name a {@code Name} object with the XML name for
* the new element * the new element
* *
* @return the new <code>SOAPElement</code> object that was * @return the new {@code SOAPElement} object that was
* created * created
* *
* @exception SOAPException if there is an error in creating the * @exception SOAPException if there is an error in creating the
* <code>SOAPElement</code> object * {@code SOAPElement} object
* *
* @deprecated Use * @deprecated Use
* javax.xml.soap.SOAPFactory.createElement(javax.xml.soap.Name) * javax.xml.soap.SOAPFactory.createElement(javax.xml.soap.Name)
@ -72,17 +72,17 @@ public class SOAPElementFactory {
} }
/** /**
* Create a <code>SOAPElement</code> object initialized with the * Create a {@code SOAPElement} object initialized with the
* given local name. * given local name.
* *
* @param localName a <code>String</code> giving the local name for * @param localName a {@code String} giving the local name for
* the new element * the new element
* *
* @return the new <code>SOAPElement</code> object that was * @return the new {@code SOAPElement} object that was
* created * created
* *
* @exception SOAPException if there is an error in creating the * @exception SOAPException if there is an error in creating the
* <code>SOAPElement</code> object * {@code SOAPElement} object
* *
* @deprecated Use * @deprecated Use
* javax.xml.soap.SOAPFactory.createElement(String localName) instead * javax.xml.soap.SOAPFactory.createElement(String localName) instead
@ -94,17 +94,17 @@ public class SOAPElementFactory {
} }
/** /**
* Create a new <code>SOAPElement</code> object with the given * Create a new {@code SOAPElement} object with the given
* local name, prefix and uri. * local name, prefix and uri.
* *
* @param localName a <code>String</code> giving the local name * @param localName a {@code String} giving the local name
* for the new element * for the new element
* @param prefix the prefix for this <code>SOAPElement</code> * @param prefix the prefix for this {@code SOAPElement}
* @param uri a <code>String</code> giving the URI of the * @param uri a {@code String} giving the URI of the
* namespace to which the new element belongs * namespace to which the new element belongs
* *
* @exception SOAPException if there is an error in creating the * @exception SOAPException if there is an error in creating the
* <code>SOAPElement</code> object * {@code SOAPElement} object
* *
* @deprecated Use * @deprecated Use
* javax.xml.soap.SOAPFactory.createElement(String localName, * javax.xml.soap.SOAPFactory.createElement(String localName,
@ -120,12 +120,12 @@ public class SOAPElementFactory {
} }
/** /**
* Creates a new instance of <code>SOAPElementFactory</code>. * Creates a new instance of {@code SOAPElementFactory}.
* *
* @return a new instance of a <code>SOAPElementFactory</code> * @return a new instance of a {@code SOAPElementFactory}
* *
* @exception SOAPException if there was an error creating the * @exception SOAPException if there was an error creating the
* default <code>SOAPElementFactory</code> * default {@code SOAPElementFactory}
*/ */
public static SOAPElementFactory newInstance() throws SOAPException { public static SOAPElementFactory newInstance() throws SOAPException {
try { try {

150
jaxws/src/java.xml.ws/share/classes/javax/xml/soap/SOAPEnvelope.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -28,87 +28,87 @@ package javax.xml.soap;
/** /**
* The container for the SOAPHeader and SOAPBody portions of a * The container for the SOAPHeader and SOAPBody portions of a
* <code>SOAPPart</code> object. By default, a <code>SOAPMessage</code> * {@code SOAPPart} object. By default, a {@code SOAPMessage}
* object is created with a <code>SOAPPart</code> object that has a * object is created with a {@code SOAPPart} object that has a
* <code>SOAPEnvelope</code> object. The <code>SOAPEnvelope</code> object * {@code SOAPEnvelope} object. The {@code SOAPEnvelope} object
* by default has an empty <code>SOAPBody</code> object and an empty * by default has an empty {@code SOAPBody} object and an empty
* <code>SOAPHeader</code> object. The <code>SOAPBody</code> object is * {@code SOAPHeader} object. The {@code SOAPBody} object is
* required, and the <code>SOAPHeader</code> object, though * required, and the {@code SOAPHeader} object, though
* optional, is used in the majority of cases. If the * optional, is used in the majority of cases. If the
* <code>SOAPHeader</code> object is not needed, it can be deleted, * {@code SOAPHeader} object is not needed, it can be deleted,
* which is shown later. * which is shown later.
* <P> * <P>
* A client can access the <code>SOAPHeader</code> and <code>SOAPBody</code> * A client can access the {@code SOAPHeader} and {@code SOAPBody}
* objects by calling the methods <code>SOAPEnvelope.getHeader</code> and * objects by calling the methods {@code SOAPEnvelope.getHeader} and
* <code>SOAPEnvelope.getBody</code>. The * {@code SOAPEnvelope.getBody}. The
* following lines of code use these two methods after starting with * following lines of code use these two methods after starting with
* the <code>SOAPMessage</code> * the {@code SOAPMessage}
* object <i>message</i> to get the <code>SOAPPart</code> object <i>sp</i>, * object <i>message</i> to get the {@code SOAPPart} object <i>sp</i>,
* which is then used to get the <code>SOAPEnvelope</code> object <i>se</i>. * which is then used to get the {@code SOAPEnvelope} object <i>se</i>.
* *
* <PRE> * <pre>{@code
* SOAPPart sp = message.getSOAPPart(); * SOAPPart sp = message.getSOAPPart();
* SOAPEnvelope se = sp.getEnvelope(); * SOAPEnvelope se = sp.getEnvelope();
* SOAPHeader sh = se.getHeader(); * SOAPHeader sh = se.getHeader();
* SOAPBody sb = se.getBody(); * SOAPBody sb = se.getBody();
* </PRE> * }</pre>
* <P> * <P>
* It is possible to change the body or header of a <code>SOAPEnvelope</code> * It is possible to change the body or header of a {@code SOAPEnvelope}
* object by retrieving the current one, deleting it, and then adding * object by retrieving the current one, deleting it, and then adding
* a new body or header. The <code>javax.xml.soap.Node</code> method * a new body or header. The {@code javax.xml.soap.Node} method
* <code>deleteNode</code> deletes the XML element (node) on which it is * {@code deleteNode} deletes the XML element (node) on which it is
* called. For example, the following line of code deletes the * called. For example, the following line of code deletes the
* <code>SOAPBody</code> object that is retrieved by the method <code>getBody</code>. * {@code SOAPBody} object that is retrieved by the method {@code getBody}.
* <PRE> * <pre>{@code
* se.getBody().detachNode(); * se.getBody().detachNode();
* </PRE> * }</pre>
* To create a <code>SOAPHeader</code> object to replace the one that was removed, * To create a {@code SOAPHeader} object to replace the one that was removed,
* a client uses * a client uses
* the method <code>SOAPEnvelope.addHeader</code>, which creates a new header and * the method {@code SOAPEnvelope.addHeader}, which creates a new header and
* adds it to the <code>SOAPEnvelope</code> object. Similarly, the method * adds it to the {@code SOAPEnvelope} object. Similarly, the method
* <code>addBody</code> creates a new <code>SOAPBody</code> object and adds * {@code addBody} creates a new {@code SOAPBody} object and adds
* it to the <code>SOAPEnvelope</code> object. The following code fragment * it to the {@code SOAPEnvelope} object. The following code fragment
* retrieves the current header, removes it, and adds a new one. Then * retrieves the current header, removes it, and adds a new one. Then
* it retrieves the current body, removes it, and adds a new one. * it retrieves the current body, removes it, and adds a new one.
* *
* <PRE> * <pre>{@code
* SOAPPart sp = message.getSOAPPart(); * SOAPPart sp = message.getSOAPPart();
* SOAPEnvelope se = sp.getEnvelope(); * SOAPEnvelope se = sp.getEnvelope();
* se.getHeader().detachNode(); * se.getHeader().detachNode();
* SOAPHeader sh = se.addHeader(); * SOAPHeader sh = se.addHeader();
* se.getBody().detachNode(); * se.getBody().detachNode();
* SOAPBody sb = se.addBody(); * SOAPBody sb = se.addBody();
* </PRE> * }</pre>
* It is an error to add a <code>SOAPBody</code> or <code>SOAPHeader</code> * It is an error to add a {@code SOAPBody} or {@code SOAPHeader}
* object if one already exists. * object if one already exists.
* <P> * <P>
* The <code>SOAPEnvelope</code> interface provides three methods for creating * The {@code SOAPEnvelope} interface provides three methods for creating
* <code>Name</code> objects. One method creates <code>Name</code> objects with * {@code Name} objects. One method creates {@code Name} objects with
* a local name, a namespace prefix, and a namesapce URI. The second method creates * a local name, a namespace prefix, and a namesapce URI. The second method creates
* <code>Name</code> objects with a local name and a namespace prefix, and the third * {@code Name} objects with a local name and a namespace prefix, and the third
* creates <code>Name</code> objects with just a local name. The following line of * creates {@code Name} objects with just a local name. The following line of
* code, in which <i>se</i> is a <code>SOAPEnvelope</code> object, creates a new * code, in which <i>se</i> is a {@code SOAPEnvelope} object, creates a new
* <code>Name</code> object with all three. * {@code Name} object with all three.
* <PRE> * <pre>{@code
* Name name = se.createName("GetLastTradePrice", "WOMBAT", * Name name = se.createName("GetLastTradePrice", "WOMBAT",
* "http://www.wombat.org/trader"); * "http://www.wombat.org/trader");
* </PRE> * }</pre>
* *
* @since 1.6 * @since 1.6
*/ */
public interface SOAPEnvelope extends SOAPElement { public interface SOAPEnvelope extends SOAPElement {
/** /**
* Creates a new <code>Name</code> object initialized with the * Creates a new {@code Name} object initialized with the
* given local name, namespace prefix, and namespace URI. * given local name, namespace prefix, and namespace URI.
* <P> * <P>
* This factory method creates <code>Name</code> objects for use in * This factory method creates {@code Name} objects for use in
* the SOAP/XML document. * the SOAP/XML document.
* *
* @param localName a <code>String</code> giving the local name * @param localName a {@code String} giving the local name
* @param prefix a <code>String</code> giving the prefix of the namespace * @param prefix a {@code String} giving the prefix of the namespace
* @param uri a <code>String</code> giving the URI of the namespace * @param uri a {@code String} giving the URI of the namespace
* @return a <code>Name</code> object initialized with the given * @return a {@code Name} object initialized with the given
* local name, namespace prefix, and namespace URI * local name, namespace prefix, and namespace URI
* @throws SOAPException if there is a SOAP error * @throws SOAPException if there is a SOAP error
*/ */
@ -117,14 +117,14 @@ public interface SOAPEnvelope extends SOAPElement {
throws SOAPException; throws SOAPException;
/** /**
* Creates a new <code>Name</code> object initialized with the * Creates a new {@code Name} object initialized with the
* given local name. * given local name.
* <P> * <P>
* This factory method creates <code>Name</code> objects for use in * This factory method creates {@code Name} objects for use in
* the SOAP/XML document. * the SOAP/XML document.
* *
* @param localName a <code>String</code> giving the local name * @param localName a {@code String} giving the local name
* @return a <code>Name</code> object initialized with the given * @return a {@code Name} object initialized with the given
* local name * local name
* @throws SOAPException if there is a SOAP error * @throws SOAPException if there is a SOAP error
*/ */
@ -132,71 +132,71 @@ public interface SOAPEnvelope extends SOAPElement {
throws SOAPException; throws SOAPException;
/** /**
* Returns the <code>SOAPHeader</code> object for * Returns the {@code SOAPHeader} object for
* this <code>SOAPEnvelope</code> object. * this {@code SOAPEnvelope} object.
* <P> * <P>
* A new <code>SOAPMessage</code> object is by default created with a * A new {@code SOAPMessage} object is by default created with a
* <code>SOAPEnvelope</code> object that contains an empty * {@code SOAPEnvelope} object that contains an empty
* <code>SOAPHeader</code> object. As a result, the method * {@code SOAPHeader} object. As a result, the method
* <code>getHeader</code> will always return a <code>SOAPHeader</code> * {@code getHeader} will always return a {@code SOAPHeader}
* object unless the header has been removed and a new one has not * object unless the header has been removed and a new one has not
* been added. * been added.
* *
* @return the <code>SOAPHeader</code> object or <code>null</code> if * @return the {@code SOAPHeader} object or {@code null} if
* there is none * there is none
* @exception SOAPException if there is a problem obtaining the * @exception SOAPException if there is a problem obtaining the
* <code>SOAPHeader</code> object * {@code SOAPHeader} object
*/ */
public SOAPHeader getHeader() throws SOAPException; public SOAPHeader getHeader() throws SOAPException;
/** /**
* Returns the <code>SOAPBody</code> object associated with this * Returns the {@code SOAPBody} object associated with this
* <code>SOAPEnvelope</code> object. * {@code SOAPEnvelope} object.
* <P> * <P>
* A new <code>SOAPMessage</code> object is by default created with a * A new {@code SOAPMessage} object is by default created with a
* <code>SOAPEnvelope</code> object that contains an empty * {@code SOAPEnvelope} object that contains an empty
* <code>SOAPBody</code> object. As a result, the method * {@code SOAPBody} object. As a result, the method
* <code>getBody</code> will always return a <code>SOAPBody</code> * {@code getBody} will always return a {@code SOAPBody}
* object unless the body has been removed and a new one has not * object unless the body has been removed and a new one has not
* been added. * been added.
* *
* @return the <code>SOAPBody</code> object for this * @return the {@code SOAPBody} object for this
* <code>SOAPEnvelope</code> object or <code>null</code> * {@code SOAPEnvelope} object or {@code null}
* if there is none * if there is none
* @exception SOAPException if there is a problem obtaining the * @exception SOAPException if there is a problem obtaining the
* <code>SOAPBody</code> object * {@code SOAPBody} object
*/ */
public SOAPBody getBody() throws SOAPException; public SOAPBody getBody() throws SOAPException;
/** /**
* Creates a <code>SOAPHeader</code> object and sets it as the * Creates a {@code SOAPHeader} object and sets it as the
* <code>SOAPHeader</code> object for this <code>SOAPEnvelope</code> * {@code SOAPHeader} object for this {@code SOAPEnvelope}
* object. * object.
* <P> * <P>
* It is illegal to add a header when the envelope already * It is illegal to add a header when the envelope already
* contains a header. Therefore, this method should be called * contains a header. Therefore, this method should be called
* only after the existing header has been removed. * only after the existing header has been removed.
* *
* @return the new <code>SOAPHeader</code> object * @return the new {@code SOAPHeader} object
* *
* @exception SOAPException if this * @exception SOAPException if this
* <code>SOAPEnvelope</code> object already contains a * {@code SOAPEnvelope} object already contains a
* valid <code>SOAPHeader</code> object * valid {@code SOAPHeader} object
*/ */
public SOAPHeader addHeader() throws SOAPException; public SOAPHeader addHeader() throws SOAPException;
/** /**
* Creates a <code>SOAPBody</code> object and sets it as the * Creates a {@code SOAPBody} object and sets it as the
* <code>SOAPBody</code> object for this <code>SOAPEnvelope</code> * {@code SOAPBody} object for this {@code SOAPEnvelope}
* object. * object.
* <P> * <P>
* It is illegal to add a body when the envelope already * It is illegal to add a body when the envelope already
* contains a body. Therefore, this method should be called * contains a body. Therefore, this method should be called
* only after the existing body has been removed. * only after the existing body has been removed.
* *
* @return the new <code>SOAPBody</code> object * @return the new {@code SOAPBody} object
* *
* @exception SOAPException if this * @exception SOAPException if this
* <code>SOAPEnvelope</code> object already contains a * {@code SOAPEnvelope} object already contains a
* valid <code>SOAPBody</code> object * valid {@code SOAPBody} object
*/ */
public SOAPBody addBody() throws SOAPException; public SOAPBody addBody() throws SOAPException;
} }

76
jaxws/src/java.xml.ws/share/classes/javax/xml/soap/SOAPException.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -27,16 +27,16 @@ package javax.xml.soap;
/** /**
* An exception that signals that a SOAP exception has occurred. A * An exception that signals that a SOAP exception has occurred. A
* <code>SOAPException</code> object may contain a <code>String</code> * {@code SOAPException} object may contain a {@code String}
* that gives the reason for the exception, an embedded * that gives the reason for the exception, an embedded
* <code>Throwable</code> object, or both. This class provides methods * {@code Throwable} object, or both. This class provides methods
* for retrieving reason messages and for retrieving the embedded * for retrieving reason messages and for retrieving the embedded
* <code>Throwable</code> object. * {@code Throwable} object.
* *
* <P> Typical reasons for throwing a <code>SOAPException</code> * <P> Typical reasons for throwing a {@code SOAPException}
* object are problems such as difficulty setting a header, not being * object are problems such as difficulty setting a header, not being
* able to send a message, and not being able to get a connection with * able to send a message, and not being able to get a connection with
* the provider. Reasons for embedding a <code>Throwable</code> * the provider. Reasons for embedding a {@code Throwable}
* object include problems such as input/output errors or a parsing * object include problems such as input/output errors or a parsing
* problem, such as an error in parsing a header. * problem, such as an error in parsing a header.
* *
@ -46,8 +46,8 @@ public class SOAPException extends Exception {
private Throwable cause; private Throwable cause;
/** /**
* Constructs a <code>SOAPException</code> object with no * Constructs a {@code SOAPException} object with no
* reason or embedded <code>Throwable</code> object. * reason or embedded {@code Throwable} object.
*/ */
public SOAPException() { public SOAPException() {
super(); super();
@ -55,8 +55,8 @@ public class SOAPException extends Exception {
} }
/** /**
* Constructs a <code>SOAPException</code> object with the given * Constructs a {@code SOAPException} object with the given
* <code>String</code> as the reason for the exception being thrown. * {@code String} as the reason for the exception being thrown.
* *
* @param reason a description of what caused the exception * @param reason a description of what caused the exception
*/ */
@ -66,14 +66,14 @@ public class SOAPException extends Exception {
} }
/** /**
* Constructs a <code>SOAPException</code> object with the given * Constructs a {@code SOAPException} object with the given
* <code>String</code> as the reason for the exception being thrown * {@code String} as the reason for the exception being thrown
* and the given <code>Throwable</code> object as an embedded * and the given {@code Throwable} object as an embedded
* exception. * exception.
* *
* @param reason a description of what caused the exception * @param reason a description of what caused the exception
* @param cause a <code>Throwable</code> object that is to * @param cause a {@code Throwable} object that is to
* be embedded in this <code>SOAPException</code> object * be embedded in this {@code SOAPException} object
*/ */
public SOAPException(String reason, Throwable cause) { public SOAPException(String reason, Throwable cause) {
super(reason); super(reason);
@ -81,8 +81,8 @@ public class SOAPException extends Exception {
} }
/** /**
* Constructs a <code>SOAPException</code> object initialized * Constructs a {@code SOAPException} object initialized
* with the given <code>Throwable</code> object. * with the given {@code Throwable} object.
*/ */
public SOAPException(Throwable cause) { public SOAPException(Throwable cause) {
super(cause.toString()); super(cause.toString());
@ -90,17 +90,17 @@ public class SOAPException extends Exception {
} }
/** /**
* Returns the detail message for this <code>SOAPException</code> * Returns the detail message for this {@code SOAPException}
* object. * object.
* <P> * <P>
* If there is an embedded <code>Throwable</code> object, and if the * If there is an embedded {@code Throwable} object, and if the
* <code>SOAPException</code> object has no detail message of its * {@code SOAPException} object has no detail message of its
* own, this method will return the detail message from the embedded * own, this method will return the detail message from the embedded
* <code>Throwable</code> object. * {@code Throwable} object.
* *
* @return the error or warning message for this * @return the error or warning message for this
* <code>SOAPException</code> or, if it has none, the * {@code SOAPException} or, if it has none, the
* message of the embedded <code>Throwable</code> object, * message of the embedded {@code Throwable} object,
* if there is one * if there is one
*/ */
public String getMessage() { public String getMessage() {
@ -113,11 +113,11 @@ public class SOAPException extends Exception {
} }
/** /**
* Returns the <code>Throwable</code> object embedded in this * Returns the {@code Throwable} object embedded in this
* <code>SOAPException</code> if there is one. Otherwise, this method * {@code SOAPException} if there is one. Otherwise, this method
* returns <code>null</code>. * returns {@code null}.
* *
* @return the embedded <code>Throwable</code> object or <code>null</code> * @return the embedded {@code Throwable} object or {@code null}
* if there is none * if there is none
*/ */
@ -126,29 +126,29 @@ public class SOAPException extends Exception {
} }
/** /**
* Initializes the <code>cause</code> field of this <code>SOAPException</code> * Initializes the {@code cause} field of this {@code SOAPException}
* object with the given <code>Throwable</code> object. * object with the given {@code Throwable} object.
* <P> * <P>
* This method can be called at most once. It is generally called from * This method can be called at most once. It is generally called from
* within the constructor or immediately after the constructor has * within the constructor or immediately after the constructor has
* returned a new <code>SOAPException</code> object. * returned a new {@code SOAPException} object.
* If this <code>SOAPException</code> object was created with the * If this {@code SOAPException} object was created with the
* constructor {@link #SOAPException(Throwable)} or * constructor {@link #SOAPException(Throwable)} or
* {@link #SOAPException(String,Throwable)}, meaning that its * {@link #SOAPException(String,Throwable)}, meaning that its
* <code>cause</code> field already has a value, this method cannot be * {@code cause} field already has a value, this method cannot be
* called even once. * called even once.
* *
* @param cause the <code>Throwable</code> object that caused this * @param cause the {@code Throwable} object that caused this
* <code>SOAPException</code> object to be thrown. The value of this * {@code SOAPException} object to be thrown. The value of this
* parameter is saved for later retrieval by the * parameter is saved for later retrieval by the
* {@link #getCause()} method. A <tt>null</tt> value is * {@link #getCause()} method. A <tt>null</tt> value is
* permitted and indicates that the cause is nonexistent or * permitted and indicates that the cause is nonexistent or
* unknown. * unknown.
* @return a reference to this <code>SOAPException</code> instance * @return a reference to this {@code SOAPException} instance
* @throws IllegalArgumentException if <code>cause</code> is this * @throws IllegalArgumentException if {@code cause} is this
* <code>Throwable</code> object. (A <code>Throwable</code> object * {@code Throwable} object. (A {@code Throwable} object
* cannot be its own cause.) * cannot be its own cause.)
* @throws IllegalStateException if the cause for this <code>SOAPException</code> object * @throws IllegalStateException if the cause for this {@code SOAPException} object
* has already been initialized * has already been initialized
*/ */
public synchronized Throwable initCause(Throwable cause) { public synchronized Throwable initCause(Throwable cause) {

160
jaxws/src/java.xml.ws/share/classes/javax/xml/soap/SOAPFactory.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -30,18 +30,18 @@ import javax.xml.namespace.QName;
import org.w3c.dom.Element; import org.w3c.dom.Element;
/** /**
* <code>SOAPFactory</code> is a factory for creating various objects * {@code SOAPFactory} is a factory for creating various objects
* that exist in the SOAP XML tree. * that exist in the SOAP XML tree.
* <code>SOAPFactory</code> can be * {@code SOAPFactory} can be
* used to create XML fragments that will eventually end up in the * used to create XML fragments that will eventually end up in the
* SOAP part. These fragments can be inserted as children of the * SOAP part. These fragments can be inserted as children of the
* {@link SOAPHeaderElement} or {@link SOAPBodyElement} or * {@link SOAPHeaderElement} or {@link SOAPBodyElement} or
* {@link SOAPEnvelope} or other {@link SOAPElement} objects. * {@link SOAPEnvelope} or other {@link SOAPElement} objects.
* *
* <code>SOAPFactory</code> also has methods to create * {@code SOAPFactory} also has methods to create
* <code>javax.xml.soap.Detail</code> objects as well as * {@code javax.xml.soap.Detail} objects as well as
* <code>java.xml.soap.Name</code> objects. * {@code java.xml.soap.Name} objects.
* *
* @since 1.6 * @since 1.6
*/ */
@ -49,34 +49,34 @@ public abstract class SOAPFactory {
/** /**
* A constant representing the property used to lookup the name of * A constant representing the property used to lookup the name of
* a <code>SOAPFactory</code> implementation class. * a {@code SOAPFactory} implementation class.
*/ */
static private final String SOAP_FACTORY_PROPERTY = static private final String SOAP_FACTORY_PROPERTY =
"javax.xml.soap.SOAPFactory"; "javax.xml.soap.SOAPFactory";
/** /**
* Class name of default <code>SOAPFactory</code> implementation. * Class name of default {@code SOAPFactory} implementation.
*/ */
static final String DEFAULT_SOAP_FACTORY static final String DEFAULT_SOAP_FACTORY
= "com.sun.xml.internal.messaging.saaj.soap.ver1_1.SOAPFactory1_1Impl"; = "com.sun.xml.internal.messaging.saaj.soap.ver1_1.SOAPFactory1_1Impl";
/** /**
* Creates a <code>SOAPElement</code> object from an existing DOM * Creates a {@code SOAPElement} object from an existing DOM
* <code>Element</code>. If the DOM <code>Element</code> that is passed in * {@code Element}. If the DOM {@code Element} that is passed in
* as an argument is already a <code>SOAPElement</code> then this method * as an argument is already a {@code SOAPElement} then this method
* must return it unmodified without any further work. Otherwise, a new * must return it unmodified without any further work. Otherwise, a new
* <code>SOAPElement</code> is created and a deep copy is made of the * {@code SOAPElement} is created and a deep copy is made of the
* <code>domElement</code> argument. The concrete type of the return value * {@code domElement} argument. The concrete type of the return value
* will depend on the name of the <code>domElement</code> argument. If any * will depend on the name of the {@code domElement} argument. If any
* part of the tree rooted in <code>domElement</code> violates SOAP rules, a * part of the tree rooted in {@code domElement} violates SOAP rules, a
* <code>SOAPException</code> will be thrown. * {@code SOAPException} will be thrown.
* *
* @param domElement - the <code>Element</code> to be copied. * @param domElement - the {@code Element} to be copied.
* *
* @return a new <code>SOAPElement</code> that is a copy of <code>domElement</code>. * @return a new {@code SOAPElement} that is a copy of {@code domElement}.
* *
* @exception SOAPException if there is an error in creating the * @exception SOAPException if there is an error in creating the
* <code>SOAPElement</code> object * {@code SOAPElement} object
* *
* @since 1.6, SAAJ 1.3 * @since 1.6, SAAJ 1.3
*/ */
@ -85,41 +85,41 @@ public abstract class SOAPFactory {
} }
/** /**
* Creates a <code>SOAPElement</code> object initialized with the * Creates a {@code SOAPElement} object initialized with the
* given <code>Name</code> object. The concrete type of the return value * given {@code Name} object. The concrete type of the return value
* will depend on the name given to the new <code>SOAPElement</code>. For * will depend on the name given to the new {@code SOAPElement}. For
* instance, a new <code>SOAPElement</code> with the name * instance, a new {@code SOAPElement} with the name
* "{http://www.w3.org/2003/05/soap-envelope}Envelope" would cause a * "{http://www.w3.org/2003/05/soap-envelope}Envelope" would cause a
* <code>SOAPEnvelope</code> that supports SOAP 1.2 behavior to be created. * {@code SOAPEnvelope} that supports SOAP 1.2 behavior to be created.
* *
* @param name a <code>Name</code> object with the XML name for * @param name a {@code Name} object with the XML name for
* the new element * the new element
* *
* @return the new <code>SOAPElement</code> object that was * @return the new {@code SOAPElement} object that was
* created * created
* *
* @exception SOAPException if there is an error in creating the * @exception SOAPException if there is an error in creating the
* <code>SOAPElement</code> object * {@code SOAPElement} object
* @see SOAPFactory#createElement(javax.xml.namespace.QName) * @see SOAPFactory#createElement(javax.xml.namespace.QName)
*/ */
public abstract SOAPElement createElement(Name name) throws SOAPException; public abstract SOAPElement createElement(Name name) throws SOAPException;
/** /**
* Creates a <code>SOAPElement</code> object initialized with the * Creates a {@code SOAPElement} object initialized with the
* given <code>QName</code> object. The concrete type of the return value * given {@code QName} object. The concrete type of the return value
* will depend on the name given to the new <code>SOAPElement</code>. For * will depend on the name given to the new {@code SOAPElement}. For
* instance, a new <code>SOAPElement</code> with the name * instance, a new {@code SOAPElement} with the name
* "{http://www.w3.org/2003/05/soap-envelope}Envelope" would cause a * "{http://www.w3.org/2003/05/soap-envelope}Envelope" would cause a
* <code>SOAPEnvelope</code> that supports SOAP 1.2 behavior to be created. * {@code SOAPEnvelope} that supports SOAP 1.2 behavior to be created.
* *
* @param qname a <code>QName</code> object with the XML name for * @param qname a {@code QName} object with the XML name for
* the new element * the new element
* *
* @return the new <code>SOAPElement</code> object that was * @return the new {@code SOAPElement} object that was
* created * created
* *
* @exception SOAPException if there is an error in creating the * @exception SOAPException if there is an error in creating the
* <code>SOAPElement</code> object * {@code SOAPElement} object
* @see SOAPFactory#createElement(Name) * @see SOAPFactory#createElement(Name)
* @since 1.6, SAAJ 1.3 * @since 1.6, SAAJ 1.3
*/ */
@ -128,38 +128,38 @@ public abstract class SOAPFactory {
} }
/** /**
* Creates a <code>SOAPElement</code> object initialized with the * Creates a {@code SOAPElement} object initialized with the
* given local name. * given local name.
* *
* @param localName a <code>String</code> giving the local name for * @param localName a {@code String} giving the local name for
* the new element * the new element
* *
* @return the new <code>SOAPElement</code> object that was * @return the new {@code SOAPElement} object that was
* created * created
* *
* @exception SOAPException if there is an error in creating the * @exception SOAPException if there is an error in creating the
* <code>SOAPElement</code> object * {@code SOAPElement} object
*/ */
public abstract SOAPElement createElement(String localName) public abstract SOAPElement createElement(String localName)
throws SOAPException; throws SOAPException;
/** /**
* Creates a new <code>SOAPElement</code> object with the given * Creates a new {@code SOAPElement} object with the given
* local name, prefix and uri. The concrete type of the return value * local name, prefix and uri. The concrete type of the return value
* will depend on the name given to the new <code>SOAPElement</code>. For * will depend on the name given to the new {@code SOAPElement}. For
* instance, a new <code>SOAPElement</code> with the name * instance, a new {@code SOAPElement} with the name
* "{http://www.w3.org/2003/05/soap-envelope}Envelope" would cause a * "{http://www.w3.org/2003/05/soap-envelope}Envelope" would cause a
* <code>SOAPEnvelope</code> that supports SOAP 1.2 behavior to be created. * {@code SOAPEnvelope} that supports SOAP 1.2 behavior to be created.
* *
* @param localName a <code>String</code> giving the local name * @param localName a {@code String} giving the local name
* for the new element * for the new element
* @param prefix the prefix for this <code>SOAPElement</code> * @param prefix the prefix for this {@code SOAPElement}
* @param uri a <code>String</code> giving the URI of the * @param uri a {@code String} giving the URI of the
* namespace to which the new element belongs * namespace to which the new element belongs
* *
* @exception SOAPException if there is an error in creating the * @exception SOAPException if there is an error in creating the
* <code>SOAPElement</code> object * {@code SOAPElement} object
*/ */
public abstract SOAPElement createElement( public abstract SOAPElement createElement(
String localName, String localName,
@ -168,51 +168,51 @@ public abstract class SOAPFactory {
throws SOAPException; throws SOAPException;
/** /**
* Creates a new <code>Detail</code> object which serves as a container * Creates a new {@code Detail} object which serves as a container
* for <code>DetailEntry</code> objects. * for {@code DetailEntry} objects.
* <P> * <P>
* This factory method creates <code>Detail</code> objects for use in * This factory method creates {@code Detail} objects for use in
* situations where it is not practical to use the <code>SOAPFault</code> * situations where it is not practical to use the {@code SOAPFault}
* abstraction. * abstraction.
* *
* @return a <code>Detail</code> object * @return a {@code Detail} object
* @throws SOAPException if there is a SOAP error * @throws SOAPException if there is a SOAP error
* @throws UnsupportedOperationException if the protocol specified * @throws UnsupportedOperationException if the protocol specified
* for the SOAPFactory was <code>DYNAMIC_SOAP_PROTOCOL</code> * for the SOAPFactory was {@code DYNAMIC_SOAP_PROTOCOL}
*/ */
public abstract Detail createDetail() throws SOAPException; public abstract Detail createDetail() throws SOAPException;
/** /**
*Creates a new <code>SOAPFault</code> object initialized with the given <code>reasonText</code> *Creates a new {@code SOAPFault} object initialized with the given {@code reasonText}
* and <code>faultCode</code> * and {@code faultCode}
*@param reasonText the ReasonText/FaultString for the fault *@param reasonText the ReasonText/FaultString for the fault
*@param faultCode the FaultCode for the fault *@param faultCode the FaultCode for the fault
*@return a <code>SOAPFault</code> object *@return a {@code SOAPFault} object
*@throws SOAPException if there is a SOAP error *@throws SOAPException if there is a SOAP error
*@since 1.6, SAAJ 1.3 *@since 1.6, SAAJ 1.3
*/ */
public abstract SOAPFault createFault(String reasonText, QName faultCode) throws SOAPException; public abstract SOAPFault createFault(String reasonText, QName faultCode) throws SOAPException;
/** /**
*Creates a new default <code>SOAPFault</code> object *Creates a new default {@code SOAPFault} object
*@return a <code>SOAPFault</code> object *@return a {@code SOAPFault} object
*@throws SOAPException if there is a SOAP error *@throws SOAPException if there is a SOAP error
*@since 1.6, SAAJ 1.3 *@since 1.6, SAAJ 1.3
*/ */
public abstract SOAPFault createFault() throws SOAPException; public abstract SOAPFault createFault() throws SOAPException;
/** /**
* Creates a new <code>Name</code> object initialized with the * Creates a new {@code Name} object initialized with the
* given local name, namespace prefix, and namespace URI. * given local name, namespace prefix, and namespace URI.
* <P> * <P>
* This factory method creates <code>Name</code> objects for use in * This factory method creates {@code Name} objects for use in
* situations where it is not practical to use the <code>SOAPEnvelope</code> * situations where it is not practical to use the {@code SOAPEnvelope}
* abstraction. * abstraction.
* *
* @param localName a <code>String</code> giving the local name * @param localName a {@code String} giving the local name
* @param prefix a <code>String</code> giving the prefix of the namespace * @param prefix a {@code String} giving the prefix of the namespace
* @param uri a <code>String</code> giving the URI of the namespace * @param uri a {@code String} giving the URI of the namespace
* @return a <code>Name</code> object initialized with the given * @return a {@code Name} object initialized with the given
* local name, namespace prefix, and namespace URI * local name, namespace prefix, and namespace URI
* @throws SOAPException if there is a SOAP error * @throws SOAPException if there is a SOAP error
*/ */
@ -223,22 +223,22 @@ public abstract class SOAPFactory {
throws SOAPException; throws SOAPException;
/** /**
* Creates a new <code>Name</code> object initialized with the * Creates a new {@code Name} object initialized with the
* given local name. * given local name.
* <P> * <P>
* This factory method creates <code>Name</code> objects for use in * This factory method creates {@code Name} objects for use in
* situations where it is not practical to use the <code>SOAPEnvelope</code> * situations where it is not practical to use the {@code SOAPEnvelope}
* abstraction. * abstraction.
* *
* @param localName a <code>String</code> giving the local name * @param localName a {@code String} giving the local name
* @return a <code>Name</code> object initialized with the given * @return a {@code Name} object initialized with the given
* local name * local name
* @throws SOAPException if there is a SOAP error * @throws SOAPException if there is a SOAP error
*/ */
public abstract Name createName(String localName) throws SOAPException; public abstract Name createName(String localName) throws SOAPException;
/** /**
* Creates a new <code>SOAPFactory</code> object that is an instance of * Creates a new {@code SOAPFactory} object that is an instance of
* the default implementation (SOAP 1.1), * the default implementation (SOAP 1.1),
* *
* This method uses the following ordered lookup procedure to determine the SOAPFactory implementation class to load: * This method uses the following ordered lookup procedure to determine the SOAPFactory implementation class to load:
@ -252,10 +252,10 @@ public abstract class SOAPFactory {
* <LI> Use the SAAJMetaFactory instance to locate the SOAPFactory implementation class. * <LI> Use the SAAJMetaFactory instance to locate the SOAPFactory implementation class.
* </UL> * </UL>
* *
* @return a new instance of a <code>SOAPFactory</code> * @return a new instance of a {@code SOAPFactory}
* *
* @exception SOAPException if there was an error creating the * @exception SOAPException if there was an error creating the
* default <code>SOAPFactory</code> * default {@code SOAPFactory}
* @see SAAJMetaFactory * @see SAAJMetaFactory
*/ */
public static SOAPFactory newInstance() public static SOAPFactory newInstance()
@ -275,21 +275,21 @@ public abstract class SOAPFactory {
} }
/** /**
* Creates a new <code>SOAPFactory</code> object that is an instance of * Creates a new {@code SOAPFactory} object that is an instance of
* the specified implementation, this method uses the SAAJMetaFactory to * the specified implementation, this method uses the SAAJMetaFactory to
* locate the implementation class and create the SOAPFactory instance. * locate the implementation class and create the SOAPFactory instance.
* *
* @return a new instance of a <code>SOAPFactory</code> * @return a new instance of a {@code SOAPFactory}
* *
* @param protocol a string constant representing the protocol of the * @param protocol a string constant representing the protocol of the
* specified SOAP factory implementation. May be * specified SOAP factory implementation. May be
* either <code>DYNAMIC_SOAP_PROTOCOL</code>, * either {@code DYNAMIC_SOAP_PROTOCOL},
* <code>DEFAULT_SOAP_PROTOCOL</code> (which is the same * {@code DEFAULT_SOAP_PROTOCOL} (which is the same
* as) <code>SOAP_1_1_PROTOCOL</code>, or * as) {@code SOAP_1_1_PROTOCOL}, or
* <code>SOAP_1_2_PROTOCOL</code>. * {@code SOAP_1_2_PROTOCOL}.
* *
* @exception SOAPException if there was an error creating the * @exception SOAPException if there was an error creating the
* specified <code>SOAPFactory</code> * specified {@code SOAPFactory}
* @see SAAJMetaFactory * @see SAAJMetaFactory
* @since 1.6, SAAJ 1.3 * @since 1.6, SAAJ 1.3
*/ */

206
jaxws/src/java.xml.ws/share/classes/javax/xml/soap/SOAPFault.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -31,16 +31,16 @@ import java.util.Locale;
import javax.xml.namespace.QName; import javax.xml.namespace.QName;
/** /**
* An element in the <code>SOAPBody</code> object that contains * An element in the {@code SOAPBody} object that contains
* error and/or status information. This information may relate to * error and/or status information. This information may relate to
* errors in the <code>SOAPMessage</code> object or to problems * errors in the {@code SOAPMessage} object or to problems
* that are not related to the content in the message itself. Problems * that are not related to the content in the message itself. Problems
* not related to the message itself are generally errors in * not related to the message itself are generally errors in
* processing, such as the inability to communicate with an upstream * processing, such as the inability to communicate with an upstream
* server. * server.
* <P> * <P>
* Depending on the <code>protocol</code> specified while creating the * Depending on the {@code protocol} specified while creating the
* <code>MessageFactory</code> instance, a <code>SOAPFault</code> has * {@code MessageFactory} instance, a {@code SOAPFault} has
* sub-elements as defined in the SOAP 1.1/SOAP 1.2 specification. * sub-elements as defined in the SOAP 1.1/SOAP 1.2 specification.
* *
* @since 1.6 * @since 1.6
@ -48,14 +48,14 @@ import javax.xml.namespace.QName;
public interface SOAPFault extends SOAPBodyElement { public interface SOAPFault extends SOAPBodyElement {
/** /**
* Sets this <code>SOAPFault</code> object with the given fault code. * Sets this {@code SOAPFault} object with the given fault code.
* *
* <P> Fault codes, which give information about the fault, are defined * <P> Fault codes, which give information about the fault, are defined
* in the SOAP 1.1 specification. A fault code is mandatory and must * in the SOAP 1.1 specification. A fault code is mandatory and must
* be of type <code>Name</code>. This method provides a convenient * be of type {@code Name}. This method provides a convenient
* way to set a fault code. For example, * way to set a fault code. For example,
* *
* <PRE> * <pre>{@code
* SOAPEnvelope se = ...; * SOAPEnvelope se = ...;
* // Create a qualified name in the SOAP namespace with a localName * // Create a qualified name in the SOAP namespace with a localName
* // of "Client". Note that prefix parameter is optional and is null * // of "Client". Note that prefix parameter is optional and is null
@ -64,10 +64,10 @@ public interface SOAPFault extends SOAPBodyElement {
* SOAPConstants.URI_NS_SOAP_ENVELOPE); * SOAPConstants.URI_NS_SOAP_ENVELOPE);
* SOAPFault fault = ...; * SOAPFault fault = ...;
* fault.setFaultCode(qname); * fault.setFaultCode(qname);
* </PRE> * }</pre>
* It is preferable to use this method over {@link #setFaultCode(String)}. * It is preferable to use this method over {@link #setFaultCode(String)}.
* *
* @param faultCodeQName a <code>Name</code> object giving the fault * @param faultCodeQName a {@code Name} object giving the fault
* code to be set. It must be namespace qualified. * code to be set. It must be namespace qualified.
* @see #getFaultCodeAsName * @see #getFaultCodeAsName
* *
@ -79,16 +79,16 @@ public interface SOAPFault extends SOAPBodyElement {
public void setFaultCode(Name faultCodeQName) throws SOAPException; public void setFaultCode(Name faultCodeQName) throws SOAPException;
/** /**
* Sets this <code>SOAPFault</code> object with the given fault code. * Sets this {@code SOAPFault} object with the given fault code.
* *
* It is preferable to use this method over {@link #setFaultCode(Name)}. * It is preferable to use this method over {@link #setFaultCode(Name)}.
* *
* @param faultCodeQName a <code>QName</code> object giving the fault * @param faultCodeQName a {@code QName} object giving the fault
* code to be set. It must be namespace qualified. * code to be set. It must be namespace qualified.
* @see #getFaultCodeAsQName * @see #getFaultCodeAsQName
* *
* @exception SOAPException if there was an error in adding the * @exception SOAPException if there was an error in adding the
* <code>faultcode</code> element to the underlying XML tree. * {@code faultcode} element to the underlying XML tree.
* *
* @see #setFaultCode(Name) * @see #setFaultCode(Name)
* @see #getFaultCodeAsQName() * @see #getFaultCodeAsQName()
@ -98,14 +98,14 @@ public interface SOAPFault extends SOAPBodyElement {
public void setFaultCode(QName faultCodeQName) throws SOAPException; public void setFaultCode(QName faultCodeQName) throws SOAPException;
/** /**
* Sets this <code>SOAPFault</code> object with the give fault code. * Sets this {@code SOAPFault} object with the give fault code.
* <P> * <P>
* Fault codes, which given information about the fault, are defined in * Fault codes, which given information about the fault, are defined in
* the SOAP 1.1 specification. This element is mandatory in SOAP 1.1. * the SOAP 1.1 specification. This element is mandatory in SOAP 1.1.
* Because the fault code is required to be a QName it is preferable to * Because the fault code is required to be a QName it is preferable to
* use the {@link #setFaultCode(Name)} form of this method. * use the {@link #setFaultCode(Name)} form of this method.
* *
* @param faultCode a <code>String</code> giving the fault code to be set. * @param faultCode a {@code String} giving the fault code to be set.
* It must be of the form "prefix:localName" where the prefix has * It must be of the form "prefix:localName" where the prefix has
* been defined in a namespace declaration. * been defined in a namespace declaration.
* @see #setFaultCode(Name) * @see #setFaultCode(Name)
@ -113,21 +113,21 @@ public interface SOAPFault extends SOAPBodyElement {
* @see SOAPElement#addNamespaceDeclaration * @see SOAPElement#addNamespaceDeclaration
* *
* @exception SOAPException if there was an error in adding the * @exception SOAPException if there was an error in adding the
* <code>faultCode</code> to the underlying XML tree. * {@code faultCode} to the underlying XML tree.
*/ */
public void setFaultCode(String faultCode) throws SOAPException; public void setFaultCode(String faultCode) throws SOAPException;
/** /**
* Gets the mandatory SOAP 1.1 fault code for this * Gets the mandatory SOAP 1.1 fault code for this
* <code>SOAPFault</code> object as a SAAJ <code>Name</code> object. * {@code SOAPFault} object as a SAAJ {@code Name} object.
* The SOAP 1.1 specification requires the value of the "faultcode" * The SOAP 1.1 specification requires the value of the "faultcode"
* element to be of type QName. This method returns the content of the * element to be of type QName. This method returns the content of the
* element as a QName in the form of a SAAJ Name object. This method * element as a QName in the form of a SAAJ Name object. This method
* should be used instead of the <code>getFaultCode</code> method since * should be used instead of the {@code getFaultCode} method since
* it allows applications to easily access the namespace name without * it allows applications to easily access the namespace name without
* additional parsing. * additional parsing.
* *
* @return a <code>Name</code> representing the faultcode * @return a {@code Name} representing the faultcode
* @see #setFaultCode(Name) * @see #setFaultCode(Name)
* *
* @since 1.6, SAAJ 1.2 * @since 1.6, SAAJ 1.2
@ -137,9 +137,9 @@ public interface SOAPFault extends SOAPBodyElement {
/** /**
* Gets the fault code for this * Gets the fault code for this
* <code>SOAPFault</code> object as a <code>QName</code> object. * {@code SOAPFault} object as a {@code QName} object.
* *
* @return a <code>QName</code> representing the faultcode * @return a {@code QName} representing the faultcode
* *
* @see #setFaultCode(QName) * @see #setFaultCode(QName)
* *
@ -148,12 +148,12 @@ public interface SOAPFault extends SOAPBodyElement {
public QName getFaultCodeAsQName(); public QName getFaultCodeAsQName();
/** /**
* Gets the Subcodes for this <code>SOAPFault</code> as an iterator over * Gets the Subcodes for this {@code SOAPFault} as an iterator over
* <code>QNames</code>. * {@code QNames}.
* *
* @return an <code>Iterator</code> that accesses a sequence of * @return an {@code Iterator} that accesses a sequence of
* <code>QNames</code>. This <code>Iterator</code> should not support * {@code QNames}. This {@code Iterator} should not support
* the optional <code>remove</code> method. The order in which the * the optional {@code remove} method. The order in which the
* Subcodes are returned reflects the hierarchy of Subcodes present * Subcodes are returned reflects the hierarchy of Subcodes present
* in the fault from top to bottom. * in the fault from top to bottom.
* *
@ -166,9 +166,9 @@ public interface SOAPFault extends SOAPBodyElement {
/** /**
* Removes any Subcodes that may be contained by this * Removes any Subcodes that may be contained by this
* <code>SOAPFault</code>. Subsequent calls to * {@code SOAPFault}. Subsequent calls to
* <code>getFaultSubcodes</code> will return an empty iterator until a call * {@code getFaultSubcodes} will return an empty iterator until a call
* to <code>appendFaultSubcode</code> is made. * to {@code appendFaultSubcode} is made.
* *
* @exception UnsupportedOperationException if this message does not * @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Subcode. * support the SOAP 1.2 concept of Subcode.
@ -179,7 +179,7 @@ public interface SOAPFault extends SOAPBodyElement {
/** /**
* Adds a Subcode to the end of the sequence of Subcodes contained by this * Adds a Subcode to the end of the sequence of Subcodes contained by this
* <code>SOAPFault</code>. Subcodes, which were introduced in SOAP 1.2, are * {@code SOAPFault}. Subcodes, which were introduced in SOAP 1.2, are
* represented by a recursive sequence of subelements rooted in the * represented by a recursive sequence of subelements rooted in the
* mandatory Code subelement of a SOAP Fault. * mandatory Code subelement of a SOAP Fault.
* *
@ -194,83 +194,83 @@ public interface SOAPFault extends SOAPBodyElement {
public void appendFaultSubcode(QName subcode) throws SOAPException; public void appendFaultSubcode(QName subcode) throws SOAPException;
/** /**
* Gets the fault code for this <code>SOAPFault</code> object. * Gets the fault code for this {@code SOAPFault} object.
* *
* @return a <code>String</code> with the fault code * @return a {@code String} with the fault code
* @see #getFaultCodeAsName * @see #getFaultCodeAsName
* @see #setFaultCode * @see #setFaultCode
*/ */
public String getFaultCode(); public String getFaultCode();
/** /**
* Sets this <code>SOAPFault</code> object with the given fault actor. * Sets this {@code SOAPFault} object with the given fault actor.
* <P> * <P>
* The fault actor is the recipient in the message path who caused the * The fault actor is the recipient in the message path who caused the
* fault to happen. * fault to happen.
* <P> * <P>
* If this <code>SOAPFault</code> supports SOAP 1.2 then this call is * If this {@code SOAPFault} supports SOAP 1.2 then this call is
* equivalent to {@link #setFaultRole(String)} * equivalent to {@link #setFaultRole(String)}
* *
* @param faultActor a <code>String</code> identifying the actor that * @param faultActor a {@code String} identifying the actor that
* caused this <code>SOAPFault</code> object * caused this {@code SOAPFault} object
* @see #getFaultActor * @see #getFaultActor
* *
* @exception SOAPException if there was an error in adding the * @exception SOAPException if there was an error in adding the
* <code>faultActor</code> to the underlying XML tree. * {@code faultActor} to the underlying XML tree.
*/ */
public void setFaultActor(String faultActor) throws SOAPException; public void setFaultActor(String faultActor) throws SOAPException;
/** /**
* Gets the fault actor for this <code>SOAPFault</code> object. * Gets the fault actor for this {@code SOAPFault} object.
* <P> * <P>
* If this <code>SOAPFault</code> supports SOAP 1.2 then this call is * If this {@code SOAPFault} supports SOAP 1.2 then this call is
* equivalent to {@link #getFaultRole()} * equivalent to {@link #getFaultRole()}
* *
* @return a <code>String</code> giving the actor in the message path * @return a {@code String} giving the actor in the message path
* that caused this <code>SOAPFault</code> object * that caused this {@code SOAPFault} object
* @see #setFaultActor * @see #setFaultActor
*/ */
public String getFaultActor(); public String getFaultActor();
/** /**
* Sets the fault string for this <code>SOAPFault</code> object * Sets the fault string for this {@code SOAPFault} object
* to the given string. * to the given string.
* <P> * <P>
* If this * If this
* <code>SOAPFault</code> is part of a message that supports SOAP 1.2 then * {@code SOAPFault} is part of a message that supports SOAP 1.2 then
* this call is equivalent to: * this call is equivalent to:
* <pre> * <pre>{@code
* addFaultReasonText(faultString, Locale.getDefault()); * addFaultReasonText(faultString, Locale.getDefault());
* </pre> * }</pre>
* *
* @param faultString a <code>String</code> giving an explanation of * @param faultString a {@code String} giving an explanation of
* the fault * the fault
* @see #getFaultString * @see #getFaultString
* *
* @exception SOAPException if there was an error in adding the * @exception SOAPException if there was an error in adding the
* <code>faultString</code> to the underlying XML tree. * {@code faultString} to the underlying XML tree.
*/ */
public void setFaultString(String faultString) throws SOAPException; public void setFaultString(String faultString) throws SOAPException;
/** /**
* Sets the fault string for this <code>SOAPFault</code> object * Sets the fault string for this {@code SOAPFault} object
* to the given string and localized to the given locale. * to the given string and localized to the given locale.
* <P> * <P>
* If this * If this
* <code>SOAPFault</code> is part of a message that supports SOAP 1.2 then * {@code SOAPFault} is part of a message that supports SOAP 1.2 then
* this call is equivalent to: * this call is equivalent to:
* <pre> * <pre>{@code
* addFaultReasonText(faultString, locale); * addFaultReasonText(faultString, locale);
* </pre> * }</pre>
* *
* @param faultString a <code>String</code> giving an explanation of * @param faultString a {@code String} giving an explanation of
* the fault * the fault
* @param locale a {@link java.util.Locale Locale} object indicating * @param locale a {@link java.util.Locale Locale} object indicating
* the native language of the <code>faultString</code> * the native language of the {@code faultString}
* @see #getFaultString * @see #getFaultString
* *
* @exception SOAPException if there was an error in adding the * @exception SOAPException if there was an error in adding the
* <code>faultString</code> to the underlying XML tree. * {@code faultString} to the underlying XML tree.
* *
* @since 1.6, SAAJ 1.2 * @since 1.6, SAAJ 1.2
*/ */
@ -278,20 +278,20 @@ public interface SOAPFault extends SOAPBodyElement {
throws SOAPException; throws SOAPException;
/** /**
* Gets the fault string for this <code>SOAPFault</code> object. * Gets the fault string for this {@code SOAPFault} object.
* <P> * <P>
* If this * If this
* <code>SOAPFault</code> is part of a message that supports SOAP 1.2 then * {@code SOAPFault} is part of a message that supports SOAP 1.2 then
* this call is equivalent to: * this call is equivalent to:
* <pre> * <pre>{@code
* String reason = null; * String reason = null;
* try { * try {
* reason = (String) getFaultReasonTexts().next(); * reason = (String) getFaultReasonTexts().next();
* } catch (SOAPException e) {} * } catch (SOAPException e) {}
* return reason; * return reason;
* </pre> * }</pre>
* *
* @return a <code>String</code> giving an explanation of * @return a {@code String} giving an explanation of
* the fault * the fault
* @see #setFaultString(String) * @see #setFaultString(String)
* @see #setFaultString(String, Locale) * @see #setFaultString(String, Locale)
@ -299,22 +299,22 @@ public interface SOAPFault extends SOAPBodyElement {
public String getFaultString(); public String getFaultString();
/** /**
* Gets the locale of the fault string for this <code>SOAPFault</code> * Gets the locale of the fault string for this {@code SOAPFault}
* object. * object.
* <P> * <P>
* If this * If this
* <code>SOAPFault</code> is part of a message that supports SOAP 1.2 then * {@code SOAPFault} is part of a message that supports SOAP 1.2 then
* this call is equivalent to: * this call is equivalent to:
* <pre> * <pre>{@code
* Locale locale = null; * Locale locale = null;
* try { * try {
* locale = (Locale) getFaultReasonLocales().next(); * locale = (Locale) getFaultReasonLocales().next();
* } catch (SOAPException e) {} * } catch (SOAPException e) {}
* return locale; * return locale;
* </pre> * }</pre>
* *
* @return a <code>Locale</code> object indicating the native language of * @return a {@code Locale} object indicating the native language of
* the fault string or <code>null</code> if no locale was specified * the fault string or {@code null} if no locale was specified
* @see #setFaultString(String, Locale) * @see #setFaultString(String, Locale)
* *
* @since 1.6, SAAJ 1.2 * @since 1.6, SAAJ 1.2
@ -322,11 +322,11 @@ public interface SOAPFault extends SOAPBodyElement {
public Locale getFaultStringLocale(); public Locale getFaultStringLocale();
/** /**
* Returns true if this <code>SOAPFault</code> has a <code>Detail</code> * Returns true if this {@code SOAPFault} has a {@code Detail}
* subelement and false otherwise. Equivalent to * subelement and false otherwise. Equivalent to
* <code>(getDetail()!=null)</code>. * {@code (getDetail()!=null)}.
* *
* @return true if this <code>SOAPFault</code> has a <code>Detail</code> * @return true if this {@code SOAPFault} has a {@code Detail}
* subelement and false otherwise. * subelement and false otherwise.
* *
* @since 1.6, SAAJ 1.3 * @since 1.6, SAAJ 1.3
@ -334,44 +334,44 @@ public interface SOAPFault extends SOAPBodyElement {
public boolean hasDetail(); public boolean hasDetail();
/** /**
* Returns the optional detail element for this <code>SOAPFault</code> * Returns the optional detail element for this {@code SOAPFault}
* object. * object.
* <P> * <P>
* A <code>Detail</code> object carries application-specific error * A {@code Detail} object carries application-specific error
* information, the scope of the error information is restricted to * information, the scope of the error information is restricted to
* faults in the <code>SOAPBodyElement</code> objects if this is a * faults in the {@code SOAPBodyElement} objects if this is a
* SOAP 1.1 Fault. * SOAP 1.1 Fault.
* *
* @return a <code>Detail</code> object with application-specific * @return a {@code Detail} object with application-specific
* error information if present, null otherwise * error information if present, null otherwise
*/ */
public Detail getDetail(); public Detail getDetail();
/** /**
* Creates an optional <code>Detail</code> object and sets it as the * Creates an optional {@code Detail} object and sets it as the
* <code>Detail</code> object for this <code>SOAPFault</code> * {@code Detail} object for this {@code SOAPFault}
* object. * object.
* <P> * <P>
* It is illegal to add a detail when the fault already * It is illegal to add a detail when the fault already
* contains a detail. Therefore, this method should be called * contains a detail. Therefore, this method should be called
* only after the existing detail has been removed. * only after the existing detail has been removed.
* *
* @return the new <code>Detail</code> object * @return the new {@code Detail} object
* *
* @exception SOAPException if this * @exception SOAPException if this
* <code>SOAPFault</code> object already contains a * {@code SOAPFault} object already contains a
* valid <code>Detail</code> object * valid {@code Detail} object
*/ */
public Detail addDetail() throws SOAPException; public Detail addDetail() throws SOAPException;
/** /**
* Returns an <code>Iterator</code> over a distinct sequence of * Returns an {@code Iterator} over a distinct sequence of
* <code>Locale</code>s for which there are associated Reason Text items. * {@code Locale}s for which there are associated Reason Text items.
* Any of these <code>Locale</code>s can be used in a call to * Any of these {@code Locale}s can be used in a call to
* <code>getFaultReasonText</code> in order to obtain a localized version * {@code getFaultReasonText} in order to obtain a localized version
* of the Reason Text string. * of the Reason Text string.
* *
* @return an <code>Iterator</code> over a sequence of <code>Locale</code> * @return an {@code Iterator} over a sequence of {@code Locale}
* objects for which there are associated Reason Text items. * objects for which there are associated Reason Text items.
* *
* @exception SOAPException if there was an error in retrieving * @exception SOAPException if there was an error in retrieving
@ -384,11 +384,11 @@ public interface SOAPFault extends SOAPBodyElement {
public Iterator getFaultReasonLocales() throws SOAPException; public Iterator getFaultReasonLocales() throws SOAPException;
/** /**
* Returns an <code>Iterator</code> over a sequence of * Returns an {@code Iterator} over a sequence of
* <code>String</code> objects containing all of the Reason Text items for * {@code String} objects containing all of the Reason Text items for
* this <code>SOAPFault</code>. * this {@code SOAPFault}.
* *
* @return an <code>Iterator</code> over env:Fault/env:Reason/env:Text items. * @return an {@code Iterator} over env:Fault/env:Reason/env:Text items.
* *
* @exception SOAPException if there was an error in retrieving * @exception SOAPException if there was an error in retrieving
* the fault Reason texts. * the fault Reason texts.
@ -400,14 +400,14 @@ public interface SOAPFault extends SOAPBodyElement {
public Iterator getFaultReasonTexts() throws SOAPException; public Iterator getFaultReasonTexts() throws SOAPException;
/** /**
* Returns the Reason Text associated with the given <code>Locale</code>. * Returns the Reason Text associated with the given {@code Locale}.
* If more than one such Reason Text exists the first matching Text is * If more than one such Reason Text exists the first matching Text is
* returned * returned
* *
* @param locale -- the <code>Locale</code> for which a localized * @param locale -- the {@code Locale} for which a localized
* Reason Text is desired * Reason Text is desired
* *
* @return the Reason Text associated with <code>locale</code> * @return the Reason Text associated with {@code locale}
* *
* @see #getFaultString * @see #getFaultString
* *
@ -423,23 +423,23 @@ public interface SOAPFault extends SOAPBodyElement {
/** /**
* Appends or replaces a Reason Text item containing the specified * Appends or replaces a Reason Text item containing the specified
* text message and an <i>xml:lang</i> derived from * text message and an <i>xml:lang</i> derived from
* <code>locale</code>. If a Reason Text item with this * {@code locale}. If a Reason Text item with this
* <i>xml:lang</i> already exists its text value will be replaced * <i>xml:lang</i> already exists its text value will be replaced
* with <code>text</code>. * with {@code text}.
* The <code>locale</code> parameter should not be <code>null</code> * The {@code locale} parameter should not be {@code null}
* <P> * <P>
* Code sample: * Code sample:
* *
* <PRE> * <pre>{@code
* SOAPFault fault = ...; * SOAPFault fault = ...;
* fault.addFaultReasonText("Version Mismatch", Locale.ENGLISH); * fault.addFaultReasonText("Version Mismatch", Locale.ENGLISH);
* </PRE> * }</pre>
* *
* @param text -- reason message string * @param text -- reason message string
* @param locale -- Locale object representing the locale of the message * @param locale -- Locale object representing the locale of the message
* *
* @exception SOAPException if there was an error in adding the Reason text * @exception SOAPException if there was an error in adding the Reason text
* or the <code>locale</code> passed was <code>null</code>. * or the {@code locale} passed was {@code null}.
* @exception UnsupportedOperationException if this message does not * @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Reason. * support the SOAP 1.2 concept of Fault Reason.
* *
@ -450,11 +450,11 @@ public interface SOAPFault extends SOAPBodyElement {
/** /**
* Returns the optional Node element value for this * Returns the optional Node element value for this
* <code>SOAPFault</code> object. The Node element is * {@code SOAPFault} object. The Node element is
* optional in SOAP 1.2. * optional in SOAP 1.2.
* *
* @return Content of the env:Fault/env:Node element as a String * @return Content of the env:Fault/env:Node element as a String
* or <code>null</code> if none * or {@code null} if none
* *
* @exception UnsupportedOperationException if this message does not * @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Node. * support the SOAP 1.2 concept of Fault Node.
@ -465,11 +465,11 @@ public interface SOAPFault extends SOAPBodyElement {
/** /**
* Creates or replaces any existing Node element value for * Creates or replaces any existing Node element value for
* this <code>SOAPFault</code> object. The Node element * this {@code SOAPFault} object. The Node element
* is optional in SOAP 1.2. * is optional in SOAP 1.2.
* *
* @exception SOAPException if there was an error in setting the * @exception SOAPException if there was an error in setting the
* Node for this <code>SOAPFault</code> object. * Node for this {@code SOAPFault} object.
* @exception UnsupportedOperationException if this message does not * @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Node. * support the SOAP 1.2 concept of Fault Node.
* *
@ -480,11 +480,11 @@ public interface SOAPFault extends SOAPBodyElement {
/** /**
* Returns the optional Role element value for this * Returns the optional Role element value for this
* <code>SOAPFault</code> object. The Role element is * {@code SOAPFault} object. The Role element is
* optional in SOAP 1.2. * optional in SOAP 1.2.
* *
* @return Content of the env:Fault/env:Role element as a String * @return Content of the env:Fault/env:Role element as a String
* or <code>null</code> if none * or {@code null} if none
* *
* @exception UnsupportedOperationException if this message does not * @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Role. * support the SOAP 1.2 concept of Fault Role.
@ -495,13 +495,13 @@ public interface SOAPFault extends SOAPBodyElement {
/** /**
* Creates or replaces any existing Role element value for * Creates or replaces any existing Role element value for
* this <code>SOAPFault</code> object. The Role element * this {@code SOAPFault} object. The Role element
* is optional in SOAP 1.2. * is optional in SOAP 1.2.
* *
* @param uri - the URI of the Role * @param uri - the URI of the Role
* *
* @exception SOAPException if there was an error in setting the * @exception SOAPException if there was an error in setting the
* Role for this <code>SOAPFault</code> object. * Role for this {@code SOAPFault} object.
* *
* @exception UnsupportedOperationException if this message does not * @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Role. * support the SOAP 1.2 concept of Fault Role.

10
jaxws/src/java.xml.ws/share/classes/javax/xml/soap/SOAPFaultElement.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -27,11 +27,11 @@ package javax.xml.soap;
/** /**
* A representation of the contents in * A representation of the contents in
* a <code>SOAPFault</code> object. The <code>Detail</code> interface * a {@code SOAPFault} object. The {@code Detail} interface
* is a <code>SOAPFaultElement</code>. * is a {@code SOAPFaultElement}.
* <P> * <P>
* Content is added to a <code>SOAPFaultElement</code> using the * Content is added to a {@code SOAPFaultElement} using the
* <code>SOAPElement</code> method <code>addTextNode</code>. * {@code SOAPElement} method {@code addTextNode}.
* *
* @since 1.6 * @since 1.6
*/ */

166
jaxws/src/java.xml.ws/share/classes/javax/xml/soap/SOAPHeader.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -34,49 +34,49 @@ import javax.xml.namespace.QName;
* element. A SOAP header element consists of XML data that affects * element. A SOAP header element consists of XML data that affects
* the way the application-specific content is processed by the message * the way the application-specific content is processed by the message
* provider. For example, transaction semantics, authentication information, * provider. For example, transaction semantics, authentication information,
* and so on, can be specified as the content of a <code>SOAPHeader</code> * and so on, can be specified as the content of a {@code SOAPHeader}
* object. * object.
* <P> * <P>
* A <code>SOAPEnvelope</code> object contains an empty * A {@code SOAPEnvelope} object contains an empty
* <code>SOAPHeader</code> object by default. If the <code>SOAPHeader</code> * {@code SOAPHeader} object by default. If the {@code SOAPHeader}
* object, which is optional, is not needed, it can be retrieved and deleted * object, which is optional, is not needed, it can be retrieved and deleted
* with the following line of code. The variable <i>se</i> is a * with the following line of code. The variable <i>se</i> is a
* <code>SOAPEnvelope</code> object. * {@code SOAPEnvelope} object.
* <PRE> * <pre>{@code
* se.getHeader().detachNode(); * se.getHeader().detachNode();
* </PRE> * }</pre>
* *
* A <code>SOAPHeader</code> object is created with the <code>SOAPEnvelope</code> * A {@code SOAPHeader} object is created with the {@code SOAPEnvelope}
* method <code>addHeader</code>. This method, which creates a new header and adds it * method {@code addHeader}. This method, which creates a new header and adds it
* to the envelope, may be called only after the existing header has been removed. * to the envelope, may be called only after the existing header has been removed.
* *
* <PRE> * <pre>{@code
* se.getHeader().detachNode(); * se.getHeader().detachNode();
* SOAPHeader sh = se.addHeader(); * SOAPHeader sh = se.addHeader();
* </PRE> * }</pre>
* <P> * <P>
* A <code>SOAPHeader</code> object can have only <code>SOAPHeaderElement</code> * A {@code SOAPHeader} object can have only {@code SOAPHeaderElement}
* objects as its immediate children. The method <code>addHeaderElement</code> * objects as its immediate children. The method {@code addHeaderElement}
* creates a new <code>HeaderElement</code> object and adds it to the * creates a new {@code HeaderElement} object and adds it to the
* <code>SOAPHeader</code> object. In the following line of code, the * {@code SOAPHeader} object. In the following line of code, the
* argument to the method <code>addHeaderElement</code> is a <code>Name</code> * argument to the method {@code addHeaderElement} is a {@code Name}
* object that is the name for the new <code>HeaderElement</code> object. * object that is the name for the new {@code HeaderElement} object.
* <PRE> * <pre>{@code
* SOAPHeaderElement shElement = sh.addHeaderElement(name); * SOAPHeaderElement shElement = sh.addHeaderElement(name);
* </PRE> * }</pre>
* *
* @see SOAPHeaderElement * @see SOAPHeaderElement
* @since 1.6 * @since 1.6
*/ */
public interface SOAPHeader extends SOAPElement { public interface SOAPHeader extends SOAPElement {
/** /**
* Creates a new <code>SOAPHeaderElement</code> object initialized with the * Creates a new {@code SOAPHeaderElement} object initialized with the
* specified name and adds it to this <code>SOAPHeader</code> object. * specified name and adds it to this {@code SOAPHeader} object.
* *
* @param name a <code>Name</code> object with the name of the new * @param name a {@code Name} object with the name of the new
* <code>SOAPHeaderElement</code> object * {@code SOAPHeaderElement} object
* @return the new <code>SOAPHeaderElement</code> object that was * @return the new {@code SOAPHeaderElement} object that was
* inserted into this <code>SOAPHeader</code> object * inserted into this {@code SOAPHeader} object
* @exception SOAPException if a SOAP error occurs * @exception SOAPException if a SOAP error occurs
* @see SOAPHeader#addHeaderElement(javax.xml.namespace.QName) * @see SOAPHeader#addHeaderElement(javax.xml.namespace.QName)
*/ */
@ -84,13 +84,13 @@ public interface SOAPHeader extends SOAPElement {
throws SOAPException; throws SOAPException;
/** /**
* Creates a new <code>SOAPHeaderElement</code> object initialized with the * Creates a new {@code SOAPHeaderElement} object initialized with the
* specified qname and adds it to this <code>SOAPHeader</code> object. * specified qname and adds it to this {@code SOAPHeader} object.
* *
* @param qname a <code>QName</code> object with the qname of the new * @param qname a {@code QName} object with the qname of the new
* <code>SOAPHeaderElement</code> object * {@code SOAPHeaderElement} object
* @return the new <code>SOAPHeaderElement</code> object that was * @return the new {@code SOAPHeaderElement} object that was
* inserted into this <code>SOAPHeader</code> object * inserted into this {@code SOAPHeader} object
* @exception SOAPException if a SOAP error occurs * @exception SOAPException if a SOAP error occurs
* @see SOAPHeader#addHeaderElement(Name) * @see SOAPHeader#addHeaderElement(Name)
* @since 1.6, SAAJ 1.3 * @since 1.6, SAAJ 1.3
@ -99,19 +99,19 @@ public interface SOAPHeader extends SOAPElement {
throws SOAPException; throws SOAPException;
/** /**
* Returns an <code>Iterator</code> over all the <code>SOAPHeaderElement</code> objects * Returns an {@code Iterator} over all the {@code SOAPHeaderElement} objects
* in this <code>SOAPHeader</code> object * in this {@code SOAPHeader} object
* that have the specified <i>actor</i> and that have a MustUnderstand attribute * that have the specified <i>actor</i> and that have a MustUnderstand attribute
* whose value is equivalent to <code>true</code>. * whose value is equivalent to {@code true}.
* <p> * <p>
* In SOAP 1.2 the <i>env:actor</i> attribute is replaced by the <i>env:role</i> * In SOAP 1.2 the <i>env:actor</i> attribute is replaced by the <i>env:role</i>
* attribute, but with essentially the same semantics. * attribute, but with essentially the same semantics.
* *
* @param actor a <code>String</code> giving the URI of the <code>actor</code> / <code>role</code> * @param actor a {@code String} giving the URI of the {@code actor} / {@code role}
* for which to search * for which to search
* @return an <code>Iterator</code> object over all the * @return an {@code Iterator} object over all the
* <code>SOAPHeaderElement</code> objects that contain the specified * {@code SOAPHeaderElement} objects that contain the specified
* <code>actor</code> / <code>role</code> and are marked as MustUnderstand * {@code actor} / {@code role} and are marked as MustUnderstand
* @see #examineHeaderElements * @see #examineHeaderElements
* @see #extractHeaderElements * @see #extractHeaderElements
* @see SOAPConstants#URI_SOAP_ACTOR_NEXT * @see SOAPConstants#URI_SOAP_ACTOR_NEXT
@ -121,8 +121,8 @@ public interface SOAPHeader extends SOAPElement {
public Iterator examineMustUnderstandHeaderElements(String actor); public Iterator examineMustUnderstandHeaderElements(String actor);
/** /**
* Returns an <code>Iterator</code> over all the <code>SOAPHeaderElement</code> objects * Returns an {@code Iterator} over all the {@code SOAPHeaderElement} objects
* in this <code>SOAPHeader</code> object * in this {@code SOAPHeader} object
* that have the specified <i>actor</i>. * that have the specified <i>actor</i>.
* *
* An <i>actor</i> is a global attribute that indicates the intermediate * An <i>actor</i> is a global attribute that indicates the intermediate
@ -130,40 +130,40 @@ public interface SOAPHeader extends SOAPElement {
* receiver. An actor receives the message and processes it before sending * receiver. An actor receives the message and processes it before sending
* it on to the next actor. The default actor is the ultimate intended * it on to the next actor. The default actor is the ultimate intended
* recipient for the message, so if no actor attribute is included in a * recipient for the message, so if no actor attribute is included in a
* <code>SOAPHeader</code> object, it is sent to the ultimate receiver * {@code SOAPHeader} object, it is sent to the ultimate receiver
* along with the message body. * along with the message body.
* <p> * <p>
* In SOAP 1.2 the <i>env:actor</i> attribute is replaced by the <i>env:role</i> * In SOAP 1.2 the <i>env:actor</i> attribute is replaced by the <i>env:role</i>
* attribute, but with essentially the same semantics. * attribute, but with essentially the same semantics.
* *
* @param actor a <code>String</code> giving the URI of the <code>actor</code> / <code>role</code> * @param actor a {@code String} giving the URI of the {@code actor} / {@code role}
* for which to search * for which to search
* @return an <code>Iterator</code> object over all the * @return an {@code Iterator} object over all the
* <code>SOAPHeaderElement</code> objects that contain the specified * {@code SOAPHeaderElement} objects that contain the specified
* <code>actor</code> / <code>role</code> * {@code actor} / {@code role}
* @see #extractHeaderElements * @see #extractHeaderElements
* @see SOAPConstants#URI_SOAP_ACTOR_NEXT * @see SOAPConstants#URI_SOAP_ACTOR_NEXT
*/ */
public Iterator examineHeaderElements(String actor); public Iterator examineHeaderElements(String actor);
/** /**
* Returns an <code>Iterator</code> over all the <code>SOAPHeaderElement</code> objects * Returns an {@code Iterator} over all the {@code SOAPHeaderElement} objects
* in this <code>SOAPHeader</code> object * in this {@code SOAPHeader} object
* that have the specified <i>actor</i> and detaches them * that have the specified <i>actor</i> and detaches them
* from this <code>SOAPHeader</code> object. * from this {@code SOAPHeader} object.
* <P> * <P>
* This method allows an actor to process the parts of the * This method allows an actor to process the parts of the
* <code>SOAPHeader</code> object that apply to it and to remove * {@code SOAPHeader} object that apply to it and to remove
* them before passing the message on to the next actor. * them before passing the message on to the next actor.
* <p> * <p>
* In SOAP 1.2 the <i>env:actor</i> attribute is replaced by the <i>env:role</i> * In SOAP 1.2 the <i>env:actor</i> attribute is replaced by the <i>env:role</i>
* attribute, but with essentially the same semantics. * attribute, but with essentially the same semantics.
* *
* @param actor a <code>String</code> giving the URI of the <code>actor</code> / <code>role</code> * @param actor a {@code String} giving the URI of the {@code actor} / {@code role}
* for which to search * for which to search
* @return an <code>Iterator</code> object over all the * @return an {@code Iterator} object over all the
* <code>SOAPHeaderElement</code> objects that contain the specified * {@code SOAPHeaderElement} objects that contain the specified
* <code>actor</code> / <code>role</code> * {@code actor} / {@code role}
* *
* @see #examineHeaderElements * @see #examineHeaderElements
* @see SOAPConstants#URI_SOAP_ACTOR_NEXT * @see SOAPConstants#URI_SOAP_ACTOR_NEXT
@ -171,14 +171,14 @@ public interface SOAPHeader extends SOAPElement {
public Iterator extractHeaderElements(String actor); public Iterator extractHeaderElements(String actor);
/** /**
* Creates a new NotUnderstood <code>SOAPHeaderElement</code> object initialized * Creates a new NotUnderstood {@code SOAPHeaderElement} object initialized
* with the specified name and adds it to this <code>SOAPHeader</code> object. * with the specified name and adds it to this {@code SOAPHeader} object.
* This operation is supported only by SOAP 1.2. * This operation is supported only by SOAP 1.2.
* *
* @param name a <code>QName</code> object with the name of the * @param name a {@code QName} object with the name of the
* <code>SOAPHeaderElement</code> object that was not understood. * {@code SOAPHeaderElement} object that was not understood.
* @return the new <code>SOAPHeaderElement</code> object that was * @return the new {@code SOAPHeaderElement} object that was
* inserted into this <code>SOAPHeader</code> object * inserted into this {@code SOAPHeader} object
* @exception SOAPException if a SOAP error occurs. * @exception SOAPException if a SOAP error occurs.
* @exception UnsupportedOperationException if this is a SOAP 1.1 Header. * @exception UnsupportedOperationException if this is a SOAP 1.1 Header.
* @since 1.6, SAAJ 1.3 * @since 1.6, SAAJ 1.3
@ -187,15 +187,15 @@ public interface SOAPHeader extends SOAPElement {
throws SOAPException; throws SOAPException;
/** /**
* Creates a new Upgrade <code>SOAPHeaderElement</code> object initialized * Creates a new Upgrade {@code SOAPHeaderElement} object initialized
* with the specified List of supported SOAP URIs and adds it to this * with the specified List of supported SOAP URIs and adds it to this
* <code>SOAPHeader</code> object. * {@code SOAPHeader} object.
* This operation is supported on both SOAP 1.1 and SOAP 1.2 header. * This operation is supported on both SOAP 1.1 and SOAP 1.2 header.
* *
* @param supportedSOAPURIs an <code>Iterator</code> object with the URIs of SOAP * @param supportedSOAPURIs an {@code Iterator} object with the URIs of SOAP
* versions supported. * versions supported.
* @return the new <code>SOAPHeaderElement</code> object that was * @return the new {@code SOAPHeaderElement} object that was
* inserted into this <code>SOAPHeader</code> object * inserted into this {@code SOAPHeader} object
* @exception SOAPException if a SOAP error occurs. * @exception SOAPException if a SOAP error occurs.
* @since 1.6, SAAJ 1.3 * @since 1.6, SAAJ 1.3
*/ */
@ -203,14 +203,14 @@ public interface SOAPHeader extends SOAPElement {
throws SOAPException; throws SOAPException;
/** /**
* Creates a new Upgrade <code>SOAPHeaderElement</code> object initialized * Creates a new Upgrade {@code SOAPHeaderElement} object initialized
* with the specified array of supported SOAP URIs and adds it to this * with the specified array of supported SOAP URIs and adds it to this
* <code>SOAPHeader</code> object. * {@code SOAPHeader} object.
* This operation is supported on both SOAP 1.1 and SOAP 1.2 header. * This operation is supported on both SOAP 1.1 and SOAP 1.2 header.
* *
* @param supportedSoapUris an array of the URIs of SOAP versions supported. * @param supportedSoapUris an array of the URIs of SOAP versions supported.
* @return the new <code>SOAPHeaderElement</code> object that was * @return the new {@code SOAPHeaderElement} object that was
* inserted into this <code>SOAPHeader</code> object * inserted into this {@code SOAPHeader} object
* @exception SOAPException if a SOAP error occurs. * @exception SOAPException if a SOAP error occurs.
* @since 1.6, SAAJ 1.3 * @since 1.6, SAAJ 1.3
*/ */
@ -218,14 +218,14 @@ public interface SOAPHeader extends SOAPElement {
throws SOAPException; throws SOAPException;
/** /**
* Creates a new Upgrade <code>SOAPHeaderElement</code> object initialized * Creates a new Upgrade {@code SOAPHeaderElement} object initialized
* with the specified supported SOAP URI and adds it to this * with the specified supported SOAP URI and adds it to this
* <code>SOAPHeader</code> object. * {@code SOAPHeader} object.
* This operation is supported on both SOAP 1.1 and SOAP 1.2 header. * This operation is supported on both SOAP 1.1 and SOAP 1.2 header.
* *
* @param supportedSoapUri the URI of SOAP the version that is supported. * @param supportedSoapUri the URI of SOAP the version that is supported.
* @return the new <code>SOAPHeaderElement</code> object that was * @return the new {@code SOAPHeaderElement} object that was
* inserted into this <code>SOAPHeader</code> object * inserted into this {@code SOAPHeader} object
* @exception SOAPException if a SOAP error occurs. * @exception SOAPException if a SOAP error occurs.
* @since 1.6, SAAJ 1.3 * @since 1.6, SAAJ 1.3
*/ */
@ -233,12 +233,12 @@ public interface SOAPHeader extends SOAPElement {
throws SOAPException; throws SOAPException;
/** /**
* Returns an <code>Iterator</code> over all the <code>SOAPHeaderElement</code> objects * Returns an {@code Iterator} over all the {@code SOAPHeaderElement} objects
* in this <code>SOAPHeader</code> object. * in this {@code SOAPHeader} object.
* *
* @return an <code>Iterator</code> object over all the * @return an {@code Iterator} object over all the
* <code>SOAPHeaderElement</code> objects contained by this * {@code SOAPHeaderElement} objects contained by this
* <code>SOAPHeader</code> * {@code SOAPHeader}
* @see #extractAllHeaderElements * @see #extractAllHeaderElements
* *
* @since 1.6, SAAJ 1.2 * @since 1.6, SAAJ 1.2
@ -246,13 +246,13 @@ public interface SOAPHeader extends SOAPElement {
public Iterator examineAllHeaderElements(); public Iterator examineAllHeaderElements();
/** /**
* Returns an <code>Iterator</code> over all the <code>SOAPHeaderElement</code> objects * Returns an {@code Iterator} over all the {@code SOAPHeaderElement} objects
* in this <code>SOAPHeader</code> object and detaches them * in this {@code SOAPHeader} object and detaches them
* from this <code>SOAPHeader</code> object. * from this {@code SOAPHeader} object.
* *
* @return an <code>Iterator</code> object over all the * @return an {@code Iterator} object over all the
* <code>SOAPHeaderElement</code> objects contained by this * {@code SOAPHeaderElement} objects contained by this
* <code>SOAPHeader</code> * {@code SOAPHeader}
* *
* @see #examineAllHeaderElements * @see #examineAllHeaderElements
* *

60
jaxws/src/java.xml.ws/share/classes/javax/xml/soap/SOAPHeaderElement.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -28,25 +28,25 @@ package javax.xml.soap;
/** /**
* An object representing the contents in the SOAP header part of the * An object representing the contents in the SOAP header part of the
* SOAP envelope. * SOAP envelope.
* The immediate children of a <code>SOAPHeader</code> object can * The immediate children of a {@code SOAPHeader} object can
* be represented only as <code>SOAPHeaderElement</code> objects. * be represented only as {@code SOAPHeaderElement} objects.
* <P> * <P>
* A <code>SOAPHeaderElement</code> object can have other * A {@code SOAPHeaderElement} object can have other
* <code>SOAPElement</code> objects as its children. * {@code SOAPElement} objects as its children.
* *
* @since 1.6 * @since 1.6
*/ */
public interface SOAPHeaderElement extends SOAPElement { public interface SOAPHeaderElement extends SOAPElement {
/** /**
* Sets the actor associated with this <code>SOAPHeaderElement</code> * Sets the actor associated with this {@code SOAPHeaderElement}
* object to the specified actor. The default value of an actor is: * object to the specified actor. The default value of an actor is:
* <code>SOAPConstants.URI_SOAP_ACTOR_NEXT</code> * {@code SOAPConstants.URI_SOAP_ACTOR_NEXT}
* <P> * <P>
* If this <code>SOAPHeaderElement</code> supports SOAP 1.2 then this call is * If this {@code SOAPHeaderElement} supports SOAP 1.2 then this call is
* equivalent to {@link #setRole(String)} * equivalent to {@link #setRole(String)}
* *
* @param actorURI a <code>String</code> giving the URI of the actor * @param actorURI a {@code String} giving the URI of the actor
* to set * to set
* *
* @exception IllegalArgumentException if there is a problem in * @exception IllegalArgumentException if there is a problem in
@ -57,10 +57,10 @@ public interface SOAPHeaderElement extends SOAPElement {
public void setActor(String actorURI); public void setActor(String actorURI);
/** /**
* Sets the <code>Role</code> associated with this <code>SOAPHeaderElement</code> * Sets the {@code Role} associated with this {@code SOAPHeaderElement}
* object to the specified <code>Role</code>. * object to the specified {@code Role}.
* *
* @param uri - the URI of the <code>Role</code> * @param uri - the URI of the {@code Role}
* *
* @throws SOAPException if there is an error in setting the role * @throws SOAPException if there is an error in setting the role
* *
@ -73,20 +73,20 @@ public interface SOAPHeaderElement extends SOAPElement {
/** /**
* Returns the uri of the <i>actor</i> attribute of this * Returns the uri of the <i>actor</i> attribute of this
* <code>SOAPHeaderElement</code>. * {@code SOAPHeaderElement}.
*<P> *<P>
* If this <code>SOAPHeaderElement</code> supports SOAP 1.2 then this call is * If this {@code SOAPHeaderElement} supports SOAP 1.2 then this call is
* equivalent to {@link #getRole()} * equivalent to {@link #getRole()}
* @return a <code>String</code> giving the URI of the actor * @return a {@code String} giving the URI of the actor
* @see #setActor * @see #setActor
*/ */
public String getActor(); public String getActor();
/** /**
* Returns the value of the <i>Role</i> attribute of this * Returns the value of the <i>Role</i> attribute of this
* <code>SOAPHeaderElement</code>. * {@code SOAPHeaderElement}.
* *
* @return a <code>String</code> giving the URI of the <code>Role</code> * @return a {@code String} giving the URI of the {@code Role}
* *
* @exception UnsupportedOperationException if this message does not * @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Role. * support the SOAP 1.2 concept of Fault Role.
@ -96,16 +96,16 @@ public interface SOAPHeaderElement extends SOAPElement {
public String getRole(); public String getRole();
/** /**
* Sets the mustUnderstand attribute for this <code>SOAPHeaderElement</code> * Sets the mustUnderstand attribute for this {@code SOAPHeaderElement}
* object to be either true or false. * object to be either true or false.
* <P> * <P>
* If the mustUnderstand attribute is on, the actor who receives the * If the mustUnderstand attribute is on, the actor who receives the
* <code>SOAPHeaderElement</code> must process it correctly. This * {@code SOAPHeaderElement} must process it correctly. This
* ensures, for example, that if the <code>SOAPHeaderElement</code> * ensures, for example, that if the {@code SOAPHeaderElement}
* object modifies the message, that the message is being modified correctly. * object modifies the message, that the message is being modified correctly.
* *
* @param mustUnderstand <code>true</code> to set the mustUnderstand * @param mustUnderstand {@code true} to set the mustUnderstand
* attribute to true; <code>false</code> to set it to false * attribute to true; {@code false} to set it to false
* *
* @exception IllegalArgumentException if there is a problem in * @exception IllegalArgumentException if there is a problem in
* setting the mustUnderstand attribute * setting the mustUnderstand attribute
@ -116,16 +116,16 @@ public interface SOAPHeaderElement extends SOAPElement {
/** /**
* Returns the boolean value of the mustUnderstand attribute for this * Returns the boolean value of the mustUnderstand attribute for this
* <code>SOAPHeaderElement</code>. * {@code SOAPHeaderElement}.
* *
* @return <code>true</code> if the mustUnderstand attribute of this * @return {@code true} if the mustUnderstand attribute of this
* <code>SOAPHeaderElement</code> object is turned on; <code>false</code> * {@code SOAPHeaderElement} object is turned on; {@code false}
* otherwise * otherwise
*/ */
public boolean getMustUnderstand(); public boolean getMustUnderstand();
/** /**
* Sets the <i>relay</i> attribute for this <code>SOAPHeaderElement</code> to be * Sets the <i>relay</i> attribute for this {@code SOAPHeaderElement} to be
* either true or false. * either true or false.
* <P> * <P>
* The SOAP relay attribute is set to true to indicate that the SOAP header * The SOAP relay attribute is set to true to indicate that the SOAP header
@ -133,7 +133,7 @@ public interface SOAPHeaderElement extends SOAPElement {
* but not actually process it. This attribute is ignored on header blocks * but not actually process it. This attribute is ignored on header blocks
* whose mustUnderstand attribute is set to true or that are targeted at * whose mustUnderstand attribute is set to true or that are targeted at
* the ultimate reciever (which is the default). The default value of this * the ultimate reciever (which is the default). The default value of this
* attribute is <code>false</code>. * attribute is {@code false}.
* *
* @param relay the new value of the <i>relay</i> attribute * @param relay the new value of the <i>relay</i> attribute
* *
@ -151,10 +151,10 @@ public interface SOAPHeaderElement extends SOAPElement {
/** /**
* Returns the boolean value of the <i>relay</i> attribute for this * Returns the boolean value of the <i>relay</i> attribute for this
* <code>SOAPHeaderElement</code> * {@code SOAPHeaderElement}
* *
* @return <code>true</code> if the relay attribute is turned on; * @return {@code true} if the relay attribute is turned on;
* <code>false</code> otherwise * {@code false} otherwise
* *
* @exception UnsupportedOperationException if this message does not * @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Relay attribute. * support the SOAP 1.2 concept of Relay attribute.

17
jaxws/src/java.xml.ws/share/classes/javax/xml/soap/SOAPMessage.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -55,12 +55,12 @@ import javax.activation.DataHandler;
* object, and the {@code SOAPEnvelope} object is used to retrieve the * object, and the {@code SOAPEnvelope} object is used to retrieve the
* {@code SOAPBody} and {@code SOAPHeader} objects. * {@code SOAPBody} and {@code SOAPHeader} objects.
* *
* <PRE> * <pre>{@code
* SOAPPart sp = message.getSOAPPart(); * SOAPPart sp = message.getSOAPPart();
* SOAPEnvelope se = sp.getEnvelope(); * SOAPEnvelope se = sp.getEnvelope();
* SOAPBody sb = se.getBody(); * SOAPBody sb = se.getBody();
* SOAPHeader sh = se.getHeader(); * SOAPHeader sh = se.getHeader();
* </PRE> * }</pre>
* *
* <P> * <P>
* In addition to the mandatory {@code SOAPPart} object, a {@code SOAPMessage} * In addition to the mandatory {@code SOAPPart} object, a {@code SOAPMessage}
@ -103,6 +103,7 @@ import javax.activation.DataHandler;
* @since 1.6 * @since 1.6
*/ */
public abstract class SOAPMessage { public abstract class SOAPMessage {
/** /**
* Specifies the character type encoding for the SOAP Message. Valid values * Specifies the character type encoding for the SOAP Message. Valid values
* include "utf-8" and "utf-16". See vendor documentation for additional * include "utf-8" and "utf-16". See vendor documentation for additional
@ -147,7 +148,7 @@ public abstract class SOAPMessage {
/** /**
* Gets the SOAP part of this {@code SOAPMessage} object. * Gets the SOAP part of this {@code SOAPMessage} object.
* <P> * <p>
* {@code SOAPMessage} object contains one or more attachments, the * {@code SOAPMessage} object contains one or more attachments, the
* SOAP Part must be the first MIME body part in the message. * SOAP Part must be the first MIME body part in the message.
* *
@ -161,8 +162,7 @@ public abstract class SOAPMessage {
* *
* @return the {@code SOAPBody} object contained by this {@code SOAPMessage} * @return the {@code SOAPBody} object contained by this {@code SOAPMessage}
* object * object
* @exception SOAPException * @throws SOAPException if the SOAP Body does not exist or cannot be retrieved
* if the SOAP Body does not exist or cannot be retrieved
* @since 1.6, SAAJ 1.2 * @since 1.6, SAAJ 1.2
*/ */
public SOAPBody getSOAPBody() throws SOAPException { public SOAPBody getSOAPBody() throws SOAPException {
@ -185,7 +185,7 @@ public abstract class SOAPMessage {
/** /**
* Removes all {@code AttachmentPart} objects that have been added * Removes all {@code AttachmentPart} objects that have been added
* to this {@code SOAPMessage} object. * to this {@code SOAPMessage} object.
* <P> * <p>
* This method does not touch the SOAP part. * This method does not touch the SOAP part.
*/ */
public abstract void removeAllAttachments(); public abstract void removeAllAttachments();
@ -212,8 +212,7 @@ public abstract class SOAPMessage {
* entries that match the specified headers. Note that a returned * entries that match the specified headers. Note that a returned
* attachment could have headers in addition to those specified. * attachment could have headers in addition to those specified.
* *
* @param headers * @param headers a {@code MimeHeaders} object containing the MIME
* a {@code MimeHeaders} object containing the MIME
* headers for which to search * headers for which to search
* @return an iterator over all attachments that have a header that matches * @return an iterator over all attachments that have a header that matches
* one of the given headers * one of the given headers

6
jaxws/src/java.xml.ws/share/classes/javax/xml/soap/SOAPPart.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -54,9 +54,9 @@ import javax.xml.transform.Source;
* calling the method {@code SOAPMessage.getSOAPPart}. The * calling the method {@code SOAPMessage.getSOAPPart}. The
* following line of code, in which {@code message} is a * following line of code, in which {@code message} is a
* {@code SOAPMessage} object, retrieves the SOAP part of a message. * {@code SOAPMessage} object, retrieves the SOAP part of a message.
* <PRE> * <pre>{@code
* SOAPPart soapPart = message.getSOAPPart(); * SOAPPart soapPart = message.getSOAPPart();
* </PRE> * }</pre>
* <P> * <P>
* A {@code SOAPPart} object contains a {@code SOAPEnvelope} object, * A {@code SOAPPart} object contains a {@code SOAPEnvelope} object,
* which in turn contains a {@code SOAPBody} object and a * which in turn contains a {@code SOAPBody} object and a

10
jaxws/src/java.xml.ws/share/classes/javax/xml/soap/Text.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -26,7 +26,7 @@
package javax.xml.soap; package javax.xml.soap;
/** /**
* A representation of a node whose value is text. A <code>Text</code> object * A representation of a node whose value is text. A {@code Text} object
* may represent text that is content or text that is a comment. * may represent text that is content or text that is a comment.
* *
* @since 1.6 * @since 1.6
@ -34,10 +34,10 @@ package javax.xml.soap;
public interface Text extends Node, org.w3c.dom.Text { public interface Text extends Node, org.w3c.dom.Text {
/** /**
* Retrieves whether this <code>Text</code> object represents a comment. * Retrieves whether this {@code Text} object represents a comment.
* *
* @return <code>true</code> if this <code>Text</code> object is a * @return {@code true} if this {@code Text} object is a
* comment; <code>false</code> otherwise * comment; {@code false} otherwise
*/ */
public boolean isComment(); public boolean isComment();
} }

4
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/AsyncHandler.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -25,7 +25,7 @@
package javax.xml.ws; package javax.xml.ws;
/** The <code>AsyncHandler</code> interface is implemented by /** The {@code AsyncHandler} interface is implemented by
* clients that wish to receive callback notification of the completion of * clients that wish to receive callback notification of the completion of
* service endpoint operations invoked asynchronously. * service endpoint operations invoked asynchronously.
* *

62
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/BindingProvider.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -29,7 +29,7 @@ import java.util.Map;
import javax.xml.ws.wsaddressing.W3CEndpointReference; import javax.xml.ws.wsaddressing.W3CEndpointReference;
/** /**
* The <code>BindingProvider</code> interface provides access to the * The {@code BindingProvider} interface provides access to the
* protocol binding and associated context objects for request and * protocol binding and associated context objects for request and
* response message processing. * response message processing.
* *
@ -40,14 +40,14 @@ import javax.xml.ws.wsaddressing.W3CEndpointReference;
public interface BindingProvider { public interface BindingProvider {
/** /**
* Standard property: User name for authentication. * Standard property: User name for authentication.
* <p>Type: <code>java.lang.String</code> * <p>Type: {@code java.lang.String}
**/ **/
public static final String USERNAME_PROPERTY = public static final String USERNAME_PROPERTY =
"javax.xml.ws.security.auth.username"; "javax.xml.ws.security.auth.username";
/** /**
* Standard property: Password for authentication. * Standard property: Password for authentication.
* <p>Type: <code>java.lang.String</code> * <p>Type: {@code java.lang.String}
**/ **/
public static final String PASSWORD_PROPERTY = public static final String PASSWORD_PROPERTY =
"javax.xml.ws.security.auth.password"; "javax.xml.ws.security.auth.password";
@ -57,7 +57,7 @@ public interface BindingProvider {
* URI scheme for the endpoint address specification MUST * URI scheme for the endpoint address specification MUST
* correspond to the protocol/transport binding for the * correspond to the protocol/transport binding for the
* binding in use. * binding in use.
* <p>Type: <code>java.lang.String</code> * <p>Type: {@code java.lang.String}
**/ **/
public static final String ENDPOINT_ADDRESS_PROPERTY = public static final String ENDPOINT_ADDRESS_PROPERTY =
"javax.xml.ws.service.endpoint.address"; "javax.xml.ws.service.endpoint.address";
@ -66,10 +66,10 @@ public interface BindingProvider {
* Standard property: This boolean property is used by a service * Standard property: This boolean property is used by a service
* client to indicate whether or not it wants to participate in * client to indicate whether or not it wants to participate in
* a session with a service endpoint. If this property is set to * a session with a service endpoint. If this property is set to
* <code>true</code>, the service client indicates that it wants the session * {@code true}, the service client indicates that it wants the session
* to be maintained. If set to <code>false</code>, the session is not maintained. * to be maintained. If set to {@code false}, the session is not maintained.
* The default value for this property is <code>false</code>. * The default value for this property is {@code false}.
* <p>Type: <code>java.lang.Boolean</code> * <p>Type: {@code java.lang.Boolean}
**/ **/
public static final String SESSION_MAINTAIN_PROPERTY = public static final String SESSION_MAINTAIN_PROPERTY =
"javax.xml.ws.session.maintain"; "javax.xml.ws.session.maintain";
@ -77,29 +77,29 @@ public interface BindingProvider {
/** /**
* Standard property for SOAPAction. This boolean property * Standard property for SOAPAction. This boolean property
* indicates whether or not the value of the * indicates whether or not the value of the
* <code>javax.xml.ws.soap.http.soapaction.uri</code> property * {@code javax.xml.ws.soap.http.soapaction.uri} property
* is used for the value of the SOAPAction. The * is used for the value of the SOAPAction. The
* default value of this property is <code>false</code> indicating * default value of this property is {@code false} indicating
* that the * that the
* <code>javax.xml.ws.soap.http.soapaction.uri</code> property * {@code javax.xml.ws.soap.http.soapaction.uri} property
* is not used for the value of the SOAPAction, however, * is not used for the value of the SOAPAction, however,
* if WS-Addressing is enabled, the default value is * if WS-Addressing is enabled, the default value is
* <code>true</code>. * {@code true}.
* *
* <p>Type: <code>java.lang.Boolean</code> * <p>Type: {@code java.lang.Boolean}
**/ **/
public static final String SOAPACTION_USE_PROPERTY = public static final String SOAPACTION_USE_PROPERTY =
"javax.xml.ws.soap.http.soapaction.use"; "javax.xml.ws.soap.http.soapaction.use";
/** /**
* Standard property for SOAPAction. Indicates the SOAPAction * Standard property for SOAPAction. Indicates the SOAPAction
* URI if the <code>javax.xml.ws.soap.http.soapaction.use</code> * URI if the {@code javax.xml.ws.soap.http.soapaction.use}
* property is set to <code>true</code>. If WS-Addressing * property is set to {@code true}. If WS-Addressing
* is enabled, this value will also be used for the value of the * is enabled, this value will also be used for the value of the
* WS-Addressing Action header. If this property is not set, * WS-Addressing Action header. If this property is not set,
* the default SOAPAction and WS-Addressing Action will be sent. * the default SOAPAction and WS-Addressing Action will be sent.
* *
* <p>Type: <code>java.lang.String</code> * <p>Type: {@code java.lang.String}
**/ **/
public static final String SOAPACTION_URI_PROPERTY = public static final String SOAPACTION_URI_PROPERTY =
"javax.xml.ws.soap.http.soapaction.uri"; "javax.xml.ws.soap.http.soapaction.uri";
@ -139,18 +139,18 @@ public interface BindingProvider {
/** /**
* Returns the <code>EndpointReference</code> associated with * Returns the {@code EndpointReference} associated with
* this <code>BindingProvider</code> instance. * this {@code BindingProvider} instance.
* <p> * <p>
* If the Binding for this <code>bindingProvider</code> is * If the Binding for this {@code bindingProvider} is
* either SOAP1.1/HTTP or SOAP1.2/HTTP, then a * either SOAP1.1/HTTP or SOAP1.2/HTTP, then a
* <code>W3CEndpointReference</code> MUST be returned. * {@code W3CEndpointReference} MUST be returned.
* *
* @return EndpointReference of the target endpoint associated with this * @return EndpointReference of the target endpoint associated with this
* <code>BindingProvider</code> instance. * {@code BindingProvider} instance.
* *
* @throws java.lang.UnsupportedOperationException If this * @throws java.lang.UnsupportedOperationException If this
* <code>BindingProvider</code> uses the XML/HTTP binding. * {@code BindingProvider} uses the XML/HTTP binding.
* *
* @see W3CEndpointReference * @see W3CEndpointReference
* *
@ -160,21 +160,21 @@ public interface BindingProvider {
/** /**
* Returns the <code>EndpointReference</code> associated with * Returns the {@code EndpointReference} associated with
* this <code>BindingProvider</code> instance. The instance * this {@code BindingProvider} instance. The instance
* returned will be of type <code>clazz</code>. * returned will be of type {@code clazz}.
* *
* @param clazz Specifies the type of <code>EndpointReference</code> * @param clazz Specifies the type of {@code EndpointReference}
* that MUST be returned. * that MUST be returned.
* @return EndpointReference of the target endpoint associated with this * @return EndpointReference of the target endpoint associated with this
* <code>BindingProvider</code> instance. MUST be of type * {@code BindingProvider} instance. MUST be of type
* <code>clazz</code>. * {@code clazz}.
* @throws WebServiceException If the Class <code>clazz</code> * @throws WebServiceException If the Class {@code clazz}
* is not supported by this implementation. * is not supported by this implementation.
* @throws java.lang.UnsupportedOperationException If this * @throws java.lang.UnsupportedOperationException If this
* <code>BindingProvider</code> uses the XML/HTTP binding. * {@code BindingProvider} uses the XML/HTTP binding.
* *
* @since 1.6, JAX-WS 2.1 * @since 1.6, JAX-WS 2.1
*/ */

6
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/BindingType.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -32,7 +32,7 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy; import java.lang.annotation.RetentionPolicy;
/** /**
* The <code>BindingType</code> annotation is used to * The {@code BindingType} annotation is used to
* specify the binding to use for a web service * specify the binding to use for a web service
* endpoint implementation class. * endpoint implementation class.
* <p> * <p>
@ -50,7 +50,7 @@ public @interface BindingType {
* A binding identifier (a URI). * A binding identifier (a URI).
* If not specified, the default is the SOAP 1.1 / HTTP binding. * If not specified, the default is the SOAP 1.1 / HTTP binding.
* <p> * <p>
* See the <code>SOAPBinding</code> and <code>HTTPBinding</code> * See the {@code SOAPBinding} and {@code HTTPBinding}
* for the definition of the standard binding identifiers. * for the definition of the standard binding identifiers.
* *
* @see javax.xml.ws.Binding * @see javax.xml.ws.Binding

118
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/Endpoint.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -37,23 +37,23 @@ import org.w3c.dom.Element;
* A Web service endpoint. * A Web service endpoint.
* *
* <p>Endpoints are created using the static methods defined in this * <p>Endpoints are created using the static methods defined in this
* class. An endpoint is always tied to one <code>Binding</code> * class. An endpoint is always tied to one {@code Binding}
* and one implementor, both set at endpoint creation time. * and one implementor, both set at endpoint creation time.
* *
* <p>An endpoint is either in a published or an unpublished state. * <p>An endpoint is either in a published or an unpublished state.
* The <code>publish</code> methods can be used to start publishing * The {@code publish} methods can be used to start publishing
* an endpoint, at which point it starts accepting incoming requests. * an endpoint, at which point it starts accepting incoming requests.
* Conversely, the <code>stop</code> method can be used to stop * Conversely, the {@code stop} method can be used to stop
* accepting incoming requests and take the endpoint down. * accepting incoming requests and take the endpoint down.
* Once stopped, an endpoint cannot be published again. * Once stopped, an endpoint cannot be published again.
* *
* <p>An <code>Executor</code> may be set on the endpoint in order * <p>An {@code Executor} may be set on the endpoint in order
* to gain better control over the threads used to dispatch incoming * to gain better control over the threads used to dispatch incoming
* requests. For instance, thread pooling with certain parameters * requests. For instance, thread pooling with certain parameters
* can be enabled by creating a <code>ThreadPoolExecutor</code> and * can be enabled by creating a {@code ThreadPoolExecutor} and
* registering it with the endpoint. * registering it with the endpoint.
* *
* <p>Handler chains can be set using the contained <code>Binding</code>. * <p>Handler chains can be set using the contained {@code Binding}.
* *
* <p>An endpoint may have a list of metadata documents, such as WSDL * <p>An endpoint may have a list of metadata documents, such as WSDL
* and XMLSchema documents, bound to it. At publishing time, the * and XMLSchema documents, bound to it. At publishing time, the
@ -114,8 +114,8 @@ public abstract class Endpoint {
* *
* @param implementor The endpoint implementor. * @param implementor The endpoint implementor.
* @param features A list of WebServiceFeature to configure on the * @param features A list of WebServiceFeature to configure on the
* endpoint. Supported features not in the <code>features * endpoint. Supported features not in the {@code features
* </code> parameter will have their default values. * } parameter will have their default values.
* *
* *
* @return The newly created endpoint. * @return The newly created endpoint.
@ -135,7 +135,7 @@ public abstract class Endpoint {
* {@link javax.xml.ws.Endpoint#publish(Object)} methods. * {@link javax.xml.ws.Endpoint#publish(Object)} methods.
* *
* @param bindingId A URI specifying the binding to use. If the bindingID is * @param bindingId A URI specifying the binding to use. If the bindingID is
* <code>null</code> and no binding is specified via a BindingType * {@code null} and no binding is specified via a BindingType
* annotation then a default SOAP 1.1 / HTTP binding MUST be used. * annotation then a default SOAP 1.1 / HTTP binding MUST be used.
* *
* @param implementor The endpoint implementor. * @param implementor The endpoint implementor.
@ -156,14 +156,14 @@ public abstract class Endpoint {
* {@link javax.xml.ws.Endpoint#publish(Object)} methods. * {@link javax.xml.ws.Endpoint#publish(Object)} methods.
* *
* @param bindingId A URI specifying the binding to use. If the bindingID is * @param bindingId A URI specifying the binding to use. If the bindingID is
* <code>null</code> and no binding is specified via a BindingType * {@code null} and no binding is specified via a BindingType
* annotation then a default SOAP 1.1 / HTTP binding MUST be used. * annotation then a default SOAP 1.1 / HTTP binding MUST be used.
* *
* @param implementor The endpoint implementor. * @param implementor The endpoint implementor.
* *
* @param features A list of WebServiceFeature to configure on the * @param features A list of WebServiceFeature to configure on the
* endpoint. Supported features not in the <code>features * endpoint. Supported features not in the {@code features
* </code> parameter will have their default values. * } parameter will have their default values.
* *
* @return The newly created endpoint. * @return The newly created endpoint.
* @since 1.7, JAX-WS 2.2 * @since 1.7, JAX-WS 2.2
@ -205,9 +205,9 @@ public abstract class Endpoint {
* If the endpoint has been published already or it has been stopped. * If the endpoint has been published already or it has been stopped.
* *
* @throws java.lang.SecurityException * @throws java.lang.SecurityException
* If a <code>java.lang.SecurityManger</code> * If a {@code java.lang.SecurityManger}
* is being used and the application doesn't have the * is being used and the application doesn't have the
* <code>WebServicePermission("publishEndpoint")</code> permission. * {@code WebServicePermission("publishEndpoint")} permission.
**/ **/
public abstract void publish(String address); public abstract void publish(String address);
@ -231,9 +231,9 @@ public abstract class Endpoint {
* @return The newly created endpoint. * @return The newly created endpoint.
* *
* @throws java.lang.SecurityException * @throws java.lang.SecurityException
* If a <code>java.lang.SecurityManger</code> * If a {@code java.lang.SecurityManger}
* is being used and the application doesn't have the * is being used and the application doesn't have the
* <code>WebServicePermission("publishEndpoint")</code> permission. * {@code WebServicePermission("publishEndpoint")} permission.
* *
**/ **/
public static Endpoint publish(String address, Object implementor) { public static Endpoint publish(String address, Object implementor) {
@ -258,14 +258,14 @@ public abstract class Endpoint {
* URI schemes. * URI schemes.
* @param implementor The endpoint implementor. * @param implementor The endpoint implementor.
* @param features A list of WebServiceFeature to configure on the * @param features A list of WebServiceFeature to configure on the
* endpoint. Supported features not in the <code>features * endpoint. Supported features not in the {@code features
* </code> parameter will have their default values. * } parameter will have their default values.
* @return The newly created endpoint. * @return The newly created endpoint.
* *
* @throws java.lang.SecurityException * @throws java.lang.SecurityException
* If a <code>java.lang.SecurityManger</code> * If a {@code java.lang.SecurityManger}
* is being used and the application doesn't have the * is being used and the application doesn't have the
* <code>WebServicePermission("publishEndpoint")</code> permission. * {@code WebServicePermission("publishEndpoint")} permission.
* @since 1.7, JAX-WS 2.2 * @since 1.7, JAX-WS 2.2
*/ */
public static Endpoint publish(String address, Object implementor, WebServiceFeature ... features) { public static Endpoint publish(String address, Object implementor, WebServiceFeature ... features) {
@ -294,9 +294,9 @@ public abstract class Endpoint {
* If the endpoint has been published already or it has been stopped. * If the endpoint has been published already or it has been stopped.
* *
* @throws java.lang.SecurityException * @throws java.lang.SecurityException
* If a <code>java.lang.SecurityManger</code> * If a {@code java.lang.SecurityManger}
* is being used and the application doesn't have the * is being used and the application doesn't have the
* <code>WebServicePermission("publishEndpoint")</code> permission. * {@code WebServicePermission("publishEndpoint")} permission.
**/ **/
public abstract void publish(Object serverContext); public abstract void publish(Object serverContext);
@ -327,9 +327,9 @@ public abstract class Endpoint {
* If the endpoint has been published already or it has been stopped. * If the endpoint has been published already or it has been stopped.
* *
* @throws java.lang.SecurityException * @throws java.lang.SecurityException
* If a <code>java.lang.SecurityManger</code> * If a {@code java.lang.SecurityManger}
* is being used and the application doesn't have the * is being used and the application doesn't have the
* <code>WebServicePermission("publishEndpoint")</code> permission. * {@code WebServicePermission("publishEndpoint")} permission.
* @since 1.7, JAX-WS 2.2 * @since 1.7, JAX-WS 2.2
*/ */
public void publish(HttpContext serverContext) { public void publish(HttpContext serverContext) {
@ -348,14 +348,14 @@ public abstract class Endpoint {
/** /**
* Returns true if the endpoint is in the published state. * Returns true if the endpoint is in the published state.
* *
* @return <code>true</code> if the endpoint is in the published state. * @return {@code true} if the endpoint is in the published state.
**/ **/
public abstract boolean isPublished(); public abstract boolean isPublished();
/** /**
* Returns a list of metadata documents for the service. * Returns a list of metadata documents for the service.
* *
* @return <code>List&lt;javax.xml.transform.Source&gt;</code> A list of metadata documents for the service * @return {@code List<javax.xml.transform.Source>} A list of metadata documents for the service
**/ **/
public abstract List<javax.xml.transform.Source> getMetadata(); public abstract List<javax.xml.transform.Source> getMetadata();
@ -372,12 +372,12 @@ public abstract class Endpoint {
public abstract void setMetadata(List<javax.xml.transform.Source> metadata); public abstract void setMetadata(List<javax.xml.transform.Source> metadata);
/** /**
* Returns the executor for this <code>Endpoint</code>instance. * Returns the executor for this {@code Endpoint}instance.
* *
* The executor is used to dispatch an incoming request to * The executor is used to dispatch an incoming request to
* the implementor object. * the implementor object.
* *
* @return The <code>java.util.concurrent.Executor</code> to be * @return The {@code java.util.concurrent.Executor} to be
* used to dispatch a request. * used to dispatch a request.
* *
* @see java.util.concurrent.Executor * @see java.util.concurrent.Executor
@ -385,17 +385,17 @@ public abstract class Endpoint {
public abstract java.util.concurrent.Executor getExecutor(); public abstract java.util.concurrent.Executor getExecutor();
/** /**
* Sets the executor for this <code>Endpoint</code> instance. * Sets the executor for this {@code Endpoint} instance.
* *
* The executor is used to dispatch an incoming request to * The executor is used to dispatch an incoming request to
* the implementor object. * the implementor object.
* *
* If this <code>Endpoint</code> is published using the * If this {@code Endpoint} is published using the
* <code>publish(Object)</code> method and the specified server * {@code publish(Object)} method and the specified server
* context defines its own threading behavior, the executor * context defines its own threading behavior, the executor
* may be ignored. * may be ignored.
* *
* @param executor The <code>java.util.concurrent.Executor</code> * @param executor The {@code java.util.concurrent.Executor}
* to be used to dispatch a request. * to be used to dispatch a request.
* *
* @throws SecurityException If the instance does not support * @throws SecurityException If the instance does not support
@ -408,7 +408,7 @@ public abstract class Endpoint {
/** /**
* Returns the property bag for this <code>Endpoint</code> instance. * Returns the property bag for this {@code Endpoint} instance.
* *
* @return Map&lt;String,Object&gt; The property bag * @return Map&lt;String,Object&gt; The property bag
* associated with this instance. * associated with this instance.
@ -416,7 +416,7 @@ public abstract class Endpoint {
public abstract Map<String,Object> getProperties(); public abstract Map<String,Object> getProperties();
/** /**
* Sets the property bag for this <code>Endpoint</code> instance. * Sets the property bag for this {@code Endpoint} instance.
* *
* @param properties The property bag associated with * @param properties The property bag associated with
* this instance. * this instance.
@ -424,24 +424,24 @@ public abstract class Endpoint {
public abstract void setProperties(Map<String,Object> properties); public abstract void setProperties(Map<String,Object> properties);
/** /**
* Returns the <code>EndpointReference</code> associated with * Returns the {@code EndpointReference} associated with
* this <code>Endpoint</code> instance. * this {@code Endpoint} instance.
* <p> * <p>
* If the Binding for this <code>bindingProvider</code> is * If the Binding for this {@code bindingProvider} is
* either SOAP1.1/HTTP or SOAP1.2/HTTP, then a * either SOAP1.1/HTTP or SOAP1.2/HTTP, then a
* <code>W3CEndpointReference</code> MUST be returned. * {@code W3CEndpointReference} MUST be returned.
* *
* @param referenceParameters Reference parameters to be associated with the * @param referenceParameters Reference parameters to be associated with the
* returned <code>EndpointReference</code> instance. * returned {@code EndpointReference} instance.
* @return EndpointReference of this <code>Endpoint</code> instance. * @return EndpointReference of this {@code Endpoint} instance.
* If the returned <code>EndpointReference</code> is of type * If the returned {@code EndpointReference} is of type
* <code>W3CEndpointReference</code> then it MUST contain the * {@code W3CEndpointReference} then it MUST contain the
* the specified <code>referenceParameters</code>. * the specified {@code referenceParameters}.
* @throws WebServiceException If any error in the creation of * @throws WebServiceException If any error in the creation of
* the <code>EndpointReference</code> or if the <code>Endpoint</code> is * the {@code EndpointReference} or if the {@code Endpoint} is
* not in the published state. * not in the published state.
* @throws UnsupportedOperationException If this <code>BindingProvider</code> * @throws UnsupportedOperationException If this {@code BindingProvider}
* uses the XML/HTTP binding. * uses the XML/HTTP binding.
* *
* @see W3CEndpointReference * @see W3CEndpointReference
@ -452,23 +452,23 @@ public abstract class Endpoint {
/** /**
* Returns the <code>EndpointReference</code> associated with * Returns the {@code EndpointReference} associated with
* this <code>Endpoint</code> instance. * this {@code Endpoint} instance.
* *
* @param clazz Specifies the type of EndpointReference that MUST be returned. * @param clazz Specifies the type of EndpointReference that MUST be returned.
* @param referenceParameters Reference parameters to be associated with the * @param referenceParameters Reference parameters to be associated with the
* returned <code>EndpointReference</code> instance. * returned {@code EndpointReference} instance.
* @return EndpointReference of type <code>clazz</code> of this * @return EndpointReference of type {@code clazz} of this
* <code>Endpoint</code> instance. * {@code Endpoint} instance.
* If the returned <code>EndpointReference</code> is of type * If the returned {@code EndpointReference} is of type
* <code>W3CEndpointReference</code> then it MUST contain the * {@code W3CEndpointReference} then it MUST contain the
* the specified <code>referenceParameters</code>. * the specified {@code referenceParameters}.
* @throws WebServiceException If any error in the creation of * @throws WebServiceException If any error in the creation of
* the <code>EndpointReference</code> or if the <code>Endpoint</code> is * the {@code EndpointReference} or if the {@code Endpoint} is
* not in the published state or if the <code>clazz</code> is not a supported * not in the published state or if the {@code clazz} is not a supported
* <code>EndpointReference</code> type. * {@code EndpointReference} type.
* @throws UnsupportedOperationException If this <code>BindingProvider</code> * @throws UnsupportedOperationException If this {@code BindingProvider}
* uses the XML/HTTP binding. * uses the XML/HTTP binding.
* *
* *
@ -478,7 +478,7 @@ public abstract class Endpoint {
Element... referenceParameters); Element... referenceParameters);
/** /**
* By settng a <code>EndpointContext</code>, JAX-WS runtime knows about * By settng a {@code EndpointContext}, JAX-WS runtime knows about
* addresses of other endpoints in an application. If multiple endpoints * addresses of other endpoints in an application. If multiple endpoints
* share different ports of a WSDL, then the multiple port addresses * share different ports of a WSDL, then the multiple port addresses
* are patched when the WSDL is accessed. * are patched when the WSDL is accessed.

5
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/EndpointContext.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2009, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2009, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -25,11 +25,10 @@
package javax.xml.ws; package javax.xml.ws;
import javax.xml.ws.Endpoint;
import java.util.Set; import java.util.Set;
/** /**
* <code>EndpointContext</code> allows multiple endpoints in an application * {@code EndpointContext} allows multiple endpoints in an application
* to share any information. For example, servlet application's war may * to share any information. For example, servlet application's war may
* contain multiple endpoints and these endpoints can get addresses of each * contain multiple endpoints and these endpoints can get addresses of each
* other by sharing this context. If multiple endpoints share different * other by sharing this context. If multiple endpoints share different

74
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/EndpointReference.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -44,35 +44,35 @@ import java.io.StringWriter;
* need not be concerned with its contents. The web service * need not be concerned with its contents. The web service
* developer should use this class strictly as a mechanism to * developer should use this class strictly as a mechanism to
* reference a remote web service endpoint. See the {@link Service} APIs * reference a remote web service endpoint. See the {@link Service} APIs
* that clients can use to that utilize an <code>EndpointReference</code>. * that clients can use to that utilize an {@code EndpointReference}.
* See the {@link javax.xml.ws.Endpoint}, and * See the {@link javax.xml.ws.Endpoint}, and
* {@link javax.xml.ws.BindingProvider} APIs on how * {@link javax.xml.ws.BindingProvider} APIs on how
* <code>EndpointReferences</code> can be created for published * {@code EndpointReferences} can be created for published
* endpoints. * endpoints.
* <p> * <p>
* Concrete implementations of this class will represent * Concrete implementations of this class will represent
* an <code>EndpointReference</code> for a particular version of Addressing. * an {@code EndpointReference} for a particular version of Addressing.
* For example the {@link W3CEndpointReference} is for use * For example the {@link W3CEndpointReference} is for use
* with W3C Web Services Addressing 1.0 - Core Recommendation. * with W3C Web Services Addressing 1.0 - Core Recommendation.
* If JAX-WS implementors need to support different versions * If JAX-WS implementors need to support different versions
* of addressing, they should write their own * of addressing, they should write their own
* <code>EndpointReference</code> subclass for that version. * {@code EndpointReference} subclass for that version.
* This will allow a JAX-WS implementation to create * This will allow a JAX-WS implementation to create
* a vendor specific <code>EndpointReferences</code> that the * a vendor specific {@code EndpointReferences} that the
* vendor can use to flag a different version of * vendor can use to flag a different version of
* addressing. * addressing.
* <p> * <p>
* Web service developers that wish to pass or return * Web service developers that wish to pass or return
* <code>EndpointReference</code> in Java methods in an * {@code EndpointReference} in Java methods in an
* SEI should use * SEI should use
* concrete instances of an <code>EndpointReference</code> such * concrete instances of an {@code EndpointReference} such
* as the <code>W3CEndpointReference</code>. This way the * as the {@code W3CEndpointReference}. This way the
* schema mapped from the SEI will be more descriptive of the * schema mapped from the SEI will be more descriptive of the
* type of endpoint reference being passed. * type of endpoint reference being passed.
* <p> * <p>
* JAX-WS implementors are expected to extract the XML infoset * JAX-WS implementors are expected to extract the XML infoset
* from an <CODE>EndpointReferece</CODE> using the * from an {@code EndpointReferece} using the
* <code>{@link EndpointReference#writeTo}</code> * {@link EndpointReference#writeTo}
* method. * method.
* <p> * <p>
* JAXB will bind this class to xs:anyType. If a better binding * JAXB will bind this class to xs:anyType. If a better binding
@ -92,68 +92,68 @@ public abstract class EndpointReference {
/** /**
* Factory method to read an EndpointReference from the infoset contained in * Factory method to read an EndpointReference from the infoset contained in
* <code>eprInfoset</code>. This method delegates to the vendor specific * {@code eprInfoset}. This method delegates to the vendor specific
* implementation of the {@link javax.xml.ws.spi.Provider#readEndpointReference} method. * implementation of the {@link javax.xml.ws.spi.Provider#readEndpointReference} method.
* *
* @param eprInfoset The <code>EndpointReference</code> infoset to be unmarshalled * @param eprInfoset The {@code EndpointReference} infoset to be unmarshalled
* *
* @return the EndpointReference unmarshalled from <code>eprInfoset</code> * @return the EndpointReference unmarshalled from {@code eprInfoset}
* never <code>null</code> * never {@code null}
* @throws WebServiceException * @throws WebServiceException
* if an error occurs while creating the * if an error occurs while creating the
* <code>EndpointReference</code> from the <CODE>eprInfoset</CODE> * {@code EndpointReference} from the {@code eprInfoset}
* @throws java.lang.IllegalArgumentException * @throws java.lang.IllegalArgumentException
* if the <code>null</code> <code>eprInfoset</code> value is given. * if the {@code null} {@code eprInfoset} value is given.
*/ */
public static EndpointReference readFrom(Source eprInfoset) { public static EndpointReference readFrom(Source eprInfoset) {
return Provider.provider().readEndpointReference(eprInfoset); return Provider.provider().readEndpointReference(eprInfoset);
} }
/** /**
* write this <code>EndpointReference</code> to the specified infoset format * write this {@code EndpointReference} to the specified infoset format
* *
* @param result for writing infoset * @param result for writing infoset
* @throws WebServiceException * @throws WebServiceException
* if there is an error writing the * if there is an error writing the
* <code>EndpointReference</code> to the specified <code>result</code>. * {@code EndpointReference} to the specified {@code result}.
* *
* @throws java.lang.IllegalArgumentException * @throws java.lang.IllegalArgumentException
* If the <code>null</code> <code>result</code> value is given. * If the {@code null} {@code result} value is given.
*/ */
public abstract void writeTo(Result result); public abstract void writeTo(Result result);
/** /**
* The <code>getPort</code> method returns a proxy. If there * The {@code getPort} method returns a proxy. If there
* are any reference parameters in the * are any reference parameters in the
* <code>EndpointReference</code> instance, then those reference * {@code EndpointReference} instance, then those reference
* parameters MUST appear as SOAP headers, indicating them to be * parameters MUST appear as SOAP headers, indicating them to be
* reference parameters, on all messages sent to the endpoint. * reference parameters, on all messages sent to the endpoint.
* The parameter <code>serviceEndpointInterface</code> specifies * The parameter {@code serviceEndpointInterface} specifies
* the service endpoint interface that is supported by the * the service endpoint interface that is supported by the
* returned proxy. * returned proxy.
* The <code>EndpointReference</code> instance specifies the * The {@code EndpointReference} instance specifies the
* endpoint that will be invoked by the returned proxy. * endpoint that will be invoked by the returned proxy.
* In the implementation of this method, the JAX-WS * In the implementation of this method, the JAX-WS
* runtime system takes the responsibility of selecting a protocol * runtime system takes the responsibility of selecting a protocol
* binding (and a port) and configuring the proxy accordingly from * binding (and a port) and configuring the proxy accordingly from
* the WSDL Metadata from this <code>EndpointReference</code> or from * the WSDL Metadata from this {@code EndpointReference} or from
* annotations on the <code>serviceEndpointInterface</code>. For this method * annotations on the {@code serviceEndpointInterface}. For this method
* to successfully return a proxy, WSDL metadata MUST be available and the * to successfully return a proxy, WSDL metadata MUST be available and the
* <code>EndpointReference</code> instance MUST contain an implementation understood * {@code EndpointReference} instance MUST contain an implementation understood
* <code>serviceName</code> metadata. * {@code serviceName} metadata.
* <p> * <p>
* Because this port is not created from a <code>Service</code> object, handlers * Because this port is not created from a {@code Service} object, handlers
* will not automatically be configured, and the <code>HandlerResolver</code> * will not automatically be configured, and the {@code HandlerResolver}
* and <code>Executor</code> cannot be get or set for this port. The * and {@code Executor} cannot be get or set for this port. The
* <code>BindingProvider().getBinding().setHandlerChain()</code> * {@code BindingProvider().getBinding().setHandlerChain()}
* method can be used to manually configure handlers for this port. * method can be used to manually configure handlers for this port.
* *
* *
* @param serviceEndpointInterface Service endpoint interface * @param serviceEndpointInterface Service endpoint interface
* @param features An array of <code>WebServiceFeatures</code> to configure on the * @param features An array of {@code WebServiceFeatures} to configure on the
* proxy. Supported features not in the <code>features * proxy. Supported features not in the {@code features
* </code> parameter will have their default values. * } parameter will have their default values.
* @return Object Proxy instance that supports the * @return Object Proxy instance that supports the
* specified service endpoint interface * specified service endpoint interface
* @throws WebServiceException * @throws WebServiceException
@ -163,10 +163,10 @@ public abstract class EndpointReference {
* <LI>If there is any missing WSDL metadata * <LI>If there is any missing WSDL metadata
* as required by this method * as required by this method
* <LI>If this * <LI>If this
* <code>endpointReference</code> * {@code endpointReference}
* is invalid * is invalid
* <LI>If an illegal * <LI>If an illegal
* <code>serviceEndpointInterface</code> * {@code serviceEndpointInterface}
* is specified * is specified
* <LI>If a feature is enabled that is not compatible with * <LI>If a feature is enabled that is not compatible with
* this port or is unsupported. * this port or is unsupported.

6
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/Holder.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -28,7 +28,7 @@ package javax.xml.ws;
import java.io.Serializable; import java.io.Serializable;
/** /**
* Holds a value of type <code>T</code>. * Holds a value of type {@code T}.
* *
* @since 1.6, JAX-WS 2.0 * @since 1.6, JAX-WS 2.0
*/ */
@ -42,7 +42,7 @@ public final class Holder<T> implements Serializable {
public T value; public T value;
/** /**
* Creates a new holder with a <code>null</code> value. * Creates a new holder with a {@code null} value.
*/ */
public Holder() { public Holder() {
} }

18
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/LogicalMessage.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -28,7 +28,7 @@ package javax.xml.ws;
import javax.xml.transform.Source; import javax.xml.transform.Source;
import javax.xml.bind.JAXBContext; import javax.xml.bind.JAXBContext;
/** The <code>LogicalMessage</code> interface represents a /** The {@code LogicalMessage} interface represents a
* protocol agnostic XML message and contains methods that * protocol agnostic XML message and contains methods that
* provide access to the payload of the message. * provide access to the payload of the message.
* *
@ -38,17 +38,17 @@ public interface LogicalMessage {
/** Gets the message payload as an XML source, may be called /** Gets the message payload as an XML source, may be called
* multiple times on the same LogicalMessage instance, always * multiple times on the same LogicalMessage instance, always
* returns a new <code>Source</code> that may be used to retrieve the entire * returns a new {@code Source} that may be used to retrieve the entire
* message payload. * message payload.
* *
* <p>If the returned <code>Source</code> is an instance of * <p>If the returned {@code Source} is an instance of
* <code>DOMSource</code>, then * {@code DOMSource}, then
* modifications to the encapsulated DOM tree change the message * modifications to the encapsulated DOM tree change the message
* payload in-place, there is no need to susequently call * payload in-place, there is no need to susequently call
* <code>setPayload</code>. Other types of <code>Source</code> provide only * {@code setPayload}. Other types of {@code Source} provide only
* read access to the message payload. * read access to the message payload.
* *
* @return The contained message payload; returns <code>null</code> if no * @return The contained message payload; returns {@code null} if no
* payload is present in this message. * payload is present in this message.
**/ **/
public Source getPayload(); public Source getPayload();
@ -65,11 +65,11 @@ public interface LogicalMessage {
/** Gets the message payload as a JAXB object. Note that there is no /** Gets the message payload as a JAXB object. Note that there is no
* connection between the returned object and the message payload, * connection between the returned object and the message payload,
* changes to the payload require calling <code>setPayload</code>. * changes to the payload require calling {@code setPayload}.
* *
* @param context The JAXBContext that should be used to unmarshall * @param context The JAXBContext that should be used to unmarshall
* the message payload * the message payload
* @return The contained message payload; returns <code>null</code> if no * @return The contained message payload; returns {@code null} if no
* payload is present in this message * payload is present in this message
* @throws WebServiceException If an error occurs when using a supplied * @throws WebServiceException If an error occurs when using a supplied
* JAXBContext to unmarshall the payload. The cause of * JAXBContext to unmarshall the payload. The cause of

16
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/ProtocolException.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -25,7 +25,7 @@
package javax.xml.ws; package javax.xml.ws;
/** The <code>ProtocolException</code> class is a /** The {@code ProtocolException} class is a
* base class for exceptions related to a specific protocol binding. Subclasses * base class for exceptions related to a specific protocol binding. Subclasses
* are used to communicate protocol level fault information to clients and may * are used to communicate protocol level fault information to clients and may
* be used on the server to control the protocol specific fault representation. * be used on the server to control the protocol specific fault representation.
@ -34,9 +34,9 @@ package javax.xml.ws;
**/ **/
public class ProtocolException extends WebServiceException { public class ProtocolException extends WebServiceException {
/** /**
* Constructs a new protocol exception with <code>null</code> as its detail message. The * Constructs a new protocol exception with {@code null} as its detail message. The
* cause is not initialized, and may subsequently be initialized by a call * cause is not initialized, and may subsequently be initialized by a call
* to <code>Throwable.initCause(java.lang.Throwable)</code>. * to {@code Throwable.initCause(java.lang.Throwable)}.
*/ */
public ProtocolException() { public ProtocolException() {
super(); super();
@ -45,7 +45,7 @@ public class ProtocolException extends WebServiceException {
/** /**
* Constructs a new protocol exception with the specified detail message. * Constructs a new protocol exception with the specified detail message.
* The cause is not initialized, and may subsequently be initialized by a * The cause is not initialized, and may subsequently be initialized by a
* call to <code>Throwable.initCause(java.lang.Throwable)</code>. * call to {@code Throwable.initCause(java.lang.Throwable)}.
* *
* @param message the detail message. The detail message is saved for later * @param message the detail message. The detail message is saved for later
* retrieval by the Throwable.getMessage() method. * retrieval by the Throwable.getMessage() method.
@ -64,7 +64,7 @@ public class ProtocolException extends WebServiceException {
* @param message the detail message (which is saved for later retrieval by * @param message the detail message (which is saved for later retrieval by
* the Throwable.getMessage() method). * the Throwable.getMessage() method).
* @param cause the cause (which is saved for later retrieval by the * @param cause the cause (which is saved for later retrieval by the
* <code>Throwable.getCause()</code> method). (A <code>null</code> value is permitted, and indicates * {@code Throwable.getCause()} method). (A {@code null} value is permitted, and indicates
* that the cause is nonexistent or unknown.) * that the cause is nonexistent or unknown.)
*/ */
public ProtocolException(String message, Throwable cause) { public ProtocolException(String message, Throwable cause) {
@ -73,13 +73,13 @@ public class ProtocolException extends WebServiceException {
/** /**
* Constructs a new runtime exception with the specified cause and a detail * Constructs a new runtime exception with the specified cause and a detail
* message of <code>(cause==null ? null : cause.toString())</code> (which typically * message of {@code (cause==null ? null : cause.toString())} (which typically
* contains the class and detail message of cause). This constructor is * contains the class and detail message of cause). This constructor is
* useful for runtime exceptions that are little more than wrappers for * useful for runtime exceptions that are little more than wrappers for
* other throwables. * other throwables.
* *
* @param cause the cause (which is saved for later retrieval by the * @param cause the cause (which is saved for later retrieval by the
* <code>Throwable.getCause()</code> method). (A <code>null</code> value is permitted, and indicates * {@code Throwable.getCause()} method). (A {@code null} value is permitted, and indicates
* that the cause is nonexistent or unknown.) * that the cause is nonexistent or unknown.)
*/ */
public ProtocolException(Throwable cause) { public ProtocolException(Throwable cause) {

20
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/Provider.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -26,16 +26,16 @@
package javax.xml.ws; package javax.xml.ws;
/** /**
* <p>Service endpoints may implement the <code>Provider</code> * <p>Service endpoints may implement the {@code Provider}
* interface as a dynamic alternative to an SEI. * interface as a dynamic alternative to an SEI.
* *
* <p>Implementations are required to support <code>Provider&lt;Source&gt;</code>, * <p>Implementations are required to support {@code Provider<Source>},
* <code>Provider&lt;SOAPMessage&gt;</code> and * {@code Provider<SOAPMessage>} and
* <code>Provider&lt;DataSource&gt;</code>, depending on the binding * {@code Provider<DataSource>}, depending on the binding
* in use and the service mode. * in use and the service mode.
* *
* <p>The <code>ServiceMode</code> annotation can be used to control whether * <p>The {@code ServiceMode} annotation can be used to control whether
* the <code>Provider</code> instance will receive entire protocol messages * the {@code Provider} instance will receive entire protocol messages
* or just message payloads. * or just message payloads.
* *
* @since 1.6, JAX-WS 2.0 * @since 1.6, JAX-WS 2.0
@ -50,11 +50,11 @@ public interface Provider<T> {
* message. * message.
* *
* @param request The request message or message payload. * @param request The request message or message payload.
* @return The response message or message payload. May be <code>null</code> if * @return The response message or message payload. May be {@code null} if
there is no response. there is no response.
* @throws WebServiceException If there is an error processing request. * @throws WebServiceException If there is an error processing request.
* The cause of the <code>WebServiceException</code> may be set to a subclass * The cause of the {@code WebServiceException} may be set to a subclass
* of <code>ProtocolException</code> to control the protocol level * of {@code ProtocolException} to control the protocol level
* representation of the exception. * representation of the exception.
* @see javax.xml.ws.handler.MessageContext * @see javax.xml.ws.handler.MessageContext
* @see javax.xml.ws.ProtocolException * @see javax.xml.ws.ProtocolException

10
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/RequestWrapper.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -33,11 +33,11 @@ import java.lang.annotation.RetentionPolicy;
/** /**
* Used to annotate methods in the Service Endpoint Interface with the request * Used to annotate methods in the Service Endpoint Interface with the request
* wrapper bean to be used at runtime. The default value of the <code>localName</code> is * wrapper bean to be used at runtime. The default value of the {@code localName} is
* the <code>operationName</code>, as defined in <code>WebMethod</code> annotation and the * the {@code operationName}, as defined in {@code WebMethod} annotation and the
* <code>targetNamespace</code> is the target namespace of the SEI. * {@code targetNamespace} is the target namespace of the SEI.
* <p> When starting from Java this annotation is used resolve * <p> When starting from Java this annotation is used resolve
* overloading conflicts in document literal mode. Only the <code>className</code> * overloading conflicts in document literal mode. Only the {@code className}
* is required in this case. * is required in this case.
* *
* @since 1.6, JAX-WS 2.0 * @since 1.6, JAX-WS 2.0

12
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/RespectBinding.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -34,18 +34,18 @@ import javax.xml.ws.spi.WebServiceFeatureAnnotation;
/** /**
* This feature clarifies the use of the <code>wsdl:binding</code> * This feature clarifies the use of the {@code wsdl:binding}
* in a JAX-WS runtime. * in a JAX-WS runtime.
* <p> * <p>
* This annotation MUST only be used in conjunction the * This annotation MUST only be used in conjunction the
* <code>javax.jws.WebService</code>, {@link WebServiceProvider}, * {@code javax.jws.WebService}, {@link WebServiceProvider},
* {@link WebServiceRef} annotations. * {@link WebServiceRef} annotations.
* When used with the <code>javax.jws.WebService</code> annotation this * When used with the {@code javax.jws.WebService} annotation this
* annotation MUST only be used on the service endpoint implementation * annotation MUST only be used on the service endpoint implementation
* class. * class.
* When used with a <code>WebServiceRef</code> annotation, this annotation * When used with a {@code WebServiceRef} annotation, this annotation
* MUST only be used when a proxy instance is created. The injected SEI * MUST only be used when a proxy instance is created. The injected SEI
* proxy, and endpoint MUST honor the values of the <code>RespectBinding</code> * proxy, and endpoint MUST honor the values of the {@code RespectBinding}
* annotation. * annotation.
* <p> * <p>
* *

26
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/RespectBindingFeature.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -28,7 +28,7 @@ package javax.xml.ws;
import javax.xml.ws.soap.AddressingFeature; import javax.xml.ws.soap.AddressingFeature;
/** /**
* This feature clarifies the use of the <code>wsdl:binding</code> * This feature clarifies the use of the {@code wsdl:binding}
* in a JAX-WS runtime. * in a JAX-WS runtime.
* *
* This feature can be used during the creation of SEI proxy, and * This feature can be used during the creation of SEI proxy, and
@ -38,26 +38,26 @@ import javax.xml.ws.soap.AddressingFeature;
* <p> * <p>
* This feature is only useful with web services that have an * This feature is only useful with web services that have an
* associated WSDL. Enabling this feature requires that a JAX-WS * associated WSDL. Enabling this feature requires that a JAX-WS
* implementation inspect the <code>wsdl:binding</code> for an * implementation inspect the {@code wsdl:binding} for an
* endpoint at runtime to make sure that all <code>wsdl:extensions</code> * endpoint at runtime to make sure that all {@code wsdl:extensions}
* that have the <code>required</code> attribute set to <code>true</code> * that have the {@code required} attribute set to {@code true}
* are understood and are being used. * are understood and are being used.
* <p> * <p>
* The following describes the affects of this feature with respect * The following describes the affects of this feature with respect
* to be enabled or disabled: * to be enabled or disabled:
* <ul> * <ul>
* <li> ENABLED: In this Mode, a JAX-WS runtime MUST assure that all * <li> ENABLED: In this Mode, a JAX-WS runtime MUST assure that all
* required <code>wsdl:binding</code> extensions(including policies) are * required {@code wsdl:binding} extensions(including policies) are
* either understood and used by the runtime, or explicitly disabled by the * either understood and used by the runtime, or explicitly disabled by the
* web service application. A web service can disable a particular * web service application. A web service can disable a particular
* extension if there is a corresponding {@link WebServiceFeature} or annotation. * extension if there is a corresponding {@link WebServiceFeature} or annotation.
* Similarly, a web service client can disable * Similarly, a web service client can disable
* particular extension using the corresponding <code>WebServiceFeature</code> while * particular extension using the corresponding {@code WebServiceFeature} while
* creating a proxy or Dispatch instance. * creating a proxy or Dispatch instance.
* The runtime MUST also make sure that binding of * The runtime MUST also make sure that binding of
* SEI parameters/return values respect the <code>wsdl:binding</code>. * SEI parameters/return values respect the {@code wsdl:binding}.
* With this feature enabled, if a required (<code>wsdl:required="true"</code>) * With this feature enabled, if a required ({@code wsdl:required="true"})
* <code>wsdl:binding</code> extension is in the WSDL and it is not * {@code wsdl:binding} extension is in the WSDL and it is not
* supported by a JAX-WS runtime and it has not * supported by a JAX-WS runtime and it has not
* been explicitly turned off by the web service developer, then * been explicitly turned off by the web service developer, then
* that JAX-WS runtime MUST behave appropriately based on whether it is * that JAX-WS runtime MUST behave appropriately based on whether it is
@ -71,8 +71,8 @@ import javax.xml.ws.soap.AddressingFeature;
* </ul> * </ul>
* *
* <li> DISABLED: In this Mode, an implementation may choose whether * <li> DISABLED: In this Mode, an implementation may choose whether
* to inspect the <code>wsdl:binding</code> or not and to what degree * to inspect the {@code wsdl:binding} or not and to what degree
* the <code>wsdl:binding</code> will be inspected. For example, * the {@code wsdl:binding} will be inspected. For example,
* one implementation may choose to behave as if this feature is enabled, * one implementation may choose to behave as if this feature is enabled,
* another implementation may only choose to verify the SEI's * another implementation may only choose to verify the SEI's
* parameter/return type bindings. * parameter/return type bindings.
@ -91,7 +91,7 @@ public final class RespectBindingFeature extends WebServiceFeature {
/** /**
* Creates an <code>RespectBindingFeature</code>. * Creates an {@code RespectBindingFeature}.
* The instance created will be enabled. * The instance created will be enabled.
*/ */
public RespectBindingFeature() { public RespectBindingFeature() {

10
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/Response.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -28,14 +28,14 @@ package javax.xml.ws;
import java.util.Map; import java.util.Map;
import java.util.concurrent.Future; import java.util.concurrent.Future;
/** The <code>Response</code> interface provides methods used to obtain the /** The {@code Response} interface provides methods used to obtain the
* payload and context of a message sent in response to an operation * payload and context of a message sent in response to an operation
* invocation. * invocation.
* *
* <p>For asynchronous operation invocations it provides additional methods * <p>For asynchronous operation invocations it provides additional methods
* to check the status of the request. The <code>get(...)</code> methods may * to check the status of the request. The {@code get(...)} methods may
* throw the standard * throw the standard
* set of exceptions and their cause may be a <code>RemoteException</code> or a * set of exceptions and their cause may be a {@code RemoteException} or a
* {@link WebServiceException} that represents the error that occured during the * {@link WebServiceException} that represents the error that occured during the
* asynchronous method invocation.</p> * asynchronous method invocation.</p>
* *
@ -44,7 +44,7 @@ import java.util.concurrent.Future;
public interface Response<T> extends Future<T> { public interface Response<T> extends Future<T> {
/** Gets the contained response context. /** Gets the contained response context.
* *
* @return The contained response context. May be <code>null</code> if a * @return The contained response context. May be {@code null} if a
* response is not yet available. * response is not yet available.
* *
**/ **/

10
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/ResponseWrapper.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -32,11 +32,11 @@ import java.lang.annotation.ElementType;
import java.lang.annotation.RetentionPolicy; import java.lang.annotation.RetentionPolicy;
/** /**
* Used to annotate methods in the Service Endpoint Interface with the response * Used to annotate methods in the Service Endpoint Interface with the response
* wrapper bean to be used at runtime. The default value of the <code>localName</code> is * wrapper bean to be used at runtime. The default value of the {@code localName} is
* the <code>operationName</code> as defined in <code>WebMethod</code> annotation appended with * the {@code operationName} as defined in {@code WebMethod} annotation appended with
* <code>Response</code> and the <code>targetNamespace</code> is the target namespace of the SEI. * {@code Response} and the {@code targetNamespace} is the target namespace of the SEI.
* <p> When starting from Java this annotation is used resolve * <p> When starting from Java this annotation is used resolve
* overloading conflicts in document literal mode. Only the <code>className</code> * overloading conflicts in document literal mode. Only the {@code className}
* is required in this case. * is required in this case.
* *
* @since 1.6, JAX-WS 2.0 * @since 1.6, JAX-WS 2.0

314
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/Service.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -33,8 +33,8 @@ import javax.xml.ws.spi.ServiceDelegate;
import javax.xml.ws.spi.Provider; import javax.xml.ws.spi.Provider;
/** /**
* <code>Service</code> objects provide the client view of a Web service. * {@code Service} objects provide the client view of a Web service.
* <p><code>Service</code> acts as a factory of the following: * <p>{@code Service} acts as a factory of the following:
* <ul> * <ul>
* <li>Proxies for a target service endpoint.</li> * <li>Proxies for a target service endpoint.</li>
* <li>Instances of {@link javax.xml.ws.Dispatch} for * <li>Instances of {@link javax.xml.ws.Dispatch} for
@ -44,17 +44,17 @@ import javax.xml.ws.spi.Provider;
* </ul> * </ul>
* *
* <p>The ports available on a service can be enumerated using the * <p>The ports available on a service can be enumerated using the
* <code>getPorts</code> method. Alternatively, you can pass a * {@code getPorts} method. Alternatively, you can pass a
* service endpoint interface to the unary <code>getPort</code> method * service endpoint interface to the unary {@code getPort} method
* and let the runtime select a compatible port. * and let the runtime select a compatible port.
* *
* <p>Handler chains for all the objects created by a <code>Service</code> * <p>Handler chains for all the objects created by a {@code Service}
* can be set by means of a <code>HandlerResolver</code>. * can be set by means of a {@code HandlerResolver}.
* *
* <p>An <code>Executor</code> may be set on the service in order * <p>An {@code Executor} may be set on the service in order
* to gain better control over the threads used to dispatch asynchronous * to gain better control over the threads used to dispatch asynchronous
* callbacks. For instance, thread pooling with certain parameters * callbacks. For instance, thread pooling with certain parameters
* can be enabled by creating a <code>ThreadPoolExecutor</code> and * can be enabled by creating a {@code ThreadPoolExecutor} and
* registering it with the service. * registering it with the service.
* *
* @since 1.6, JAX-WS 2.0 * @since 1.6, JAX-WS 2.0
@ -67,8 +67,8 @@ public class Service {
private ServiceDelegate delegate; private ServiceDelegate delegate;
/** /**
* The orientation of a dynamic client or service. <code>MESSAGE</code> provides * The orientation of a dynamic client or service. {@code MESSAGE} provides
* access to entire protocol message, <code>PAYLOAD</code> to protocol message * access to entire protocol message, {@code PAYLOAD} to protocol message
* payload only. * payload only.
**/ **/
public enum Mode { MESSAGE, PAYLOAD } public enum Mode { MESSAGE, PAYLOAD }
@ -87,9 +87,9 @@ public class Service {
/** /**
* The <code>getPort</code> method returns a proxy. A service client * The {@code getPort} method returns a proxy. A service client
* uses this proxy to invoke operations on the target * uses this proxy to invoke operations on the target
* service endpoint. The <code>serviceEndpointInterface</code> * service endpoint. The {@code serviceEndpointInterface}
* specifies the service endpoint interface that is supported by * specifies the service endpoint interface that is supported by
* the created dynamic proxy instance. * the created dynamic proxy instance.
* *
@ -108,8 +108,8 @@ public class Service {
* <LI>If there is any missing WSDL metadata * <LI>If there is any missing WSDL metadata
* as required by this method. * as required by this method.
* <LI>If an illegal * <LI>If an illegal
* <code>serviceEndpointInterface</code> * {@code serviceEndpointInterface}
* or <code>portName</code> is specified. * or {@code portName} is specified.
* </UL> * </UL>
* @see java.lang.reflect.Proxy * @see java.lang.reflect.Proxy
* @see java.lang.reflect.InvocationHandler * @see java.lang.reflect.InvocationHandler
@ -120,9 +120,9 @@ public class Service {
} }
/** /**
* The <code>getPort</code> method returns a proxy. A service client * The {@code getPort} method returns a proxy. A service client
* uses this proxy to invoke operations on the target * uses this proxy to invoke operations on the target
* service endpoint. The <code>serviceEndpointInterface</code> * service endpoint. The {@code serviceEndpointInterface}
* specifies the service endpoint interface that is supported by * specifies the service endpoint interface that is supported by
* the created dynamic proxy instance. * the created dynamic proxy instance.
* *
@ -131,8 +131,8 @@ public class Service {
* @param serviceEndpointInterface Service endpoint interface * @param serviceEndpointInterface Service endpoint interface
* supported by the dynamic proxy instance. * supported by the dynamic proxy instance.
* @param features A list of WebServiceFeatures to configure on the * @param features A list of WebServiceFeatures to configure on the
* proxy. Supported features not in the <code>features * proxy. Supported features not in the {@code features
* </code> parameter will have their default values. * } parameter will have their default values.
* @return Object Proxy instance that * @return Object Proxy instance that
* supports the specified service endpoint * supports the specified service endpoint
* interface. * interface.
@ -144,8 +144,8 @@ public class Service {
* <LI>If there is any missing WSDL metadata * <LI>If there is any missing WSDL metadata
* as required by this method. * as required by this method.
* <LI>If an illegal * <LI>If an illegal
* <code>serviceEndpointInterface</code> * {@code serviceEndpointInterface}
* or <code>portName</code> is specified. * or {@code portName} is specified.
* <LI>If a feature is enabled that is not compatible * <LI>If a feature is enabled that is not compatible
* with this port or is unsupported. * with this port or is unsupported.
* </UL> * </UL>
@ -162,8 +162,8 @@ public class Service {
/** /**
* The <code>getPort</code> method returns a proxy. The parameter * The {@code getPort} method returns a proxy. The parameter
* <code>serviceEndpointInterface</code> specifies the service * {@code serviceEndpointInterface} specifies the service
* endpoint interface that is supported by the returned proxy. * endpoint interface that is supported by the returned proxy.
* In the implementation of this method, the JAX-WS * In the implementation of this method, the JAX-WS
* runtime system takes the responsibility of selecting a protocol * runtime system takes the responsibility of selecting a protocol
@ -180,7 +180,7 @@ public class Service {
* <LI>If there is any missing WSDL metadata * <LI>If there is any missing WSDL metadata
* as required by this method. * as required by this method.
* <LI>If an illegal * <LI>If an illegal
* <code>serviceEndpointInterface</code> * {@code serviceEndpointInterface}
* is specified. * is specified.
* </UL> * </UL>
**/ **/
@ -190,8 +190,8 @@ public class Service {
/** /**
* The <code>getPort</code> method returns a proxy. The parameter * The {@code getPort} method returns a proxy. The parameter
* <code>serviceEndpointInterface</code> specifies the service * {@code serviceEndpointInterface} specifies the service
* endpoint interface that is supported by the returned proxy. * endpoint interface that is supported by the returned proxy.
* In the implementation of this method, the JAX-WS * In the implementation of this method, the JAX-WS
* runtime system takes the responsibility of selecting a protocol * runtime system takes the responsibility of selecting a protocol
@ -200,8 +200,8 @@ public class Service {
* *
* @param serviceEndpointInterface Service endpoint interface. * @param serviceEndpointInterface Service endpoint interface.
* @param features A list of WebServiceFeatures to configure on the * @param features A list of WebServiceFeatures to configure on the
* proxy. Supported features not in the <code>features * proxy. Supported features not in the {@code features
* </code> parameter will have their default values. * } parameter will have their default values.
* @return Object instance that supports the * @return Object instance that supports the
* specified service endpoint interface. * specified service endpoint interface.
* @throws WebServiceException * @throws WebServiceException
@ -211,7 +211,7 @@ public class Service {
* <LI>If there is any missing WSDL metadata * <LI>If there is any missing WSDL metadata
* as required by this method. * as required by this method.
* <LI>If an illegal * <LI>If an illegal
* <code>serviceEndpointInterface</code> * {@code serviceEndpointInterface}
* is specified. * is specified.
* <LI>If a feature is enabled that is not compatible * <LI>If a feature is enabled that is not compatible
* with this port or is unsupported. * with this port or is unsupported.
@ -228,31 +228,31 @@ public class Service {
/** /**
* The <code>getPort</code> method returns a proxy. * The {@code getPort} method returns a proxy.
* The parameter <code>endpointReference</code> specifies the * The parameter {@code endpointReference} specifies the
* endpoint that will be invoked by the returned proxy. If there * endpoint that will be invoked by the returned proxy. If there
* are any reference parameters in the * are any reference parameters in the
* <code>endpointReference</code>, then those reference * {@code endpointReference}, then those reference
* parameters MUST appear as SOAP headers, indicating them to be * parameters MUST appear as SOAP headers, indicating them to be
* reference parameters, on all messages sent to the endpoint. * reference parameters, on all messages sent to the endpoint.
* The <code>endpointReference's</code> address MUST be used * The {@code endpointReference's} address MUST be used
* for invocations on the endpoint. * for invocations on the endpoint.
* The parameter <code>serviceEndpointInterface</code> specifies * The parameter {@code serviceEndpointInterface} specifies
* the service endpoint interface that is supported by the * the service endpoint interface that is supported by the
* returned proxy. * returned proxy.
* In the implementation of this method, the JAX-WS * In the implementation of this method, the JAX-WS
* runtime system takes the responsibility of selecting a protocol * runtime system takes the responsibility of selecting a protocol
* binding (and a port) and configuring the proxy accordingly from * binding (and a port) and configuring the proxy accordingly from
* the WSDL associated with this <code>Service</code> instance or * the WSDL associated with this {@code Service} instance or
* from the metadata from the <code>endpointReference</code>. * from the metadata from the {@code endpointReference}.
* If this <code>Service</code> instance has a WSDL and * If this {@code Service} instance has a WSDL and
* the <code>endpointReference</code> metadata * the {@code endpointReference} metadata
* also has a WSDL, then the WSDL from this instance MUST be used. * also has a WSDL, then the WSDL from this instance MUST be used.
* If this <code>Service</code> instance does not have a WSDL and * If this {@code Service} instance does not have a WSDL and
* the <code>endpointReference</code> does have a WSDL, then the * the {@code endpointReference} does have a WSDL, then the
* WSDL from the <code>endpointReference</code> MAY be used. * WSDL from the {@code endpointReference} MAY be used.
* The returned proxy should not be reconfigured by the client. * The returned proxy should not be reconfigured by the client.
* If this <code>Service</code> instance has a known proxy * If this {@code Service} instance has a known proxy
* port that matches the information contained in * port that matches the information contained in
* the WSDL, * the WSDL,
* then that proxy is returned, otherwise a WebServiceException * then that proxy is returned, otherwise a WebServiceException
@ -260,20 +260,20 @@ public class Service {
* <p> * <p>
* Calling this method has the same behavior as the following * Calling this method has the same behavior as the following
* <pre> * <pre>
* <code>port = service.getPort(portName, serviceEndpointInterface);</code> * {@code port = service.getPort(portName, serviceEndpointInterface);}
* </pre> * </pre>
* where the <code>portName</code> is retrieved from the * where the {@code portName} is retrieved from the
* metadata of the <code>endpointReference</code> or from the * metadata of the {@code endpointReference} or from the
* <code>serviceEndpointInterface</code> and the WSDL * {@code serviceEndpointInterface} and the WSDL
* associated with this <code>Service</code> instance. * associated with this {@code Service} instance.
* *
* @param endpointReference The <code>EndpointReference</code> * @param endpointReference The {@code EndpointReference}
* for the target service endpoint that will be invoked by the * for the target service endpoint that will be invoked by the
* returned proxy. * returned proxy.
* @param serviceEndpointInterface Service endpoint interface. * @param serviceEndpointInterface Service endpoint interface.
* @param features A list of <code>WebServiceFeatures</code> to configure on the * @param features A list of {@code WebServiceFeatures} to configure on the
* proxy. Supported features not in the <code>features * proxy. Supported features not in the {@code features
* </code> parameter will have their default values. * } parameter will have their default values.
* @return Object Proxy instance that supports the * @return Object Proxy instance that supports the
* specified service endpoint interface. * specified service endpoint interface.
* @throws WebServiceException * @throws WebServiceException
@ -282,16 +282,16 @@ public class Service {
* of the proxy. * of the proxy.
* <LI>If there is any missing WSDL metadata * <LI>If there is any missing WSDL metadata
* as required by this method. * as required by this method.
* <LI>If the <code>endpointReference</code> metadata does * <LI>If the {@code endpointReference} metadata does
* not match the <code>serviceName</code> of this * not match the {@code serviceName} of this
* <code>Service</code> instance. * {@code Service} instance.
* <LI>If a <code>portName</code> cannot be extracted * <LI>If a {@code portName} cannot be extracted
* from the WSDL or <code>endpointReference</code> metadata. * from the WSDL or {@code endpointReference} metadata.
* <LI>If an invalid * <LI>If an invalid
* <code>endpointReference</code> * {@code endpointReference}
* is specified. * is specified.
* <LI>If an invalid * <LI>If an invalid
* <code>serviceEndpointInterface</code> * {@code serviceEndpointInterface}
* is specified. * is specified.
* <LI>If a feature is enabled that is not compatible * <LI>If a feature is enabled that is not compatible
* with this port or is unsupported. * with this port or is unsupported.
@ -307,7 +307,7 @@ public class Service {
/** /**
* Creates a new port for the service. Ports created in this way contain * Creates a new port for the service. Ports created in this way contain
* no WSDL port type information and can only be used for creating * no WSDL port type information and can only be used for creating
* <code>Dispatch</code>instances. * {@code Dispatch}instances.
* *
* @param portName Qualified name for the target service endpoint. * @param portName Qualified name for the target service endpoint.
* @param bindingId A String identifier of a binding. * @param bindingId A String identifier of a binding.
@ -325,14 +325,14 @@ public class Service {
/** /**
* Creates a <code>Dispatch</code> instance for use with objects of * Creates a {@code Dispatch} instance for use with objects of
* the client's choosing. * the client's choosing.
* *
* @param portName Qualified name for the target service endpoint * @param portName Qualified name for the target service endpoint
* @param type The class of object used for messages or message * @param type The class of object used for messages or message
* payloads. Implementations are required to support * payloads. Implementations are required to support
* <code>javax.xml.transform.Source</code>, <code>javax.xml.soap.SOAPMessage</code> * {@code javax.xml.transform.Source}, {@code javax.xml.soap.SOAPMessage}
* and <code>javax.activation.DataSource</code>, depending on * and {@code javax.activation.DataSource}, depending on
* the binding in use. * the binding in use.
* @param mode Controls whether the created dispatch instance is message * @param mode Controls whether the created dispatch instance is message
* or payload oriented, i.e. whether the client will work with complete * or payload oriented, i.e. whether the client will work with complete
@ -343,7 +343,7 @@ public class Service {
* *
* @return Dispatch instance. * @return Dispatch instance.
* @throws WebServiceException If any error in the creation of * @throws WebServiceException If any error in the creation of
* the <code>Dispatch</code> object. * the {@code Dispatch} object.
* *
* @see javax.xml.transform.Source * @see javax.xml.transform.Source
* @see javax.xml.soap.SOAPMessage * @see javax.xml.soap.SOAPMessage
@ -354,26 +354,26 @@ public class Service {
/** /**
* Creates a <code>Dispatch</code> instance for use with objects of * Creates a {@code Dispatch} instance for use with objects of
* the client's choosing. * the client's choosing.
* *
* @param portName Qualified name for the target service endpoint * @param portName Qualified name for the target service endpoint
* @param type The class of object used for messages or message * @param type The class of object used for messages or message
* payloads. Implementations are required to support * payloads. Implementations are required to support
* <code>javax.xml.transform.Source</code> and <code>javax.xml.soap.SOAPMessage</code>. * {@code javax.xml.transform.Source} and {@code javax.xml.soap.SOAPMessage}.
* @param mode Controls whether the created dispatch instance is message * @param mode Controls whether the created dispatch instance is message
* or payload oriented, i.e. whether the client will work with complete * or payload oriented, i.e. whether the client will work with complete
* protocol messages or message payloads. E.g. when using the SOAP * protocol messages or message payloads. E.g. when using the SOAP
* protocol, this parameter controls whether the client will work with * protocol, this parameter controls whether the client will work with
* SOAP messages or the contents of a SOAP body. Mode MUST be <code>MESSAGE</code> * SOAP messages or the contents of a SOAP body. Mode MUST be {@code MESSAGE}
* when type is <code>SOAPMessage</code>. * when type is {@code SOAPMessage}.
* @param features A list of <code>WebServiceFeatures</code> to configure on the * @param features A list of {@code WebServiceFeatures} to configure on the
* proxy. Supported features not in the <code>features * proxy. Supported features not in the {@code features
* </code> parameter will have their default values. * } parameter will have their default values.
* *
* @return Dispatch instance. * @return Dispatch instance.
* @throws WebServiceException If any error in the creation of * @throws WebServiceException If any error in the creation of
* the <code>Dispatch</code> object or if a * the {@code Dispatch} object or if a
* feature is enabled that is not compatible with * feature is enabled that is not compatible with
* this port or is unsupported. * this port or is unsupported.
* *
@ -390,64 +390,64 @@ public class Service {
/** /**
* Creates a <code>Dispatch</code> instance for use with objects of * Creates a {@code Dispatch} instance for use with objects of
* the client's choosing. If there * the client's choosing. If there
* are any reference parameters in the * are any reference parameters in the
* <code>endpointReference</code>, then those reference * {@code endpointReference}, then those reference
* parameters MUST appear as SOAP headers, indicating them to be * parameters MUST appear as SOAP headers, indicating them to be
* reference parameters, on all messages sent to the endpoint. * reference parameters, on all messages sent to the endpoint.
* The <code>endpointReference's</code> address MUST be used * The {@code endpointReference's} address MUST be used
* for invocations on the endpoint. * for invocations on the endpoint.
* In the implementation of this method, the JAX-WS * In the implementation of this method, the JAX-WS
* runtime system takes the responsibility of selecting a protocol * runtime system takes the responsibility of selecting a protocol
* binding (and a port) and configuring the dispatch accordingly from * binding (and a port) and configuring the dispatch accordingly from
* the WSDL associated with this <code>Service</code> instance or * the WSDL associated with this {@code Service} instance or
* from the metadata from the <code>endpointReference</code>. * from the metadata from the {@code endpointReference}.
* If this <code>Service</code> instance has a WSDL and * If this {@code Service} instance has a WSDL and
* the <code>endpointReference</code> * the {@code endpointReference}
* also has a WSDL in its metadata, then the WSDL from this instance MUST be used. * also has a WSDL in its metadata, then the WSDL from this instance MUST be used.
* If this <code>Service</code> instance does not have a WSDL and * If this {@code Service} instance does not have a WSDL and
* the <code>endpointReference</code> does have a WSDL, then the * the {@code endpointReference} does have a WSDL, then the
* WSDL from the <code>endpointReference</code> MAY be used. * WSDL from the {@code endpointReference} MAY be used.
* An implementation MUST be able to retrieve the <code>portName</code> from the * An implementation MUST be able to retrieve the {@code portName} from the
* <code>endpointReference</code> metadata. * {@code endpointReference} metadata.
* <p> * <p>
* This method behaves the same as calling * This method behaves the same as calling
* <pre> * <pre>
* <code>dispatch = service.createDispatch(portName, type, mode, features);</code> * {@code dispatch = service.createDispatch(portName, type, mode, features);}
* </pre> * </pre>
* where the <code>portName</code> is retrieved from the * where the {@code portName} is retrieved from the
* WSDL or <code>EndpointReference</code> metadata. * WSDL or {@code EndpointReference} metadata.
* *
* @param endpointReference The <code>EndpointReference</code> * @param endpointReference The {@code EndpointReference}
* for the target service endpoint that will be invoked by the * for the target service endpoint that will be invoked by the
* returned <code>Dispatch</code> object. * returned {@code Dispatch} object.
* @param type The class of object used to messages or message * @param type The class of object used to messages or message
* payloads. Implementations are required to support * payloads. Implementations are required to support
* <code>javax.xml.transform.Source</code> and <code>javax.xml.soap.SOAPMessage</code>. * {@code javax.xml.transform.Source} and {@code javax.xml.soap.SOAPMessage}.
* @param mode Controls whether the created dispatch instance is message * @param mode Controls whether the created dispatch instance is message
* or payload oriented, i.e. whether the client will work with complete * or payload oriented, i.e. whether the client will work with complete
* protocol messages or message payloads. E.g. when using the SOAP * protocol messages or message payloads. E.g. when using the SOAP
* protocol, this parameter controls whether the client will work with * protocol, this parameter controls whether the client will work with
* SOAP messages or the contents of a SOAP body. Mode MUST be <code>MESSAGE</code> * SOAP messages or the contents of a SOAP body. Mode MUST be {@code MESSAGE}
* when type is <code>SOAPMessage</code>. * when type is {@code SOAPMessage}.
* @param features An array of <code>WebServiceFeatures</code> to configure on the * @param features An array of {@code WebServiceFeatures} to configure on the
* proxy. Supported features not in the <code>features * proxy. Supported features not in the {@code features
* </code> parameter will have their default values. * } parameter will have their default values.
* *
* @return Dispatch instance * @return Dispatch instance
* @throws WebServiceException * @throws WebServiceException
* <UL> * <UL>
* <LI>If there is any missing WSDL metadata * <LI>If there is any missing WSDL metadata
* as required by this method. * as required by this method.
* <li>If the <code>endpointReference</code> metadata does * <li>If the {@code endpointReference} metadata does
* not match the <code>serviceName</code> or <code>portName</code> * not match the {@code serviceName} or {@code portName}
* of a WSDL associated * of a WSDL associated
* with this <code>Service</code> instance. * with this {@code Service} instance.
* <li>If the <code>portName</code> cannot be determined * <li>If the {@code portName} cannot be determined
* from the <code>EndpointReference</code> metadata. * from the {@code EndpointReference} metadata.
* <li>If any error in the creation of * <li>If any error in the creation of
* the <code>Dispatch</code> object. * the {@code Dispatch} object.
* <li>If a feature is enabled that is not * <li>If a feature is enabled that is not
* compatible with this port or is unsupported. * compatible with this port or is unsupported.
* </UL> * </UL>
@ -465,7 +465,7 @@ public class Service {
} }
/** /**
* Creates a <code>Dispatch</code> instance for use with JAXB * Creates a {@code Dispatch} instance for use with JAXB
* generated objects. * generated objects.
* *
* @param portName Qualified name for the target service endpoint * @param portName Qualified name for the target service endpoint
@ -479,7 +479,7 @@ public class Service {
* *
* @return Dispatch instance. * @return Dispatch instance.
* @throws WebServiceException If any error in the creation of * @throws WebServiceException If any error in the creation of
* the <code>Dispatch</code> object. * the {@code Dispatch} object.
* *
* @see javax.xml.bind.JAXBContext * @see javax.xml.bind.JAXBContext
**/ **/
@ -490,7 +490,7 @@ public class Service {
/** /**
* Creates a <code>Dispatch</code> instance for use with JAXB * Creates a {@code Dispatch} instance for use with JAXB
* generated objects. * generated objects.
* *
* @param portName Qualified name for the target service endpoint * @param portName Qualified name for the target service endpoint
@ -501,13 +501,13 @@ public class Service {
* protocol messages or message payloads. E.g. when using the SOAP * protocol messages or message payloads. E.g. when using the SOAP
* protocol, this parameter controls whether the client will work with * protocol, this parameter controls whether the client will work with
* SOAP messages or the contents of a SOAP body. * SOAP messages or the contents of a SOAP body.
* @param features A list of <code>WebServiceFeatures</code> to configure on the * @param features A list of {@code WebServiceFeatures} to configure on the
* proxy. Supported features not in the <code>features * proxy. Supported features not in the {@code features
* </code> parameter will have their default values. * } parameter will have their default values.
* *
* @return Dispatch instance. * @return Dispatch instance.
* @throws WebServiceException If any error in the creation of * @throws WebServiceException If any error in the creation of
* the <code>Dispatch</code> object or if a * the {@code Dispatch} object or if a
* feature is enabled that is not compatible with * feature is enabled that is not compatible with
* this port or is unsupported. * this port or is unsupported.
* *
@ -523,39 +523,39 @@ public class Service {
/** /**
* Creates a <code>Dispatch</code> instance for use with JAXB * Creates a {@code Dispatch} instance for use with JAXB
* generated objects. If there * generated objects. If there
* are any reference parameters in the * are any reference parameters in the
* <code>endpointReference</code>, then those reference * {@code endpointReference}, then those reference
* parameters MUST appear as SOAP headers, indicating them to be * parameters MUST appear as SOAP headers, indicating them to be
* reference parameters, on all messages sent to the endpoint. * reference parameters, on all messages sent to the endpoint.
* The <code>endpointReference's</code> address MUST be used * The {@code endpointReference's} address MUST be used
* for invocations on the endpoint. * for invocations on the endpoint.
* In the implementation of this method, the JAX-WS * In the implementation of this method, the JAX-WS
* runtime system takes the responsibility of selecting a protocol * runtime system takes the responsibility of selecting a protocol
* binding (and a port) and configuring the dispatch accordingly from * binding (and a port) and configuring the dispatch accordingly from
* the WSDL associated with this <code>Service</code> instance or * the WSDL associated with this {@code Service} instance or
* from the metadata from the <code>endpointReference</code>. * from the metadata from the {@code endpointReference}.
* If this <code>Service</code> instance has a WSDL and * If this {@code Service} instance has a WSDL and
* the <code>endpointReference</code> * the {@code endpointReference}
* also has a WSDL in its metadata, then the WSDL from this instance * also has a WSDL in its metadata, then the WSDL from this instance
* MUST be used. * MUST be used.
* If this <code>Service</code> instance does not have a WSDL and * If this {@code Service} instance does not have a WSDL and
* the <code>endpointReference</code> does have a WSDL, then the * the {@code endpointReference} does have a WSDL, then the
* WSDL from the <code>endpointReference</code> MAY be used. * WSDL from the {@code endpointReference} MAY be used.
* An implementation MUST be able to retrieve the <code>portName</code> from the * An implementation MUST be able to retrieve the {@code portName} from the
* <code>endpointReference</code> metadata. * {@code endpointReference} metadata.
* <p> * <p>
* This method behavies the same as calling * This method behavies the same as calling
* <pre> * <pre>
* <code>dispatch = service.createDispatch(portName, context, mode, features);</code> * {@code dispatch = service.createDispatch(portName, context, mode, features);}
* </pre> * </pre>
* where the <code>portName</code> is retrieved from the * where the {@code portName} is retrieved from the
* WSDL or <code>endpointReference</code> metadata. * WSDL or {@code endpointReference} metadata.
* *
* @param endpointReference The <code>EndpointReference</code> * @param endpointReference The {@code EndpointReference}
* for the target service endpoint that will be invoked by the * for the target service endpoint that will be invoked by the
* returned <code>Dispatch</code> object. * returned {@code Dispatch} object.
* @param context The JAXB context used to marshall and unmarshall * @param context The JAXB context used to marshall and unmarshall
* messages or message payloads. * messages or message payloads.
* @param mode Controls whether the created dispatch instance is message * @param mode Controls whether the created dispatch instance is message
@ -563,23 +563,23 @@ public class Service {
* protocol messages or message payloads. E.g. when using the SOAP * protocol messages or message payloads. E.g. when using the SOAP
* protocol, this parameter controls whether the client will work with * protocol, this parameter controls whether the client will work with
* SOAP messages or the contents of a SOAP body. * SOAP messages or the contents of a SOAP body.
* @param features An array of <code>WebServiceFeatures</code> to configure on the * @param features An array of {@code WebServiceFeatures} to configure on the
* proxy. Supported features not in the <code>features * proxy. Supported features not in the {@code features
* </code> parameter will have their default values. * } parameter will have their default values.
* *
* @return Dispatch instance * @return Dispatch instance
* @throws WebServiceException * @throws WebServiceException
* <UL> * <UL>
* <li>If there is any missing WSDL metadata * <li>If there is any missing WSDL metadata
* as required by this method. * as required by this method.
* <li>If the <code>endpointReference</code> metadata does * <li>If the {@code endpointReference} metadata does
* not match the <code>serviceName</code> or <code>portName</code> * not match the {@code serviceName} or {@code portName}
* of a WSDL associated * of a WSDL associated
* with this <code>Service</code> instance. * with this {@code Service} instance.
* <li>If the <code>portName</code> cannot be determined * <li>If the {@code portName} cannot be determined
* from the <code>EndpointReference</code> metadata. * from the {@code EndpointReference} metadata.
* <li>If any error in the creation of * <li>If any error in the creation of
* the <code>Dispatch</code> object. * the {@code Dispatch} object.
* <li>if a feature is enabled that is not * <li>if a feature is enabled that is not
* compatible with this port or is unsupported. * compatible with this port or is unsupported.
* </UL> * </UL>
@ -604,12 +604,12 @@ public class Service {
} }
/** /**
* Returns an <code>Iterator</code> for the list of * Returns an {@code Iterator} for the list of
* <code>QName</code>s of service endpoints grouped by this * {@code QName}s of service endpoints grouped by this
* service * service
* *
* @return Returns <code>java.util.Iterator</code> with elements * @return Returns {@code java.util.Iterator} with elements
* of type <code>javax.xml.namespace.QName</code>. * of type {@code javax.xml.namespace.QName}.
* @throws WebServiceException If this Service class does not * @throws WebServiceException If this Service class does not
* have access to the required WSDL metadata. * have access to the required WSDL metadata.
**/ **/
@ -630,8 +630,8 @@ public class Service {
/** /**
* Returns the configured handler resolver. * Returns the configured handler resolver.
* *
* @return HandlerResolver The <code>HandlerResolver</code> being * @return HandlerResolver The {@code HandlerResolver} being
* used by this <code>Service</code> instance, or <code>null</code> * used by this {@code Service} instance, or {@code null}
* if there isn't one. * if there isn't one.
**/ **/
public HandlerResolver getHandlerResolver() { public HandlerResolver getHandlerResolver() {
@ -639,14 +639,14 @@ public class Service {
} }
/** /**
* Sets the <code>HandlerResolver</code> for this <code>Service</code> * Sets the {@code HandlerResolver} for this {@code Service}
* instance. * instance.
* <p> * <p>
* The handler resolver, if present, will be called once for each * The handler resolver, if present, will be called once for each
* proxy or dispatch instance that is created, and the handler chain * proxy or dispatch instance that is created, and the handler chain
* returned by the resolver will be set on the instance. * returned by the resolver will be set on the instance.
* *
* @param handlerResolver The <code>HandlerResolver</code> to use * @param handlerResolver The {@code HandlerResolver} to use
* for all subsequently created proxy/dispatch objects. * for all subsequently created proxy/dispatch objects.
* *
* @see javax.xml.ws.handler.HandlerResolver * @see javax.xml.ws.handler.HandlerResolver
@ -656,12 +656,12 @@ public class Service {
} }
/** /**
* Returns the executor for this <code>Service</code>instance. * Returns the executor for this {@code Service}instance.
* *
* The executor is used for all asynchronous invocations that * The executor is used for all asynchronous invocations that
* require callbacks. * require callbacks.
* *
* @return The <code>java.util.concurrent.Executor</code> to be * @return The {@code java.util.concurrent.Executor} to be
* used to invoke a callback. * used to invoke a callback.
* *
* @see java.util.concurrent.Executor * @see java.util.concurrent.Executor
@ -671,12 +671,12 @@ public class Service {
} }
/** /**
* Sets the executor for this <code>Service</code> instance. * Sets the executor for this {@code Service} instance.
* *
* The executor is used for all asynchronous invocations that * The executor is used for all asynchronous invocations that
* require callbacks. * require callbacks.
* *
* @param executor The <code>java.util.concurrent.Executor</code> * @param executor The {@code java.util.concurrent.Executor}
* to be used to invoke a callback. * to be used to invoke a callback.
* *
* @throws SecurityException If the instance does not support * @throws SecurityException If the instance does not support
@ -690,14 +690,14 @@ public class Service {
} }
/** /**
* Creates a <code>Service</code> instance. * Creates a {@code Service} instance.
* *
* The specified WSDL document location and service qualified name MUST * The specified WSDL document location and service qualified name MUST
* uniquely identify a <code>wsdl:service</code> element. * uniquely identify a {@code wsdl:service} element.
* *
* @param wsdlDocumentLocation <code>URL</code> for the WSDL document location * @param wsdlDocumentLocation {@code URL} for the WSDL document location
* for the service * for the service
* @param serviceName <code>QName</code> for the service * @param serviceName {@code QName} for the service
* @throws WebServiceException If any error in creation of the * @throws WebServiceException If any error in creation of the
* specified service. * specified service.
**/ **/
@ -708,15 +708,15 @@ public class Service {
} }
/** /**
* Creates a <code>Service</code> instance. The created instance is * Creates a {@code Service} instance. The created instance is
* configured with the web service features. * configured with the web service features.
* *
* The specified WSDL document location and service qualified name MUST * The specified WSDL document location and service qualified name MUST
* uniquely identify a <code>wsdl:service</code> element. * uniquely identify a {@code wsdl:service} element.
* *
* @param wsdlDocumentLocation <code>URL</code> for the WSDL document location * @param wsdlDocumentLocation {@code URL} for the WSDL document location
* for the service * for the service
* @param serviceName <code>QName</code> for the service * @param serviceName {@code QName} for the service
* @param features Web Service features that must be configured on * @param features Web Service features that must be configured on
* the service. If the provider doesn't understand a feature, * the service. If the provider doesn't understand a feature,
* it must throw a WebServiceException. * it must throw a WebServiceException.
@ -731,9 +731,9 @@ public class Service {
} }
/** /**
* Creates a <code>Service</code> instance. * Creates a {@code Service} instance.
* *
* @param serviceName <code>QName</code> for the service * @param serviceName {@code QName} for the service
* @throws WebServiceException If any error in creation of the * @throws WebServiceException If any error in creation of the
* specified service * specified service
*/ */
@ -742,10 +742,10 @@ public class Service {
} }
/** /**
* Creates a <code>Service</code> instance. The created instance is * Creates a {@code Service} instance. The created instance is
* configured with the web service features. * configured with the web service features.
* *
* @param serviceName <code>QName</code> for the service * @param serviceName {@code QName} for the service
* @param features Web Service features that must be configured on * @param features Web Service features that must be configured on
* the service. If the provider doesn't understand a feature, * the service. If the provider doesn't understand a feature,
* it must throw a WebServiceException. * it must throw a WebServiceException.

8
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/ServiceMode.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -44,9 +44,9 @@ import java.lang.annotation.Inherited;
@Documented @Documented
public @interface ServiceMode { public @interface ServiceMode {
/** /**
* Service mode. <code>PAYLOAD</code> indicates that the <code>Provider</code> implementation * Service mode. {@code PAYLOAD} indicates that the {@code Provider} implementation
* wishes to work with protocol message payloads only. <code>MESSAGE</code> indicates * wishes to work with protocol message payloads only. {@code MESSAGE} indicates
* that the <code>Provider</code> implementation wishes to work with entire protocol * that the {@code Provider} implementation wishes to work with entire protocol
* messages. * messages.
**/ **/
public Service.Mode value() default Service.Mode.PAYLOAD; public Service.Mode value() default Service.Mode.PAYLOAD;

8
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/WebEndpoint.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -36,9 +36,9 @@ import java.lang.annotation.RetentionPolicy;
* methods of a generated service interface. * methods of a generated service interface.
* *
* <p>The information specified in this annotation is sufficient * <p>The information specified in this annotation is sufficient
* to uniquely identify a <code>wsdl:port</code> element * to uniquely identify a {@code wsdl:port} element
* inside a <code>wsdl:service</code>. The latter is * inside a {@code wsdl:service}. The latter is
* determined based on the value of the <code>WebServiceClient</code> * determined based on the value of the {@code WebServiceClient}
* annotation on the generated service interface itself. * annotation on the generated service interface itself.
* *
* @since 1.6, JAX-WS 2.0 * @since 1.6, JAX-WS 2.0

6
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/WebServiceClient.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -35,8 +35,8 @@ import java.lang.annotation.RetentionPolicy;
* Used to annotate a generated service interface. * Used to annotate a generated service interface.
* *
* <p>The information specified in this annotation is sufficient * <p>The information specified in this annotation is sufficient
* to uniquely identify a <code>wsdl:service</code> * to uniquely identify a {@code wsdl:service}
* element inside a WSDL document. This <code>wsdl:service</code> * element inside a WSDL document. This {@code wsdl:service}
* element represents the Web service for which the generated * element represents the Web service for which the generated
* service interface provides a client view. * service interface provides a client view.
* *

54
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/WebServiceContext.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -32,14 +32,14 @@ import org.w3c.dom.Element;
/** /**
* A <code>WebServiceContext</code> makes it possible for * A {@code WebServiceContext} makes it possible for
* a web service endpoint implementation class to access * a web service endpoint implementation class to access
* message context and security information relative to * message context and security information relative to
* a request being served. * a request being served.
* *
* Typically a <code>WebServiceContext</code> is injected * Typically a {@code WebServiceContext} is injected
* into an endpoint implementation class using the * into an endpoint implementation class using the
* <code>Resource</code> annotation. * {@code Resource} annotation.
* *
* @since 1.6, JAX-WS 2.0 * @since 1.6, JAX-WS 2.0
* *
@ -48,7 +48,7 @@ import org.w3c.dom.Element;
public interface WebServiceContext { public interface WebServiceContext {
/** /**
* Returns the <code>MessageContext</code> for the request being served * Returns the {@code MessageContext} for the request being served
* at the time this method is called. Only properties with * at the time this method is called. Only properties with
* APPLICATION scope will be visible to the application. * APPLICATION scope will be visible to the application.
* *
@ -68,7 +68,7 @@ public interface WebServiceContext {
* Returns the Principal that identifies the sender * Returns the Principal that identifies the sender
* of the request currently being serviced. If the * of the request currently being serviced. If the
* sender has not been authenticated, the method * sender has not been authenticated, the method
* returns <code>null</code>. * returns {@code null}.
* *
* @return Principal The principal object. * @return Principal The principal object.
* *
@ -85,11 +85,11 @@ public interface WebServiceContext {
* Returns a boolean indicating whether the * Returns a boolean indicating whether the
* authenticated user is included in the specified * authenticated user is included in the specified
* logical role. If the user has not been * logical role. If the user has not been
* authenticated, the method returns <code>false</code>. * authenticated, the method returns {@code false}.
* *
* @param role A <code>String</code> specifying the name of the role * @param role A {@code String} specifying the name of the role
* *
* @return a <code>boolean</code> indicating whether * @return a {@code boolean} indicating whether
* the sender of the request belongs to a given role * the sender of the request belongs to a given role
* *
* @throws IllegalStateException This exception is thrown * @throws IllegalStateException This exception is thrown
@ -99,20 +99,20 @@ public interface WebServiceContext {
public boolean isUserInRole(String role); public boolean isUserInRole(String role);
/** /**
* Returns the <code>EndpointReference</code> for this * Returns the {@code EndpointReference} for this
* endpoint. * endpoint.
* <p> * <p>
* If the {@link Binding} for this <code>bindingProvider</code> is * If the {@link Binding} for this {@code bindingProvider} is
* either SOAP1.1/HTTP or SOAP1.2/HTTP, then a * either SOAP1.1/HTTP or SOAP1.2/HTTP, then a
* <code>W3CEndpointReference</code> MUST be returned. * {@code W3CEndpointReference} MUST be returned.
* *
* @param referenceParameters Reference parameters to be associated with the * @param referenceParameters Reference parameters to be associated with the
* returned <code>EndpointReference</code> instance. * returned {@code EndpointReference} instance.
* @return EndpointReference of the endpoint associated with this * @return EndpointReference of the endpoint associated with this
* <code>WebServiceContext</code>. * {@code WebServiceContext}.
* If the returned <code>EndpointReference</code> is of type * If the returned {@code EndpointReference} is of type
* <code>W3CEndpointReference</code> then it MUST contain the * {@code W3CEndpointReference} then it MUST contain the
* the specified <code>referenceParameters</code>. * the specified {@code referenceParameters}.
* *
* @throws IllegalStateException This exception is thrown * @throws IllegalStateException This exception is thrown
* if the method is called while no request is * if the method is called while no request is
@ -125,24 +125,24 @@ public interface WebServiceContext {
public EndpointReference getEndpointReference(Element... referenceParameters); public EndpointReference getEndpointReference(Element... referenceParameters);
/** /**
* Returns the <code>EndpointReference</code> associated with * Returns the {@code EndpointReference} associated with
* this endpoint. * this endpoint.
* *
* @param clazz The type of <code>EndpointReference</code> that * @param clazz The type of {@code EndpointReference} that
* MUST be returned. * MUST be returned.
* @param referenceParameters Reference parameters to be associated with the * @param referenceParameters Reference parameters to be associated with the
* returned <code>EndpointReference</code> instance. * returned {@code EndpointReference} instance.
* @return EndpointReference of type <code>clazz</code> of the endpoint * @return EndpointReference of type {@code clazz} of the endpoint
* associated with this <code>WebServiceContext</code> instance. * associated with this {@code WebServiceContext} instance.
* If the returned <code>EndpointReference</code> is of type * If the returned {@code EndpointReference} is of type
* <code>W3CEndpointReference</code> then it MUST contain the * {@code W3CEndpointReference} then it MUST contain the
* the specified <code>referenceParameters</code>. * the specified {@code referenceParameters}.
* *
* @throws IllegalStateException This exception is thrown * @throws IllegalStateException This exception is thrown
* if the method is called while no request is * if the method is called while no request is
* being serviced. * being serviced.
* @throws WebServiceException If the <code>clazz</code> type of * @throws WebServiceException If the {@code clazz} type of
* <code>EndpointReference</code> is not supported. * {@code EndpointReference} is not supported.
* *
* @since 1.6, JAX-WS 2.1 * @since 1.6, JAX-WS 2.1
**/ **/

6
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/WebServiceException.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -25,7 +25,7 @@
package javax.xml.ws; package javax.xml.ws;
/** The <code>WebServiceException</code> class is the base /** The {@code WebServiceException} class is the base
* exception class for all JAX-WS API runtime exceptions. * exception class for all JAX-WS API runtime exceptions.
* *
* @since 1.6, JAX-WS 2.0 * @since 1.6, JAX-WS 2.0
@ -33,7 +33,7 @@ package javax.xml.ws;
public class WebServiceException extends java.lang.RuntimeException { public class WebServiceException extends java.lang.RuntimeException {
/** Constructs a new exception with <code>null</code> as its /** Constructs a new exception with {@code null} as its
* detail message. The cause is not initialized. * detail message. The cause is not initialized.
**/ **/
public WebServiceException() { public WebServiceException() {

8
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/WebServiceFeature.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -34,7 +34,7 @@ package javax.xml.ws;
* JAX-WS implementors are free to define additional features if * JAX-WS implementors are free to define additional features if
* necessary. Vendor specific features may not be portable so * necessary. Vendor specific features may not be portable so
* caution should be used when using them. Each Feature definition * caution should be used when using them. Each Feature definition
* MUST define a <code>public static final String ID</code> * MUST define a {@code public static final String ID}
* that can be used in the Feature annotation to refer * that can be used in the Feature annotation to refer
* to the feature. This ID MUST be unique across all features * to the feature. This ID MUST be unique across all features
* of all vendors. When defining a vendor specific feature ID, * of all vendors. When defining a vendor specific feature ID,
@ -71,9 +71,9 @@ public abstract class WebServiceFeature {
/** /**
* Returns <code>true</code> if this feature is enabled. * Returns {@code true} if this feature is enabled.
* *
* @return <code>true</code> if and only if the feature is enabled . * @return {@code true} if and only if the feature is enabled .
*/ */
public boolean isEnabled() { public boolean isEnabled() {
return enabled; return enabled;

24
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/WebServiceRef.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2014, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -34,7 +34,7 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy; import java.lang.annotation.RetentionPolicy;
/** /**
* The <code>WebServiceRef</code> annotation is used to * The {@code WebServiceRef} annotation is used to
* define a reference to a web service and * define a reference to a web service and
* (optionally) an injection target for it. * (optionally) an injection target for it.
* It can be used to inject both service and proxy * It can be used to inject both service and proxy
@ -47,21 +47,21 @@ import java.lang.annotation.RetentionPolicy;
* Web service references are resources in the Java EE 5 sense. * Web service references are resources in the Java EE 5 sense.
* The annotations (for example, {@link Addressing}) annotated with * The annotations (for example, {@link Addressing}) annotated with
* meta-annotation {@link WebServiceFeatureAnnotation} * meta-annotation {@link WebServiceFeatureAnnotation}
* can be used in conjunction with <code>WebServiceRef</code>. * can be used in conjunction with {@code WebServiceRef}.
* The created reference MUST be configured with annotation's web service * The created reference MUST be configured with annotation's web service
* feature. * feature.
* *
* <p> * <p>
* For example, in the code below, the injected * For example, in the code below, the injected
* <code>StockQuoteProvider</code> proxy MUST * {@code StockQuoteProvider} proxy MUST
* have WS-Addressing enabled as specifed by the * have WS-Addressing enabled as specifed by the
* {@link Addressing} * {@link Addressing}
* annotation. * annotation.
* *
* <pre><code> * <pre><code>
* public class MyClient { * public class MyClient {
* &#64;Addressing * {@literal @}Addressing
* &#64;WebServiceRef(StockQuoteService.class) * {@literal @}WebServiceRef(StockQuoteService.class)
* private StockQuoteProvider stockQuoteProvider; * private StockQuoteProvider stockQuoteProvider;
* ... * ...
* } * }
@ -69,8 +69,8 @@ import java.lang.annotation.RetentionPolicy;
* *
* <p> * <p>
* If a JAX-WS implementation encounters an unsupported or unrecognized * If a JAX-WS implementation encounters an unsupported or unrecognized
* annotation annotated with the <code>WebServiceFeatureAnnotation</code> * annotation annotated with the {@code WebServiceFeatureAnnotation}
* that is specified with <code>WebServiceRef</code>, an ERROR MUST be given. * that is specified with {@code WebServiceRef}, an ERROR MUST be given.
* *
* @see javax.annotation.Resource * @see javax.annotation.Resource
* @see WebServiceFeatureAnnotation * @see WebServiceFeatureAnnotation
@ -91,7 +91,7 @@ public @interface WebServiceRef {
* and this MUST be specified. * and this MUST be specified.
* *
* The JNDI name can be absolute(with any logical namespace) or relative * The JNDI name can be absolute(with any logical namespace) or relative
* to JNDI <code>java:comp/env</code> namespace. * to JNDI {@code java:comp/env} namespace.
*/ */
String name() default ""; String name() default "";
@ -106,11 +106,11 @@ public @interface WebServiceRef {
/** /**
* A product specific name that this resource should be mapped to. * A product specific name that this resource should be mapped to.
* The name of this resource, as defined by the <code>name</code> * The name of this resource, as defined by the {@code name}
* element or defaulted, is a name that is local to the application * element or defaulted, is a name that is local to the application
* component using the resource. (When a relative JNDI name * component using the resource. (When a relative JNDI name
* is specified, then it's a name in the JNDI * is specified, then it's a name in the JNDI
* <code>java:comp/env</code> namespace.) Many application servers * {@code java:comp/env} namespace.) Many application servers
* provide a way to map these local names to names of resources * provide a way to map these local names to names of resources
* known to the application server. This mapped name is often a * known to the application server. This mapped name is often a
* <i>global</i> JNDI name, but may be a name of any form. * <i>global</i> JNDI name, but may be a name of any form.
@ -124,7 +124,7 @@ public @interface WebServiceRef {
/** /**
* The service class, always a type extending * The service class, always a type extending
* <code>javax.xml.ws.Service</code>. This element MUST be specified * {@code javax.xml.ws.Service}. This element MUST be specified
* whenever the type of the reference is a service endpoint interface. * whenever the type of the reference is a service endpoint interface.
*/ */
// 2.1 has Class value() default Object.class; // 2.1 has Class value() default Object.class;

12
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/WebServiceRefs.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -32,7 +32,7 @@ import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.*; import static java.lang.annotation.RetentionPolicy.*;
/** /**
* The <code>WebServiceRefs</code> annotation allows * The {@code WebServiceRefs} annotation allows
* multiple web service references to be declared at the * multiple web service references to be declared at the
* class level. * class level.
* *
@ -50,13 +50,13 @@ import static java.lang.annotation.RetentionPolicy.*;
* to inject the resource along with its features. * to inject the resource along with its features.
* *
* <p> * <p>
* <b>Example</b>: The <code>StockQuoteProvider</code> * <b>Example</b>: The {@code StockQuoteProvider}
* proxy instance, and the <code>StockQuoteService</code> service * proxy instance, and the {@code StockQuoteService} service
* instance are injected using @WebServiceRefs. * instance are injected using @WebServiceRefs.
* *
* <pre><code> * <pre><code>
* &#64;WebServiceRefs({&#64;WebServiceRef(name="service/stockquoteservice", value=StockQuoteService.class), * {@literal @}WebServiceRefs({{@literal @}WebServiceRef(name="service/stockquoteservice", value=StockQuoteService.class),
* &#64;WebServiceRef(name="service/stockquoteprovider", type=StockQuoteProvider.class, value=StockQuoteService.class}) * {@literal @}WebServiceRef(name="service/stockquoteprovider", type=StockQuoteProvider.class, value=StockQuoteService.class})
* public class MyClient { * public class MyClient {
* void init() { * void init() {
* Context ic = new InitialContext(); * Context ic = new InitialContext();

16
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/handler/Handler.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -28,14 +28,14 @@ package javax.xml.ws.handler;
import javax.xml.ws.ProtocolException; import javax.xml.ws.ProtocolException;
import javax.xml.ws.handler.MessageContext; import javax.xml.ws.handler.MessageContext;
/** The <code>Handler</code> interface /** The {@code Handler} interface
* is the base interface for JAX-WS handlers. * is the base interface for JAX-WS handlers.
* *
* @since 1.6, JAX-WS 2.0 * @since 1.6, JAX-WS 2.0
**/ **/
public interface Handler<C extends MessageContext> { public interface Handler<C extends MessageContext> {
/** The <code>handleMessage</code> method is invoked for normal processing /** The {@code handleMessage} method is invoked for normal processing
* of inbound and outbound messages. Refer to the description of the handler * of inbound and outbound messages. Refer to the description of the handler
* framework in the JAX-WS specification for full details. * framework in the JAX-WS specification for full details.
* *
@ -43,9 +43,9 @@ public interface Handler<C extends MessageContext> {
* @return An indication of whether handler processing should continue for * @return An indication of whether handler processing should continue for
* the current message * the current message
* <ul> * <ul>
* <li>Return <code>true</code> to continue * <li>Return {@code true} to continue
* processing.</li> * processing.</li>
* <li>Return <code>false</code> to block * <li>Return {@code false} to block
* processing.</li> * processing.</li>
* </ul> * </ul>
* @throws RuntimeException Causes the JAX-WS runtime to cease * @throws RuntimeException Causes the JAX-WS runtime to cease
@ -55,7 +55,7 @@ public interface Handler<C extends MessageContext> {
**/ **/
public boolean handleMessage(C context); public boolean handleMessage(C context);
/** The <code>handleFault</code> method is invoked for fault message /** The {@code handleFault} method is invoked for fault message
* processing. Refer to the description of the handler * processing. Refer to the description of the handler
* framework in the JAX-WS specification for full details. * framework in the JAX-WS specification for full details.
* *
@ -63,9 +63,9 @@ public interface Handler<C extends MessageContext> {
* @return An indication of whether handler fault processing should continue * @return An indication of whether handler fault processing should continue
* for the current message * for the current message
* <ul> * <ul>
* <li>Return <code>true</code> to continue * <li>Return {@code true} to continue
* processing.</li> * processing.</li>
* <li>Return <code>false</code> to block * <li>Return {@code false} to block
* processing.</li> * processing.</li>
* </ul> * </ul>
* @throws RuntimeException Causes the JAX-WS runtime to cease * @throws RuntimeException Causes the JAX-WS runtime to cease

4
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/handler/LogicalHandler.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -25,7 +25,7 @@
package javax.xml.ws.handler; package javax.xml.ws.handler;
/** The <code>LogicalHandler</code> extends /** The {@code LogicalHandler} extends
* Handler to provide typesafety for the message context parameter. * Handler to provide typesafety for the message context parameter.
* *
* @since 1.6, JAX-WS 2.0 * @since 1.6, JAX-WS 2.0

8
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/handler/LogicalMessageContext.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -27,8 +27,8 @@ package javax.xml.ws.handler;
import javax.xml.ws.LogicalMessage; import javax.xml.ws.LogicalMessage;
/** The <code>LogicalMessageContext</code> interface extends /** The {@code LogicalMessageContext} interface extends
* <code>MessageContext</code> to * {@code MessageContext} to
* provide access to a the contained message as a protocol neutral * provide access to a the contained message as a protocol neutral
* LogicalMessage * LogicalMessage
* *
@ -39,7 +39,7 @@ public interface LogicalMessageContext
/** Gets the message from this message context /** Gets the message from this message context
* *
* @return The contained message; returns <code>null</code> if no * @return The contained message; returns {@code null} if no
* message is present in this message context * message is present in this message context
**/ **/
public LogicalMessage getMessage(); public LogicalMessage getMessage();

6
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/handler/PortInfo.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -28,8 +28,8 @@ package javax.xml.ws.handler;
import javax.xml.namespace.QName; import javax.xml.namespace.QName;
/** /**
* The <code>PortInfo</code> interface is used by a * The {@code PortInfo} interface is used by a
* <code>HandlerResolver</code> to query information about * {@code HandlerResolver} to query information about
* the port it is being asked to create a handler chain for. * the port it is being asked to create a handler chain for.
* <p> * <p>
* This interface is never implemented by an application, * This interface is never implemented by an application,

8
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/handler/soap/SOAPHandler.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -29,7 +29,7 @@ import javax.xml.namespace.QName;
import javax.xml.ws.handler.Handler; import javax.xml.ws.handler.Handler;
import java.util.Set; import java.util.Set;
/** The <code>SOAPHandler</code> class extends <code>Handler</code> /** The {@code SOAPHandler} class extends {@code Handler}
* to provide typesafety for the message context parameter and add a method * to provide typesafety for the message context parameter and add a method
* to obtain access to the headers that may be processed by the handler. * to obtain access to the headers that may be processed by the handler.
* *
@ -41,8 +41,8 @@ public interface SOAPHandler<T extends SOAPMessageContext>
/** Gets the header blocks that can be processed by this Handler /** Gets the header blocks that can be processed by this Handler
* instance. * instance.
* *
* @return Set of <code>QNames</code> of header blocks processed by this * @return Set of {@code QNames} of header blocks processed by this
* handler instance. <code>QName</code> is the qualified * handler instance. {@code QName} is the qualified
* name of the outermost element of the Header block. * name of the outermost element of the Header block.
**/ **/
Set<QName> getHeaders(); Set<QName> getHeaders();

36
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/handler/soap/SOAPMessageContext.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -30,9 +30,9 @@ import javax.xml.bind.JAXBContext;
import javax.xml.namespace.QName; import javax.xml.namespace.QName;
import java.util.Set; import java.util.Set;
/** The interface <code>SOAPMessageContext</code> /** The interface {@code SOAPMessageContext}
* provides access to the SOAP message for either RPC request or * provides access to the SOAP message for either RPC request or
* response. The <code>javax.xml.soap.SOAPMessage</code> specifies * response. The {@code javax.xml.soap.SOAPMessage} specifies
* the standard Java API for the representation of a SOAP 1.1 message * the standard Java API for the representation of a SOAP 1.1 message
* with attachments. * with attachments.
* *
@ -43,20 +43,20 @@ import java.util.Set;
public interface SOAPMessageContext public interface SOAPMessageContext
extends javax.xml.ws.handler.MessageContext { extends javax.xml.ws.handler.MessageContext {
/** Gets the <code>SOAPMessage</code> from this message context. Modifications /** Gets the {@code SOAPMessage} from this message context. Modifications
* to the returned <code>SOAPMessage</code> change the message in-place, there * to the returned {@code SOAPMessage} change the message in-place, there
* is no need to subsequently call <code>setMessage</code>. * is no need to subsequently call {@code setMessage}.
* *
* @return Returns the <code>SOAPMessage</code>; returns <code>null</code> if no * @return Returns the {@code SOAPMessage}; returns {@code null} if no
* <code>SOAPMessage</code> is present in this message context * {@code SOAPMessage} is present in this message context
**/ **/
public SOAPMessage getMessage(); public SOAPMessage getMessage();
/** Sets the SOAPMessage in this message context /** Sets the SOAPMessage in this message context
* *
* @param message SOAP message * @param message SOAP message
* @throws WebServiceException If any error during the setting * @throws javax.xml.ws.WebServiceException If any error during the setting
* of the <code>SOAPMessage</code> in this message context * of the {@code SOAPMessage} in this message context
* @throws java.lang.UnsupportedOperationException If this * @throws java.lang.UnsupportedOperationException If this
* operation is not supported * operation is not supported
**/ **/
@ -69,16 +69,16 @@ public interface SOAPMessageContext
* @param header The XML qualified name of the SOAP header(s). * @param header The XML qualified name of the SOAP header(s).
* @param context The JAXBContext that should be used to unmarshall the * @param context The JAXBContext that should be used to unmarshall the
* header * header
* @param allRoles If <code>true</code> then returns headers for all SOAP * @param allRoles If {@code true} then returns headers for all SOAP
* roles, if <code>false</code> then only returns headers targetted * roles, if {@code false} then only returns headers targetted
* at the roles currently being played by this SOAP node, see * at the roles currently being played by this SOAP node, see
* <code>getRoles</code>. * {@code getRoles}.
* @return An array of unmarshalled headers; returns an empty array if no * @return An array of unmarshalled headers; returns an empty array if no
* message is present in this message context or no headers match * message is present in this message context or no headers match
* the supplied qualified name. * the supplied qualified name.
* @throws WebServiceException If an error occurs when using the supplied * @throws javax.xml.ws.WebServiceException If an error occurs when using the supplied
* <code>JAXBContext</code> to unmarshall. The cause of * {@code JAXBContext} to unmarshall. The cause of
* the <code>WebServiceException</code> is the original <code>JAXBException</code>. * the {@code WebServiceException} is the original {@code JAXBException}.
**/ **/
public Object[] getHeaders(QName header, JAXBContext context, public Object[] getHeaders(QName header, JAXBContext context,
boolean allRoles); boolean allRoles);
@ -87,13 +87,13 @@ public interface SOAPMessageContext
* of the handler chain. * of the handler chain.
* Note that SOAP actor roles apply to the SOAP node and * Note that SOAP actor roles apply to the SOAP node and
* are managed using {@link javax.xml.ws.soap.SOAPBinding#setRoles} and * are managed using {@link javax.xml.ws.soap.SOAPBinding#setRoles} and
* {@link javax.xml.ws.soap.SOAPBinding#getRoles}. <code>Handler</code> instances in * {@link javax.xml.ws.soap.SOAPBinding#getRoles}. {@code Handler} instances in
* the handler chain use this information about the SOAP actor * the handler chain use this information about the SOAP actor
* roles to process the SOAP header blocks. Note that the * roles to process the SOAP header blocks. Note that the
* SOAP actor roles are invariant during the processing of * SOAP actor roles are invariant during the processing of
* SOAP message through the handler chain. * SOAP message through the handler chain.
* *
* @return Array of <code>String</code> for SOAP actor roles * @return Array of {@code String} for SOAP actor roles
**/ **/
public Set<String> getRoles(); public Set<String> getRoles();
} }

4
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/http/HTTPBinding.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -28,7 +28,7 @@ package javax.xml.ws.http;
import javax.xml.ws.Binding; import javax.xml.ws.Binding;
/** The <code>HTTPBinding</code> interface is an /** The {@code HTTPBinding} interface is an
* abstraction for the XML/HTTP binding. * abstraction for the XML/HTTP binding.
* *
* @since 1.6, JAX-WS 2.0 * @since 1.6, JAX-WS 2.0

6
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/http/HTTPException.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -26,7 +26,7 @@
package javax.xml.ws.http; package javax.xml.ws.http;
/** The <code>HTTPException</code> exception represents a /** The {@code HTTPException} exception represents a
* XML/HTTP fault. * XML/HTTP fault.
* *
* <p>Since there is no standard format for faults or exceptions * <p>Since there is no standard format for faults or exceptions
@ -39,7 +39,7 @@ public class HTTPException extends javax.xml.ws.ProtocolException {
private int statusCode; private int statusCode;
/** Constructor for the HTTPException /** Constructor for the HTTPException
* @param statusCode <code>int</code> for the HTTP status code * @param statusCode {@code int} for the HTTP status code
**/ **/
public HTTPException(int statusCode) { public HTTPException(int statusCode) {
super(); super();

8
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/soap/Addressing.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -46,12 +46,12 @@ import javax.xml.ws.spi.WebServiceFeatureAnnotation;
* This annotation MUST only be used in conjunction with the * This annotation MUST only be used in conjunction with the
* {@link javax.jws.WebService}, {@link WebServiceProvider}, * {@link javax.jws.WebService}, {@link WebServiceProvider},
* and {@link WebServiceRef} annotations. * and {@link WebServiceRef} annotations.
* When used with a <code>javax.jws.WebService</code> annotation, this * When used with a {@code javax.jws.WebService} annotation, this
* annotation MUST only be used on the service endpoint implementation * annotation MUST only be used on the service endpoint implementation
* class. * class.
* When used with a <code>WebServiceRef</code> annotation, this annotation * When used with a {@code WebServiceRef} annotation, this annotation
* MUST only be used when a proxy instance is created. The injected SEI * MUST only be used when a proxy instance is created. The injected SEI
* proxy, and endpoint MUST honor the values of the <code>Addressing</code> * proxy, and endpoint MUST honor the values of the {@code Addressing}
* annotation. * annotation.
* <p> * <p>
* This annotation's behaviour is defined by the corresponding feature * This annotation's behaviour is defined by the corresponding feature

6
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/soap/SOAPBinding.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -70,7 +70,7 @@ public interface SOAPBinding extends Binding {
/** Sets the roles played by the SOAP binding instance. /** Sets the roles played by the SOAP binding instance.
* *
* @param roles The set of roles played by the binding instance. * @param roles The set of roles played by the binding instance.
* @throws WebServiceException On an error in the configuration of * @throws javax.xml.ws.WebServiceException On an error in the configuration of
* the list of roles. * the list of roles.
**/ **/
public void setRoles(Set<String> roles); public void setRoles(Set<String> roles);
@ -88,7 +88,7 @@ public interface SOAPBinding extends Binding {
* *
* @param flag A {@code boolean} specifying whether the use of MTOM should * @param flag A {@code boolean} specifying whether the use of MTOM should
* be enabled or disabled. * be enabled or disabled.
* @throws WebServiceException If the specified setting is not supported * @throws javax.xml.ws.WebServiceException If the specified setting is not supported
* by this binding instance. * by this binding instance.
* *
**/ **/

24
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/soap/SOAPFaultException.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -27,18 +27,18 @@ package javax.xml.ws.soap;
import javax.xml.soap.SOAPFault; import javax.xml.soap.SOAPFault;
/** The <code>SOAPFaultException</code> exception represents a /** The {@code SOAPFaultException} exception represents a
* SOAP 1.1 or 1.2 fault. * SOAP 1.1 or 1.2 fault.
* *
* <p>A <code>SOAPFaultException</code> wraps a SAAJ <code>SOAPFault</code> * <p>A {@code SOAPFaultException} wraps a SAAJ {@code SOAPFault}
* that manages the SOAP-specific representation of faults. * that manages the SOAP-specific representation of faults.
* The <code>createFault</code> method of * The {@code createFault} method of
* <code>javax.xml.soap.SOAPFactory</code> may be used to create an instance * {@code javax.xml.soap.SOAPFactory} may be used to create an instance
* of <code>javax.xml.soap.SOAPFault</code> for use with the * of {@code javax.xml.soap.SOAPFault} for use with the
* constructor. <code>SOAPBinding</code> contains an accessor for the * constructor. {@code SOAPBinding} contains an accessor for the
* <code>SOAPFactory</code> used by the binding instance. * {@code SOAPFactory} used by the binding instance.
* *
* <p>Note that the value of <code>getFault</code> is the only part of the * <p>Note that the value of {@code getFault} is the only part of the
* exception used when searializing a SOAP fault. * exception used when searializing a SOAP fault.
* *
* <p>Refer to the SOAP specification for a complete * <p>Refer to the SOAP specification for a complete
@ -55,7 +55,7 @@ public class SOAPFaultException extends javax.xml.ws.ProtocolException {
private SOAPFault fault; private SOAPFault fault;
/** Constructor for SOAPFaultException /** Constructor for SOAPFaultException
* @param fault <code>SOAPFault</code> representing the fault * @param fault {@code SOAPFault} representing the fault
* *
* @see javax.xml.soap.SOAPFactory#createFault * @see javax.xml.soap.SOAPFactory#createFault
**/ **/
@ -64,9 +64,9 @@ public class SOAPFaultException extends javax.xml.ws.ProtocolException {
this.fault = fault; this.fault = fault;
} }
/** Gets the embedded <code>SOAPFault</code> instance. /** Gets the embedded {@code SOAPFault} instance.
* *
* @return <code>javax.xml.soap.SOAPFault</code> SOAP * @return {@code javax.xml.soap.SOAPFault} SOAP
* fault element * fault element
**/ **/
public javax.xml.soap.SOAPFault getFault() { public javax.xml.soap.SOAPFault getFault() {

14
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/spi/FactoryFinder.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -34,7 +34,7 @@ class FactoryFinder {
/** /**
* Creates an instance of the specified class using the specified * Creates an instance of the specified class using the specified
* <code>ClassLoader</code> object. * {@code ClassLoader} object.
* *
* @exception WebServiceException if the given class could not be found * @exception WebServiceException if the given class could not be found
* or could not be instantiated * or could not be instantiated
@ -56,22 +56,22 @@ class FactoryFinder {
} }
/** /**
* Finds the implementation <code>Class</code> object for the given * Finds the implementation {@code Class} object for the given
* factory name, or if that fails, finds the <code>Class</code> object * factory name, or if that fails, finds the {@code Class} object
* for the given fallback class name. The arguments supplied MUST be * for the given fallback class name. The arguments supplied MUST be
* used in order. If using the first argument is successful, the second * used in order. If using the first argument is successful, the second
* one will not be used. * one will not be used.
* <P> * <P>
* This method is package private so that this code can be shared. * This method is package private so that this code can be shared.
* *
* @return the <code>Class</code> object of the specified message factory; * @return the {@code Class} object of the specified message factory;
* may not be <code>null</code> * may not be {@code null}
* *
* @param factoryId the name of the factory to find, which is * @param factoryId the name of the factory to find, which is
* a system property * a system property
* @param fallbackClassName the implementation class name, which is * @param fallbackClassName the implementation class name, which is
* to be used only if nothing else * to be used only if nothing else
* is found; <code>null</code> to indicate that * is found; {@code null} to indicate that
* there is no fallback class name * there is no fallback class name
* @exception WebServiceException if there is an error * @exception WebServiceException if there is an error
*/ */

10
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/spi/Invoker.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2009, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2009, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -37,8 +37,8 @@ import java.lang.reflect.InvocationTargetException;
* for a web service invocation. Finally, Invoker does the actual * for a web service invocation. Finally, Invoker does the actual
* invocation of web service on endpoint instance. * invocation of web service on endpoint instance.
* *
* Container also injects the provided <code>WebServiceContext</code> and takes * Container also injects the provided {@code WebServiceContext} and takes
* care of invoking <code>javax.annotation.PostConstruct</code> methods, * care of invoking {@code javax.annotation.PostConstruct} methods,
* if present, on the endpoint implementation. * if present, on the endpoint implementation.
* *
* @see Provider#createEndpoint(String, Class, Invoker, WebServiceFeature...) * @see Provider#createEndpoint(String, Class, Invoker, WebServiceFeature...)
@ -51,7 +51,7 @@ public abstract class Invoker {
/** /**
* JAX-WS runtimes calls this method to ask container to inject * JAX-WS runtimes calls this method to ask container to inject
* WebServiceContext on the endpoint instance. The * WebServiceContext on the endpoint instance. The
* <code>WebServiceContext</code> object uses thread-local information * {@code WebServiceContext} object uses thread-local information
* to return the correct information during the actual endpoint invocation * to return the correct information during the actual endpoint invocation
* regardless of how many threads are concurrently being used to serve * regardless of how many threads are concurrently being used to serve
* requests. * requests.
@ -70,7 +70,7 @@ public abstract class Invoker {
/** /**
* JAX-WS runtime calls this method to do the actual web service * JAX-WS runtime calls this method to do the actual web service
* invocation on endpoint instance. The injected * invocation on endpoint instance. The injected
* <code>WebServiceContext.getMessageContext()</code> gives the correct * {@code WebServiceContext.getMessageContext()} gives the correct
* information for this invocation. * information for this invocation.
* *
* @param m Method to be invoked on the service * @param m Method to be invoked on the service

4
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/spi/Provider.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2014, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -288,7 +288,7 @@ public abstract class Provider {
* method can automatically determine the {@code address} of * method can automatically determine the {@code address} of
* an endpoint that is published by the same Java EE application and is * an endpoint that is published by the same Java EE application and is
* identified by the {@code serviceName} and * identified by the {@code serviceName} and
* {@code portName} propeties. If the {@code address} is * {@code portName} properties. If the {@code address} is
* {@code null} and the {@code serviceName} and * {@code null} and the {@code serviceName} and
* {@code portName} do not identify an endpoint published by the * {@code portName} do not identify an endpoint published by the
* same Java EE application, a * same Java EE application, a

280
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/spi/ServiceDelegate.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -37,11 +37,11 @@ import javax.xml.ws.WebServiceException;
/** /**
* Service delegates are used internally by <code>Service</code> objects * Service delegates are used internally by {@code Service} objects
* to allow pluggability of JAX-WS implementations. * to allow pluggability of JAX-WS implementations.
* <p> * <p>
* Every <code>Service</code> object has its own delegate, created using * Every {@code Service} object has its own delegate, created using
* the {@link javax.xml.ws.spi.Provider#createServiceDelegate} method. A <code>Service</code> * the {@link javax.xml.ws.spi.Provider#createServiceDelegate} method. A {@code Service}
* object delegates all of its instance methods to its delegate. * object delegates all of its instance methods to its delegate.
* *
* @see javax.xml.ws.Service * @see javax.xml.ws.Service
@ -55,9 +55,9 @@ public abstract class ServiceDelegate {
} }
/** /**
* The <code>getPort</code> method returns a proxy. A service client * The {@code getPort} method returns a proxy. A service client
* uses this proxy to invoke operations on the target * uses this proxy to invoke operations on the target
* service endpoint. The <code>serviceEndpointInterface</code> * service endpoint. The {@code serviceEndpointInterface}
* specifies the service endpoint interface that is supported by * specifies the service endpoint interface that is supported by
* the created dynamic proxy instance. * the created dynamic proxy instance.
* *
@ -76,8 +76,8 @@ public abstract class ServiceDelegate {
* <LI>If there is any missing WSDL metadata * <LI>If there is any missing WSDL metadata
* as required by this method * as required by this method
* <LI>If an illegal * <LI>If an illegal
* <code>serviceEndpointInterface</code> * {@code serviceEndpointInterface}
* or <code>portName</code> is specified * or {@code portName} is specified
* </UL> * </UL>
* @see java.lang.reflect.Proxy * @see java.lang.reflect.Proxy
* @see java.lang.reflect.InvocationHandler * @see java.lang.reflect.InvocationHandler
@ -86,9 +86,9 @@ public abstract class ServiceDelegate {
Class<T> serviceEndpointInterface); Class<T> serviceEndpointInterface);
/** /**
* The <code>getPort</code> method returns a proxy. A service client * The {@code getPort} method returns a proxy. A service client
* uses this proxy to invoke operations on the target * uses this proxy to invoke operations on the target
* service endpoint. The <code>serviceEndpointInterface</code> * service endpoint. The {@code serviceEndpointInterface}
* specifies the service endpoint interface that is supported by * specifies the service endpoint interface that is supported by
* the created dynamic proxy instance. * the created dynamic proxy instance.
* *
@ -97,8 +97,8 @@ public abstract class ServiceDelegate {
* @param serviceEndpointInterface Service endpoint interface * @param serviceEndpointInterface Service endpoint interface
* supported by the dynamic proxy or instance * supported by the dynamic proxy or instance
* @param features A list of WebServiceFeatures to configure on the * @param features A list of WebServiceFeatures to configure on the
* proxy. Supported features not in the <code>features * proxy. Supported features not in the {@code features
* </code> parameter will have their default values. * } parameter will have their default values.
* @return Object Proxy instance that * @return Object Proxy instance that
* supports the specified service endpoint * supports the specified service endpoint
* interface * interface
@ -110,8 +110,8 @@ public abstract class ServiceDelegate {
* <LI>If there is any missing WSDL metadata * <LI>If there is any missing WSDL metadata
* as required by this method * as required by this method
* <LI>If an illegal * <LI>If an illegal
* <code>serviceEndpointInterface</code> * {@code serviceEndpointInterface}
* or <code>portName</code> is specified * or {@code portName} is specified
* <LI>If a feature is enabled that is not compatible * <LI>If a feature is enabled that is not compatible
* with this port or is unsupported. * with this port or is unsupported.
* </UL> * </UL>
@ -125,31 +125,31 @@ public abstract class ServiceDelegate {
Class<T> serviceEndpointInterface, WebServiceFeature... features); Class<T> serviceEndpointInterface, WebServiceFeature... features);
/** /**
* The <code>getPort</code> method returns a proxy. * The {@code getPort} method returns a proxy.
* The parameter <code>endpointReference</code> specifies the * The parameter {@code endpointReference} specifies the
* endpoint that will be invoked by the returned proxy. If there * endpoint that will be invoked by the returned proxy. If there
* are any reference parameters in the * are any reference parameters in the
* <code>endpointReference</code>, then those reference * {@code endpointReference}, then those reference
* parameters MUST appear as SOAP headers, indicating them to be * parameters MUST appear as SOAP headers, indicating them to be
* reference parameters, on all messages sent to the endpoint. * reference parameters, on all messages sent to the endpoint.
* The <code>endpointReference's</code> address MUST be used * The {@code endpointReference's} address MUST be used
* for invocations on the endpoint. * for invocations on the endpoint.
* The parameter <code>serviceEndpointInterface</code> specifies * The parameter {@code serviceEndpointInterface} specifies
* the service endpoint interface that is supported by the * the service endpoint interface that is supported by the
* returned proxy. * returned proxy.
* In the implementation of this method, the JAX-WS * In the implementation of this method, the JAX-WS
* runtime system takes the responsibility of selecting a protocol * runtime system takes the responsibility of selecting a protocol
* binding (and a port) and configuring the proxy accordingly from * binding (and a port) and configuring the proxy accordingly from
* the WSDL associated with this <code>Service</code> instance or * the WSDL associated with this {@code Service} instance or
* from the metadata from the <code>endpointReference</code>. * from the metadata from the {@code endpointReference}.
* If this <code>Service</code> instance has a WSDL and * If this {@code Service} instance has a WSDL and
* the <code>endpointReference</code> metadata * the {@code endpointReference} metadata
* also has a WSDL, then the WSDL from this instance MUST be used. * also has a WSDL, then the WSDL from this instance MUST be used.
* If this <code>Service</code> instance does not have a WSDL and * If this {@code Service} instance does not have a WSDL and
* the <code>endpointReference</code> does have a WSDL, then the * the {@code endpointReference} does have a WSDL, then the
* WSDL from the <code>endpointReference</code> MAY be used. * WSDL from the {@code endpointReference} MAY be used.
* The returned proxy should not be reconfigured by the client. * The returned proxy should not be reconfigured by the client.
* If this <code>Service</code> instance has a known proxy * If this {@code Service} instance has a known proxy
* port that matches the information contained in * port that matches the information contained in
* the WSDL, * the WSDL,
* then that proxy is returned, otherwise a WebServiceException * then that proxy is returned, otherwise a WebServiceException
@ -157,20 +157,20 @@ public abstract class ServiceDelegate {
* <p> * <p>
* Calling this method has the same behavior as the following * Calling this method has the same behavior as the following
* <pre> * <pre>
* <code>port = service.getPort(portName, serviceEndpointInterface);</code> * {@code port = service.getPort(portName, serviceEndpointInterface);}
* </pre> * </pre>
* where the <code>portName</code> is retrieved from the * where the {@code portName} is retrieved from the
* metadata of the <code>endpointReference</code> or from the * metadata of the {@code endpointReference} or from the
* <code>serviceEndpointInterface</code> and the WSDL * {@code serviceEndpointInterface} and the WSDL
* associated with this <code>Service</code> instance. * associated with this {@code Service} instance.
* *
* @param endpointReference The <code>EndpointReference</code> * @param endpointReference The {@code EndpointReference}
* for the target service endpoint that will be invoked by the * for the target service endpoint that will be invoked by the
* returned proxy. * returned proxy.
* @param serviceEndpointInterface Service endpoint interface. * @param serviceEndpointInterface Service endpoint interface.
* @param features A list of <code>WebServiceFeatures</code> to configure on the * @param features A list of {@code WebServiceFeatures} to configure on the
* proxy. Supported features not in the <code>features * proxy. Supported features not in the {@code features
* </code> parameter will have their default values. * } parameter will have their default values.
* @return Object Proxy instance that supports the * @return Object Proxy instance that supports the
* specified service endpoint interface. * specified service endpoint interface.
* @throws WebServiceException * @throws WebServiceException
@ -179,16 +179,16 @@ public abstract class ServiceDelegate {
* of the proxy. * of the proxy.
* <LI>If there is any missing WSDL metadata * <LI>If there is any missing WSDL metadata
* as required by this method. * as required by this method.
* <LI>If the <code>endpointReference</code> metadata does * <LI>If the {@code endpointReference} metadata does
* not match the <code>serviceName</code> of this * not match the {@code serviceName} of this
* <code>Service</code> instance. * {@code Service} instance.
* <LI>If a <code>portName</code> cannot be extracted * <LI>If a {@code portName} cannot be extracted
* from the WSDL or <code>endpointReference</code> metadata. * from the WSDL or {@code endpointReference} metadata.
* <LI>If an invalid * <LI>If an invalid
* <code>endpointReference</code> * {@code endpointReference}
* is specified. * is specified.
* <LI>If an invalid * <LI>If an invalid
* <code>serviceEndpointInterface</code> * {@code serviceEndpointInterface}
* is specified. * is specified.
* <LI>If a feature is enabled that is not compatible * <LI>If a feature is enabled that is not compatible
* with this port or is unsupported. * with this port or is unsupported.
@ -201,8 +201,8 @@ public abstract class ServiceDelegate {
/** /**
* The <code>getPort</code> method returns a proxy. The parameter * The {@code getPort} method returns a proxy. The parameter
* <code>serviceEndpointInterface</code> specifies the service * {@code serviceEndpointInterface} specifies the service
* endpoint interface that is supported by the returned proxy. * endpoint interface that is supported by the returned proxy.
* In the implementation of this method, the JAX-WS * In the implementation of this method, the JAX-WS
* runtime system takes the responsibility of selecting a protocol * runtime system takes the responsibility of selecting a protocol
@ -219,7 +219,7 @@ public abstract class ServiceDelegate {
* <LI>If there is any missing WSDL metadata * <LI>If there is any missing WSDL metadata
* as required by this method * as required by this method
* <LI>If an illegal * <LI>If an illegal
* <code>serviceEndpointInterface</code> * {@code serviceEndpointInterface}
* is specified * is specified
* </UL> * </UL>
**/ **/
@ -227,8 +227,8 @@ public abstract class ServiceDelegate {
/** /**
* The <code>getPort</code> method returns a proxy. The parameter * The {@code getPort} method returns a proxy. The parameter
* <code>serviceEndpointInterface</code> specifies the service * {@code serviceEndpointInterface} specifies the service
* endpoint interface that is supported by the returned proxy. * endpoint interface that is supported by the returned proxy.
* In the implementation of this method, the JAX-WS * In the implementation of this method, the JAX-WS
* runtime system takes the responsibility of selecting a protocol * runtime system takes the responsibility of selecting a protocol
@ -236,9 +236,9 @@ public abstract class ServiceDelegate {
* The returned proxy should not be reconfigured by the client. * The returned proxy should not be reconfigured by the client.
* *
* @param serviceEndpointInterface Service endpoint interface * @param serviceEndpointInterface Service endpoint interface
* @param features An array of <code>WebServiceFeatures</code> to configure on the * @param features An array of {@code WebServiceFeatures} to configure on the
* proxy. Supported features not in the <code>features * proxy. Supported features not in the {@code features
* </code> parameter will have their default values. * } parameter will have their default values.
* @return Object instance that supports the * @return Object instance that supports the
* specified service endpoint interface * specified service endpoint interface
* @throws WebServiceException * @throws WebServiceException
@ -248,7 +248,7 @@ public abstract class ServiceDelegate {
* <LI>If there is any missing WSDL metadata * <LI>If there is any missing WSDL metadata
* as required by this method * as required by this method
* <LI>If an illegal * <LI>If an illegal
* <code>serviceEndpointInterface</code> * {@code serviceEndpointInterface}
* is specified * is specified
* <LI>If a feature is enabled that is not compatible * <LI>If a feature is enabled that is not compatible
* with this port or is unsupported. * with this port or is unsupported.
@ -265,7 +265,7 @@ public abstract class ServiceDelegate {
/** /**
* Creates a new port for the service. Ports created in this way contain * Creates a new port for the service. Ports created in this way contain
* no WSDL port type information and can only be used for creating * no WSDL port type information and can only be used for creating
* <code>Dispatch</code>instances. * {@code Dispatch}instances.
* *
* @param portName Qualified name for the target service endpoint * @param portName Qualified name for the target service endpoint
* @param bindingId A URI identifier of a binding. * @param bindingId A URI identifier of a binding.
@ -283,23 +283,23 @@ public abstract class ServiceDelegate {
/** /**
* Creates a <code>Dispatch</code> instance for use with objects of * Creates a {@code Dispatch} instance for use with objects of
* the user's choosing. * the user's choosing.
* *
* @param portName Qualified name for the target service endpoint * @param portName Qualified name for the target service endpoint
* @param type The class of object used for messages or message * @param type The class of object used for messages or message
* payloads. Implementations are required to support * payloads. Implementations are required to support
* <code>javax.xml.transform.Source</code> and <code>javax.xml.soap.SOAPMessage</code>. * {@code javax.xml.transform.Source} and {@code javax.xml.soap.SOAPMessage}.
* @param mode Controls whether the created dispatch instance is message * @param mode Controls whether the created dispatch instance is message
* or payload oriented, i.e. whether the user will work with complete * or payload oriented, i.e. whether the user will work with complete
* protocol messages or message payloads. E.g. when using the SOAP * protocol messages or message payloads. E.g. when using the SOAP
* protocol, this parameter controls whether the user will work with * protocol, this parameter controls whether the user will work with
* SOAP messages or the contents of a SOAP body. Mode MUST be <code>MESSAGE</code> * SOAP messages or the contents of a SOAP body. Mode MUST be {@code MESSAGE}
* when type is <code>SOAPMessage</code>. * when type is {@code SOAPMessage}.
* *
* @return Dispatch instance * @return Dispatch instance
* @throws WebServiceException If any error in the creation of * @throws WebServiceException If any error in the creation of
* the <code>Dispatch</code> object * the {@code Dispatch} object
* @see javax.xml.transform.Source * @see javax.xml.transform.Source
* @see javax.xml.soap.SOAPMessage * @see javax.xml.soap.SOAPMessage
**/ **/
@ -307,26 +307,26 @@ public abstract class ServiceDelegate {
Service.Mode mode); Service.Mode mode);
/** /**
* Creates a <code>Dispatch</code> instance for use with objects of * Creates a {@code Dispatch} instance for use with objects of
* the user's choosing. * the user's choosing.
* *
* @param portName Qualified name for the target service endpoint * @param portName Qualified name for the target service endpoint
* @param type The class of object used for messages or message * @param type The class of object used for messages or message
* payloads. Implementations are required to support * payloads. Implementations are required to support
* <code>javax.xml.transform.Source</code> and <code>javax.xml.soap.SOAPMessage</code>. * {@code javax.xml.transform.Source} and {@code javax.xml.soap.SOAPMessage}.
* @param mode Controls whether the created dispatch instance is message * @param mode Controls whether the created dispatch instance is message
* or payload oriented, i.e. whether the user will work with complete * or payload oriented, i.e. whether the user will work with complete
* protocol messages or message payloads. E.g. when using the SOAP * protocol messages or message payloads. E.g. when using the SOAP
* protocol, this parameter controls whether the user will work with * protocol, this parameter controls whether the user will work with
* SOAP messages or the contents of a SOAP body. Mode MUST be <code>MESSAGE</code> * SOAP messages or the contents of a SOAP body. Mode MUST be {@code MESSAGE}
* when type is <code>SOAPMessage</code>. * when type is {@code SOAPMessage}.
* @param features A list of <code>WebServiceFeatures</code> to configure on the * @param features A list of {@code WebServiceFeatures} to configure on the
* proxy. Supported features not in the <code>features * proxy. Supported features not in the {@code features
* </code> parameter will have their default values. * } parameter will have their default values.
* *
* @return Dispatch instance * @return Dispatch instance
* @throws WebServiceException If any error in the creation of * @throws WebServiceException If any error in the creation of
* the <code>Dispatch</code> object or if a * the {@code Dispatch} object or if a
* feature is enabled that is not compatible with * feature is enabled that is not compatible with
* this port or is unsupported. * this port or is unsupported.
* *
@ -340,64 +340,64 @@ public abstract class ServiceDelegate {
Service.Mode mode, WebServiceFeature... features); Service.Mode mode, WebServiceFeature... features);
/** /**
* Creates a <code>Dispatch</code> instance for use with objects of * Creates a {@code Dispatch} instance for use with objects of
* the user's choosing. If there * the user's choosing. If there
* are any reference parameters in the * are any reference parameters in the
* <code>endpointReference</code>, then those reference * {@code endpointReference}, then those reference
* parameters MUST appear as SOAP headers, indicating them to be * parameters MUST appear as SOAP headers, indicating them to be
* reference parameters, on all messages sent to the endpoint. * reference parameters, on all messages sent to the endpoint.
* The <code>endpointReference's</code> address MUST be used * The {@code endpointReference's} address MUST be used
* for invocations on the endpoint. * for invocations on the endpoint.
* In the implementation of this method, the JAX-WS * In the implementation of this method, the JAX-WS
* runtime system takes the responsibility of selecting a protocol * runtime system takes the responsibility of selecting a protocol
* binding (and a port) and configuring the dispatch accordingly from * binding (and a port) and configuring the dispatch accordingly from
* the WSDL associated with this <code>Service</code> instance or * the WSDL associated with this {@code Service} instance or
* from the metadata from the <code>endpointReference</code>. * from the metadata from the {@code endpointReference}.
* If this <code>Service</code> instance has a WSDL and * If this {@code Service} instance has a WSDL and
* the <code>endpointReference</code> * the {@code endpointReference}
* also has a WSDL in its metadata, then the WSDL from this instance MUST be used. * also has a WSDL in its metadata, then the WSDL from this instance MUST be used.
* If this <code>Service</code> instance does not have a WSDL and * If this {@code Service} instance does not have a WSDL and
* the <code>endpointReference</code> does have a WSDL, then the * the {@code endpointReference} does have a WSDL, then the
* WSDL from the <code>endpointReference</code> MAY be used. * WSDL from the {@code endpointReference} MAY be used.
* An implementation MUST be able to retrieve the <code>portName</code> from the * An implementation MUST be able to retrieve the {@code portName} from the
* <code>endpointReference</code> metadata. * {@code endpointReference} metadata.
* <p> * <p>
* This method behaves the same as calling * This method behaves the same as calling
* <pre> * <pre>
* <code>dispatch = service.createDispatch(portName, type, mode, features);</code> * {@code dispatch = service.createDispatch(portName, type, mode, features);}
* </pre> * </pre>
* where the <code>portName</code> is retrieved from the * where the {@code portName} is retrieved from the
* WSDL or <code>EndpointReference</code> metadata. * WSDL or {@code EndpointReference} metadata.
* *
* @param endpointReference The <code>EndpointReference</code> * @param endpointReference The {@code EndpointReference}
* for the target service endpoint that will be invoked by the * for the target service endpoint that will be invoked by the
* returned <code>Dispatch</code> object. * returned {@code Dispatch} object.
* @param type The class of object used to messages or message * @param type The class of object used to messages or message
* payloads. Implementations are required to support * payloads. Implementations are required to support
* <code>javax.xml.transform.Source</code> and <code>javax.xml.soap.SOAPMessage</code>. * {@code javax.xml.transform.Source} and {@code javax.xml.soap.SOAPMessage}.
* @param mode Controls whether the created dispatch instance is message * @param mode Controls whether the created dispatch instance is message
* or payload oriented, i.e. whether the user will work with complete * or payload oriented, i.e. whether the user will work with complete
* protocol messages or message payloads. E.g. when using the SOAP * protocol messages or message payloads. E.g. when using the SOAP
* protocol, this parameter controls whether the user will work with * protocol, this parameter controls whether the user will work with
* SOAP messages or the contents of a SOAP body. Mode MUST be <code>MESSAGE</code> * SOAP messages or the contents of a SOAP body. Mode MUST be {@code MESSAGE}
* when type is <code>SOAPMessage</code>. * when type is {@code SOAPMessage}.
* @param features An array of <code>WebServiceFeatures</code> to configure on the * @param features An array of {@code WebServiceFeatures} to configure on the
* proxy. Supported features not in the <code>features * proxy. Supported features not in the {@code features
* </code> parameter will have their default values. * } parameter will have their default values.
* *
* @return Dispatch instance * @return Dispatch instance
* @throws WebServiceException * @throws WebServiceException
* <UL> * <UL>
* <LI>If there is any missing WSDL metadata * <LI>If there is any missing WSDL metadata
* as required by this method. * as required by this method.
* <li>If the <code>endpointReference</code> metadata does * <li>If the {@code endpointReference} metadata does
* not match the <code>serviceName</code> or <code>portName</code> * not match the {@code serviceName} or {@code portName}
* of a WSDL associated * of a WSDL associated
* with this <code>Service</code> instance. * with this {@code Service} instance.
* <li>If the <code>portName</code> cannot be determined * <li>If the {@code portName} cannot be determined
* from the <code>EndpointReference</code> metadata. * from the {@code EndpointReference} metadata.
* <li>If any error in the creation of * <li>If any error in the creation of
* the <code>Dispatch</code> object. * the {@code Dispatch} object.
* <li>If a feature is enabled that is not * <li>If a feature is enabled that is not
* compatible with this port or is unsupported. * compatible with this port or is unsupported.
* </UL> * </UL>
@ -415,7 +415,7 @@ public abstract class ServiceDelegate {
/** /**
* Creates a <code>Dispatch</code> instance for use with JAXB * Creates a {@code Dispatch} instance for use with JAXB
* generated objects. * generated objects.
* *
* @param portName Qualified name for the target service endpoint * @param portName Qualified name for the target service endpoint
@ -429,7 +429,7 @@ public abstract class ServiceDelegate {
* *
* @return Dispatch instance * @return Dispatch instance
* @throws WebServiceException If any error in the creation of * @throws WebServiceException If any error in the creation of
* the <code>Dispatch</code> object * the {@code Dispatch} object
* *
* @see javax.xml.bind.JAXBContext * @see javax.xml.bind.JAXBContext
**/ **/
@ -438,7 +438,7 @@ public abstract class ServiceDelegate {
/** /**
* Creates a <code>Dispatch</code> instance for use with JAXB * Creates a {@code Dispatch} instance for use with JAXB
* generated objects. * generated objects.
* *
* @param portName Qualified name for the target service endpoint * @param portName Qualified name for the target service endpoint
@ -449,13 +449,13 @@ public abstract class ServiceDelegate {
* protocol messages or message payloads. E.g. when using the SOAP * protocol messages or message payloads. E.g. when using the SOAP
* protocol, this parameter controls whether the user will work with * protocol, this parameter controls whether the user will work with
* SOAP messages or the contents of a SOAP body. * SOAP messages or the contents of a SOAP body.
* @param features A list of <code>WebServiceFeatures</code> to configure on the * @param features A list of {@code WebServiceFeatures} to configure on the
* proxy. Supported features not in the <code>features * proxy. Supported features not in the {@code features
* </code> parameter will have their default values. * } parameter will have their default values.
* *
* @return Dispatch instance * @return Dispatch instance
* @throws WebServiceException If any error in the creation of * @throws WebServiceException If any error in the creation of
* the <code>Dispatch</code> object or if a * the {@code Dispatch} object or if a
* feature is enabled that is not compatible with * feature is enabled that is not compatible with
* this port or is unsupported. * this port or is unsupported.
* *
@ -468,39 +468,39 @@ public abstract class ServiceDelegate {
JAXBContext context, Service.Mode mode, WebServiceFeature... features); JAXBContext context, Service.Mode mode, WebServiceFeature... features);
/** /**
* Creates a <code>Dispatch</code> instance for use with JAXB * Creates a {@code Dispatch} instance for use with JAXB
* generated objects. If there * generated objects. If there
* are any reference parameters in the * are any reference parameters in the
* <code>endpointReference</code>, then those reference * {@code endpointReference}, then those reference
* parameters MUST appear as SOAP headers, indicating them to be * parameters MUST appear as SOAP headers, indicating them to be
* reference parameters, on all messages sent to the endpoint. * reference parameters, on all messages sent to the endpoint.
* The <code>endpointReference's</code> address MUST be used * The {@code endpointReference's} address MUST be used
* for invocations on the endpoint. * for invocations on the endpoint.
* In the implementation of this method, the JAX-WS * In the implementation of this method, the JAX-WS
* runtime system takes the responsibility of selecting a protocol * runtime system takes the responsibility of selecting a protocol
* binding (and a port) and configuring the dispatch accordingly from * binding (and a port) and configuring the dispatch accordingly from
* the WSDL associated with this <code>Service</code> instance or * the WSDL associated with this {@code Service} instance or
* from the metadata from the <code>endpointReference</code>. * from the metadata from the {@code endpointReference}.
* If this <code>Service</code> instance has a WSDL and * If this {@code Service} instance has a WSDL and
* the <code>endpointReference</code> * the {@code endpointReference}
* also has a WSDL in its metadata, then the WSDL from this instance * also has a WSDL in its metadata, then the WSDL from this instance
* MUST be used. * MUST be used.
* If this <code>Service</code> instance does not have a WSDL and * If this {@code Service} instance does not have a WSDL and
* the <code>endpointReference</code> does have a WSDL, then the * the {@code endpointReference} does have a WSDL, then the
* WSDL from the <code>endpointReference</code> MAY be used. * WSDL from the {@code endpointReference} MAY be used.
* An implementation MUST be able to retrieve the <code>portName</code> from the * An implementation MUST be able to retrieve the {@code portName} from the
* <code>endpointReference</code> metadata. * {@code endpointReference} metadata.
* <p> * <p>
* This method behavies the same as calling * This method behavies the same as calling
* <pre> * <pre>
* <code>dispatch = service.createDispatch(portName, context, mode, features);</code> * {@code dispatch = service.createDispatch(portName, context, mode, features);}
* </pre> * </pre>
* where the <code>portName</code> is retrieved from the * where the {@code portName} is retrieved from the
* WSDL or <code>endpointReference</code> metadata. * WSDL or {@code endpointReference} metadata.
* *
* @param endpointReference The <code>EndpointReference</code> * @param endpointReference The {@code EndpointReference}
* for the target service endpoint that will be invoked by the * for the target service endpoint that will be invoked by the
* returned <code>Dispatch</code> object. * returned {@code Dispatch} object.
* @param context The JAXB context used to marshall and unmarshall * @param context The JAXB context used to marshall and unmarshall
* messages or message payloads. * messages or message payloads.
* @param mode Controls whether the created dispatch instance is message * @param mode Controls whether the created dispatch instance is message
@ -508,23 +508,23 @@ public abstract class ServiceDelegate {
* protocol messages or message payloads. E.g. when using the SOAP * protocol messages or message payloads. E.g. when using the SOAP
* protocol, this parameter controls whether the user will work with * protocol, this parameter controls whether the user will work with
* SOAP messages or the contents of a SOAP body. * SOAP messages or the contents of a SOAP body.
* @param features An array of <code>WebServiceFeatures</code> to configure on the * @param features An array of {@code WebServiceFeatures} to configure on the
* proxy. Supported features not in the <code>features * proxy. Supported features not in the {@code features
* </code> parameter will have their default values. * } parameter will have their default values.
* *
* @return Dispatch instance * @return Dispatch instance
* @throws WebServiceException * @throws WebServiceException
* <UL> * <UL>
* <li>If there is any missing WSDL metadata * <li>If there is any missing WSDL metadata
* as required by this method. * as required by this method.
* <li>If the <code>endpointReference</code> metadata does * <li>If the {@code endpointReference} metadata does
* not match the <code>serviceName</code> or <code>portName</code> * not match the {@code serviceName} or {@code portName}
* of a WSDL associated * of a WSDL associated
* with this <code>Service</code> instance. * with this {@code Service} instance.
* <li>If the <code>portName</code> cannot be determined * <li>If the {@code portName} cannot be determined
* from the <code>EndpointReference</code> metadata. * from the {@code EndpointReference} metadata.
* <li>If any error in the creation of * <li>If any error in the creation of
* the <code>Dispatch</code> object. * the {@code Dispatch} object.
* <li>if a feature is enabled that is not * <li>if a feature is enabled that is not
* compatible with this port or is unsupported. * compatible with this port or is unsupported.
* </UL> * </UL>
@ -546,12 +546,12 @@ public abstract class ServiceDelegate {
public abstract QName getServiceName(); public abstract QName getServiceName();
/** /**
* Returns an <code>Iterator</code> for the list of * Returns an {@code Iterator} for the list of
* <code>QName</code>s of service endpoints grouped by this * {@code QName}s of service endpoints grouped by this
* service * service
* *
* @return Returns <code>java.util.Iterator</code> with elements * @return Returns {@code java.util.Iterator} with elements
* of type <code>javax.xml.namespace.QName</code> * of type {@code javax.xml.namespace.QName}
* @throws WebServiceException If this Service class does not * @throws WebServiceException If this Service class does not
* have access to the required WSDL metadata * have access to the required WSDL metadata
**/ **/
@ -568,21 +568,21 @@ public abstract class ServiceDelegate {
/** /**
* Returns the configured handler resolver. * Returns the configured handler resolver.
* *
* @return HandlerResolver The <code>HandlerResolver</code> being * @return HandlerResolver The {@code HandlerResolver} being
* used by this <code>Service</code> instance, or <code>null</code> * used by this {@code Service} instance, or {@code null}
* if there isn't one. * if there isn't one.
**/ **/
public abstract HandlerResolver getHandlerResolver(); public abstract HandlerResolver getHandlerResolver();
/** /**
* Sets the <code>HandlerResolver</code> for this <code>Service</code> * Sets the {@code HandlerResolver} for this {@code Service}
* instance. * instance.
* <p> * <p>
* The handler resolver, if present, will be called once for each * The handler resolver, if present, will be called once for each
* proxy or dispatch instance that is created, and the handler chain * proxy or dispatch instance that is created, and the handler chain
* returned by the resolver will be set on the instance. * returned by the resolver will be set on the instance.
* *
* @param handlerResolver The <code>HandlerResolver</code> to use * @param handlerResolver The {@code HandlerResolver} to use
* for all subsequently created proxy/dispatch objects. * for all subsequently created proxy/dispatch objects.
* *
* @see javax.xml.ws.handler.HandlerResolver * @see javax.xml.ws.handler.HandlerResolver
@ -590,12 +590,12 @@ public abstract class ServiceDelegate {
public abstract void setHandlerResolver(HandlerResolver handlerResolver); public abstract void setHandlerResolver(HandlerResolver handlerResolver);
/** /**
* Returns the executor for this <code>Service</code>instance. * Returns the executor for this {@code Service}instance.
* *
* The executor is used for all asynchronous invocations that * The executor is used for all asynchronous invocations that
* require callbacks. * require callbacks.
* *
* @return The <code>java.util.concurrent.Executor</code> to be * @return The {@code java.util.concurrent.Executor} to be
* used to invoke a callback. * used to invoke a callback.
* *
* @see java.util.concurrent.Executor * @see java.util.concurrent.Executor
@ -603,12 +603,12 @@ public abstract class ServiceDelegate {
public abstract java.util.concurrent.Executor getExecutor(); public abstract java.util.concurrent.Executor getExecutor();
/** /**
* Sets the executor for this <code>Service</code> instance. * Sets the executor for this {@code Service} instance.
* *
* The executor is used for all asynchronous invocations that * The executor is used for all asynchronous invocations that
* require callbacks. * require callbacks.
* *
* @param executor The <code>java.util.concurrent.Executor</code> * @param executor The {@code java.util.concurrent.Executor}
* to be used to invoke a callback. * to be used to invoke a callback.
* *
* @throws SecurityException If the instance does not support * @throws SecurityException If the instance does not support

10
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/spi/http/HttpExchange.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -41,7 +41,7 @@ import java.security.Principal;
* for examining the request from the client, and for building and * for examining the request from the client, and for building and
* sending the response. * sending the response.
* <p> * <p>
* A <code>HttpExchange</code> must be closed to free or reuse * A {@code HttpExchange} must be closed to free or reuse
* underlying resources. The effect of failing to close an exchange * underlying resources. The effect of failing to close an exchange
* is undefined. * is undefined.
* *
@ -277,7 +277,7 @@ public abstract class HttpExchange {
/** /**
* Returns an attribute that is associated with this * Returns an attribute that is associated with this
* <code>HttpExchange</code>. JAX-WS handlers and endpoints may then * {@code HttpExchange}. JAX-WS handlers and endpoints may then
* access the attribute via {@link MessageContext}. * access the attribute via {@link MessageContext}.
* <p> * <p>
* Servlet containers must expose {@link MessageContext#SERVLET_CONTEXT}, * Servlet containers must expose {@link MessageContext#SERVLET_CONTEXT},
@ -299,7 +299,7 @@ public abstract class HttpExchange {
/** /**
* Gives all the attribute names that are associated with * Gives all the attribute names that are associated with
* this <code>HttpExchange</code>. * this {@code HttpExchange}.
* *
* @return set of all attribute names * @return set of all attribute names
* @see #getAttribute(String) * @see #getAttribute(String)
@ -308,7 +308,7 @@ public abstract class HttpExchange {
/** /**
* Returns the {@link Principal} that represents the authenticated * Returns the {@link Principal} that represents the authenticated
* user for this <code>HttpExchange</code>. * user for this {@code HttpExchange}.
* *
* @return Principal for an authenticated user, or * @return Principal for an authenticated user, or
* <tt>null</tt> if not authenticated * <tt>null</tt> if not authenticated

4
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/wsaddressing/W3CEndpointReference.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2014, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -90,7 +90,7 @@ public final class W3CEndpointReference extends EndpointReference {
* If the source does NOT contain a valid W3C WS-Addressing * If the source does NOT contain a valid W3C WS-Addressing
* EndpointReference. * EndpointReference.
* @throws NullPointerException * @throws NullPointerException
* If the <code>null</code> <code>source</code> value is given * If the {@code null} {@code source} value is given
*/ */
public W3CEndpointReference(Source source) { public W3CEndpointReference(Source source) {
try { try {

237
jaxws/src/java.xml.ws/share/classes/javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.java
View file

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2005, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -38,35 +38,35 @@ import javax.xml.ws.spi.Provider;
/** /**
* This class is used to build <code>W3CEndpointReference</code> * This class is used to build {@code W3CEndpointReference}
* instances. The intended use of this clsss is for * instances. The intended use of this clsss is for
* an application component, for example a factory component, * an application component, for example a factory component,
* to create an <code>W3CEndpointReference</code> for a * to create an {@code W3CEndpointReference} for a
* web service endpoint published by the same * web service endpoint published by the same
* Java EE application. It can also be used to create * Java EE application. It can also be used to create
* <code>W3CEndpointReferences</code> for an Java SE based * {@code W3CEndpointReferences} for an Java SE based
* endpoint by providing the <code>address</code> property. * endpoint by providing the {@code address} property.
* <p> * <p>
* When creating a <code>W3CEndpointReference</code> for an * When creating a {@code W3CEndpointReference} for an
* endpoint that is not published by the same Java EE application, * endpoint that is not published by the same Java EE application,
* the <code>address</code> property MUST be specified. * the {@code address} property MUST be specified.
* <p> * <p>
* When creating a <code>W3CEndpointReference</code> for an endpoint * When creating a {@code W3CEndpointReference} for an endpoint
* published by the same Java EE application, the <code>address</code> * published by the same Java EE application, the {@code address}
* property MAY be <code>null</code> but then the <code>serviceName</code> * property MAY be {@code null} but then the {@code serviceName}
* and <code>endpointName</code> MUST specify an endpoint published by * and {@code endpointName} MUST specify an endpoint published by
* the same Java EE application. * the same Java EE application.
* <p> * <p>
* When the <code>wsdlDocumentLocation</code> is specified it MUST refer * When the {@code wsdlDocumentLocation} is specified it MUST refer
* to a valid WSDL document and the <code>serviceName</code> and * to a valid WSDL document and the {@code serviceName} and
* <code>endpointName</code> (if specified) MUST match a service and port * {@code endpointName} (if specified) MUST match a service and port
* in the WSDL document. * in the WSDL document.
* *
* @since 1.6, JAX-WS 2.1 * @since 1.6, JAX-WS 2.1
*/ */
public final class W3CEndpointReferenceBuilder { public final class W3CEndpointReferenceBuilder {
/** /**
* Creates a new <code>W3CEndpointReferenceBuilder</code> instance. * Creates a new {@code W3CEndpointReferenceBuilder} instance.
*/ */
public W3CEndpointReferenceBuilder() { public W3CEndpointReferenceBuilder() {
referenceParameters = new ArrayList<Element>(); referenceParameters = new ArrayList<Element>();
@ -76,20 +76,20 @@ public final class W3CEndpointReferenceBuilder {
} }
/** /**
* Sets the <code>address</code> to the * Sets the {@code address} to the
* <code>W3CEndpointReference</code> instance's * {@code W3CEndpointReference} instance's
* <code>wsa:Address</code>. * {@code wsa:Address}.
* <p> * <p>
* The <code>address</code> MUST be set to a non-<code>null</code> * The {@code address} MUST be set to a non-{@code null}
* value when building a <code>W3CEndpointReference</code> for a * value when building a {@code W3CEndpointReference} for a
* web service endpoint that is not published by the same * web service endpoint that is not published by the same
* Java EE application or when running on Java SE. * Java EE application or when running on Java SE.
* *
* @param address The address of the endpoint to be targeted * @param address The address of the endpoint to be targeted
* by the returned <code>W3CEndpointReference</code>. * by the returned {@code W3CEndpointReference}.
* *
* @return A <code>W3CEndpointReferenceBuilder</code> instance with * @return A {@code W3CEndpointReferenceBuilder} instance with
* the <code>address</code> set to the <code>wsa:Address</code>. * the {@code address} set to the {@code wsa:Address}.
*/ */
public W3CEndpointReferenceBuilder address(String address) { public W3CEndpointReferenceBuilder address(String address) {
this.address = address; this.address = address;
@ -97,19 +97,19 @@ public final class W3CEndpointReferenceBuilder {
} }
/** /**
* Sets the <code>interfaceName</code> as the * Sets the {@code interfaceName} as the
* <code>wsam:InterfaceName</code> element in the * {@code wsam:InterfaceName} element in the
* <code>wsa:Metadata</code> element. * {@code wsa:Metadata} element.
* *
* See <a href="http://www.w3.org/TR/2007/REC-ws-addr-metadata-20070904/#refmetadatfromepr"> * See <a href="http://www.w3.org/TR/2007/REC-ws-addr-metadata-20070904/#refmetadatfromepr">
* 2.1 Referencing WSDL Metadata from an EPR</a> for more details. * 2.1 Referencing WSDL Metadata from an EPR</a> for more details.
* *
* @param interfaceName The port type name of the endpoint to be targeted * @param interfaceName The port type name of the endpoint to be targeted
* by the returned <code>W3CEndpointReference</code>. * by the returned {@code W3CEndpointReference}.
* *
* @return A <code>W3CEndpointReferenceBuilder</code> instance with * @return A {@code W3CEndpointReferenceBuilder} instance with
* the <code>interfaceName</code> as <code>wsam:InterfaceName</code> * the {@code interfaceName} as {@code wsam:InterfaceName}
* element added to the <code>wsa:Metadata</code> element * element added to the {@code wsa:Metadata} element
* @since 1.7 * @since 1.7
*/ */
public W3CEndpointReferenceBuilder interfaceName(QName interfaceName) { public W3CEndpointReferenceBuilder interfaceName(QName interfaceName) {
@ -118,22 +118,22 @@ public final class W3CEndpointReferenceBuilder {
} }
/** /**
* Sets the <code>serviceName</code> as the * Sets the {@code serviceName} as the
* <code>wsam:ServiceName</code> element in the * {@code wsam:ServiceName} element in the
* <code>wsa:Metadata</code> element. * {@code wsa:Metadata} element.
* *
* See <a href="http://www.w3.org/TR/2007/REC-ws-addr-metadata-20070904/#refmetadatfromepr"> * See <a href="http://www.w3.org/TR/2007/REC-ws-addr-metadata-20070904/#refmetadatfromepr">
* 2.1 Referencing WSDL Metadata from an EPR</a> for more details. * 2.1 Referencing WSDL Metadata from an EPR</a> for more details.
* *
* @param serviceName The service name of the endpoint to be targeted * @param serviceName The service name of the endpoint to be targeted
* by the returned <code>W3CEndpointReference</code>. This property * by the returned {@code W3CEndpointReference}. This property
* may also be used with the <code>endpointName</code> (portName) * may also be used with the {@code endpointName} (portName)
* property to lookup the <code>address</code> of a web service * property to lookup the {@code address} of a web service
* endpoint that is published by the same Java EE application. * endpoint that is published by the same Java EE application.
* *
* @return A <code>W3CEndpointReferenceBuilder</code> instance with * @return A {@code W3CEndpointReferenceBuilder} instance with
* the <code>serviceName</code> as <code>wsam:ServiceName</code> * the {@code serviceName} as {@code wsam:ServiceName}
* element added to the <code>wsa:Metadata</code> element * element added to the {@code wsa:Metadata} element
* *
*/ */
public W3CEndpointReferenceBuilder serviceName(QName serviceName) { public W3CEndpointReferenceBuilder serviceName(QName serviceName) {
@ -142,30 +142,31 @@ public final class W3CEndpointReferenceBuilder {
} }
/** /**
* Sets the <code>endpointName</code> as * Sets the {@code endpointName} as
* <code>wsam:ServiceName/@EndpointName</code> in the * {@code wsam:ServiceName/@EndpointName} in the
* <code>wsa:Metadata</code> element. This method can only be called * {@code wsa:Metadata} element. This method can only be called
* after the {@link #serviceName} method has been called. * after the {@link #serviceName} method has been called.
* <p> * <p>
* See <a href="http://www.w3.org/TR/2007/REC-ws-addr-metadata-20070904/#refmetadatfromepr"> * See <a href="http://www.w3.org/TR/2007/REC-ws-addr-metadata-20070904/#refmetadatfromepr">
* 2.1 Referencing WSDL Metadata from an EPR</a> for more details. * 2.1 Referencing WSDL Metadata from an EPR</a> for more details.
* *
* @param endpointName The name of the endpoint to be targeted * @param endpointName The name of the endpoint to be targeted
* by the returned <code>W3CEndpointReference</code>. The * by the returned {@code W3CEndpointReference}. The
* <code>endpointName</code> (portName) property may also be * {@code endpointName} (portName) property may also be
* used with the <code>serviceName</code> property to lookup * used with the {@code serviceName} property to lookup
* the <code>address</code> of a web service * the {@code address} of a web service
* endpoint published by the same Java EE application. * endpoint published by the same Java EE application.
* *
* @return A <code>W3CEndpointReferenceBuilder</code> instance with * @return A {@code W3CEndpointReferenceBuilder} instance with
* the <code>endpointName</code> as * the {@code endpointName} as
* <code>wsam:ServiceName/@EndpointName</code> in the * {@code wsam:ServiceName/@EndpointName} in the
* <code>wsa:Metadata</code> element. * {@code wsa:Metadata} element.
* *
* @throws IllegalStateException, if the <code>serviceName</code> * @throws java.lang.IllegalStateException if the {@code serviceName}
* has not been set. * has not been set
* @throws IllegalArgumentException, if the <code>endpointName</code>'s *
* Namespace URI doesn't match <code>serviceName</code>'s Namespace URI * @throws java.lang.IllegalArgumentException if the {@code endpointName}'s
* Namespace URI doesn't match {@code serviceName}'s Namespace URI
* *
*/ */
public W3CEndpointReferenceBuilder endpointName(QName endpointName) { public W3CEndpointReferenceBuilder endpointName(QName endpointName) {
@ -178,8 +179,8 @@ public final class W3CEndpointReferenceBuilder {
} }
/** /**
* Sets the <code>wsdlDocumentLocation</code> that will be referenced * Sets the {@code wsdlDocumentLocation} that will be referenced
* as <code>wsa:Metadata/@wsdli:wsdlLocation</code>. The namespace name * as {@code wsa:Metadata/@wsdli:wsdlLocation}. The namespace name
* for the wsdli:wsdlLocation's value can be taken from the WSDL itself. * for the wsdli:wsdlLocation's value can be taken from the WSDL itself.
* *
* <p> * <p>
@ -187,10 +188,10 @@ public final class W3CEndpointReferenceBuilder {
* 2.1 Referencing WSDL Metadata from an EPR</a> for more details. * 2.1 Referencing WSDL Metadata from an EPR</a> for more details.
* *
* @param wsdlDocumentLocation The location of the WSDL document to * @param wsdlDocumentLocation The location of the WSDL document to
* be referenced in the <code>wsa:Metadata</code> of the * be referenced in the {@code wsa:Metadata} of the
* <code>W3CEndpointReference</code>. * {@code W3CEndpointReference}.
* @return A <code>W3CEndpointReferenceBuilder</code> instance with * @return A {@code W3CEndpointReferenceBuilder} instance with
* the <code>wsdlDocumentLocation</code> that is to be referenced. * the {@code wsdlDocumentLocation} that is to be referenced.
*/ */
public W3CEndpointReferenceBuilder wsdlDocumentLocation(String wsdlDocumentLocation) { public W3CEndpointReferenceBuilder wsdlDocumentLocation(String wsdlDocumentLocation) {
this.wsdlDocumentLocation = wsdlDocumentLocation; this.wsdlDocumentLocation = wsdlDocumentLocation;
@ -198,19 +199,19 @@ public final class W3CEndpointReferenceBuilder {
} }
/** /**
* Adds the <code>referenceParameter</code> to the * Adds the {@code referenceParameter} to the
* <code>W3CEndpointReference</code> instance * {@code W3CEndpointReference} instance
* <code>wsa:ReferenceParameters</code> element. * {@code wsa:ReferenceParameters} element.
* *
* @param referenceParameter The element to be added to the * @param referenceParameter The element to be added to the
* <code>wsa:ReferenceParameters</code> element. * {@code wsa:ReferenceParameters} element.
* *
* @return A <code>W3CEndpointReferenceBuilder</code> instance with * @return A {@code W3CEndpointReferenceBuilder} instance with
* the <code>referenceParameter</code> added to the * the {@code referenceParameter} added to the
* <code>wsa:ReferenceParameters</code> element. * {@code wsa:ReferenceParameters} element.
* *
* @throws java.lang.IllegalArgumentException if <code>referenceParameter</code> * @throws java.lang.IllegalArgumentException if {@code referenceParameter}
* is <code>null</code>. * is {@code null}.
*/ */
public W3CEndpointReferenceBuilder referenceParameter(Element referenceParameter) { public W3CEndpointReferenceBuilder referenceParameter(Element referenceParameter) {
if (referenceParameter == null) if (referenceParameter == null)
@ -220,19 +221,19 @@ public final class W3CEndpointReferenceBuilder {
} }
/** /**
* Adds the <code>metadataElement</code> to the * Adds the {@code metadataElement} to the
* <code>W3CEndpointReference</code> instance's * {@code W3CEndpointReference} instance's
* <code>wsa:Metadata</code> element. * {@code wsa:Metadata} element.
* *
* @param metadataElement The element to be added to the * @param metadataElement The element to be added to the
* <code>wsa:Metadata</code> element. * {@code wsa:Metadata} element.
* *
* @return A <code>W3CEndpointReferenceBuilder</code> instance with * @return A {@code W3CEndpointReferenceBuilder} instance with
* the <code>metadataElement</code> added to the * the {@code metadataElement} added to the
* <code>wsa:Metadata</code> element. * {@code wsa:Metadata} element.
* *
* @throws java.lang.IllegalArgumentException if <code>metadataElement</code> * @throws java.lang.IllegalArgumentException if {@code metadataElement}
* is <code>null</code>. * is {@code null}.
*/ */
public W3CEndpointReferenceBuilder metadata(Element metadataElement) { public W3CEndpointReferenceBuilder metadata(Element metadataElement) {
if (metadataElement == null) if (metadataElement == null)
@ -243,16 +244,16 @@ public final class W3CEndpointReferenceBuilder {
/** /**
* Adds an extension element to the * Adds an extension element to the
* <code>W3CEndpointReference</code> instance's * {@code W3CEndpointReference} instance's
* <code>wsa:EndpointReference</code> element. * {@code wsa:EndpointReference} element.
* *
* @param element The extension element to be added to the * @param element The extension element to be added to the
* <code>W3CEndpointReference</code> * {@code W3CEndpointReference}
* @return A <code>W3CEndpointReferenceBuilder</code> instance with * @return A {@code W3CEndpointReferenceBuilder} instance with
* the extension <code>element</code> added to the * the extension {@code element} added to the
* <code>W3CEndpointReference</code> instance. * {@code W3CEndpointReference} instance.
* @throws java.lang.IllegalArgumentException if <code>element</code> * @throws java.lang.IllegalArgumentException if {@code element}
* is <code>null</code>. * is {@code null}.
* *
* @since 1.7, JAX-WS 2.2 * @since 1.7, JAX-WS 2.2
*/ */
@ -266,17 +267,17 @@ public final class W3CEndpointReferenceBuilder {
/** /**
* Adds an extension attribute to the * Adds an extension attribute to the
* <code>W3CEndpointReference</code> instance's * {@code W3CEndpointReference} instance's
* <code>wsa:EndpointReference</code> element. * {@code wsa:EndpointReference} element.
* *
* @param name The name of the extension attribute to be added to the * @param name The name of the extension attribute to be added to the
* <code>W3CEndpointReference</code> * {@code W3CEndpointReference}
* @param value extension attribute value * @param value extension attribute value
* @return A <code>W3CEndpointReferenceBuilder</code> instance with * @return A {@code W3CEndpointReferenceBuilder} instance with
* the extension attribute added to the <code>W3CEndpointReference</code> * the extension attribute added to the {@code W3CEndpointReference}
* instance. * instance.
* @throws java.lang.IllegalArgumentException if <code>name</code> * @throws java.lang.IllegalArgumentException if {@code name}
* or <code>value</code> is <code>null</code>. * or {@code value} is {@code null}.
* *
* @since 1.7, JAX-WS 2.2 * @since 1.7, JAX-WS 2.2
*/ */
@ -289,48 +290,48 @@ public final class W3CEndpointReferenceBuilder {
} }
/** /**
* Builds a <code>W3CEndpointReference</code> from the accumulated * Builds a {@code W3CEndpointReference} from the accumulated
* properties set on this <code>W3CEndpointReferenceBuilder</code> * properties set on this {@code W3CEndpointReferenceBuilder}
* instance. * instance.
* <p> * <p>
* This method can be used to create a <code>W3CEndpointReference</code> * This method can be used to create a {@code W3CEndpointReference}
* for any endpoint by specifying the <code>address</code> property along * for any endpoint by specifying the {@code address} property along
* with any other desired properties. This method * with any other desired properties. This method
* can also be used to create a <code>W3CEndpointReference</code> for * can also be used to create a {@code W3CEndpointReference} for
* an endpoint that is published by the same Java EE application. * an endpoint that is published by the same Java EE application.
* This method can automatically determine the <code>address</code> of * This method can automatically determine the {@code address} of
* an endpoint published by the same Java EE application that is identified by the * an endpoint published by the same Java EE application that is identified by the
* <code>serviceName</code> and * {@code serviceName} and
* <code>endpointName</code> properties. If the <code>address</code> is * {@code endpointName} properties. If the {@code address} is
* <code>null</code> and the <code>serviceName</code> and * {@code null} and the {@code serviceName} and
* <code>endpointName</code> * {@code endpointName}
* do not identify an endpoint published by the same Java EE application, a * do not identify an endpoint published by the same Java EE application, a
* <code>java.lang.IllegalStateException</code> MUST be thrown. * {@code java.lang.IllegalStateException} MUST be thrown.
* *
* *
* @return <code>W3CEndpointReference</code> from the accumulated * @return {@code W3CEndpointReference} from the accumulated
* properties set on this <code>W3CEndpointReferenceBuilder</code> * properties set on this {@code W3CEndpointReferenceBuilder}
* instance. This method never returns <code>null</code>. * instance. This method never returns {@code null}.
* *
* @throws IllegalStateException * @throws IllegalStateException
* <ul> * <ul>
* <li>If the <code>address</code>, <code>serviceName</code> and * <li>If the {@code address}, {@code serviceName} and
* <code>endpointName</code> are all <code>null</code>. * {@code endpointName} are all {@code null}.
* <li>If the <code>serviceName</code> service is <code>null</code> and the * <li>If the {@code serviceName} service is {@code null} and the
* <code>endpointName</code> is NOT <code>null</code>. * {@code endpointName} is NOT {@code null}.
* <li>If the <code>address</code> property is <code>null</code> and * <li>If the {@code address} property is {@code null} and
* the <code>serviceName</code> and <code>endpointName</code> do not * the {@code serviceName} and {@code endpointName} do not
* specify a valid endpoint published by the same Java EE * specify a valid endpoint published by the same Java EE
* application. * application.
* <li>If the <code>serviceName</code> is NOT <code>null</code> * <li>If the {@code serviceName} is NOT {@code null}
* and is not present in the specified WSDL. * and is not present in the specified WSDL.
* <li>If the <code>endpointName</code> port is not <code>null</code> and it * <li>If the {@code endpointName} port is not {@code null} and it
* is not present in <code>serviceName</code> service in the WSDL. * is not present in {@code serviceName} service in the WSDL.
* <li>If the <code>wsdlDocumentLocation</code> is NOT <code>null</code> * <li>If the {@code wsdlDocumentLocation} is NOT {@code null}
* and does not represent a valid WSDL. * and does not represent a valid WSDL.
* </ul> * </ul>
* @throws WebServiceException If an error occurs while creating the * @throws WebServiceException If an error occurs while creating the
* <code>W3CEndpointReference</code>. * {@code W3CEndpointReference}.
* *
*/ */
public W3CEndpointReference build() { public W3CEndpointReference build() {