javax.jbi.servicedesc.ServiceEndpoint Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jbi-api Show documentation

API Interfaces specified by the JSR 208 Expert Committee

There is a newer version: 2.4.3

/*
 * BEGIN_HEADER - DO NOT EDIT
 *
 * The contents of this file are subject to the terms
 * of the Common Development and Distribution License
 * (the "License").  You may not use this file except
 * in compliance with the License.
 *
 * You can obtain a copy of the license at
 * https://open-esb.dev.java.net/public/CDDLv1.0.html.
 * See the License for the specific language governing
 * permissions and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL
 * HEADER in each file and include the License file at
 * https://open-esb.dev.java.net/public/CDDLv1.0.html.
 * If applicable add the following below this CDDL HEADER,
 * with the fields enclosed by brackets "[]" replaced with
 * your own identifying information: Portions Copyright
 * [year] [name of copyright owner]
 */

/*
 * @(#)ServiceEndpoint.java
 * Copyright 2004-2007 Sun Microsystems, Inc. All Rights Reserved.
 *
 * END_HEADER - DO NOT EDIT
 */
package javax.jbi.servicedesc;

import javax.xml.namespace.QName;

/**
 * Reference to an endpoint, used to refer to an endpoint as well as query
 * information about the endpoint. An endpoint is an addressable entity in the
 * JBI schemaorg_apache_xmlbeans.system, used for accessing the provider of a specific service.
 *
 * @author JSR208 Expert Group
 */
public interface ServiceEndpoint
{
    /**
     * Get a reference to this endpoint, using an endpoint reference vocabulary
     * that is known to the provider.
     * @param operationName the name of the operation to be performed by a
     * consumer of the generated endpoint reference. Set to null
     * if this is not applicable.
     * @return endpoint reference as an XML fragment; null if the
     * provider does not support such references.
     */
    org.w3c.dom.DocumentFragment getAsReference(QName operationName);

    /**
     * Returns the name of this endpoint.
     * @return the endpoint name.
     */
    String getEndpointName();

    /**
     * Get the qualified names of all the interfaces implemented by this
     * service endpoint.
     * @return array of all interfaces implemented by this service endpoint;
     * must be non-null and non-empty.
     */
    javax.xml.namespace.QName[] getInterfaces();

    /**
     *  Returns the service name of this endpoint.
     *  @return the qualified service name.
     */
    javax.xml.namespace.QName getServiceName();
}