Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.update.core
Interface ISite

All Superinterfaces:
IAdaptable
All Known Subinterfaces:
ISiteWithMirrors
All Known Implementing Classes:
Site

Deprecated. The org.eclipse.update component has been replaced by Equinox p2. This provisional API was never promoted to stable API, and may be removed from a future release of the platform.

public interface ISite
extends IAdaptable

Site represents a location containing some number of features (packaged or installed). Sites are treated purely as an installation and packaging construct. They do not play a role during Eclipse plug-in execution.

Clients may implement this interface. However, in most cases clients should directly instantiate or subclass the provided implementation of this interface.

Note: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Since:
2.0
See Also:
Site

Field Summary
static  String DEFAULT_INSTALLED_FEATURE_TYPE
          Deprecated. Default type for an installed feature.
static  String DEFAULT_PACKAGED_FEATURE_TYPE
          Deprecated. Default type for a packaged feature.
static int SITE_ACCESS_EXCEPTION
          Deprecated. If we are unable to access a site, the returned CoreException will contain this return code.
 
Method Summary
 void addPluginEntry ( IPluginEntry pluginEntry)
          Deprecated. Adds a new plug-in entry to this site.
  IFeature createFeature ( String type, URL url)
          Deprecated. use createFeature(String,URL,IProgressMonitor) instead
  IFeature createFeature ( String type, URL url, IProgressMonitor monitor)
          Deprecated. Creates a new feature object.
  IArchiveReference[] getArchives ()
          Deprecated. Returns an array of plug-in and non-plug-in archives located on this site
  ICategory[] getCategories ()
          Deprecated. Returns an array of categories defined by the site.
  ICategory getCategory ( String name)
          Deprecated. Returns the named site category.
  IConfiguredSite getCurrentConfiguredSite ()
          Deprecated. Returns the IConfiguredSite for this site in the current configuration or null if none found.
  String getDefaultPackagedFeatureType ()
          Deprecated. Returns the default type for a packaged feature supported by this site
  IURLEntry getDescription ()
          Deprecated. Returns the site description.
 long getDownloadSizeFor ( IFeature feature)
          Deprecated. Returns the size of the files that need to be downloaded in order to install the specified feature on this site, if it can be determined.
  ISiteFeatureReference getFeatureReference ( IFeature feature)
          Deprecated. Returns a reference to the specified feature if it is installed on this site.
  ISiteFeatureReference[] getFeatureReferences ()
          Deprecated. Returns an array of references to features on this site.
 long getInstallSizeFor ( IFeature feature)
          Deprecated. Returns the size of the files that need to be installed for the specified feature on this site, if it can be determined.
  IPluginEntry[] getPluginEntries ()
          Deprecated. Returns an array of entries corresponding to plug-ins installed on this site.
  IPluginEntry[] getPluginEntriesOnlyReferencedBy ( IFeature feature)
          Deprecated. Returns an array of entries corresponding to plug-ins that are installed on this site and are referenced only by the specified feature.
 int getPluginEntryCount ()
          Deprecated. Returns the number of plug-ins installed on this site
  ISiteFeatureReference[] getRawFeatureReferences ()
          Deprecated. Returns an array of references to features on this site.
  ISiteContentProvider getSiteContentProvider ()
          Deprecated. Returns the content provider for this site.
  String getType ()
          Deprecated. Return the site type.
  URL getURL ()
          Deprecated. Returns the site URL
  IFeatureReference install ( IFeature feature, IFeatureReference[] optionalfeatures, IVerificationListener verificationListener, IProgressMonitor monitor)
          Deprecated. Installs the specified feature on this site.
  IFeatureReference install ( IFeature feature, IVerificationListener verificationListener, IProgressMonitor monitor)
          Deprecated. Installs the specified feature on this site.
 void remove ( IFeature feature, IProgressMonitor monitor)
          Deprecated. Removes (uninstalls) the specified feature from this site.
 void setSiteContentProvider ( ISiteContentProvider siteContentProvider)
          Deprecated. Sets the site content provider.
 
Methods inherited from interface org.eclipse.core.runtime. IAdaptable
getAdapter
 

Field Detail

DEFAULT_INSTALLED_FEATURE_TYPE

static final 
String DEFAULT_INSTALLED_FEATURE_TYPE
Deprecated. 
Default type for an installed feature. Different concrete feature implementations can be registered together with their corresponding type using the org.eclipse.update.core.featureTypes extension point.

Since:
2.0
See Also:
Constant Field Values

DEFAULT_PACKAGED_FEATURE_TYPE

static final 
String DEFAULT_PACKAGED_FEATURE_TYPE
Deprecated. 
Default type for a packaged feature. Different concrete feature implementations can be registered together with their corresponding type using the org.eclipse.update.core.featureTypes extension point.

Since:
2.0
See Also:
Constant Field Values

SITE_ACCESS_EXCEPTION

static final int SITE_ACCESS_EXCEPTION
Deprecated. 
If we are unable to access a site, the returned CoreException will contain this return code.

Since:
2.0.1
See Also:
Constant Field Values
Method Detail

getURL

URL getURL()
Deprecated. 
Returns the site URL

Returns:
site URL
Since:
2.0

getType

String getType()
Deprecated. 
Return the site type. Different concrete site implementations can be registered together with their corresponding type using the org.eclipse.update.core.siteTypes extension point.

Returns:
site type, or null.
Since:
2.0

getDescription

IURLEntry getDescription()
Deprecated. 
Returns the site description.

Returns:
site description, or null.
Since:
2.0

getCategories

ICategory[] getCategories()
Deprecated. 
Returns an array of categories defined by the site.

Returns:
array of site categories, or an empty array.
Since:
2.0

getCategory

ICategory getCategory(
String name)
Deprecated. 
Returns the named site category.

Parameters:
name - category name
Returns:
named category, or null ifit does not exist
Since:
2.0

getFeatureReferences

ISiteFeatureReference[] getFeatureReferences()
Deprecated. 
Returns an array of references to features on this site.

Returns:
an array of feature references, or an empty array.
Since:
2.0

getRawFeatureReferences

ISiteFeatureReference[] getRawFeatureReferences()
Deprecated. 
Returns an array of references to features on this site. No filtering occurs.

Returns:
an array of feature references, or an empty array..
Since:
2.1

getFeatureReference

ISiteFeatureReference getFeatureReference(
IFeature feature)
Deprecated. 
Returns a reference to the specified feature if it is installed on this site. filtered by the operating system, windowing system and architecture system set in Sitemanager

Parameters:
feature - feature
Returns:
feature reference, or null if this feature cannot be located on this site.
Since:
2.0

getArchives

IArchiveReference[] getArchives()
Deprecated. 
Returns an array of plug-in and non-plug-in archives located on this site

Returns:
an array of archive references, or an empty array if there are no archives known to this site. Note, that an empty array does not necessarily indicate there are no archives accessible on this site. It simply indicates the site has no prior knowledge of such archives.
Since:
2.0

getSiteContentProvider

ISiteContentProvider getSiteContentProvider()
                                            throws 
CoreException
Deprecated. 
Returns the content provider for this site. A content provider is an abstraction of each site organization. It allows the content of the site to be accessed in a standard way regardless of the organization. All concrete sites need to be able to return a content provider.

Returns:
site content provider
Throws:
CoreException
Since:
2.0

getDefaultPackagedFeatureType

String getDefaultPackagedFeatureType()
Deprecated. 
Returns the default type for a packaged feature supported by this site

Returns:
feature type, as registered in the org.eclipse.update.core.featureTypes extension point.
Since:
2.0

getPluginEntries

IPluginEntry[] getPluginEntries()
Deprecated. 
Returns an array of entries corresponding to plug-ins installed on this site.

Returns:
array of plug-in entries,or an empty array.
Since:
2.0

getPluginEntryCount

int getPluginEntryCount()
Deprecated. 
Returns the number of plug-ins installed on this site

Returns:
number of installed plug-ins
Since:
2.0

addPluginEntry

void addPluginEntry(
IPluginEntry pluginEntry)
Deprecated. 
Adds a new plug-in entry to this site.

Parameters:
pluginEntry - plug-in entry
Since:
2.0

getPluginEntriesOnlyReferencedBy

IPluginEntry[] getPluginEntriesOnlyReferencedBy(
IFeature feature)
                                                throws 
CoreException
Deprecated. 
Returns an array of entries corresponding to plug-ins that are installed on this site and are referenced only by the specified feature. These are plug-ins that are not shared with any other feature.

Parameters:
feature - feature
Returns:
an array of plug-in entries, or an empty array.
Throws:
CoreException
Since:
2.0

getDownloadSizeFor

long getDownloadSizeFor(
IFeature feature)
Deprecated. 
Returns the size of the files that need to be downloaded in order to install the specified feature on this site, if it can be determined. This method takes into account any plug-ins that are already available on this site.

Parameters:
feature - candidate feature
Returns:
download size of the feature in KiloBytes, or an indication the size could not be determined
Since:
2.0
See Also:
ContentEntryModel.UNKNOWN_SIZE

getInstallSizeFor

long getInstallSizeFor(
IFeature feature)
Deprecated. 
Returns the size of the files that need to be installed for the specified feature on this site, if it can be determined. This method takes into account any plug-ins that are already installed on this site.

Parameters:
feature - candidate feature
Returns:
install size of the feature in KiloBytes, or an indication the size could not be determined
Since:
2.0
See Also:
ContentEntryModel.UNKNOWN_SIZE

install

IFeatureReference install(
IFeature feature,
                          
IVerificationListener verificationListener,
                          
IProgressMonitor monitor)
                          throws 
InstallAbortedException,
                                 
CoreException
Deprecated. 
Installs the specified feature on this site.

Parameters:
feature - feature to install
verificationListener - install verification listener
monitor - install monitor, can be null
Throws:
InstallAbortedException - when the user cancels the install
CoreException
Since:
2.0

install

IFeatureReference install(
IFeature feature,
                          
IFeatureReference[] optionalfeatures,
                          
IVerificationListener verificationListener,
                          
IProgressMonitor monitor)
                          throws 
InstallAbortedException,
                                 
CoreException
Deprecated. 
Installs the specified feature on this site. Only optional features passed as parameter will be installed.

Parameters:
feature - feature to install
optionalfeatures - list of optional features to be installed
verificationListener - install verification listener
monitor - install monitor, can be null
Throws:
InstallAbortedException - when the user cancels the install
CoreException
Since:
2.0

remove

void remove(
IFeature feature,
            
IProgressMonitor monitor)
            throws 
CoreException
Deprecated. 
Removes (uninstalls) the specified feature from this site. This method takes into account plug-in entries referenced by the specified fetaure that continue to be required by other features installed on this site.

Parameters:
feature - feature to remove
monitor - progress monitor
Throws:
CoreException
Since:
2.0

setSiteContentProvider

void setSiteContentProvider(
ISiteContentProvider siteContentProvider)
Deprecated. 
Sets the site content provider. This is typically performed as part of the site creation operation. Once set, the provider should not be reset.

Parameters:
siteContentProvider - site content provider
Since:
2.0

getCurrentConfiguredSite

IConfiguredSite getCurrentConfiguredSite()
Deprecated. 
Returns the IConfiguredSite for this site in the current configuration or null if none found.

Since:
2.0.2

createFeature

IFeature createFeature(
String type,
                       
URL url)
                       throws 
CoreException
Deprecated. use createFeature(String,URL,IProgressMonitor) instead

Creates a new feature object. The feature must exist on this site or a core exception will be thrown. Concrete implementations may elect to cache instances, in which case subsequent calls to create a feature with the same URL will return the same instance. param type the feature type that will be used to select the factory. If null is passed, default feature type will be used. param url URL of the feature archive as listed in the site. return newly created feature object, or a cached value if caching is implemented by this site.

Throws:
CoreException
Since:
2.0.2

createFeature

IFeature createFeature(
String type,
                       
URL url,
                       
IProgressMonitor monitor)
                       throws 
CoreException
Deprecated. 
Creates a new feature object. The feature must exist on this site or a core exception will be thrown. Concrete implementations may elect to cache instances, in which case subsequent calls to create a feature with the same URL will return the same instance. param type the feature type that will be used to select the factory. If null is passed, default feature type will be used. param url URL of the feature archive as listed in the site. return newly created feature object, or a cached value if caching is implemented by this site.

Parameters:
monitor - the progress monitor
Throws:
CoreException
Since:
2.1

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire