org.eclipse.jetty.server.handler.AbstractHandlerContainer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation
The Adobe Experience Manager SDK
There is a newer version: 2024.11.18751.20241128T090041Z-241100
// 
// ========================================================================
// Copyright (c) 1995-2022 Mort Bay Consulting Pty Ltd and others.
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
// 
// The Eclipse Public License is available at
// http://www.eclipse.org/legal/epl-v10.html
// 
// The Apache License v2.0 is available at
// http://www.opensource.org/licenses/apache2.0.php
// 
// You may elect to redistribute this code under either of these licenses.
// ========================================================================
// 
package org.eclipse.jetty.server.handler;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Date;
import java.util.List;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import org.eclipse.jetty.server.Handler;
import org.eclipse.jetty.server.HandlerContainer;
import org.eclipse.jetty.server.Server;
import org.eclipse.jetty.util.Callback;
import org.eclipse.jetty.util.MultiException;
import org.eclipse.jetty.util.component.Graceful;
import org.eclipse.jetty.util.log.Log;
import org.eclipse.jetty.util.log.Logger;

/**
 *  Abstract Handler Container.
 *  This is the base class for handlers that may contain other handlers.
 *
 * @deprecated The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.
 */
@Deprecated(since = "2021-05-27")
public abstract class AbstractHandlerContainer extends AbstractHandler implements HandlerContainer {

    private static final Logger LOG = Log.getLogger(AbstractHandlerContainer.class);

    public AbstractHandlerContainer() {
    }

    @Override
    public Handler[] getChildHandlers() {
        List list = new ArrayList<>();
        expandChildren(list, null);
        return list.toArray(new Handler[list.size()]);
    }

    @Override
    public Handler[] getChildHandlersByClass(Class byclass) {
        List list = new ArrayList<>();
        expandChildren(list, byclass);
        return list.toArray(new Handler[list.size()]);
    }

    @SuppressWarnings("unchecked")
    @Override
    public  T getChildHandlerByClass(Class byclass) {
        List list = new ArrayList<>();
        expandChildren(list, byclass);
        if (list.isEmpty())
            return null;
        return (T) list.get(0);
    }

    protected void expandChildren(List list, Class byClass) {
    }

    protected void expandHandler(Handler handler, List list, Class byClass) {
        if (handler == null)
            return;
        if (byClass == null || byClass.isAssignableFrom(handler.getClass()))
            list.add(handler);
        if (handler instanceof AbstractHandlerContainer)
            ((AbstractHandlerContainer) handler).expandChildren(list, byClass);
        else if (handler instanceof HandlerContainer) {
            HandlerContainer container = (HandlerContainer) handler;
            Handler[] handlers = byClass == null ? container.getChildHandlers() : container.getChildHandlersByClass(byClass);
            list.addAll(Arrays.asList(handlers));
        }
    }

    public static  T findContainerOf(HandlerContainer root, Class type, Handler handler) {
        if (root == null || handler == null)
            return null;
        Handler[] branches = root.getChildHandlersByClass(type);
        if (branches != null) {
            for (Handler h : branches) {
                @SuppressWarnings("unchecked")
                T container = (T) h;
                Handler[] candidates = container.getChildHandlersByClass(handler.getClass());
                if (candidates != null) {
                    for (Handler c : candidates) {
                        if (c == handler)
                            return container;
                    }
                }
            }
        }
        return null;
    }

    @Override
    public void setServer(Server server) {
        if (server == getServer())
            return;
        if (isStarted())
            throw new IllegalStateException(STARTED);
        super.setServer(server);
        Handler[] handlers = getHandlers();
        if (handlers != null)
            for (Handler h : handlers) {
                h.setServer(server);
            }
    }

    /**
     * Shutdown nested Gracefule handlers
     *
     * @param futures A list of Futures which must also be waited on for the shutdown (or null)
     * returns A MultiException to which any failures are added or null
     */
    protected void doShutdown(List> futures) throws MultiException {
        MultiException mex = null;
        // tell the graceful handlers that we are shutting down
        Handler[] gracefuls = getChildHandlersByClass(Graceful.class);
        if (futures == null)
            futures = new ArrayList<>(gracefuls.length);
        for (Handler graceful : gracefuls) {
            futures.add(((Graceful) graceful).shutdown());
        }
        // Wait for all futures with a reducing time budget
        long stopTimeout = getStopTimeout();
        if (stopTimeout > 0) {
            long stopBy = System.currentTimeMillis() + stopTimeout;
            if (LOG.isDebugEnabled())
                LOG.debug("Graceful shutdown {} by ", this, new Date(stopBy));
            // Wait for shutdowns
            for (Future future : futures) {
                try {
                    if (!future.isDone())
                        future.get(Math.max(1L, stopBy - System.currentTimeMillis()), TimeUnit.MILLISECONDS);
                } catch (Exception e) {
                    // If the future is also a callback, fail it here (rather than cancel) so we can capture the exception
                    if (future instanceof Callback && !future.isDone())
                        ((Callback) future).failed(e);
                    if (mex == null)
                        mex = new MultiException();
                    mex.add(e);
                }
            }
        }
        // Cancel any shutdowns not done
        for (Future future : futures) {
            if (!future.isDone())
                future.cancel(true);
        }
        if (mex != null)
            mex.ifExceptionThrowMulti();
    }
}