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 "Apache CXF JaxRS Service Properties"
Line 10: | Line 10: | ||
! Default Value | ! Default Value | ||
|- | |- | ||
− | | '''ecf.jaxrs. | + | | '''ecf.jaxrs.cxf.server.protocol''' |
| Protocol portion of the remote service complete URI. For example, the 'http' in 'http://localhost:8080/'. Should only be 'http' or 'https'. NOTE that an impl of HttpService must be available in runtime that exposes the complete URI (e.g. http://localhost:8080/ or https://foo.bar:8443/). | | Protocol portion of the remote service complete URI. For example, the 'http' in 'http://localhost:8080/'. Should only be 'http' or 'https'. NOTE that an impl of HttpService must be available in runtime that exposes the complete URI (e.g. http://localhost:8080/ or https://foo.bar:8443/). | ||
| String | | String | ||
| '''http''' | | '''http''' | ||
|- | |- | ||
− | | '''ecf.jaxrs. | + | | '''ecf.jaxrs.cxf.server.hostname''' |
| Hostname portion of the remote service complete URI. For example, the 'localhost' in 'http://localhost:8080/'. NOTE that an impl of HttpService must be available in runtime that exposes the complete URI (e.g. http://localhost:8080/ or https://foo.bar:8443/). | | Hostname portion of the remote service complete URI. For example, the 'localhost' in 'http://localhost:8080/'. NOTE that an impl of HttpService must be available in runtime that exposes the complete URI (e.g. http://localhost:8080/ or https://foo.bar:8443/). | ||
| String | | String | ||
| '''localhost''' | | '''localhost''' | ||
|- | |- | ||
− | | '''ecf.jaxrs. | + | | '''ecf.jaxrs.cxf.server.port''' |
| Port portion of the remote service complete URI. For example, the '8080' in 'http://localhost:8080/'. NOTE that an impl of HttpService must be available in runtime that exposes the complete URI (e.g. http://localhost:8080/ or https://foo.bar:8443/). | | Port portion of the remote service complete URI. For example, the '8080' in 'http://localhost:8080/'. NOTE that an impl of HttpService must be available in runtime that exposes the complete URI (e.g. http://localhost:8080/ or https://foo.bar:8443/). | ||
| Integer | | Integer | ||
Line 30: | Line 30: | ||
| '''/''' | | '''/''' | ||
|- | |- | ||
− | | '''ecf.jaxrs. | + | | '''ecf.jaxrs.cxf.server.pathPrefix''' |
| The path prefix portion of the remote service complete URI. For example, the '/' in 'http://localhost:8080/' or '/mycontext' in 'http://localhost:8080/mycontext'. NOTE that an impl of HttpService must be available in runtime that exposes the complete URI (e.g. http://localhost:8080/ or https://foo.bar:8443/). | | The path prefix portion of the remote service complete URI. For example, the '/' in 'http://localhost:8080/' or '/mycontext' in 'http://localhost:8080/mycontext'. NOTE that an impl of HttpService must be available in runtime that exposes the complete URI (e.g. http://localhost:8080/ or https://foo.bar:8443/). | ||
| Integer | | Integer | ||
Line 36: | Line 36: | ||
|} | |} | ||
− | Note that if both the ecf.jaxrs.server.pathPrefix and the ecf.jaxrs. | + | Note that if both the ecf.jaxrs.server.pathPrefix and the ecf.jaxrs.cxf.server.pathPrefix properties above are set, the ecf.jaxrs.cxf.server.pathPrefix property will take precedence. |
====Service Properties==== | ====Service Properties==== | ||
Line 47: | Line 47: | ||
! Default Value | ! Default Value | ||
|- | |- | ||
− | | '''ecf.jaxrs. | + | | '''ecf.jaxrs.cxf.server.protocol''' |
| Protocol portion of the remote service complete URI. For example, the 'http' in 'http://localhost:8080/'. Should only be 'http' or 'https'. NOTE that an impl of HttpService must be available in runtime that exposes the complete URI (e.g. http://localhost:8080/ or https://foo.bar:8443/). | | Protocol portion of the remote service complete URI. For example, the 'http' in 'http://localhost:8080/'. Should only be 'http' or 'https'. NOTE that an impl of HttpService must be available in runtime that exposes the complete URI (e.g. http://localhost:8080/ or https://foo.bar:8443/). | ||
| String | | String | ||
| '''http''' | | '''http''' | ||
|- | |- | ||
− | | '''ecf.jaxrs. | + | | '''ecf.jaxrs.cxf.server.hostname''' |
| Hostname portion of the remote service complete URI. For example, the 'localhost' in 'http://localhost:8080/'. NOTE that an impl of HttpService must be available in runtime that exposes the complete URI (e.g. http://localhost:8080/ or https://foo.bar:8443/). | | Hostname portion of the remote service complete URI. For example, the 'localhost' in 'http://localhost:8080/'. NOTE that an impl of HttpService must be available in runtime that exposes the complete URI (e.g. http://localhost:8080/ or https://foo.bar:8443/). | ||
| String | | String | ||
| '''localhost''' | | '''localhost''' | ||
|- | |- | ||
− | | '''ecf.jaxrs. | + | | '''ecf.jaxrs.cxf.server.port''' |
| Port portion of the remote service complete URI. For example, the '8080' in 'http://localhost:8080/'. NOTE that an impl of HttpService must be available in runtime that exposes the complete URI (e.g. http://localhost:8080/ or https://foo.bar:8443/). | | Port portion of the remote service complete URI. For example, the '8080' in 'http://localhost:8080/'. NOTE that an impl of HttpService must be available in runtime that exposes the complete URI (e.g. http://localhost:8080/ or https://foo.bar:8443/). | ||
| Integer | | Integer | ||
Line 67: | Line 67: | ||
| '''/''' | | '''/''' | ||
|- | |- | ||
− | | '''ecf.jaxrs. | + | | '''ecf.jaxrs.cxf.server.pathPrefix''' |
| The path prefix portion of the remote service complete URI. For example, the '/rs1' in 'http://localhost:8080/rs1' or '/rs1' in 'http://localhost:8080/mycontext/rs1' (where the pathPrefix system property above had been set to '/mycontext' and service property set to '/rs1'). NOTE that an impl of HttpService must be available in runtime that exposes the complete URI (e.g. http://localhost:8080/ or https://foo.bar:8443/). | | The path prefix portion of the remote service complete URI. For example, the '/rs1' in 'http://localhost:8080/rs1' or '/rs1' in 'http://localhost:8080/mycontext/rs1' (where the pathPrefix system property above had been set to '/mycontext' and service property set to '/rs1'). NOTE that an impl of HttpService must be available in runtime that exposes the complete URI (e.g. http://localhost:8080/ or https://foo.bar:8443/). | ||
| Integer | | Integer | ||
| '''/''' | | '''/''' | ||
|- | |- | ||
− | | '''ecf.jaxrs. | + | | '''ecf.jaxrs.cxf.server.includeRemoteServiceId''' |
| An option remote service id as suffix to path (true or false). For example, the '1' in 'http://localhost:8080/1' for remote service id = 1. If this value is set then the system generated remote service id will be appended to the . | | An option remote service id as suffix to path (true or false). For example, the '1' in 'http://localhost:8080/1' for remote service id = 1. If this value is set then the system generated remote service id will be appended to the . | ||
| boolean | | boolean | ||
Line 78: | Line 78: | ||
|} | |} | ||
− | Note that if both the ecf.jaxrs.server.pathPrefix and the ecf.jaxrs. | + | Note that if both the ecf.jaxrs.server.pathPrefix and the ecf.jaxrs.cxf.server.pathPrefix properties above are set, the ecf.jaxrs.cxf.server.pathPrefix property will also take precedence. |
Latest revision as of 01:16, 6 November 2019
ecf.jaxrs.cxf.server config
System Properties
Property Name | Description | Type | Default Value |
---|---|---|---|
ecf.jaxrs.cxf.server.protocol | Protocol portion of the remote service complete URI. For example, the 'http' in 'http://localhost:8080/'. Should only be 'http' or 'https'. NOTE that an impl of HttpService must be available in runtime that exposes the complete URI (e.g. http://localhost:8080/ or https://foo.bar:8443/). | String | http |
ecf.jaxrs.cxf.server.hostname | Hostname portion of the remote service complete URI. For example, the 'localhost' in 'http://localhost:8080/'. NOTE that an impl of HttpService must be available in runtime that exposes the complete URI (e.g. http://localhost:8080/ or https://foo.bar:8443/). | String | localhost |
ecf.jaxrs.cxf.server.port | Port portion of the remote service complete URI. For example, the '8080' in 'http://localhost:8080/'. NOTE that an impl of HttpService must be available in runtime that exposes the complete URI (e.g. http://localhost:8080/ or https://foo.bar:8443/). | Integer | 8080 for http protocol, 8443 for https protocol |
ecf.jaxrs.server.pathPrefix | The path prefix portion of the remote service complete URI. For example, the '/' in 'http://localhost:8080/' or '/mycontext' in 'http://localhost:8080/mycontext'. NOTE that an impl of HttpService must be available in runtime that exposes the complete URI (e.g. http://localhost:8080/ or https://foo.bar:8443/). | Integer | / |
ecf.jaxrs.cxf.server.pathPrefix | The path prefix portion of the remote service complete URI. For example, the '/' in 'http://localhost:8080/' or '/mycontext' in 'http://localhost:8080/mycontext'. NOTE that an impl of HttpService must be available in runtime that exposes the complete URI (e.g. http://localhost:8080/ or https://foo.bar:8443/). | Integer | / |
Note that if both the ecf.jaxrs.server.pathPrefix and the ecf.jaxrs.cxf.server.pathPrefix properties above are set, the ecf.jaxrs.cxf.server.pathPrefix property will take precedence.
Service Properties
Property Name | Description | Type | Default Value |
---|---|---|---|
ecf.jaxrs.cxf.server.protocol | Protocol portion of the remote service complete URI. For example, the 'http' in 'http://localhost:8080/'. Should only be 'http' or 'https'. NOTE that an impl of HttpService must be available in runtime that exposes the complete URI (e.g. http://localhost:8080/ or https://foo.bar:8443/). | String | http |
ecf.jaxrs.cxf.server.hostname | Hostname portion of the remote service complete URI. For example, the 'localhost' in 'http://localhost:8080/'. NOTE that an impl of HttpService must be available in runtime that exposes the complete URI (e.g. http://localhost:8080/ or https://foo.bar:8443/). | String | localhost |
ecf.jaxrs.cxf.server.port | Port portion of the remote service complete URI. For example, the '8080' in 'http://localhost:8080/'. NOTE that an impl of HttpService must be available in runtime that exposes the complete URI (e.g. http://localhost:8080/ or https://foo.bar:8443/). | Integer | 8080 for http protocol, 8443 for https protocol |
ecf.jaxrs.server.pathPrefix | The path prefix portion of the remote service complete URI. For example, the '/rs1' in 'http://localhost:8080/rs1' or '/rs1' in 'http://localhost:8080/mycontext/rs1' (where the pathPrefix system property above had been set to '/mycontext' and service property set to '/rs1'). NOTE that an impl of HttpService must be available in runtime that exposes the complete URI (e.g. http://localhost:8080/ or https://foo.bar:8443/). | Integer | / |
ecf.jaxrs.cxf.server.pathPrefix | The path prefix portion of the remote service complete URI. For example, the '/rs1' in 'http://localhost:8080/rs1' or '/rs1' in 'http://localhost:8080/mycontext/rs1' (where the pathPrefix system property above had been set to '/mycontext' and service property set to '/rs1'). NOTE that an impl of HttpService must be available in runtime that exposes the complete URI (e.g. http://localhost:8080/ or https://foo.bar:8443/). | Integer | / |
ecf.jaxrs.cxf.server.includeRemoteServiceId | An option remote service id as suffix to path (true or false). For example, the '1' in 'http://localhost:8080/1' for remote service id = 1. If this value is set then the system generated remote service id will be appended to the . | boolean | false |
Note that if both the ecf.jaxrs.server.pathPrefix and the ecf.jaxrs.cxf.server.pathPrefix properties above are set, the ecf.jaxrs.cxf.server.pathPrefix property will also take precedence.