org.apache.servicemix.nmr.api.Endpoint Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.apache.servicemix.nmr.api Show documentation
Apache ServiceMix NMR: API for the NMR
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.servicemix.nmr.api;

/**
 * Represents an endpoint to expose in the NMR.
 * Exposing an endpoint in the NMR is done using the (@link EndpointRegistry}. 
 *
 * The endpoint will be given Exchange to process and must be prepared to
 * be given several exchanges concurrently for processing.
 *
 * @version $Revision: $
 * @since 4.0
 */
public interface Endpoint {

    /**
     * Meta-data key for the unique endpoint name
     */
    String NAME = "NAME";

    /**
     * Meta-data key for the interface name
     */
    String INTERFACE_NAME = "INTERFACE_NAME";

    /**
     * Meta-data key for the service QName
     */
    String SERVICE_NAME = "SERVICE_NAME";

    /**
     * Meta-data key for the endpoint name
     */
    String ENDPOINT_NAME = "ENDPOINT_NAME";

    /**
     * Meta-data key for the WSDL url
     */
    String WSDL_URL = "WSDL_URL";

    /**
     * Meta-data for the version number of this endpoint
     */
    String VERSION = "VERSION";

    /**
     * If this property is set to true on a given
     * endpoint, it won't be used as a target for any exchange
     */
    String UNTARGETABLE = "UNTARGETABLE";

    /**
     * If this property is set to true, the injected
     * Channel will be configured to bypass the thread pool
     * for Exchange delivery
     */
    String CHANNEL_SYNC_DELIVERY = "CHANNEL_SYNC_DELIVERY";

    /**
     * If this property is set to true, the endpoint code
     * will be run as the Subject passed along with the message
     * being sent to it.
     */
    String RUN_AS_SUBJECT = "RUN_AS_SUBJECT";

    /**
     * Set the channel so that the endpoint can send exchanges back
     * when they are processed or act as a consumer itself.
     * This method will be called by the NMR while the endpoint is registered.
     * Such a channel does not need to be closed as the NMR will close it
     * automatically when the endpoint is unregistered.
     *
     * @see EndpointRegistry#register(Endpoint, java.util.Map)
     * @param channel the channel that this endpoint can use
     */
    void setChannel(Channel channel);

    /**
     * Process the given exchange.  The processing can occur in the current thread
     * or asynchronously.
     * If an endpoint has sent an exchange asynchronously to another endpoint,
     * it will receive the exchange back using this method.  An endpoint can
     * recognized such exchanges by checking the role of the exchange.
     *
     * @param exchange the exchange to process
     */
    void process(Exchange exchange);

}