org.apache.camel.spi.BrowsableEndpoint Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of camel-api Show documentation
The Camel API
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.camel.spi;

import java.util.List;
import java.util.function.Predicate;
import java.util.stream.Collectors;

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

/**
 * An optional interface an {@link Endpoint} may choose to implement which allows it to expose a way of browsing the
 * exchanges available.
 */
public interface BrowsableEndpoint extends Endpoint {

    /**
     * A quick status of the browse queue
     *
     * @param size           number of messages in the queue
     * @param firstTimestamp timestamp of first message (0 if no information)
     * @param lastTimestamp  timestamp of last message (0 if no information)
     */
    record BrowseStatus(int size, long firstTimestamp, long lastTimestamp) {
    }

    /**
     * Maximum number of messages to browse by default.
     */
    int getBrowseLimit();

    /**
     * Maximum number of messages to browse by default.
     */
    void setBrowseLimit(int browseLimit);

    /**
     * Returns a quick browse status
     *
     * @param  limit to limit the result to a maximum. Use 0 for default limit.
     * @return       the status
     */
    default BrowseStatus getBrowseStatus(int limit) {
        List list = getExchanges();
        long ts = 0;
        long ts2 = 0;
        if (!list.isEmpty()) {
            ts = list.get(0).getMessage().getHeader(Exchange.MESSAGE_TIMESTAMP, 0, long.class);
            ts2 = list.get(list.size() - 1).getMessage().getHeader(Exchange.MESSAGE_TIMESTAMP, 0, long.class);
        }
        return new BrowseStatus(list.size(), ts, ts2);
    }

    /**
     * Return the exchanges available on this endpoint
     *
     * @return the exchanges on this endpoint
     */
    List getExchanges();

    /**
     * Return the exchanges available on this endpoint, allowing to filter the result in the specific component.
     *
     * @param  limit  to limit the result to a maximum. Use 0 for default limit.
     * @param  filter filter to filter among the messages to include.
     * @return        the exchanges on this endpoint
     */
    default List getExchanges(int limit, Predicate filter) {
        List answer = getExchanges();
        if (filter != null) {
            answer = (List) answer.stream().filter(filter).collect(Collectors.toList());
        }
        if (limit > 0) {
            answer = answer.stream().limit(limit).toList();
        }
        return answer;
    }
}