Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "EIG:Configuration Properties"

Line 1: Line 1:
 
System property values are accessed via System.getProperties() or System.getProperty(<property name>);
 
System property values are accessed via System.getProperties() or System.getProperty(<property name>);
  
= Remote Services Properties =
+
== ECF Core API System Properties ==
 +
 
 +
Bundle:  [http://git.eclipse.org/c/ecf/org.eclipse.ecf.git/tree/framework/bundles/org.eclipse.ecf.identity org.eclipse.ecf.identity]
 +
 
 +
Class:  [http://git.eclipse.org/c/ecf/org.eclipse.ecf.git/tree/framework/bundles/org.eclipse.ecf.identity/src/org/eclipse/ecf/core/util/Trace.java org.eclipse.ecf.core.util.Trace]
 +
 
 +
{|{{BMTableStyle}}
 +
|-{{BMTHStyle}}
 +
! Property Name
 +
! Description
 +
! Type
 +
! Default value
 +
|-
 +
| org.eclipse.ecf.core.util.traceAll
 +
| Whether all tracing is turned on by default.  If set to true, all Trace.trace calls will result in output to System.out.  Example usage:  -Dorg.eclipse.ecf.core.util.traceAll=true
 +
| Boolean
 +
| false
 +
|-
 +
| org.eclipse.ecf.core.util.traceBundles
 +
| Whether all tracing is turned on for a list of bundles.  For all the comma-separated bundle symbolic names given, if any Trace.trace statements exist in the code for each bundle, it will result in output to System.out.  Example usage:  -Dorg.eclipse.ecf.core.util.traceBundles=org.eclipse.ecf,org.eclipse.ecf.osgi.services.remoteserviceadmin
 +
| String (comma separated list of bundle symbolic names)
 +
| empty
 +
|}
 +
 
 +
== ECF Remote Services API Properties ==
 +
 
 +
Bundle:  [http://git.eclipse.org/c/ecf/org.eclipse.ecf.git/tree/framework/bundles/org.eclipse.ecf.remoteservice org.eclipse.ecf.remoteservice]
 +
 
 +
Class:  [http://git.eclipse.org/c/ecf/org.eclipse.ecf.git/tree/framework/bundles/org.eclipse.ecf.remoteservice/src/org/eclipse/ecf/remoteservice/IRemoteCall.java org.eclipse.ecf.remoteservice.IRemoteCall]
  
 
{|{{BMTableStyle}}
 
{|{{BMTableStyle}}
Line 16: Line 44:
 
|}
 
|}
  
= OSGi Remote Service Admin (RSA) Basic Topology Manager Properties =
+
== OSGi Remote Service Admin (RSA) Basic Topology Manager System Properties ==
 +
 
 +
Bundle: [http://git.eclipse.org/c/ecf/org.eclipse.ecf.git/tree/compendium/bundles/org.eclipse.ecf.osgi.services.distribution org.eclipse.ecf.osgi.services.distribution]
 +
 
 +
Class: [http://git.eclipse.org/c/ecf/org.eclipse.ecf.git/tree/compendium/bundles/org.eclipse.ecf.osgi.services.distribution/src/org/eclipse/ecf/internal/osgi/services/distribution/BasicTopologyManagerImpl.java org.eclipse.ecf.internal.osgi.services.distribution.BasicTopologyManagerImpl]
  
 
{|{{BMTableStyle}}
 
{|{{BMTableStyle}}
Line 24: Line 56:
 
! Type
 
! Type
 
! Default value
 
! Default value
|-
 
| org.eclipse.ecf.osgi.services.discovery.endpointListenerScope
 
| The endpoint listener scope for discovery of OSGi remote services endpoints.
 
| String
 
| <none>
 
 
|-
 
|-
 
| org.eclipse.ecf.osgi.services.discovery.allowLoopbackReference
 
| org.eclipse.ecf.osgi.services.discovery.allowLoopbackReference
Line 34: Line 61:
 
| Boolean
 
| Boolean
 
| true
 
| true
 +
|-
 +
| org.eclipse.ecf.osgi.services.discovery.endpointListenerScope
 +
| The endpoint listener scope for discovery of OSGi remote services endpoints.  See the documentation from chapter 122 (Remote Service Admin) of the OSGi R6+ specification.
 +
| String
 +
| empty
 +
|}
 +
 +
Class: [http://git.eclipse.org/c/ecf/org.eclipse.ecf.git/tree/compendium/bundles/org.eclipse.ecf.osgi.services.distribution/src/org/eclipse/ecf/internal/osgi/services/distribution/BasicTopologyManagerComponent.java org.eclipse.ecf.internal.osgi.services.distribution.BasicTopologyManagerComponent]
 +
 +
{|{{BMTableStyle}}
 +
|-{{BMTHStyle}}
 +
! Property Name
 +
! Description
 +
! Type
 +
! Default value
 
|-
 
|-
 
| org.eclipse.ecf.osgi.services.basictopologymanager.exportRegisteredSvcs
 
| org.eclipse.ecf.osgi.services.basictopologymanager.exportRegisteredSvcs
Line 39: Line 81:
 
| Boolean
 
| Boolean
 
| true
 
| true
|-
 
| org.eclipse.ecf.osgi.services.basictopologymanager.exportRegisteredSvcsClassname
 
| When the basic topology manager is started, and org.eclipse.ecf.osgi.services.basictopologymanager.exportRegisteredSvcs is true, what service classname is required for export.  A default of <none> means that all remote service classes are exported.
 
| String
 
| <none>
 
 
|-
 
|-
 
| org.eclipse.ecf.osgi.services.basictopologymanager.exportRegisteredSvcsFilter
 
| org.eclipse.ecf.osgi.services.basictopologymanager.exportRegisteredSvcsFilter
Line 49: Line 86:
 
| String
 
| String
 
| (service.exported.interfaces=*)
 
| (service.exported.interfaces=*)
 +
|-
 +
| org.eclipse.ecf.osgi.services.basictopologymanager.exportRegisteredSvcsClassname
 +
| When the basic topology manager is started, and org.eclipse.ecf.osgi.services.basictopologymanager.exportRegisteredSvcs is true, what service classname is required for export.  A default of <none> means that all remote service classes are exported.
 +
| String
 +
| <none>
 
|}
 
|}
 
  
 
== ECF Generic Provider Configuration Properties ==
 
== ECF Generic Provider Configuration Properties ==

Revision as of 20:13, 15 July 2015

System property values are accessed via System.getProperties() or System.getProperty(<property name>);

ECF Core API System Properties

Bundle: org.eclipse.ecf.identity

Class: org.eclipse.ecf.core.util.Trace

Property Name Description Type Default value
org.eclipse.ecf.core.util.traceAll Whether all tracing is turned on by default. If set to true, all Trace.trace calls will result in output to System.out. Example usage: -Dorg.eclipse.ecf.core.util.traceAll=true Boolean false
org.eclipse.ecf.core.util.traceBundles Whether all tracing is turned on for a list of bundles. For all the comma-separated bundle symbolic names given, if any Trace.trace statements exist in the code for each bundle, it will result in output to System.out. Example usage: -Dorg.eclipse.ecf.core.util.traceBundles=org.eclipse.ecf,org.eclipse.ecf.osgi.services.remoteserviceadmin String (comma separated list of bundle symbolic names) empty

ECF Remote Services API Properties

Bundle: org.eclipse.ecf.remoteservice

Class: org.eclipse.ecf.remoteservice.IRemoteCall

Property Name Description Type Default value
ecf.remotecall.timeout Default timeout for remote service calls. Described in [1] Integer 30000 (milliseconds)

OSGi Remote Service Admin (RSA) Basic Topology Manager System Properties

Bundle: org.eclipse.ecf.osgi.services.distribution

Class: org.eclipse.ecf.internal.osgi.services.distribution.BasicTopologyManagerImpl

Property Name Description Type Default value
org.eclipse.ecf.osgi.services.discovery.allowLoopbackReference Whether a loopback reference to remote service provided by same framework is to be discovered/allowed. This value is only consulted if endpointListenerScope is not set. Boolean true
org.eclipse.ecf.osgi.services.discovery.endpointListenerScope The endpoint listener scope for discovery of OSGi remote services endpoints. See the documentation from chapter 122 (Remote Service Admin) of the OSGi R6+ specification. String empty

Class: org.eclipse.ecf.internal.osgi.services.distribution.BasicTopologyManagerComponent

Property Name Description Type Default value
org.eclipse.ecf.osgi.services.basictopologymanager.exportRegisteredSvcs When the basic topology manager is started, whether previously registered remote services are automatically and immediately exported. Boolean true
org.eclipse.ecf.osgi.services.basictopologymanager.exportRegisteredSvcsFilter When the basic topology manager is started, and org.eclipse.ecf.osgi.services.basictopologymanager.exportRegisteredSvcs is true, what service property filter is required to be exported. Default is '(service.exported.interfaces=*)', which means that all services that export and interfaces are exported. String (service.exported.interfaces=*)
org.eclipse.ecf.osgi.services.basictopologymanager.exportRegisteredSvcsClassname When the basic topology manager is started, and org.eclipse.ecf.osgi.services.basictopologymanager.exportRegisteredSvcs is true, what service classname is required for export. A default of <none> means that all remote service classes are exported. String <none>

ECF Generic Provider Configuration Properties

Configuration properties for ECF Generic provider (and SSL) are shown in ECF Generic Provider Configuration Properties.

R-OSGi provider

Extra configuration properties for R-OSGi are shown in R-OSGi_Properties

Restlet provider

Property Name Description Type Default value
org.eclipse.ecf.remoteservice.restlet.exporturl.protocol Protocol to use (http, for example) String <none>
org.eclipse.ecf.remoteservice.restlet.exporturl.port Port (8080, for example) String <none>

Back to the top