rest-gateway-0.0.10

This is the tenth version of REST Gateway component that sits between X-Road security server and a REST service. Starting from this version REST Gateway supports encryption/decryption of message content. More information and instructions for configuration can be found in wiki. XRd4J library was updated to version 0.0.16.

Executable JAR version supports propertiesDirectory command line variable that makes it possible to load REST Gateway configuration files from defined directory outside of the JAR file. For example:

java -jar rest-gateway.jar -DpropertiesDirectory=/my/custom/path

The component implements X-Road v4.0 SOAP profile and it's compatible with X-Road v6.4 and above. The component is tested with X-Road v6.4 and it includes the following features:

• Provider Gateway : access REST services (JSON, XML) via WSDL defined X-Road services
  • supported HTTP verbs: GET, POST, PUT and DELETE
  • WSDL must be created manually
  • REST response can be wrapped in SOAP body or SOAP attachment
  • X-Road SOAP-headers are passed via HTTP headers (X-XRd-Client, X-XRd-Service, X-XRd-UserId, X-XRd-MessageId)
• Consumer Gateway : access WSDL defined X-Road services in a RESTful manner
  • full support for services published through Provider Gateway
  • limited support for legacy services (only services which requests don't contain nested elements - all the request parameters are request element's children)
  • supported HTTP verbs: GET, POST, PUT and DELETE
  • reformatting of resource links
  • response's content type is given using Accept header (text/xml, application/json)
    • if Provider Gateway returns the response as SOAP attachment, the value of HTTP Accept header is ignored and the response is returned in the original format
  • X-Road SOAP headers are passed via HTTP headers (X-XRd-UserId, X-XRd-MessageId)
  • support for browser-based access (N.B. reformatting of resource links not supported)
    • service id and X-Road SOAP headers can be given as URL parameters
    • can be disabled through configuration
• automatic conversions: JSON -> XML, XML -> JSON, JSON-LD -> XML, XML -> JSON-LD
  • Round-trip JSON-XML-JSON conversion
  • support for JSON-LD
• use of <request> / <response> wrapper tags can be configured for each service
  • service provider decides whether to use wrappers or not, consumer end must be configured accordingly
• Provider Gateway supports filtering of request parameter names and values using regular expressions
• support for encryption/decryption of message content. More information and instructions for configuration can be found in wiki.
• new REST services can be added through configuration - no coding needed

More information and installation instructions can be found here.

rest-gateway-0.0.9

This is the ninth version of REST Gateway component that sits between X-Road security server and a REST service. Starting from this version Provider Gateway supports filtering of request parameter names and values using regular expressions. XRd4J library was updated to version 0.0.13.

Executable JAR version supports propertiesDirectory command line variable that makes it possible to load REST Gateway configuration files from defined directory outside of the JAR file. For example:

java -jar rest-gateway.jar -DpropertiesDirectory=/my/custom/path

The component implements X-Road v4.0 SOAP profile and it's compatible with X-Road v6.4 and above. The component is tested with X-Road v6.4 and it includes the following features:

• Provider Gateway : access REST services (JSON, XML) via WSDL defined X-Road services
  • supported HTTP verbs: GET, POST, PUT and DELETE
  • WSDL must be created manually
  • REST response can be wrapped in SOAP body or SOAP attachment
  • X-Road SOAP-headers are passed via HTTP headers (X-XRd-Client, X-XRd-Service, X-XRd-UserId, X-XRd-MessageId)
• Consumer Gateway : access WSDL defined X-Road services in a RESTful manner
  • full support for services published through Provider Gateway
  • limited support for legacy services (only services which requests don't contain nested elements - all the request parameters are request element's children)
  • supported HTTP verbs: GET, POST, PUT and DELETE
  • reformatting of resource links
  • response's content type is given using Accept header (text/xml, application/json)
    • if Provider Gateway returns the response as SOAP attachment, the value of HTTP Accept header is ignored and the response is returned in the original format
  • X-Road SOAP headers are passed via HTTP headers (X-XRd-UserId, X-XRd-MessageId)
  • support for browser-based access (N.B. reformatting of resource links not supported)
    • service id and X-Road SOAP headers can be given as URL parameters
    • can be disabled through configuration
• automatic conversions: JSON -> XML, XML -> JSON, JSON-LD -> XML, XML -> JSON-LD
  • Round-trip JSON-XML-JSON conversion
  • support for JSON-LD
• use of <request> / <response> wrapper tags can be configured for each service
  • service provider decides whether to use wrappers or not, consumer end must be configured accordingly
• Provider Gateway supports filtering of request parameter names and values using regular expressions
• new REST services can be added through configuration - no coding needed

More information and installation instructions can be found here.

rest-gateway-0.0.8

This is the eight version of REST Gateway component that sits between X-Road security server and a REST service. Starting from this version it's possible to configure the use of <request> / <response> wrapper tags for each service. XRd4J library was updated to version 0.0.11.

Executable JAR version supports propertiesDirectory command line variable that makes it possible to load REST Gateway configuration files from defined directory outside of the JAR file. For example:

java -jar rest-gateway.jar -DpropertiesDirectory=/my/custom/path

The component implements X-Road v4.0 SOAP profile and it's compatible with X-Road v6.4 and above. The component is tested with X-Road v6.4 and it includes the following features:

• Provider Gateway : access REST services (JSON, XML) via WSDL defined X-Road services
  • supported HTTP verbs: GET, POST, PUT and DELETE
  • WSDL must be created manually
  • REST response can be wrapped in SOAP body or SOAP attachment
  • X-Road SOAP-headers are passed via HTTP headers (X-XRd-Client, X-XRd-Service, X-XRd-UserId, X-XRd-MessageId)
• Consumer Gateway : access WSDL defined X-Road services in a RESTful manner
  • full support for services published through Provider Gateway
  • limited support for legacy services (only services which requests don't contain nested elements - all the request parameters are request element's children)
  • supported HTTP verbs: GET, POST, PUT and DELETE
  • reformatting of resource links
  • response's content type is given using Accept header (text/xml, application/json)
    • if Provider Gateway returns the response as SOAP attachment, the value of HTTP Accept header is ignored and the response is returned in the original format
  • X-Road SOAP headers are passed via HTTP headers (X-XRd-UserId, X-XRd-MessageId)
  • support for browser-based access (N.B. reformatting of resource links not supported)
    • service id and X-Road SOAP headers can be given as URL parameters
    • can be disabled through configuration
• automatic conversions: JSON -> XML, XML -> JSON, JSON-LD -> XML, XML -> JSON-LD
  • Round-trip JSON-XML-JSON conversion
  • support for JSON-LD
• use of <request> / <response> wrapper tags can be configured for each service
  • service provider decides whether to use wrappers or not, consumer end must be configured accordingly
• new REST services can be added through configuration - no coding needed

More information and installation instructions can be found here.

rest-gateway-0.0.7

This is the seventh version of REST Gateway component that sits between X-Road security server and a REST service. This version adds support for X-Road v6.4 and above. Versions below 6.4 are no longer supported. Also XRd4J library was updated to version 0.0.6.

The component implements X-Road v4.0 SOAP profile and it's compatible with X-Road v6.4 and above. The component is tested with X-Road v6.4 and it includes the following features:

• Provider Gateway : access REST services (JSON, XML) via WSDL defined X-Road services
  • supported HTTP verbs: GET, POST, PUT and DELETE
  • WSDL must be created manually
  • REST response can be wrapped in SOAP body or SOAP attachment
  • X-Road SOAP-headers are passed via HTTP headers (X-XRd-Client, X-XRd-Service, X-XRd-UserId, X-XRd-MessageId)
• Consumer Gateway : access WSDL defined X-Road services in a RESTful manner
  • full support for services published through Provider Gateway
  • limited support for legacy services (only services which requests don't contain nested elements - all the request parameters are request element's children)
  • supported HTTP verbs: GET, POST, PUT and DELETE
  • reformatting of resource links
  • response's content type is given using Accept header (text/xml, application/json)
    • if Provider Gateway returns the response as SOAP attachment, the value of HTTP Accept header is ignored and the response is returned in the original format
  • X-Road SOAP headers are passed via HTTP headers (X-XRd-UserId, X-XRd-MessageId)
  • support for browser-based access (N.B. reformatting of resource links not supported)
    • service id and X-Road SOAP headers can be given as URL parameters
    • can be disabled through configuration
• automatic conversions: JSON -> XML, XML -> JSON, JSON-LD -> XML, XML -> JSON-LD
  • Round-trip JSON-XML-JSON conversion
  • support for JSON-LD
• new REST services can be added through configuration - no coding needed

More information and installation instructions can be found here.

rest-gateway-0.0.6

This is the sixth version of REST Gateway component that sits between X-Road security server and a REST service. This version adds support for JSON-LD, adds the possibility to enable/disable browser-based access and removes restrictions related to X-Road service identifiers' length/structure. Also XRd4J library was updated to version 0.0.5.

The component implements X-Road v6 SOAP profile and is tested with X-Road v6 pre-beta. The component includes the following features:

• Provider Gateway : access REST services (JSON, XML) via WSDL defined X-Road services
  • supported HTTP verbs: GET, POST, PUT and DELETE
  • WSDL must be created manually
  • REST response can be wrapped in SOAP body or SOAP attachment
  • X-Road SOAP-headers are passed via HTTP headers (X-XRd-Client, X-XRd-Service, X-XRd-UserId, X-XRd-MessageId)
• Consumer Gateway : access WSDL defined X-Road services in a RESTful manner
  • full support for services published through Provider Gateway
  • limited support for legacy services (only services which requests don't contain nested elements - all the request parameters are request element's children)
  • supported HTTP verbs: GET, POST, PUT and DELETE
  • reformatting of resource links
  • response's content type is given using Accept header (text/xml, application/json)
    • if Provider Gateway returns the response as SOAP attachment, the value of HTTP Accept header is ignored and the response is returned in the original format
  • X-Road SOAP headers are passed via HTTP headers (X-XRd-UserId, X-XRd-MessageId)
  • support for browser-based access (N.B. reformatting of resource links not supported)
    • service id and X-Road SOAP headers can be given as URL parameters
    • can be disabled through configuration
• automatic conversions: JSON -> XML, XML -> JSON, JSON-LD -> XML, XML -> JSON-LD
  • Round-trip JSON-XML-JSON conversion
  • support for JSON-LD
• new REST services can be added through configuration - no coding needed

More information and installation instructions can be found here.

rest-gateway-0.0.5

This is the fifth version of REST Gateway component that sits between X-Road security server and a REST service. This version adds support for round-trip JSON-XML-JSON conversion. Also XRd4J library was updated to version 0.0.4.

The component implements X-Road v6 SOAP profile and is tested with X-Road v6 pre-beta. The component includes the following features:

• Provider Gateway : access REST services (JSON, XML) via WSDL defined X-Road services
  • supported HTTP verbs: GET, POST, PUT and DELETE
  • WSDL must be created manually
  • REST response can be wrapped in SOAP body or SOAP attachment
  • X-Road SOAP-headers are passed via HTTP headers (X-XRd-Client, X-XRd-Service, X-XRd-UserId, X-XRd-MessageId)
• Consumer Gateway : access WSDL defined X-Road services in a RESTful manner
  • full support for services published through Provider Gateway
  • limited support for legacy services (only services which requests don't contain nested elements - all the request parameters are request element's children)
  • supported HTTP verbs: GET, POST, PUT and DELETE
  • reformatting of resource links
  • response's content type is given using Accept header (text/xml, application/json)
    • if Provider Gateway returns the response as SOAP attachment, the value of HTTP Accept header is ignored and the response is returned in the original format
  • X-Road SOAP headers are passed via HTTP headers (X-XRd-UserId, X-XRd-MessageId)
  • support for browser-based access (N.B. reformatting of resource links not supported)
    • Service id and X-Road SOAP headers can be given as URL parameters
• automatic conversions: JSON -> XML, XML -> JSON
  • Round-trip JSON-XML-JSON conversion
• new REST services can be added through configuration - no coding needed

More information and installation instructions can be found here.

rest-gateway-0.0.4

This is the fourth version of REST Gateway component that sits between X-Road security server and a REST service. This version adds support for browser-based access to services and support for POST, PUT and DELETE HTTP verbs. Also XRd4J library was updated to version 0.0.3.

The component implements X-Road v6 SOAP profile and is tested with X-Road v6 pre-beta. The component includes the following features:

• Provider Gateway : access REST services (JSON, XML) via WSDL defined X-Road services
  • supported HTTP verbs: GET, POST, PUT and DELETE
  • WSDL must be created manually
  • REST response can be wrapped in SOAP body or SOAP attachment
  • X-Road SOAP-headers are passed via HTTP headers (X-XRd-Client, X-XRd-Service, X-XRd-UserId, X-XRd-MessageId)
• Consumer Gateway : access WSDL defined X-Road services in a RESTful manner
  • full support for services published through Provider Gateway
  • limited support for legacy services (only services which requests don't contain nested elements - all the request parameters are request element's children)
  • supported HTTP verbs: GET, POST, PUT and DELETE
  • reformatting of resource links
  • response's content type is given using Accept header (text/xml, application/json)
    • if Provider Gateway returns the response as SOAP attachment, the value of HTTP Accept header is ignored and the response is returned in the original format
  • X-Road SOAP headers are passed via HTTP headers (X-XRd-UserId, X-XRd-MessageId)
  • support for browser-based access (N.B. reformatting of resource links not supported)
    • service id and X-Road SOAP headers can be given as URL parameters
• automatic conversions: JSON -> XML, XML -> JSON
• new REST services can be added through configuration - no coding needed

More information and installation instructions can be found here.

rest-gateway-0.0.3

This is the third version of REST Gateway component that sits between X-Road security server and a REST service. The third version doesn't contain any new features compared to the second version, only XRd4J framework was updated from version 0.0.1 to version 0.0.2.

The component implements X-Road v6 SOAP profile and is tested with X-Road v6 pre-beta. The component includes the following features:

• Provider Gateway : access REST services (JSON, XML) via WSDL-defined X-Road services
  • only HTTP GET supported
  • WSDL must be created manually
  • REST response can be wrapped in SOAP body or SOAP attachment
  • X-Road SOAP-headers are passed via HTTP headers (X-XRd-Client, X-XRd-Service, X-XRd-UserId, X-XRd-MessageId)
• Consumer Gateway : access WSDL-defined X-Road services in a RESTful manner
  • full support for services published through Provider Gateway
  • limited support for legacy services (only services which requests don't contain nested elements - all the request parameters are request element's children)
  • only HTTP GET supported
  • response's content type is defined using Accept header (text/xml, application/json)
    • if Provider Gateway returns the response as SOAP attachment, the value of HTTP Accept header is ignored and the response is returned in the original format
  • X-Road SOAP-headers are passed via HTTP headers (X-XRd-UserId, X-XRd-MessageId)
  • reformatting of resource links
• Automatic conversions: JSON -> XML, XML -> JSON
• New REST services can be added through configuration - no coding needed
• Improved error handling

More information and installation instructions can be found here.

rest-gateway-0.0.2

This is the second version of REST Gateway component that sits between X-Road security server and a REST service. The component implements X-Road v6 SOAP profile and is tested with X-Road v6 pre-beta. The component includes the following features:

• Provider Gateway : access REST services (JSON, XML) via WSDL-defined X-Road services
  • only HTTP GET supported
  • WSDL must be created manually
  • REST response can be wrapped in SOAP body or SOAP attachment
  • X-Road SOAP-headers are passed via HTTP headers (X-XRd-Client, X-XRd-Service, X-XRd-UserId, X-XRd-MessageId)
• Consumer Gateway : access WSDL-defined X-Road services in a RESTful manner
  • full support for services published through Provider Gateway
  • limited support for legacy services (only services which requests don't contain nested elements - all the request parameters are request element's children)
  • only HTTP GET supported
  • response's content type is defined using Accept header (text/xml, application/json)
    • if Provider Gateway returns the response as SOAP attachment, the value of HTTP Accept header is ignored and the response is returned in the original format
  • X-Road SOAP-headers are passed via HTTP headers (X-XRd-UserId, X-XRd-MessageId)
  • reformatting of resource links
• Automatic conversions: JSON -> XML, XML -> JSON
• New REST services can be added through configuration - no coding needed
• Improved error handling

More information and installation instructions can be found here.

rest-gateway-0.0.1

This is the very first version of REST Gateway component that sits between X-Road security server and a REST service. The component implements X-Road v6 SOAP profile and is tested with X-Road v6 pre-beta. The component includes the following features:

• Provider Gateway : access REST services (JSON, XML) via WSDL-defined X-Road services
  • only HTTP GET supported
  • WSDL must be created manually
• REST response can be wrapped in SOAP body or SOAP attachment
• Automatic conversion from JSON to XML
• New REST services can be added through configuration - no coding needed
• X-Road SOAP-headers are passed via HTTP headers

More information and installation instructions can be found here.