001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU General
007: * Public License Version 2 only ("GPL") or the Common Development and Distribution
008: * License("CDDL") (collectively, the "License"). You may not use this file except in
009: * compliance with the License. You can obtain a copy of the License at
010: * http://www.netbeans.org/cddl-gplv2.html or nbbuild/licenses/CDDL-GPL-2-CP. See the
011: * License for the specific language governing permissions and limitations under the
012: * License. When distributing the software, include this License Header Notice in
013: * each file and include the License file at nbbuild/licenses/CDDL-GPL-2-CP. Sun
014: * designates this particular file as subject to the "Classpath" exception as
015: * provided by Sun in the GPL Version 2 section of the License file that
016: * accompanied this code. If applicable, add the following below the License Header,
017: * with the fields enclosed by brackets [] replaced by your own identifying
018: * information: "Portions Copyrighted [year] [name of copyright owner]"
019: *
020: * Contributor(s):
021: *
022: * The Original Software is NetBeans. The Initial Developer of the Original Software
023: * is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun Microsystems, Inc. All
024: * Rights Reserved.
025: *
026: * If you wish your version of this file to be governed by only the CDDL or only the
027: * GPL Version 2, indicate your decision by adding "[Contributor] elects to include
028: * this software in this distribution under the [CDDL or GPL Version 2] license." If
029: * you do not indicate a single choice of license, a recipient has the option to
030: * distribute your version of this file under either the CDDL, the GPL Version 2 or
031: * to extend the choice of license to its licensees as provided above. However, if
032: * you add GPL Version 2 code and therefore, elected the GPL Version 2 license, then
033: * the option applies only if the new code is made subject to such option by the
034: * copyright holder.
035: */
036:
037: package org.netbeans.installer.downloader;
038:
039: import java.io.File;
040: import java.net.URL;
041: import org.netbeans.installer.utils.helper.Pair;
042:
043: /**
044: *
045: * @author Danila_Dugurov
046: */
047:
048: public interface Pumping {
049: /**
050: * It's runtime property of pumping. It means that it's not persistence
051: * property. So if downloader client maintain it's state persistance - it
052: * mustn't base on pumpings ids.
053: */
054: String getId();
055:
056: /**
057: * @return declared pumping url.
058: */
059: URL declaredURL();
060:
061: /**
062: * @return real pumping url. It is url which was obtain at runtime. It's may be
063: * the same as declared url if no redirect may occur.
064: */
065: URL realURL();
066:
067: /**
068: * @return file corresponding to this pumping.
069: */
070: File outputFile();
071:
072: File folder();
073:
074: long length();
075:
076: /**
077: * @return mode in which downloader process it. So if Single thread mode - it's
078: * means that only one thread process pumping(so one section invoked). If multi
079: * thread mode - it's means that downloader allowed to process pumping in more
080: * then one thread concurrently. But it's not means that downloader do it.
081: * The issue process or not in multy thread deal with some external issues:
082: * for example domain police and server side speed reducing for client who try
083: * to obtain more then one connection at time. Base implementation in any case
084: * download in one thread.
085: */
086: DownloadMode mode();
087:
088: State state();
089:
090: /**
091: * one section - one thread. Section - data structure for representation and
092: * manage downloading unit
093: */
094: Section[] getSections();
095:
096: /////////////////////////////////////////////////////////////////////////////////
097: // Inner Classes
098: public static interface Section {
099: /**
100: * range of bytes this section responsible for.
101: */
102: Pair<Long, Long> getRange();
103:
104: /**
105: * absolute offset. Means if range: 12345 - 23456. initially offset equals
106: * 12345 when section downloaded it's equals 23456.
107: */
108: long offset();
109: }
110:
111: public enum State {
112: NOT_PROCESSED, CONNECTING, PUMPING, WAITING, INTERRUPTED, FAILED, FINISHED, DELETED
113: }
114: }
|