org.apache.sshd.common.util.closeable.SequentialCloseable Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sshd-common Show documentation
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.sshd.common.util.closeable;

import java.util.Collections;
import java.util.Iterator;

import org.apache.sshd.common.Closeable;
import org.apache.sshd.common.future.CloseFuture;
import org.apache.sshd.common.future.SshFutureListener;

/**
 * Waits for a group of {@link Closeable}s to complete in the given order, then signals the completion by setting the
 * "parent" future as closed
 *
 * @author Apache MINA SSHD Project
 */
public class SequentialCloseable extends SimpleCloseable {
    private final Iterable closeables;

    public SequentialCloseable(Object id, Object lock, Iterable closeables) {
        super(id, lock);
        this.closeables = (closeables == null) ? Collections.emptyList() : closeables;
    }

    @Override
    protected void doClose(boolean immediately) {
        Iterator iterator = closeables.iterator();
        SshFutureListener listener = new SshFutureListener() {
            @SuppressWarnings("synthetic-access")
            @Override
            public void operationComplete(CloseFuture previousFuture) {
                boolean traceEnabled = log.isTraceEnabled();
                while (iterator.hasNext()) {
                    Closeable c = iterator.next();
                    if (c != null) {
                        if (traceEnabled) {
                            log.trace("doClose({}) closing {} immediately={}", this, c, immediately);
                        }
                        CloseFuture nextFuture = c.close(immediately);
                        nextFuture.addListener(this);
                        return;
                    }
                }
                if (!iterator.hasNext()) {
                    if (log.isDebugEnabled()) {
                        log.debug("doClose({}) signal close complete immediately={}", this, immediately);
                    }
                    future.setClosed();
                }
            }
        };
        listener.operationComplete(null);
    }
}