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"

(→‎ECF generic provider)
 
(23 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
System property values are accessed via System.getProperties() or System.getProperty(<property name>);
+
=== Core API ===
  
−
= Remote Services 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
 +
|}
 +
 
 +
=== Remote Services API ===
 +
 
 +
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 42:
 
|}
 
|}
  
−
= OSGi Remote Service Admin (RSA) Basic Topology Manager Properties =
+
=== Remote Service Admin (RSA) Implementation ===
 +
 
 +
Bundle: [http://git.eclipse.org/c/ecf/org.eclipse.ecf.git/tree/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin org.eclipse.ecf.osgi.services.remoteserviceadmin]
 +
 
 +
Class: [http://git.eclipse.org/c/ecf/org.eclipse.ecf.git/tree/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/RemoteServiceAdmin.java org.eclipse.ecf.osgi.services.remoteserviceadminRemoteServiceAdmin]
  
 
{|{{BMTableStyle}}
 
{|{{BMTableStyle}}
Line 25: Line 55:
 
! Default value
 
! Default value
 
|-
 
|-
−
| org.eclipse.ecf.osgi.services.discovery.endpointListenerScope
+
| org.eclipse.ecf.osgi.services.remoteserviceadmin.disableServiceVersionChecking
−
| The endpoint listener scope for discovery of OSGi remote services endpoints.
+
| Whether remote service interface version checking is disabled.  If false, version checking is enabled, and if true version checking is disabled.
−
| String
+
| Boolean
−
| <none>
+
| false
 
|-
 
|-
−
| org.eclipse.ecf.osgi.services.discovery.allowLoopbackReference
+
| org.eclipse.ecf.osgi.services.remoteserviceadmin.hostAutoCreateContainer
−
| 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.
+
| If true, then during export a host container of appropriate type will be automatically created.
 
| Boolean
 
| Boolean
 
| true
 
| true
 
|-
 
|-
−
| org.eclipse.ecf.osgi.services.basictopologymanager.exportRegisteredSvcs
+
| org.eclipse.ecf.osgi.services.remoteserviceadmin.consumerAutoCreateContainer
−
| When the basic topology manager is started, whether previously registered remote services are automatically and immediately exported.
+
| If true, then during export a host container of appropriate type will be automatically created.
 
| Boolean
 
| Boolean
 
| true
 
| true
 
|-
 
|-
−
| org.eclipse.ecf.osgi.services.basictopologymanager.exportRegisteredSvcsClassname
+
| org.eclipse.ecf.osgi.services.remoteserviceadmin.hostDefaultConfigType
−
| 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.
+
| Determines the default config type for remote service hosts, if not specified via the 'service.exported.configs' service property.
 
| String
 
| String
−
| <none>
+
| ecf.generic.server
−
|-
+
−
| 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=*)
+
 
|}
 
|}
 +
<br>
  
−
= Properties for each remote services provider  =
+
Class: [http://git.eclipse.org/c/ecf/org.eclipse.ecf.git/tree/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/ConsumerContainerSelector.java org.eclipse.ecf.osgi.services.remoteserviceadmin.ConsumerContainerSelector]
−
Provider list is [[ECF_Providers]]. These properties are used when creating a new Container or via Declarative Services.
+
−
 
+
−
== ECF generic provider ==
+
  
 
{|{{BMTableStyle}}
 
{|{{BMTableStyle}}
Line 61: Line 84:
 
! Description
 
! Description
 
! Type
 
! Type
−
! Default Value
+
! Default value
−
|-
+
−
| org.eclipse.ecf.provider.generic.scheme
+
−
| Default protocol for generic provider urls.  e.g. ecftcp://localhost:3282/server
+
−
| String
+
−
| ecftcp
+
−
|-
+
−
| org.eclipse.ecf.provider.generic.host
+
−
| Default host for generic provider urls.  e.g. ecftcp://localhost:3282/server
+
−
| String
+
−
| localhost
+
−
|-
+
−
| org.eclipse.ecf.provider.generic.port
+
−
| Default port for generic provider urls.  e.g. ecftcp://localhost:3282/server
+
−
| Integer
+
−
| 3282
+
−
|-
+
−
| org.eclipse.ecf.provider.generic.name
+
−
| Default path/name for generic provider urls.  e.g. ecftcp://localhost:3282/server
+
−
| String
+
−
| /server
+
−
|-
+
−
| org.eclipse.ecf.provider.generic.keepalive
+
−
| Default keepalive for generic provider
+
−
| Integer
+
−
| 30000  (milliseconds)
+
 
|-
 
|-
−
| org.eclipse.ecf.provider.generic.host.useHostName
+
| org.eclipse.ecf.osgi.services.remoteserviceadmin.ConsumerContainerSelector.reuseExistingContainers
−
| Whether to use the value of InetAddress.getLocalHost().getCanonicalHostName() as the default host value for dynamically created generic provider urls.  If false, then 'localhost' is used as default.
+
| Whether appropriate existing containers are reused by the ConsumerContainerSelector.
 
| Boolean
 
| Boolean
 
| true
 
| true
 +
|}
 +
<br>
 +
 +
Class: [http://git.eclipse.org/c/ecf/org.eclipse.ecf.git/tree/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/HostContainerSelector.java org.eclipse.ecf.osgi.services.remoteserviceadmin.HostContainerSelector]
 +
 +
{|{{BMTableStyle}}
 +
|-{{BMTHStyle}}
 +
! Property Name
 +
! Description
 +
! Type
 +
! Default value
 
|-
 
|-
−
| org.eclipse.ecf.provider.generic.port.fallback
+
| org.eclipse.ecf.osgi.services.remoteserviceadmin.HostContainerSelector.reuseExistingContainers
−
| What fallback port to use for generic provider server urls.  If true, the generic provider port will be dynamically selected, and assured to be an available server port.  If false, the value of org.eclipse.ecf.provider.generic.port (above) is used.
+
| Whether appropriate existing containers are reused by the HostContainerSelector.
 
| Boolean
 
| Boolean
 
| true
 
| true
−
|-
 
−
| org.eclipse.ecf.provider.remoteservice.addRegistrationRequestTimeout
 
−
| Default timeout for add registration requests (issued/sent when remote services are registered)
 
−
| 7000  (milliseconds)
 
−
|-
 
−
| org.eclipse.ecf.provider.remoteservice.registryUpdateRequestTimeout
 
−
| Default timeout for update registration requests (sent when remote services registered and/or changed)
 
−
| 5000  (milliseconds)
 
−
|-
 
−
| org.eclipse.ecf.provider.remoteservice.executorType
 
−
| Default executor types for asynchronous remote services execution.  Available types are 'jobs', 'threads', 'immediate'
 
−
| jobs
 
 
|}
 
|}
  
−
'''Remote Service Configuration Properties''' - These properties may be specified as service properties when a remote service is registered.
+
=== Remote Service Admin (RSA) Basic Topology Manager Implementation ===
 +
 
 +
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 118: Line 119:
 
! Description
 
! Description
 
! Type
 
! Type
−
! Default Value
+
! Default value
 
|-
 
|-
−
| ecf.generic.server.hostname
+
| org.eclipse.ecf.osgi.services.discovery.allowLoopbackReference
−
| Hostname for the generic provider ID.  e.g. 'localhost' in ecftcp://localhost:3282/server
+
| 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
 
| String
−
| The primary DNS hostname of the local host. Or value of System property org.eclipse.ecf.provider.generic.host
+
| empty
 +
|}
 +
<br>
 +
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
 
|-
 
|-
−
| ecf.generic.server.port
+
| org.eclipse.ecf.osgi.services.basictopologymanager.exportRegisteredSvcs
−
| Port for the generic provider ID. e.g. '3282' in ecftcp://localhost:3282/server
+
| When the basic topology manager is started, whether previously registered remote services are automatically and immediately exported.
−
| Integer or String with Integer value
+
| Boolean
−
| 3282 Or value of System property org.eclipse.ecf.provider.generic.port
+
| true
 
|-
 
|-
−
| ecf.generic.server.path
+
| org.eclipse.ecf.osgi.services.basictopologymanager.exportRegisteredSvcsFilter
−
| Path section for the generic provider ID.  e.g. /server in ecftcp://localhost:3282/server
+
| 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
 
| String
−
| /server Or value of System property org.eclipse.ecf.provider.generic.name
+
| (service.exported.interfaces=*)
 
|-
 
|-
−
| ecf.generic.server.keepAlive
+
| org.eclipse.ecf.osgi.services.basictopologymanager.exportRegisteredSvcsClassname
−
| keepAlive value for generic provider
+
| 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.
−
| Integer or String with Integer value
+
−
| 30000 (ms) Or value of System property org.eclipse.ecf.provider.generic.keepAlive
+
−
|-
+
−
| ecf.generic.server.bindAddress
+
−
| Bind address to be used for opening ServerSocket
+
−
| InetAddress
+
−
| 0.0.0.0 - all available network interfaces
+
−
|-
+
−
| ecf.generic.server.id
+
−
| Entire id for generic provider e.g. ecftcp://localhost:3282/server
+
 
| String
 
| String
−
| ecftcp://<primary DNS hostname>:3282/server
+
| <none>
 
|}
 
|}
 +
<br>
 +
Bundle: [http://git.eclipse.org/c/ecf/org.eclipse.ecf.git/tree/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin org.eclipse.ecf.osgi.services.remoteserviceadmin]
  
−
== R-OSGi provider ==
+
Class: [http://git.eclipse.org/c/ecf/org.eclipse.ecf.git/tree/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/AbstractTopologyManager.java org.eclipse.ecf.osgi.services.remoteserviceadmin.AbstractTopologyManager]
−
 
+
−
Extra configuration properties for R-OSGi are shown in [[R-OSGi_Properties]]
+
  
−
== Restlet provider ==
 
 
{|{{BMTableStyle}}
 
{|{{BMTableStyle}}
 
|-{{BMTHStyle}}
 
|-{{BMTHStyle}}
Line 163: Line 168:
 
! Default value
 
! Default value
 
|-
 
|-
−
| org.eclipse.ecf.remoteservice.restlet.exporturl.protocol
+
| org.eclipse.ecf.osgi.services.remoteserviceadmin.AbstractTopologyManager.requireServiceExportedConfigs
−
| Protocol to use (http, for example)
+
| Whether any topology manager that extends AbstractTopologyManager requires the OSGi standard service property 'service.exported.configs' to be set for the service to be exported. Default is that it does not have to be set.
−
| String
+
| Boolean
−
| <none>
+
| false
−
|-
+
−
| org.eclipse.ecf.remoteservice.restlet.exporturl.port
+
−
| Port (8080, for example)
+
−
| String
+
−
| <none>
+
 
|}
 
|}
 +
 +
=== [[ECF Generic Provider Configuration Properties|Generic Distribution Provider Configuration Properties]] ===
 +
 +
=== [[R-OSGi_Properties | R-OSGi Distribution Provider Configuration Properties]] ===

Latest revision as of 20:51, 15 July 2015

Core API

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

Remote Services API

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)

Remote Service Admin (RSA) Implementation

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

Class: org.eclipse.ecf.osgi.services.remoteserviceadminRemoteServiceAdmin

Property Name Description Type Default value
org.eclipse.ecf.osgi.services.remoteserviceadmin.disableServiceVersionChecking Whether remote service interface version checking is disabled. If false, version checking is enabled, and if true version checking is disabled. Boolean false
org.eclipse.ecf.osgi.services.remoteserviceadmin.hostAutoCreateContainer If true, then during export a host container of appropriate type will be automatically created. Boolean true
org.eclipse.ecf.osgi.services.remoteserviceadmin.consumerAutoCreateContainer If true, then during export a host container of appropriate type will be automatically created. Boolean true
org.eclipse.ecf.osgi.services.remoteserviceadmin.hostDefaultConfigType Determines the default config type for remote service hosts, if not specified via the 'service.exported.configs' service property. String ecf.generic.server


Class: org.eclipse.ecf.osgi.services.remoteserviceadmin.ConsumerContainerSelector

Property Name Description Type Default value
org.eclipse.ecf.osgi.services.remoteserviceadmin.ConsumerContainerSelector.reuseExistingContainers Whether appropriate existing containers are reused by the ConsumerContainerSelector. Boolean true


Class: org.eclipse.ecf.osgi.services.remoteserviceadmin.HostContainerSelector

Property Name Description Type Default value
org.eclipse.ecf.osgi.services.remoteserviceadmin.HostContainerSelector.reuseExistingContainers Whether appropriate existing containers are reused by the HostContainerSelector. Boolean true

Remote Service Admin (RSA) Basic Topology Manager Implementation

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>


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

Class: org.eclipse.ecf.osgi.services.remoteserviceadmin.AbstractTopologyManager

Property Name Description Type Default value
org.eclipse.ecf.osgi.services.remoteserviceadmin.AbstractTopologyManager.requireServiceExportedConfigs Whether any topology manager that extends AbstractTopologyManager requires the OSGi standard service property 'service.exported.configs' to be set for the service to be exported. Default is that it does not have to be set. Boolean false

Generic Distribution Provider Configuration Properties

R-OSGi Distribution Provider Configuration Properties

Retrieved from "https://wiki.eclipse.org/index.php?title=EIG:Configuration_Properties&oldid=388690"

This page was last modified 20:51, 15 July 2015 by Scott Lewis. Based on work by Pablo .

Back to the top