org.wildfly.discovery.spi.DiscoveryRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-discovery-client Show documentation

The newest version!

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2014 Red Hat, Inc., and individual contributors
 * as indicated by the @author tags.
 *
 * Licensed 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.wildfly.discovery.spi;

/**
 * The outstanding discovery request, which may be used to cancel an ongoing discovery process.
 *
 * @author David M. Lloyd
 */
public interface DiscoveryRequest {

    /**
     * Cancel the discovery process, if possible.  If cancellation is successful, the provider should call
     * {@link DiscoveryResult#complete()}.  This method may be called after discovery was already completed.
     * This method may be called more than once and thus should be idempotent.
     */
    void cancel();

    /**
     * The null discovery request; cancel requests are ignored.  Useful for implementing trivial discovery providers.
     */
    DiscoveryRequest NULL = () -> {};
}