Module framework
Back to master index

[public] Configuration Point framework.preferencesOccurs: unbounded
Defines individual preference objects - name, value, description, etc See system.configuration, which is the service that consumes this configuration point.
Schema
Element <preference>
Attribute advanced Translator: boolean
true if this is an 'advanced' preference - not to be shown in all views.
Attribute default-value (required) Translator: string
The default value
Attribute help-id Translator: string
An optional help-id that links to further help.
Attribute name (required) (unique) Translator: string
The name of the preference - used as it's key
Attribute propagate-to-config Translator: boolean
true if the default value, and all modifications of this prefernece should be copied into the legacy ag.commons.Config used by other AG components (such as delegates). If false, this preference is not visible to such code.
Attribute requires-restart Translator: boolean
true if restart is required to effect changes to this preference
Nested Elements
<create-object class="org.astrogrid.desktop.modules.system.pref.Preference" />
<set-module property="module" />
<read-attribute attribute="default-value" property="defaultValue" />
<read-attribute attribute="name" property="name" />
<read-attribute attribute="advanced" property="advanced" />
<read-attribute attribute="propagate-to-config" property="propagateToConfig" />
<read-attribute attribute="requires-restart" property="requiresRestart" />
<read-attribute attribute="help-id" property="helpId" />
<invoke-parent method="addElement" />
Attribute name (required) (unique) Translator: string
The name of the preference - used as it's key
Attribute default-value (required) Translator: string
The default value
Attribute advanced Translator: boolean
true if this is an 'advanced' preference - not to be shown in all views.
Attribute requires-restart Translator: boolean
true if restart is required to effect changes to this preference
Attribute propagate-to-config Translator: boolean
true if the default value, and all modifications of this prefernece should be copied into the legacy ag.commons.Config used by other AG components (such as delegates). If false, this preference is not visible to such code.
Attribute help-id Translator: string
An optional help-id that links to further help.
Element <ui-name>
Name to display in UI
Conversion Rules
<push-content />
<invoke-parent method="setUiName" />
Element <description>
Description of this preference
Conversion Rules
<push-content />
<invoke-parent method="setDescription" />
Element <units>
Units / type of this value. Recognized values are 'boolean', 'file', 'url' 'number','seconds'. Other values may also be used. Recognized values might cause the UI to alter to support input of these types.
Conversion Rules
<push-content />
<invoke-parent method="setUnits" />
Element <alternative>
a suggested alternative value for this preference
Conversion Rules
<push-content />
<invoke-parent method="addAlternative" />
Element <option>
enumerates one of the allowed values for this preference
Conversion Rules
<push-content />
<invoke-parent method="addOption" />
Conversion Rules
<create-object class="org.astrogrid.desktop.modules.system.pref.Preference" />
<set-module property="module" />
<read-attribute attribute="default-value" property="defaultValue" />
<read-attribute attribute="name" property="name" />
<read-attribute attribute="advanced" property="advanced" />
<read-attribute attribute="propagate-to-config" property="propagateToConfig" />
<read-attribute attribute="requires-restart" property="requiresRestart" />
<read-attribute attribute="help-id" property="helpId" />
<invoke-parent method="addElement" />
Contribution from module cds
<preference advanced="false" default-value="http://vizier.u-strasbg.fr/viz-bin/nph-sesame/" name="cds.sesame.rest.endpoint" >
  • <ui-name >
    • Sesame endpoint
    </ui-name>
  • <description >
    • http url of the sesame name resolver service
    </description>
  • <alternative >
    • http://vizier.hia.nrc.ca/viz-bin/nph-sesame/
    </alternative>
  • <alternative >
    • http://vizier.cfa.harvard.edu/viz-bin/nph-sesame/
    </alternative>
  • <units >
    • url
    </units>
</preference>
Contribution from module cds
<preference advanced="true" default-value="http://cdsws.u-strasbg.fr/axis/services/VizieR" name="cds.vizier.endpoint" >
  • <ui-name >
    • Vizier endpoint
    </ui-name>
  • <description >
    • http url of the vizier service
    </description>
  • <units >
    • url
    </units>
</preference>
Contribution from module cds
<preference advanced="true" default-value="http://cdsws.u-strasbg.fr/axis/services/AstroCoo" name="cds.coordinate.endpoint" >
  • <ui-name >
    • Coordinate endpoint
    </ui-name>
  • <description >
    • http url of the coordinate conversion service
    </description>
  • <units >
    • url
    </units>
</preference>
Contribution from module cds
<preference advanced="true" default-value="http://cdsws.u-strasbg.fr/axis/services/UCD" name="cds.ucd.endpoint" >
  • <ui-name >
    • Ucd dictionary endpoint
    </ui-name>
  • <description >
    • http url of the dictionary service
    </description>
  • <units >
    • url
    </units>
</preference>
Contribution from module framework
<preference default-value="false" name="acr.advanced" >
  • <ui-name >
    • Show advanced features
    </ui-name>
  • <description >
    • Enables additional UI components for advanced use
    </description>
  • <units >
    • boolean
    </units>
</preference>
<preference advanced="true" default-value="false" name="acr.debug" >
  • <ui-name >
    • Debugging mode
    </ui-name>
  • <description >
    • Enables additional UI components for debugging and testing
    </description>
  • <units >
    • boolean
    </units>
</preference>
Contribution from module ivoa
<preference advanced="false" default-value="http://registry.astrogrid.org/astrogrid-registry/services/RegistryQueryv1_0" name="org.astrogrid.registry.query.endpoint" propagate-to-config="true" requires-restart="true" >
  • <ui-name >
    • Registry endpoint
    </ui-name>
  • <description >
    • http url of the main registry service
    </description>
  • <alternative >
    • http://alt.registry.astrogrid.org/astrogrid-registry/services/RegistryQueryv1_0
    </alternative>
  • <alternative >
    • http://msslxv.mssl.ucl.ac.uk:8080/mssl-registry/services/RegistryQueryv1_0
    </alternative>
  • <alternative >
    • http://harvesting-registry.roe.ac.uk/astrogrid-registry/services/RegistryQueryv1_0
    </alternative>
  • <alternative >
    • http://rakaposhi.star.le.ac.uk/astrogrid-registry/services/RegistryQueryv1_0
    </alternative>
  • <units >
    • url
    </units>
</preference>
<preference advanced="false" default-value="http://alt.registry.astrogrid.org/astrogrid-registry/services/RegistryQueryv1_0" name="org.astrogrid.registry.query.altendpoint" propagate-to-config="true" requires-restart="true" >
  • <ui-name >
    • Fallback Registry endpoint
    </ui-name>
  • <description >
    • http url of the main registry service
    </description>
  • <alternative >
    • http://registry.astrogrid.org/astrogrid-registry/services/RegistryQueryv1_0
    </alternative>
  • <alternative >
    • http://msslxv.mssl.ucl.ac.uk:8080/mssl-registry/services/RegistryQueryv1_0
    </alternative>
  • <alternative >
    • http://harvesting-registry.roe.ac.uk/astrogrid-registry/services/RegistryQueryv1_0
    </alternative>
  • <alternative >
    • http://rakaposhi.star.le.ac.uk/astrogrid-registry/services/RegistryQueryv1_0
    </alternative>
  • <units >
    • url
    </units>
</preference>
<preference default-value="86400" name="ivo.registry.cacheLife" requires-restart="true" >
  • <ui-name >
    • Cached entries expire after
    </ui-name>
  • <description >
    • 86400 seconds = a day, 604800 seconds = a week
    </description>
  • <units >
    • seconds
    </units>
</preference>
Contribution from module network
<preference default-value=" " name="network.proxyHost" requires-restart="true" >
  • <ui-name >
    • HTTP Proxy Host
    </ui-name>
  • <description >
    • Hostname for a proxy server used for all HTTP connections
    </description>
</preference>
<preference default-value="80" name="network.proxyPort" requires-restart="true" >
  • <ui-name >
    • HTTP Proxy port number
    </ui-name>
  • <description >
    • Port number of proxy server used for all HTTP connections (only relevant if Proxy Host is specified)
    </description>
  • <units >
    • number
    </units>
</preference>
<preference advanced="true" default-value="true" name="network.preferIPv4Stack" requires-restart="true" >
  • <ui-name >
    • Prefer IPv4 Stack
    </ui-name>
  • <description >
    • Value of java.net.preferIPv4Stack system property
    </description>
  • <units >
    • boolean
    </units>
</preference>
<preference advanced="true" default-value="false" name="network.preferIPv6Addresses" requires-restart="true" >
  • <ui-name >
    • Prefer IPv6 Addresses
    </ui-name>
  • <description >
    • Value of java.net.preferIPv6Addresses system property
    </description>
  • <units >
    • boolean
    </units>
</preference>
<preference advanced="true" default-value="enabled" name="org.astrogrid.filestore.chunked.send" propagate-to-config="true" requires-restart="true" >
  • <ui-name >
    • Filestore Chunking
    </ui-name>
  • <description >
    • transfer data to filestore in chunks, without buffering in memory first
    </description>
  • <option >
    • enabled
    </option>
  • <option >
    • disabled
    </option>
</preference>
Contribution from module performance
<preference advanced="false" default-value="20" name="performance.maxWorkerThreads" requires-restart="true" >
  • <ui-name >
    • Maximum background threads
    </ui-name>
  • <description >
    • <html>Maximum number of background threads to run simultaneously. <br>If the number of background processes exceed this number, the excess are queued until a <br>runningprocess completes. <br>Reduce this number if running on a low-bandwidth network, but not below 2
    </description>
  • <units >
    • number
    </units>
</preference>
<preference advanced="false" default-value="5" name="performance.timeoutFactor" requires-restart="false" >
  • <ui-name >
    • Timeout Scaling Factor
    </ui-name>
  • <description >
    • <html>A value used to linearly scale application timeouts. <br>(default is 5). Increase this number if running on a low-bandwidth network. <br>Must always be greater than 0
    </description>
  • <units >
    • number
    </units>
</preference>
<preference advanced="false" default-value="5" name="performance.showProgressDialogueAfter" requires-restart="true" >
  • <ui-name >
    • Show progress dialogues after
    </ui-name>
  • <description >
    • <html>Show progress dialogues for important processes after they have been running for a certain amount of seconds. <br>(default is 5 seconds). Set to 0 to always show progress dialogues, -1 to never show progress dialogues.
    </description>
  • <units >
    • seconds
    </units>
</preference>
<preference advanced="false" default-value="true" name="performance.prevent.oversize.registry.query" requires-restart="false" >
  • <ui-name >
    • Prevent oversized registry queries
    </ui-name>
  • <description >
    • <html>Prevent the execution of registry queries that will return huge numbers of matches. <br>Recommended to prevent user error from overloading the registry service or user interface.
    </description>
  • <units >
    • boolean
    </units>
</preference>
Contribution from module plastic
<preference default-value="true" name="messaging.start.samp" requires-restart="true" >
  • <ui-name >
    • Launch SAMP Hub at startup
    </ui-name>
  • <description >
    • When the application starts, if no SAMP hub can be found, launch an internal hub
    </description>
  • <units >
    • boolean
    </units>
</preference>
<preference default-value="false" name="messaging.start.plastic" requires-restart="true" >
  • <ui-name >
    • Launch PLASTIC Hub at startup
    </ui-name>
  • <description >
    • When the application starts, if no PLASTIC hub can be found, launch an internal hub
    </description>
  • <units >
    • boolean
    </units>
</preference>
<preference default-value="true" name="org.votech.plastic.notificationsenabled" >
  • <ui-name >
    • Display messaging events
    </ui-name>
  • <description >
    • Show messaging event notifications in the system tray
    </description>
  • <units >
    • boolean
    </units>
</preference>
Contribution from module system
<preference default-value="${user.home}${file.separator}.workbench" name="astrogrid.workdir" requires-restart="true" >
  • <ui-name >
    • Working directory
    </ui-name>
  • <description >
    • Location to store query results, cache registry queries, etc
    </description>
  • <units >
    • directory
    </units>
</preference>
Contribution from module system
<preference advanced="false" default-value="VO Explorer" name="system.ui.launchApp" >
  • <ui-name >
    • At startup, launch
    </ui-name>
  • <description >
    • Select which window to open at startup
    </description>
  • <option >
    • VO Explorer
    </option>
  • <option >
    • File Explorer
    </option>
  • <option >
    • Task Runner
    </option>
  • <option >
    • All-VO Astroscope
    </option>
  • <option >
    • All-VO Helioscope
    </option>
  • <option >
    • Multi Position Search
    </option>
  • <option >
    • none
    </option>
</preference>
Contribution from module systemIf:not (property system.webserver.disabled)
<preference advanced="true" default-value="-1" name="system.webserver.port" requires-restart="true" >
  • <ui-name >
    • Run webserver on port
    </ui-name>
  • <alternative >
    • -1
    </alternative>
  • <units >
    • (-1 to scan for available port)
    </units>
  • <description />
</preference>
<preference advanced="true" default-value="8001" name="system.webserver.startScanPort" requires-restart="true" >
  • <ui-name >
    • Webserver: scan from port
    </ui-name>
  • <description >
    • network port number to start scanning from
    </description>
  • <units >
    • number
    </units>
</preference>
<preference advanced="true" default-value="8800" name="system.webserver.endScanPort" requires-restart="true" >
  • <ui-name >
    • until port
    </ui-name>
  • <description >
    • network port number to scan up to
    </description>
  • <units >
    • number
    </units>
</preference>
<preference advanced="true" default-value="127.0.0.1" name="system.webserver.inetAddress" requires-restart="true" >
  • <ui-name >
    • Network address
    </ui-name>
  • <description >
    • Network address that webserver and RMI Server should accept connections from. Leave blank to use DNS assigned address
    </description>
</preference>
Contribution from module systemIf:not (property system.rmi.disabled)
<preference advanced="true" default-value="-1" name="system.rmi.port" requires-restart="true" >
  • <ui-name >
    • Run RMI server on port
    </ui-name>
  • <alternative >
    • -1
    </alternative>
  • <description />
  • <units >
    • (-1 to scan for available port)
    </units>
</preference>
<preference advanced="true" default-value="1099" name="system.rmi.startScanPort" requires-restart="true" >
  • <ui-name >
    • RMI server: scan from port
    </ui-name>
  • <description >
    • network port number to start scanning from
    </description>
  • <units >
    • number
    </units>
</preference>
<preference advanced="true" default-value="2099" name="system.rmi.endScanPort" requires-restart="true" >
  • <ui-name >
    • until port
    </ui-name>
  • <description >
    • network port number to scan up to
    </description>
  • <units >
    • number
    </units>
</preference>
Contribution from module system
<preference advanced="true" default-value="true" name="system.doSnitch" requires-restart="true" >
  • <ui-name >
    • Track usage
    </ui-name>
  • <description />
  • <units >
    • boolean
    </units>
</preference>
Contribution from module system
<preference default-value="true" name="system.checkForUpdates" >
  • <ui-name >
    • Check for updates on startup
    </ui-name>
  • <description />
  • <units >
    • boolean
    </units>
</preference>
Contribution from module ui
<preference default-value="true" name="taskrunner.notificationsenabled" >
  • <ui-name >
    • Display task runner events
    </ui-name>
  • <description >
    • Show task runner event notifications in the system tray
    </description>
  • <units >
    • boolean
    </units>
</preference>
Contribution from module ui
<preference advanced="true" default-value="http://technology.astrogrid.org/raw-attachment/wiki/vodesktopResources/exampleResourceLists-1.3.2.xml" name="resourcetree.examples.location" >
  • <ui-name >
    • VoExplorer Example Lists
    </ui-name>
  • <description >
    • A location containing example resource lists
    </description>
  • <units >
    • url
    </units>
</preference>
Contribution from module util
<preference advanced="false" default-value="true" name="util.selftest.runAtStartup" >
  • <ui-name >
    • Run self tests at startup
    </ui-name>
  • <description >
    • If true, self tests will be run automatically when VODesktop starts
    </description>
  • <units >
    • boolean
    </units>
</preference>
<preference advanced="true" default-value="5" name="util.selftest.testDelay" requires-restart="true" >
  • <ui-name >
    • Self test delay
    </ui-name>
  • <description >
    • Time to wait after startup before running self tests
    </description>
  • <units >
    • seconds
    </units>
</preference>
Contribution from module votechIf:not(property skua)
<preference advanced="true" default-value="false" name="experimental.suggestions.services" >
  • <ui-name >
    • Enable experimental suggestion service
    </ui-name>
  • <description >
    • Enable experimental features
    </description>
  • <units >
    • boolean
    </units>
</preference>
<preference advanced="true" default-value="http://thor.roe.ac.uk/jackdaw/like" name="votech.jackdaw.endpoint" requires-restart="true" >
  • <ui-name >
    • Experimental suggestion service endpoint
    </ui-name>
  • <description >
    • The http endpoint of a suggestions service
    </description>
  • <units >
    • url
    </units>
</preference>
Contribution from module votechIf:property skua
<preference advanced="true" default-value="http://localhost:8080" name="skua.endpoint" requires-restart="false" >
  • <ui-name >
    • SKUA endpoint
    </ui-name>
  • <description >
    • The URL of a SKUA service which you can read and write to. This is the URL of a particular SAC, and so might have to be set up beforehand by the user.
    </description>
  • <units >
    • url
    </units>
</preference>
Contribution from module votech
<preference advanced="true" default-value="http://vomon.roe.ac.uk/status.xml" name="votech.vomon.endpoint" requires-restart="true" >
  • <ui-name >
    • Services monitor endpoint
    </ui-name>
  • <description >
    • A http url that returns a vomon xml document
    </description>
  • <alternative >
    • http://vomon.astrogrid.org/status.xml
    </alternative>
  • <units >
    • url
    </units>
</preference>
<preference default-value="3600" name="votech.vomon.reload" requires-restart="true" >
  • <ui-name >
    • Refresh services monitor every
    </ui-name>
  • <units >
    • seconds
    </units>
  • <description >
    • Period between reloading the monitoring information
    </description>
</preference>

Module framework
Back to master index