9.6. Using the REST Interface
The REST Interface can be used in Red Hat JBoss Data Grid's Remote Client-Server mode to perform the following operations:
- Adding data
- Retrieving data
- Removing data
9.6.1. Adding Data Using REST
In Red Hat JBoss Data Grid's REST Interface, use the following methods to add data to the cache:
- HTTP
PUTmethod - HTTP
POSTmethod
When the
PUT and POST methods are used, the body of the request contains this data, which includes any information added by the user.
Both the
PUT and POST methods require a Content-Type header.
9.6.1.1. About PUT /{cacheName}/{cacheKey}
A
PUT request from the provided URL form places the payload, (from the request body) in the targeted cache using the provided key. The targeted cache must exist on the server for this task to successfully complete.
As an example, in the following URL, the value
hr is the cache name and payRoll%2F3 is the key. The value %2F indicates that a / was used in the key.
http://someserver/rest/hr/payRoll%2F3
Any existing data is replaced and
Time-To-Live and Last-Modified values are updated, if an update is required.
Note
A cache key that contains the value
%2F to represent a / in the key (as in the provided example) can be successfully run if the server is started using the following argument:
-Dorg.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true
9.6.1.2. About POST /{cacheName}/{cacheKey}
The
POST method from the provided URL form places the payload (from the request body) in the targeted cache using the provided key. However, in a POST method, if a value in a cache/key exists, a HTTP CONFLICT status is returned and the content is not updated.
