org.jppf.client.concurrent.JobConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jppf-client Show documentation
JPPF, the open source grid computing solution
The newest version!
/*
 * JPPF.
 * Copyright (C) 2005-2019 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.client.concurrent;

import java.util.List;

import org.jppf.client.event.JobListener;
import org.jppf.client.persistence.JobPersistence;
import org.jppf.node.protocol.*;

/**
 * This interface defines the properties that can be provided to a task submitted by a {@link JPPFExecutorService}..
 * These properties include:
 * 
 * the job's {@link org.jppf.node.protocol.JobSLA SLA}
 * the job's {@link org.jppf.node.protocol.JobMetadata metadata}
 * the job's {@link org.jppf.client.persistence.JobPersistence persistence manager}
 * 
 * @author Laurent Cohen
 */
public interface JobConfiguration {
  /**
   * Get the service level agreement between the job and the server.
   * @return an instance of {@link JobSLA}.
   */
  JobSLA getSLA();

  /**
   * Get the service level agreement between the job and the server.
   * @param jobSLA an instance of JPPFJobSLA.
   * @return this job configuration, for method chaining.
   * @exclude
   */
  JobConfiguration setSLA(final JobSLA jobSLA);

  /**
   * Get the service level agreement between the job and the client.
   * @return an instance of {@link JobClientSLA}.
   */
  JobClientSLA getClientSLA();

  /**
   * Get the service level agreement between the job and the server.
   * @param jobClientSLA an instance of JPPFJobSLA.
   * @return this job configuration, for method chaining.
   * @exclude
   */
  JobConfiguration setClientSLA(final JobClientSLA jobClientSLA);

  /**
   * Get the user-defined metadata associated with this job.
   * @return a {@link JobMetadata} instance.
   */
  JobMetadata getMetadata();

  /**
   * Get the persistence manager that enables saving and restoring the state of this job.
   * @return a {@link JobPersistence} instance.
   * @param  the type of the keys used by the persistence manager.
   */
   JobPersistence getPersistenceManager();

  /**
   * Set the persistence manager that enables saving and restoring the state of this job.
   * @param persistenceManager a {@link JobPersistence} instance.
   * @param  the type of the keys used by the persistence manager.
   * @return this job configuration, for method chaining.
   */
   JobConfiguration setPersistenceManager(final JobPersistence persistenceManager);

  /**
   * Get the job's data provider.
   * @return a {@link DataProvider} instance.
   */
  DataProvider getDataProvider();

  /**
   * Set the job's data provider.
   * @param dataProvider a {@link DataProvider} instance.
   * @return this job configuration, for method chaining.
   */
  JobConfiguration setDataProvider(DataProvider dataProvider);

  /**
   * Add a listener to the list of job listeners.
   * @param listener a {@link JobListener} instance.
   * @return this job configuration, for method chaining.
   */
  JobConfiguration addJobListener(JobListener listener);

  /**
   * Remove a listener from the list of job listeners.
   * @param listener a {@link JobListener} instance.
   * @return this job configuration, for method chaining.
   */
  JobConfiguration removeJobListener(JobListener listener);

  /**
   * Get all the job listeners added to this job configuration. 
   * @return a list of {@link JobListener} instances.
   */
  List getAllJobListeners();

  /**
   * Get all the class loaders added to this job configuration. 
   * @return a list of {@link ClassLoader} instances.
   */
  List getClassLoaders();
}