EIG:Configuration Properties

From Eclipsepedia

Jump to: navigation, search

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

Contents

Remote Services Properties

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 Properties

Property Name Description Type 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 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.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.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 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=*)

Properties for each remote services provider

Provider list is ECF_Providers. These properties are used when creating a new Container or via Declarative Services.

ECF generic provider

Property Name Description Type 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 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. Boolean true
org.eclipse.ecf.provider.generic.port.fallback 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. Boolean 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.

Property Name Description Type Default Value
ecf.generic.server.hostname Hostname for the generic provider ID. e.g. 'localhost' in ecftcp://localhost:3282/server String The primary DNS hostname of the local host. Or value of System property org.eclipse.ecf.provider.generic.host
ecf.generic.server.port Port for the generic provider ID. e.g. '3282' in ecftcp://localhost:3282/server. If -1, an open port is automatically selected Integer or String with Integer value 3282 Or value of System property org.eclipse.ecf.provider.generic.port
ecf.generic.server.path Path section for the generic provider ID. e.g. /server in ecftcp://localhost:3282/server String /server Or value of System property org.eclipse.ecf.provider.generic.name
ecf.generic.server.keepAlive keepAlive value for generic provider 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 ecftcp://<primary DNS hostname>:3282/server

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>