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"

(→‎Remote Services Properties)
 
(32 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
= Remote Services Properties =
+
=== Core API ===
 +
 
 +
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}}
 
{|{{BMTableStyle}}
Line 5: Line 9:
 
! Property Name
 
! Property Name
 
! Description
 
! Description
−
! Default value (ms)
+
! 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}}
 +
|-{{BMTHStyle}}
 +
! Property Name
 +
! Description
 +
! Type
 +
! Default value
 
|-
 
|-
 
| ecf.remotecall.timeout
 
| ecf.remotecall.timeout
 
| Default timeout for remote service calls. Described in [http://download.eclipse.org/rt/ecf/3.5.6/javadoc/org/eclipse/ecf/remoteservice/IRemoteCall.html#DEFAULT_TIMEOUT]
 
| Default timeout for remote service calls. Described in [http://download.eclipse.org/rt/ecf/3.5.6/javadoc/org/eclipse/ecf/remoteservice/IRemoteCall.html#DEFAULT_TIMEOUT]
−
| 30000
+
| Integer
 +
| 30000 (milliseconds)
 
|}
 
|}
  
−
= Properties for each remote services provider  =
+
=== Remote Service Admin (RSA) Implementation ===
−
Provider list is [[ECF_Providers]]. These properties are used when creating a new Container or via Declarative Services.
+
  
−
== ECF provider ==
+
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 22: Line 53:
 
! Description
 
! Description
 
! Type
 
! Type
−
! Default
+
! Default value
 
|-
 
|-
−
| org.eclipse.ecf.provider.generic.scheme
+
| org.eclipse.ecf.osgi.services.remoteserviceadmin.disableServiceVersionChecking
−
| Default protocol for generic provider urls.  e.g. ecftcp://localhost:3282/server
+
| Whether remote service interface version checking is disabled.  If false, version checking is enabled, and if true version checking is disabled.
−
| String
+
| Boolean
−
| ecftcp
+
| false
 
|-
 
|-
−
| org.eclipse.ecf.provider.generic.host
+
| org.eclipse.ecf.osgi.services.remoteserviceadmin.hostAutoCreateContainer
−
| Default host for generic provider urls.  e.g. ecftcp://localhost:3282/server
+
| If true, then during export a host container of appropriate type will be automatically created.
−
| String
+
| Boolean
−
| localhost
+
| true
 
|-
 
|-
−
| org.eclipse.ecf.provider.generic.port
+
| org.eclipse.ecf.osgi.services.remoteserviceadmin.consumerAutoCreateContainer
−
| Default port for generic provider urls.  e.g. ecftcp://localhost:3282/server
+
| If true, then during export a host container of appropriate type will be automatically created.
−
| Integer
+
| Boolean
−
| 3282
+
| true
 
|-
 
|-
−
| org.eclipse.ecf.provider.generic.name
+
| org.eclipse.ecf.osgi.services.remoteserviceadmin.hostDefaultConfigType
−
| Default path/name for generic provider urls. e.g. ecftcp://localhost:3282/server
+
| Determines the default config type for remote service hosts, if not specified via the 'service.exported.configs' service property.
 
| String
 
| String
−
| /server
+
| ecf.generic.server
 +
|}
 +
<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/ConsumerContainerSelector.java org.eclipse.ecf.osgi.services.remoteserviceadmin.ConsumerContainerSelector]
 +
 
 +
{|{{BMTableStyle}}
 +
|-{{BMTHStyle}}
 +
! Property Name
 +
! Description
 +
! Type
 +
! Default value
 
|-
 
|-
−
| org.eclipse.ecf.provider.generic.keepalive
+
| org.eclipse.ecf.osgi.services.remoteserviceadmin.ConsumerContainerSelector.reuseExistingContainers
−
| Default keepalive for generic provider
+
| Whether appropriate existing containers are reused by the ConsumerContainerSelector.
−
| Integer
+
| Boolean
−
| 30000
+
| 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.host.useHostName
+
| org.eclipse.ecf.osgi.services.remoteserviceadmin.HostContainerSelector.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 HostContainerSelector.
−
| String
+
| Boolean
 
| true
 
| true
 +
|}
 +
 +
=== 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}}
 +
|-{{BMTHStyle}}
 +
! Property Name
 +
! Description
 +
! Type
 +
! Default value
 
|-
 
|-
−
| org.eclipse.ecf.provider.generic.port.fallback
+
| org.eclipse.ecf.osgi.services.discovery.allowLoopbackReference
−
| 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 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
 +
| 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
 +
|-
 +
| 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
 
| true
 
|-
 
|-
−
| org.eclipse.ecf.provider.remoteservice.addRegistrationRequestTimeout
+
| org.eclipse.ecf.osgi.services.basictopologymanager.exportRegisteredSvcsFilter
−
| Default timeout for add registration requests (issued/sent when remote services are registered)
+
| 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.
−
| 7000
+
| String
−
|-  
+
| (service.exported.interfaces=*)
−
| org.eclipse.ecf.provider.remoteservice.registryUpdateRequestTimeout
+
|-
−
| Default timeout for update registration requests (sent when remote services registered and/or changed)
+
| org.eclipse.ecf.osgi.services.basictopologymanager.exportRegisteredSvcsClassname
−
| 5000
+
| 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
−
| org.eclipse.ecf.provider.remoteservice.executorType
+
| <none>
−
| Default executor types for asynchronous remote services execution.  Available types are 'jobs', 'threads', 'immediate'
+
|}
−
| jobs
+
<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]
 +
 
 +
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]
 +
 
 +
{|{{BMTableStyle}}
 +
|-{{BMTHStyle}}
 +
! 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
 
|}
 
|}
  
−
== R-OSGi provider ==
+
=== [[ECF Generic Provider Configuration Properties|Generic Distribution Provider Configuration Properties]] ===
  
−
Extra configuration properties for R-OSGi are shown in [[R-OSGi_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