OrbTrackerCommunicationProtocol.java

/**
 * Licensed to Ravel, Inc. under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  Ravel, Inc. licenses this file
 * to you 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.goldenorb;

import org.apache.hadoop.ipc.VersionedProtocol;
import org.goldenorb.conf.OrbConfiguration;
import org.goldenorb.jet.PartitionRequest;
import org.goldenorb.jet.PartitionRequestResponse;
import org.goldenorb.zookeeper.OrbZKFailure;

/**
 * {@link OrbTrackerCommunicationProtocol} is the protocol used to facilitate communication between 
 * running {@link OrbTracker} objects over Hadoop RPC.
 */
public interface OrbTrackerCommunicationProtocol extends VersionedProtocol {
  
  long versionID = 1L;
/**
 * 
 * @param  PartitionRequest partitionRequest
 * @returns PartitionRequestResponse
 */
  public PartitionRequestResponse requestPartitions(PartitionRequest partitionRequest);
  
  public void killJob(String jobNumber);
  
  public void getRequiredFiles(OrbConfiguration jobConf) throws OrbZKFailure;
}