schema.rap.settingstores.exsd Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.rap.ui
The RAP Widget Toolkit Eclipse UI Components
The newest version!




      
         
      
      
         This extension point allows developers to contribute additional <code>SettingStore</code> instances.
<p>
An <code>SettingStore</code> provides persistent storage for settings (key value pairs of Strings), which are then available beyond the scope of a single session. An <code>SettingStoreFactory</code> is responsible for creating a particular kind of <code>SettingStore</code>.
<p>
Developers that want to implement their own setting store must provide a setting store factory and register it with the framework using this extension point.
<p>
Note that at runtime only <b>one</b> (out of all available) factories will be used to create new <code>SettingStore</code> instances. Which factory is used can be controlled in two ways:
<ul>
<li>In a normal RAP deployment you can specify the factory to be used by placing the following property in the OSGi config.ini file: <code>org.eclipse.rap.rwt.settingStoreFactory=<i>id</i></code> where <i>id</i> identifies a particular factory element. Example:
<pre>
org.eclipse.rap.rwt.settingStoreFactory=file
</pre>
</li>
<li>In RWT-only deployment you can specify the factory to be used in the application configuration:
<pre>
public class SimpleConfiguration implements ApplicationConfiguration {

  public void configure( Application application ) {
    ...
    application.setSettingStoreFactory( new FileSettingStoreFactory() );
    ...
  }

}
</pre>
</li>
<li>If nothing is specified, the class <code>WorkbenchFileSettingStoreFactory</code> will be used in a regular RAP deployment. In an RWT only deployment the class <code>FileSettingStoreFactory</code> will be used instead.</li>
</ul>
      
   

   
      
         
            
         
      
      
         
            
         
         
            
               
                  a fully qualified identifier of the target extension point
               
            
         
         
            
               
                  an optional identifier of the extension instance
               
            
         
         
            
               
                  an optional name of the extension instance
               
               
                  
               
            
         
      
   

   
      
         
            
         
         
            This element is used to define setting store factories. If more than one of these elements exist with the same <code>id</code>, only the last declared element (in order of reading the registry) is considered valid.
         
      
      
         
            
               
                  the unique identifier of this factory
               
            
         
         
            
               
                  a fully qualified name of the class implementing the <code>org.eclipse.rap.rwt.service.SettingStoreFactory</code> interface.
               
               
                  
               
            
         
      
   

   
      
         
      
      
         RAP 1.1
      
   

   
      
         
      
      
<pre>
<extension
    point="org.eclipse.rap.ui.settingstores">
  <factory
      class="org.eclipse.rap.ui.internal.preferences.WorkbenchFileSettingStoreFactory"
      id="file">
  </factory>
  <factory
      class="org.eclipse.rap.rwt.service.FileSettingStoreFactory"
      id="rwtfile">
  </factory>
</extension>
</pre>
      
   

   
      
         
      
      
         To obtain a setting store use <code>RWT.getSettingStore()</code>. This will use the configured <code>org.eclipse.rap.rwt.service.SettingStoreFactory</code> to generate and return an appropriate <code>org.eclipse.rap.rwt.service.SettingStore</code> instance for this session.
<p>
Developers wishing to provide their own setting store must implement <code>SettingStore</code> and <code>SettingStoreFactory</code> and contribute their factory using this extension point.
      
   

   
      
         
      
      
         RAP provides the following default implementations:
<ul>
<li><code>WorkbenchFileSettingStoreFactory</code>, <code>FileSettingStoreFactory</code> and <code>FileSettingStore</code>
</li>
</ul>
      
   

   
      
         
      
      
         Copyright (c) 2008, 2015 EclipseSource and others.<br>
All rights reserved. This program and the accompanying materials are made
available under the terms of the Eclipse Public License v1.0 which accompanies
this distribution, and is available at <a
href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>