org.apache.sshd.common.future.VerifiableFuture Maven / Gradle / Ivy
Go to download
This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including
all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and
JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up
with different versions on classes on the class path).
/*
* 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.future;
import java.io.IOException;
import java.time.Duration;
import java.util.concurrent.TimeUnit;
/**
* Represents an asynchronous operation whose successful result can be verified somehow. The contract guarantees that if
* the {@code verifyXXX} method returns without an exception then the operation was completed successfully
*
* @param Type of verification result
* @author Apache MINA SSHD Project
*/
@FunctionalInterface
public interface VerifiableFuture {
/**
* Wait {@link Long#MAX_VALUE} msec. and verify that the operation was successful
*
* @return The (same) future instance
* @throws IOException If failed to verify successfully on time
* @see #verify(long, CancelOption[])
*/
default T verify() throws IOException {
return verify(Long.MAX_VALUE, new CancelOption[0]);
}
/**
* Wait {@link Long#MAX_VALUE} msec. and verify that the operation was successful
*
* @param options Optional {@link CancelOption}s defining the behavior on time-out or interrupt; ignored if the
* future is not {@link Cancellable}.
* @return The (same) future instance
* @throws IOException If failed to verify successfully on time
* @see #verify(long, CancelOption[])
*/
default T verify(CancelOption... options) throws IOException {
return verify(Long.MAX_VALUE, options);
}
/**
* Wait and verify that the operation was successful
*
* @param timeout The number of time units to wait
* @param unit The wait {@link TimeUnit}
* @return The (same) future instance
* @throws IOException If failed to verify successfully on time
* @see #verify(long, CancelOption[])
*/
default T verify(long timeout, TimeUnit unit) throws IOException {
return verify(timeout, unit, new CancelOption[0]);
}
/**
* Wait and verify that the operation was successful
*
* @param timeout The number of time units to wait
* @param unit The wait {@link TimeUnit}
* @param options Optional {@link CancelOption}s defining the behavior on time-out or interrupt; ignored if the
* future is not {@link Cancellable}.
* @return The (same) future instance
* @throws IOException If failed to verify successfully on time
* @see #verify(long, CancelOption[])
*/
default T verify(long timeout, TimeUnit unit, CancelOption... options) throws IOException {
return verify(unit.toMillis(timeout), options);
}
/**
* Wait and verify that the operation was successful
*
* @param timeout The maximum duration to wait, null to wait forever
* @return The (same) future instance
* @throws IOException If failed to verify successfully on time
* @see #verify(long, CancelOption[])
*/
default T verify(Duration timeout) throws IOException {
return verify(timeout, new CancelOption[0]);
}
/**
* Wait and verify that the operation was successful
*
* @param timeout The maximum duration to wait, null to wait forever
* @param options Optional {@link CancelOption}s defining the behavior on time-out or interrupt; ignored if the
* future is not {@link Cancellable}.
* @return The (same) future instance
* @throws IOException If failed to verify successfully on time
* @see #verify(long, CancelOption[])
*/
default T verify(Duration timeout, CancelOption... options) throws IOException {
return timeout != null ? verify(timeout.toMillis(), options) : verify(options);
}
/**
* Wait and verify that the operation was successful
*
* @param timeoutMillis Wait timeout in milliseconds
* @return The (same) future instance
* @throws IOException If failed to verify successfully on time
*/
default T verify(long timeoutMillis) throws IOException {
return verify(timeoutMillis, new CancelOption[0]);
}
/**
* Wait and verify that the operation was successful
*
* @param timeoutMillis Wait timeout in milliseconds
* @param options Optional {@link CancelOption}s defining the behavior on time-out or interrupt; ignored if
* the future is not {@link Cancellable}.
* @return The (same) future instance
* @throws IOException If failed to verify successfully on time
*/
T verify(long timeoutMillis, CancelOption... options) throws IOException;
}