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
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.spi.autoupdate;
043:
044: import java.io.IOException;
045: import java.util.Map;
046: import org.netbeans.api.autoupdate.UpdateUnitProvider.CATEGORY;
047:
048: /** <code>UpdateProvider</code> providers items for Autoupdate infrastructure. The items
049: * are available on e.g. Update Center. Items can represents NetBeans Module,
050: * its Localization, Feature as group of NetBeans Modules or special
051: * components which needs own native installer to make them accessible in NetBeans product.
052: * The infrastructure finds out <code>UpdateProvider</code> in <code>Lookup.getDefault()</code>,
053: * the provider can be registring declaratively in XML layer.
054: * Note: the former Autoupdate module allows declaration of former <code>AutoupdateType</code> on XML
055: * layer, these declaration are read as new one UpdateProvider by reason of backward compatability.
056: *
057: * @author Jiri Rechtacek
058: */
059: public interface UpdateProvider {
060:
061: /** Name of provider, this name is used by Autoupdate infrastructure for manimulating
062: * of providers.
063: *
064: * @return name of provider
065: */
066: public String getName();
067:
068: /** Display name of provider. This display name can be visualized in UI.
069: *
070: * @return display name of provider
071: */
072: public String getDisplayName();
073:
074: /** Description of provider. This description can be visualized in UI.
075: *
076: * @return description of provider or null
077: */
078: public String getDescription();
079:
080: /**
081: * @return <code>UpdateUnitProvider.CATEGORY</code> for a quality classification
082: * of updates comming from this instance
083: */
084: public CATEGORY getCategory();
085:
086: /** Returns <code>UpdateItem</code>s which is mapped to its unique ID.
087: * Unique ID depends on the type of <code>UpdateItem</code>.
088: *
089: * @see UpdateItem
090: * @return Map of code name of UpdateItem and instance of UpdateItem
091: * @throws java.io.IOException when any network problem appreared
092: */
093: public Map<String, UpdateItem> getUpdateItems() throws IOException;
094:
095: /** Make refresh of content of the provider. The content can by read from
096: * a cache. The <code>force</code> parameter forces reading content from
097: * remote server.
098: *
099: * @param force if true then forces to reread the content from server
100: * @return true if refresh succeed
101: * @throws java.io.IOException when any network problem appreared
102: */
103: public boolean refresh(boolean force) throws IOException;
104:
105: }
|