org.jppf.startup.JPPFClientStartupSPI Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jppf-common Show documentation

JPPF, the open source grid computing solution

There is a newer version: 6.3-alpha

/*
 * JPPF.
 * Copyright (C) 2005-2015 JPPF Team.
 * http://www.jppf.org
 *
 * 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.jppf.startup;

/**
 * This interface class represents objects that are run at client startup time.
 * More precisely, they are run just before any connection with a driver is established.
 * 
Classes implementing this interface must have a public no-arg constructor and implement the {@link java.lang.Runnable#run() run()} method.
 * 
Client startup classes allow a developer to perform initializations at runtime, such as load specific APIs,
 * create connection pools, subscribe to the monitoring MBeans notifications, etc. The range of applications is quite broad.
 * 
They are looked up by using the Service Provider Interface (SPI) lookup mechanism.
 * For the SPI to find them, proceed as follows:
 * 

 * in the classpath root create, if it does not exist, a folder named META-INF/services
 * in this folder create a file named "org.jppf.startup.JPPFClientStartupSPI"
 * the content of this file is one or more line(s) with the fully qualified class name of an implementation of this interface
 * to specify multiple implementations, just put one per line in the file
 * there can also be multiple META-INF/services/org.jppf.startup.JPPFClientStartupSPI resources in the classpath
 * (for instance in multiple jar files); all of them will be looked up and processed
 * 
 * @author Laurent Cohen
 */
public interface JPPFClientStartupSPI extends JPPFStartup
{
}