DSHandler.java

/**
 * Copyright 2010 Eric Taix 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 com.bigpupdev.synodroid.protocol;

import java.util.List;

import com.bigpupdev.synodroid.data.Folder;
import com.bigpupdev.synodroid.data.SearchEngine;
import com.bigpupdev.synodroid.data.SharedDirectory;
import com.bigpupdev.synodroid.data.Task;
import com.bigpupdev.synodroid.data.TaskContainer;
import com.bigpupdev.synodroid.data.TaskDetail;
import com.bigpupdev.synodroid.data.TaskFile;
import com.bigpupdev.synodroid.data.TaskFilesContainer;
import com.bigpupdev.synodroid.data.TaskProperties;
import com.bigpupdev.synodroid.utils.SearchResult;
import com.bigpupdev.synodroid.utils.SortOrder;

import android.net.Uri;

/**
 * This interface defines the Download Station protocol
 * 
 * @author Eric Taix (eric.taix at gmail dot com)
 */
public interface DSHandler {

	/**
	 * For DSM version 2.3 and before (to confirm to DSM 3.0 and upper), startP parameter MUST be a multiple of 25 and limitP parameter must be 25. Return all torrent
	 * 
	 * @param startP
	 *            The start index (from 0) to retrieve
	 * @param limitP
	 *            The maximum number of task to retrieve
	 * @return
	 */
	public TaskContainer getAllTask(int startP, int limitP, String sortAttrP, boolean ascendingP) throws Exception;

	/**
	 * Stop a torrent
	 * 
	 * @param taskP
	 * @throws DSMException
	 */
	public void stop(String taskids) throws Exception;

	/**
	 * Resume a torrent
	 * 
	 * @param torrentP
	 * @throws DSMException
	 */
	public void resume(String taskids) throws Exception;

	/**
	 * delete a torrent
	 * 
	 * @param torrentP
	 * @throws DSMException
	 */
	public void delete(String taskids) throws Exception;

	/**
	 * Clear all finished tasks
	 * 
	 * @throws Exception
	 */
	public void clearAll() throws Exception;

	/**
	 * Upload a file defined by an Uri
	 * 
	 * @param uriP
	 */
	public void upload(final Uri uriP) throws Exception;
	
	public byte[] generateMultipart(final Uri uriP, final String shared) throws Exception;
	
	public String getMultipartUri();
	
	public String getBoundary();

	/**
	 * Upload a file defined by an Uri
	 * 
	 * @param uriP
	 */
	public void uploadUrl(final Uri uriP, final String uname, final String pass) throws Exception;
	
	/**
	 * Upload a file defined by an Uri
	 * 
	 * @param uriP
	 */
	public void uploadUrlList(final List<Uri> uriP, final String uname, final String pass) throws Exception;

	/**
	 * Get task's raw details
	 * 
	 * @param uriP
	 */
	public TaskDetail getDetails(final Task taskP) throws Exception;

	/**
	 * Get the file list of the specified task
	 * 
	 * @param taskP
	 * @return
	 * @throws Exception
	 */
	public TaskFilesContainer getFiles(final Task taskP, int start, int limit) throws Exception;

	/**
	 * Get Properties of a task
	 * 
	 * @param taskP
	 *            The task to update
	 */
	public TaskProperties getTaskProperty(final Task taskP) throws Exception;

	public void setTaskProperty(final Task taskP, int ul_rate, int dl_rate, int priority, int max_peers, String destination, int seeding_ratio, int seeding_interval) throws Exception;

	public void setFilePriority(final Task taskP, List<TaskFile> filesP, String priority) throws Exception;

	/**
	 * Update a task
	 * 
	 * @param taskP
	 *            The task to update
	 * @param filesP
	 *            the file list (only modified files)
	 * @param seedingRatioP
	 *            The new seeding ratio in %
	 * @param seedingIntervalP
	 *            The new seeding interval (in minutes)
	 */
	public void updateTask(final Task taskP, List<TaskFile> filesP, int seedingRatioP, int seedingIntervalP) throws Exception;

	/**
	 * Retrieve all shared directories according to the user's autorizations
	 * 
	 * @return
	 * @throws Exception
	 */
	public List<SharedDirectory> enumSharedDirectory() throws Exception;

	/**
	 * Set the new shared directory for all non finished downloads
	 * 
	 * @param directoryP
	 * @throws Exception
	 */
	public void setSharedDirectory(Task taskP, String directoryP) throws Exception;

	/**
	 * Get the global current shared directory
	 * 
	 * @return
	 * @throws Exception
	 */
	public String getSharedDirectory(boolean remap) throws Exception;

	/**
	 * Download a specific URL
	 * 
	 * @param urlP
	 */
	public StringBuffer getOriginalFile(Task taskP) throws Exception;
	
	public String buildOriginalFileString(int taskid) throws Exception;

	/**
	 * Resume all paused tasks
	 * 
	 * @throws Exception
	 */
	public void resumeAll() throws Exception;

	/**
	 * Pause all running tasks
	 * 
	 * @throws Exception
	 */
	public void stopAll() throws Exception;
	
	public List<Folder> getDirectoryListing(String srcPath) throws Exception;
	
	public List<SearchEngine> getSearchEngines() throws Exception;
	public void setSearchEngines(List<SearchEngine> seList) throws Exception;

	public List<SearchResult> search(String term, SortOrder order, int start, int limit, int MAX_LOOP) throws Exception;
	
}