1/*
2 * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package com.sun.xml.internal.ws.api.server;
27
28import com.sun.xml.internal.ws.api.addressing.WSEndpointReference;
29import com.sun.xml.internal.ws.api.pipe.ServerTubeAssemblerContext;
30import com.sun.istack.internal.Nullable;
31
32import javax.xml.namespace.QName;
33
34/**
35 * Implementations of this class can contribute properties associated with an Endpoint. The properties appear as
36 * extensibility elements inside the EndpointReference of the endpoint. If any EPR extensibility elements are configured
37 * for an endpoint, the EndpointReference is published inside the WSDL.
38 *
39 * @since JAX-WS 2.2
40 * @author Rama Pulavarthi
41 */
42public abstract class EndpointReferenceExtensionContributor {
43    /**
44     *
45     * @param extension EPRExtension is passed if an extension with same QName is already configured on the endpoint
46     *      via other means (one possible way is by embedding EndpointReference in WSDL).
47     *
48     * @return  EPRExtension that should be finally configured on an Endpoint.
49     */
50    public abstract WSEndpointReference.EPRExtension getEPRExtension(WSEndpoint endpoint, @Nullable WSEndpointReference.EPRExtension extension );
51
52    /**
53     *
54     * @return QName of the extensibility element that is contributed by this extension.
55     */
56    public abstract QName getQName();
57}
58