/*

 * Copyright 2005-2006 Sun Microsystems, Inc.  All Rights Reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 */

package javax.xml.ws.wsaddressing;

import org.w3c.dom.Element;

import java.util.ArrayList;

import java.util.List;

import javax.xml.namespace.QName;

import javax.xml.ws.WebServiceException;

import javax.xml.ws.spi.Provider;

/**

 * This class is used to build <code>W3CEndpointReference</code>

 * instances. The intended use of this clsss is for

 * an application component, for example a factory component,

 * to create an <code>W3CEndpointReference</code> for a

 * web service endpoint published by the same

 * Java EE application. It can also be used to create

 * <code>W3CEndpointReferences</code> for an Java SE based

 * endpoint by providing the <code>address</code> property.

 * <p>

 * When creating a <code>W3CEndpointReference</code> for an

 * endpoint that is not published by the same Java EE application,

 * the <code>address</code> property MUST be specified.

 * <p>

 * When creating a <code>W3CEndpointReference</code> for an endpoint

 * published by the same Java EE application, the <code>address</code>

 * property MAY be <code>null</code> but then the <code>serviceName</code>

 * and <code>endpointName</code> MUST specify an endpoint published by

 * the same Java EE application.

 * <p>

 * When the <code>wsdlDocumentLocation</code> is specified it MUST refer

 * to a valid WSDL document and the <code>serviceName</code> and

 * <code>endpointName</code> (if specified) MUST match a service and port

 * in the WSDL document.

 *

 * @since JAX-WS 2.1

 */

public final class W3CEndpointReferenceBuilder {

    /**

     * Creates a new <code>W3CEndpointReferenceBuilder</code> instance.

     */

    public W3CEndpointReferenceBuilder() {

        referenceParameters = new ArrayList<Element>();

        metadata = new ArrayList<Element>();

    }

    /**

     * Sets the <code>address</code> to the

     * <code>W3CEndpointReference</code> instance's

     * <code>wsa:Address</code>.

     * <p>

     * The <code>address</code> MUST be set to a non-<code>null</code>

     * value when building a <code>W3CEndpointReference</code> for a

     * web service endpoint that is not published by the same

     * Java EE application or when running on Java SE.

     *

     * @param address The address of the endpoint to be targeted

     *      by the returned <code>W3CEndpointReference<code>.

     *

     * @return A <code>W3CEndpointReferenceBuilder</code> instance with

     *   the <code>address</code> set to the <code>wsa:Address</code>.

     */

    public W3CEndpointReferenceBuilder address(String address) {

        this.address = address;

        return this;

    }

    /**

     * Sets the <code>serviceName</code> of the endpoint to be targeted

     *      by the returned <code>W3CEndpointReference</code>.

     *

     * @param serviceName The service name of the endpoint to be targeted

     *      by the returned <code>W3CEndpointReference<code>.  This property

     *      may also be used with the <code>endpointName</code> (portName)

     *      property to lookup the <code>address</code> of a web service

     *      endpoint that is published by the same Java EE application.

     *

     * @return A <code>W3CEndpointReferenceBuilder</code> instance with

     *   the <code>serviceName</code> property set.

     *

     */

    public W3CEndpointReferenceBuilder serviceName(QName serviceName) {

        this.serviceName = serviceName;

        return this;

    }

    /**

     * Sets the <code>endpointName</code> of the endpoint to

     * be targeted by the returned <code>W3CEndpointRefernce</code>.

     * This method can only

     * be called after the {@link #serviceName} method has been called.

     *

     * @param endpointName The name of the endpoint to be targeted

     *      by the returned <code>W3CEndpointReference<code>. The

     *      <code>endpointName</code> (portName) property may also be

     *      used with the <code>serviceName</code> property to lookup

     *      the <code>address</code> of a web service

     *      endpoint published by the same Java EE application.

     *

     * @return A <code>W3CEndpointReferenceBuilder</code> instance with

     *   the <code>endpointName</code> property set.

     *

     * @throws java.lang.IllegalStateException If the <code>serviceName</code> has not

     *  been set.

     */

    public W3CEndpointReferenceBuilder endpointName(QName endpointName) {

        if (serviceName == null) {

            throw new IllegalStateException("The W3CEndpointReferenceBuilder's serviceName must be set before setting the endpointName: "+endpointName);

        }

        this.endpointName = endpointName;

        return this;

    }

    /**

     * Sets the <code>wsdlDocumentLocation</code> associated with the targeted

     * <code>W3CEndpointReference</code>.

     *

     * @param wsdlDocumentLocation The location of the WSDL document associated

     * with the targeted <code>W3CEndpointReference</code>.

     *

     * @return A <code>W3CEndpointReferenceBuilder</code> instance with

     *   the <code>wsdlDocumentLocation</code> property set.

     *

     */

    public W3CEndpointReferenceBuilder wsdlDocumentLocation(String wsdlDocumentLocation) {

        this.wsdlDocumentLocation = wsdlDocumentLocation;

        return this;

    }

    /**

     * Adds the <code>referenceParameter</code> to the

     * <code>W3CEndpointReference</code> instance

     * <code>wsa:ReferenceParameters</code> element.

     *

     * @param referenceParameter The element to be added to the

     *      <code>wsa:ReferenceParameters</code> element.

     *

     * @return A <code>W3CEndpointReferenceBuilder</code> instance with

     *   the <code>referenceParameter</code> added to the

     *   <code>wsa:ReferenceParameters</code> element.

     *

     * @throws java.lang.IllegalArgumentException if <code>referenceParameter</code>

     * is <code>null</code>.

     */

    public W3CEndpointReferenceBuilder referenceParameter(Element referenceParameter) {

        if (referenceParameter == null)

            throw new java.lang.IllegalArgumentException("The referenceParameter cannot be null.");

        referenceParameters.add(referenceParameter);

        return this;

    }

    /**

     * Adds the <code>metadataElement</code> to the

     * <code>W3CEndpointReference</code> instance's

     * <code>wsa:Metadata</code> element.

     *

     * @param metadataElement The element to be added to the

     *      <code>wsa:Metadata</code> element.

     *

     * @return A <code>W3CEndpointReferenceBuilder</code> instance with

     *   the <code>metadataElement</code> added to the

     *    <code>wsa:Metadata</code> element.

     *

     * @throws java.lang.IllegalArgumentException if <code>metadataElement</code>

     * is <code>null</code>.

     */

    public W3CEndpointReferenceBuilder metadata(Element metadataElement) {

        if (metadataElement == null)

            throw new java.lang.IllegalArgumentException("The metadataElement cannot be null.");

        metadata.add(metadataElement);

        return this;

    }

    /**

     * Builds a <code>W3CEndpointReference</code> from the accumulated

     * properties set on this <code>W3CEndpointReferenceBuilder</code>

     * instance.

     * <p>

     * This method can be used to create a <code>W3CEndpointReference</code>

     * for any endpoint by specifying the <code>address</code> property along

     * with any other desired properties.  This method

     * can also be used to create a <code>W3CEndpointReference</code> for

     * an endpoint that is published by the same Java EE application.

     * This method can automatically determine the <code>address</code> of

     * an endpoint published by the same Java EE application that is identified by the

     * <code>serviceName</code> and

     * <code>endpointName</code> properties.  If the <code>address</code> is

     * <code>null</code> and the <code>serviceName</code> and

     * <code>endpointName</code>

     * do not identify an endpoint published by the same Java EE application, a

     * <code>java.lang.IllegalStateException</code> MUST be thrown.

     *

     *

     * @return <code>W3CEndpointReference</code> from the accumulated

     * properties set on this <code>W3CEndpointReferenceBuilder</code>

     * instance. This method never returns <code>null</code>.

     *

     * @throws java.lang.IllegalStateException

     *     <ul>

     *        <li>If the <code>address</code>, <code>serviceName</code> and

     *            <code>endpointName</code> are all <code>null</code>.

     *        <li>If the <code>serviceName</code> service is <code>null</code> and the

     *            <code>endpointName</code> is NOT <code>null</code>.

     *        <li>If the <code>address</code> property is <code>null</code> and

     *            the <code>serviceName</code> and <code>endpointName</code> do not

     *            specify a valid endpoint published by the same Java EE

     *            application.

     *        <li>If the <code>serviceName</code> is NOT <code>null</code>

     *             and is not present in the specified WSDL.

     *        <li>If the <code>endpointName</code> port is not <code>null<code> and it

     *             is not present in <code>serviceName</code> service in the WSDL.

     *        <li>If the <code>wsdlDocumentLocation</code> is NOT <code>null</code>

     *            and does not represent a valid WSDL.

     *     </ul>

     * @throws WebServiceException If an error occurs while creating the

     *                             <code>W3CEndpointReference</code>.

     *

     */

    public W3CEndpointReference build() {

        return Provider.provider().createW3CEndpointReference(address,

                serviceName, endpointName, metadata, wsdlDocumentLocation,

                referenceParameters);

    }

    private String address;

    private List<Element> referenceParameters;

    private List<Element> metadata;

    private QName serviceName;

    private QName endpointName;

    private String wsdlDocumentLocation;

}