001/*
002 * JPPF.
003 * Copyright (C) 2005-2018 JPPF Team.
004 * http://www.jppf.org
005 *
006 * Licensed under the Apache License, Version 2.0 (the "License");
007 * you may not use this file except in compliance with the License.
008 * You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018
019package org.jppf.discovery;
020
021/**
022 * Abstract superclass for custom peer driver discovery mechanisms in JPPF drivers.
023 * The discovery is asynchhronus and the {@link #discover()} method of each instance runs in a separate thread.
024 * <p>To notify the driver that a new peer driver is discovered, the {@link DriverDiscovery#newConnection(DriverConnectionInfo) newConnection(DriverConnectionInfo)} method must be called.
025 * <p>Example:
026 * <pre>
027 * public class MyPeerDiscovery extends PeerDriverDiscovery {
028 *   &#64;Override
029 *   public void discover() {
030 *     newConnection(new DriverConnectionInfo("driver1", false, "localhost", 11111));
031 *   }
032 * }
033 * </pre>
034 * <p>Peer driver discovery mechanisms are found in the classpath via the service provider interface (SPI):
035 * <ul>
036 * <li>create a file named {@code META-INF/services/org.jppf.discovery.PeerDriverDiscovery}</li>
037 * <li>in this file, for each discovery implementation add a line with the fully qualified name of the implementation class,
038 * for instance: {@code org.jppf.example.MyPeerDiscovery}</li>
039 * </ul>
040 * @author Laurent Cohen
041 */
042public abstract class PeerDriverDiscovery extends DriverDiscovery<DriverConnectionInfo> {
043
044}