org.jppf.client.balancer.ClientTaskBundle 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
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.client.balancer;

import java.util.*;

import org.jppf.client.JPPFJob;
import org.jppf.node.protocol.*;

/**
 * Instances of this class group tasks from the same client together, so they are sent to the same node,
 * avoiding unnecessary transport overhead.

 * The goal is to provide a performance enhancement through an adaptive bundling of tasks originating from the same client.
 * The bundle size is computed dynamically, depending on the number of nodes connected to the server, and other factors.
 * @author Laurent Cohen
 */
public class ClientTaskBundle extends JPPFTaskBundle {
  /**
   * Explicit serialVersionUID.
   */
  private static final long serialVersionUID = 1L;
  /**
   * The job to execute.
   */
  private final ClientJob job;
  /**
   * The shared data provider for this task bundle.
   */
  private transient DataProvider dataProvider = null;
  /**
   * The tasks to be executed by the node.
   */
  private transient List> tasks = null;
  /**
   * The broadcast UUID.
   */
  private transient String broadcastUUID = null;
  /**
   * Job requeue indicator.
   */
  private boolean requeued = false;
  /**
   * Job cancel indicator
   */
  private boolean cancelled = false;

  /**
   * Initialize this task bundle and set its build number.
   * @param job the job to execute.
   * @param tasks the tasks to execute.
   */
  public ClientTaskBundle(final ClientJob job, final List> tasks) {
    if (job == null) throw new IllegalArgumentException("job is null");

    this.job = job;
    this.setSLA(job.getSLA());
    this.setMetadata(job.getJob().getMetadata());
    this.tasks = new ArrayList<>(tasks);
    this.setName(job.getJob().getName());
    setUuid(job.getUuid());
    setTaskCount(this.tasks.size());
  }

  /**
   * Get the job this job is for.
   * @return a {@link JPPFJob} instance.
   */
  public JPPFJob getJob() {
    return job.getJob();
  }

  /**
   * Get the client job this job is for
   * @return a {@link ClientJob} instance.
   */
  public ClientJob getClientJob() {
    return job;
  }

  /**
   * Get shared data provider for this task.
   * @return a DataProvider instance.
   */
  public DataProvider getDataProviderL() {
    return dataProvider;
  }

  /**
   * Set shared data provider for this task.
   * @param dataProvider a DataProvider instance.
   */
  public void setDataProviderL(final DataProvider dataProvider) {
    this.dataProvider = dataProvider;
  }

  /**
   * Get the tasks to be executed by the node.
   * @return the tasks as a List of arrays of bytes.
   */
  public List> getTasksL() {
    return tasks;
  }

  /**
   * Make a copy of this bundle.
   * @return a new ClientTaskBundle instance.
   */
  @Override
  public ClientTaskBundle copy() {
    throw new UnsupportedOperationException();
  }

  /**
   * Get the broadcast UUID.
   * @return an String instance.
   */
  public String getBroadcastUUID() {
    return broadcastUUID;
  }

  /**
   * Set the broadcast UUID.
   * @param broadcastUUID the broadcast UUID.
   */
  public void setBroadcastUUID(final String broadcastUUID) {
    this.broadcastUUID = broadcastUUID;
  }

  /**
   * Called when all or part of a job is dispatched to a node.
   * @param channel the node to which the job is dispatched.
   */
  public void jobDispatched(final ChannelWrapper channel) {
    job.jobDispatched(this, channel);
  }

  /**
   * Called to notify that the results of a number of tasks have been received from the server.
   * @param results the list of tasks whose results have been received from the server.
   */
  public void resultsReceived(final List> results) {
    job.resultsReceived(this, results);
  }

  /**
   * Called to notify that throwable eventually raised while receiving the results.
   * @param throwable the throwable that was raised while receiving the results.
   */
  public void resultsReceived(final Throwable throwable) {
    job.resultsReceived(this, throwable);
  }

  /**
   * Called to notify that the execution of a task has completed.
   * @param exception the {@link Exception} thrown during job execution or null.
   */
  public void taskCompleted(final Exception exception) {
    job.taskCompleted(this, exception);
  }

  /**
   * Called when this task bundle should be resubmitted
   */
  public synchronized void resubmit() {
    if (getSLA().isBroadcastJob()) return; // broadcast jobs cannot be resubmitted.
    requeued = true;
  }

  /**
   * Get the requeued indicator.
   * @return true if job is requeued, false otherwise.
   */
  public synchronized boolean isRequeued() {
    return requeued;
  }

  /**
   * Called when this task bundle is cancelled.
   */
  public synchronized void cancel() {
    this.cancelled = true;
  }

  /**
   * Get the cancelled indicator.
   * @return true if job is cancelled, false otherwise.
   */
  public synchronized boolean isCancelled() {
    return cancelled;
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder(getClass().getSimpleName()).append('[');
    sb.append("jobId=").append(getName());
    sb.append(", jobUuid=").append(getUuid());
    sb.append(", initialTaskCount=").append(getInitialTaskCount());
    sb.append(", taskCount=").append(getTaskCount());
    sb.append(", requeue=").append(isRequeued());
    sb.append(", cancelled=").append(isCancelled());
    sb.append(']');
    return sb.toString();
  }
}