001/*
002 *  Copyright 2016 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.core.observation;
017
018
019/**
020 * An interface to mark an observer as asynchronous. The
021 * {@link #observe(Event, java.util.Map)} method will be run in another thread
022 * and then will not block the main process. <br>
023 * Priority between AsyncObserver is still respected. For a given {@link Event},
024 * a higher priority AsyncObserver will not run until lower ones are finished.
025 */
026public interface AsyncObserver extends Observer
027{
028    /**
029     * Indicates if the observer can be run in parallel with others.
030     * If not, the observer will be run in a single worker thread that will consume the queue of non-parallelizable observers.
031     * However parallelizable observers could be run in parallel with other observers. In this case could not rely on priority anymore.
032     * @return true if parallelizable
033     */
034    public default boolean parallelizable()
035    {
036        return true;
037    }
038}