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.
Difference between revisions of "EIG:Configuration Properties"
(→Main ECF configuration properties) |
|||
| (42 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | = | + | === 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 7: | Line 9: | ||
! Property Name | ! Property Name | ||
! Description | ! Description | ||
| + | ! Type | ||
! Default value | ! Default value | ||
|- | |- | ||
| − | | ecf. | + | | 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}} | ||
|-{{BMTHStyle}} | |-{{BMTHStyle}} | ||
| − | ! Property | + | ! Property Name |
| − | ! | + | ! Description |
! Type | ! Type | ||
| + | ! Default value | ||
| + | |- | ||
| + | | 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] | ||
| + | | Integer | ||
| + | | 30000 (milliseconds) | ||
| + | |} | ||
| + | |||
| + | === 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}} | ||
| + | |-{{BMTHStyle}} | ||
| + | ! Property Name | ||
! Description | ! 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 |
|- | |- | ||
| − | | ecf. | + | | 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 | | String | ||
| − | | | + | | 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}} | {|{{BMTableStyle}} | ||
|-{{BMTHStyle}} | |-{{BMTHStyle}} | ||
| − | ! Property | + | ! Property Name |
| − | ! | + | ! Description |
! Type | ! Type | ||
| + | ! Default value | ||
| + | |- | ||
| + | | org.eclipse.ecf.osgi.services.remoteserviceadmin.ConsumerContainerSelector.reuseExistingContainers | ||
| + | | Whether appropriate existing containers are reused by the ConsumerContainerSelector. | ||
| + | | Boolean | ||
| + | | 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 | ! Description | ||
| + | ! Type | ||
| + | ! Default value | ||
|- | |- | ||
| − | | service. | + | | 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: [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.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 | | 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 |
| − | | ecf. | + | | 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 | | String | ||
| − | | | + | | (service.exported.interfaces=*) |
|- | |- | ||
| − | | ecf. | + | | 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 | | String | ||
| − | | | + | | <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] | ||
| + | |||
| + | 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 | ||
| + | |} | ||
| + | |||
| + | === [[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
Contents
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 |