org.apache.camel.impl.event.ExchangeSendingEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of camel-base Show documentation

The Base Camel Framework

There is a newer version: 4.9.0

/*
 * 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.camel.impl.event;

import org.apache.camel.Endpoint;
import org.apache.camel.Exchange;
import org.apache.camel.spi.CamelEvent;

/**
 * Event for before sending an {@link Exchange} to an {@link Endpoint}.
 * 
 * This event is emitted before attempting to send the {@link Exchange} to an {@link Endpoint}.
 * There is still some internal processing done before the actual sending takes places, and
 * therefore it is not 100% guaranteed that the sending actually happens, as an
 * internal error may occur.
 * 

 * The {@link ExchangeSentEvent} is an event which is emitted after the sending is done.
 * 
 * These two events (sending and sent) come in a pair, and therefore you need to make sure to return
 * true for both events in the {@link org.apache.camel.spi.EventNotifier#isEnabled(CamelEvent)}
 * method to receive events for either of them.
 *
 * @see ExchangeSentEvent
 */
public class ExchangeSendingEvent extends AbstractExchangeEvent implements CamelEvent.ExchangeSendingEvent {
    private static final long serialVersionUID = -19248832613958122L;

    private final Endpoint endpoint;

    public ExchangeSendingEvent(Exchange source, Endpoint endpoint) {
        super(source);
        this.endpoint = endpoint;
    }

    @Override
    public Endpoint getEndpoint() {
        return endpoint;
    }

    @Override
    public String toString() {
        return getExchange().getExchangeId() + " exchange " + getExchange() + " sending to: " + endpoint;
    }

}