001/**
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.camel.management.event;
018
019import java.util.EventObject;
020
021import org.apache.camel.Endpoint;
022import org.apache.camel.Exchange;
023
024/**
025 * Event for <b>before</b> sending an {@link Exchange} to an {@link Endpoint}.
026 * <p/>
027 * This event is emitted before attempting to send the {@link Exchange} to an {@link Endpoint}.
028 * There is still some internal processing done before the actual sending takes places, and
029 * therefore it is not 100% guaranteed that the sending actually happens, as an
030 * internal error may occur.
031 * <p/>
032 * The {@link ExchangeSentEvent} is an event which is emitted <b>after</b> the sending is done.
033 * <p/>
034 * These two events (sending and sent) come in a pair, and therefore you need to make sure to return
035 * <tt>true</tt> for both events in the {@link org.apache.camel.spi.EventNotifier#isEnabled(EventObject)}
036 * method to receive events for either of them.
037 *
038 * @see ExchangeSentEvent
039 * @version 
040 */
041public class ExchangeSendingEvent extends AbstractExchangeEvent {
042    private static final long serialVersionUID = -19248832613958122L;
043
044    private final Endpoint endpoint;
045
046    public ExchangeSendingEvent(Exchange source, Endpoint endpoint) {
047        super(source);
048        this.endpoint = endpoint;
049    }
050
051    public Endpoint getEndpoint() {
052        return endpoint;
053    }
054
055    @Override
056    public String toString() {
057        return getExchange().getExchangeId() + " exchange " + getExchange() + " sending to: " + endpoint;
058    }
059
060}