Rest with @Path("/object/{objectId}") to get all data with references?

[nimo23]

I have included all paths as described in microstream-one/microstream#549.

Using the following, I get the root with its objectId:

        @GET
	@Path("/root")
	public ViewerRootDescription root() {
		var result = storageRestAdapter.getUserRoot();
		return result;
	}

and after I get the root's objectId, I make a request to
"../object/1000000000000000028?references="true"

	@GET
	@Path("/object/{objectId}")
	public ViewerObjectDescription object(
			@PathParam("objectId") Long objectId,
			@DefaultValue(Integer.MAX_VALUE + "") @QueryParam(value = "fixedOffset") long fixedOffset,
			@DefaultValue(Integer.MAX_VALUE + "") @QueryParam(value = "fixedLength") long fixedLength,
			@DefaultValue("0") @QueryParam(value = "variableOffset") long variableOffset,
			@DefaultValue(Integer.MAX_VALUE + "") @QueryParam(value = "variableLength") long variableLength,
			@QueryParam(value = "valueLength") Long valueLength,
			@DefaultValue("true") @QueryParam(value = "references") boolean references) {

		if (valueLength == null) {
			valueLength = this.storageRestAdapter.getDefaultValueLength();
		}
		var result = storageRestAdapter.getObject(objectId, fixedOffset, fixedLength, variableOffset, variableLength,
				valueLength, references);
		return result;
	}

Then I get the following result:

{"objectId":"1000000000000000028","typeId":"1000073","length":"11","variableLength":null,"simplified":false,"data":[],"references":null}

However, I want to get all referencing data belonging to the root. The same result as when using the https://docs.eclipsestore.io/manual/storage/rest-interface/setup.html. What GET-Request should I do to get all the whole data belonging to the root.

[nimo23]

Looking in https://docs.eclipsestore.io/manual/storage/rest-interface/rest-api.html, it seems there is no api to get the root with all its instances. Looking, for example, at the source code EmbeddedStorageRestAdapter, there is an ObjectDescription which can be called by using

	public MyRest(){
		this.storageRestAdapter = StorageRestAdapter.New(storageManager);
		this.embeddedStorageRestAdapter = EmbeddedStorageRestAdapter.New(storageManager);
	}

	@GET
	@Path("/rootcontent/{objectId}")
	public ObjectDescription rootContent(Long objectId) {
		return embeddedStorageRestAdapter.getStorageObject(objectId);
	}

However, it also does not give me content of all instances stored within root. Which method do I need to get all the data?

[hg-ms]

Hi,

There are no more APIs than the callsgetUserRoot and getObject you’re already using.
When looking at the return json:

{"objectId":"1000000000000000028","typeId":"1000073","length":"11","variableLength":null,"simplified":false,"data":[],"references":null}

I miss 11 values in the “Data” array. Maybe the java object is not correctly converted to json.

Here is how a correct json response may look like:

{"objectId":"1000000000000000028","typeId":"1000073","length":"2","variableLength":null,"simplified":false,"data":["1000000000000000029","235689"],"references":[{"objectId":"1000000000000000029","typeId":"43","length":"0","variableLength":["0"],"simplified":false,"data":[[]],"references":null}]}```

[nimo23]

Hello @hg-ms ,

it seems I found a bug:

The resulting json is:

{
  "objectId" : "1000000000000000028",
  "typeId" : "1000073",
  "length" : "11",
  "variableLength" : null,
  "simplified" : false,
  "data" : [ ],
  "references" : null
}  

You see, the length is 11, but the data property is actually empty. I checked this in the GET request method:

@GET
@Path("/object/{objectId}")
public ViewerObjectDescription object(
    @PathParam("objectId") Long objectId,
    @DefaultValue(Integer.MAX_VALUE + "") @QueryParam(value = "fixedOffset") long fixedOffset,
    @DefaultValue(Integer.MAX_VALUE + "") @QueryParam(value = "fixedLength") long fixedLength,
    @DefaultValue("0") @QueryParam(value = "variableOffset") long variableOffset,
    @DefaultValue(Integer.MAX_VALUE + "") @QueryParam(value = "variableLength") long variableLength,
    @QueryParam(value = "valueLength") Long valueLength,
    @DefaultValue("true") @QueryParam(value = "references") boolean references) {

		if (valueLength == null) {
		    valueLength = this.storageRestAdapter.getDefaultValueLength();
		}

		var result = storageRestAdapter.getObject(objectId, fixedOffset, fixedLength, variableOffset, variableLength, valueLength, references);

		// prints always 0 as there is no data in the array 
		log.infov("result.getData = {0}", result.getData().length);

		// does not print any data
		for (int i = 0; i < result.getData().length; i++) {
		    log.info(result.getData()[i]);
		}

		return result;
	}

The storageRestAdapter is created in the constructor of my Rest-class:

this.storageRestAdapter = StorageRestAdapter.New(storageManager);

Maybe the java object is not correctly converted to json.

Since I log the resulting object in the method, I can say, that it is NOT a JSON conversion error because result.getData().length is 0 even though result.length is 11, i.e. the error lies somewhere else. Bug?

[hg-ms]

Hi
I just had a look at your code again, could you check the fixedOffset parameter default value please. It should be zero.
If it is greater (like Integer.Max) the data array will not contain values with a lower index.

[hg-ms]

Here is a list with the required parameter values:

Parameter	Type	Description	Default
valueLength	long	Limit size of returned value elements, e.g. String values.	Long.MAX_VALUE
fixedOffset	long	Fixed size members start offset.	0
fixedLength	long	Amount of returned fixed size members.	Long.MAX_VALUE
variableOffset	long	Variable size members start offset.	0
variableLength	long	Amount of returned variable size members.	Long.MAX_VALUE

[nimo23]

Hi @hg-ms,

I changed the parameters to request the following:

objectId = 1.000.000.000.000.000.028
fixedOffset = 0
fixedLength = 2.147.483.647
variableOffset = 0
variableLength = 0
valueLength = 9.223.372.036.854.775.807

and now I get this json:

 "objectId" : "1000000000000000028",
  "typeId" : "1000073",
  "length" : "11",
  "variableLength" : null,
  "simplified" : false,
  "data" : [ "1000000000000000029", "1000000000000000030", "1000000000000000031", "1000000000000000053", "0", "0", "0", "0", "0", "1000000000000000033", "false" ],
  "references" : [ {
    "objectId" : "1000000000000000029",
    "typeId" : "30",
    "length" : "1",
    "variableLength" : [ "0" ],
    "simplified" : true,
    "data" : [ "root" ],
    "references" : null
  }, {
    "objectId" : "1000000000000000030",
    "typeId" : "30",
    "length" : "1",
    "variableLength" : [ "0" ],
    "simplified" : true,
    "data" : [ "1234abcA" ],
    "references" : null
  }, {
    "objectId" : "1000000000000000031",
    "typeId" : "30",
    "length" : "1",
    "variableLength" : [ "0" ],
    "simplified" : true,
    "data" : [ "root@dummy.dummy" ],
    "references" : null
  }, {
    "objectId" : "1000000000000000053",
    "typeId" : "1000074",
    "length" : "3",
    "variableLength" : null,
    "simplified" : false,
    "data" : [ "1000000000000000132", "18", "0" ],
    "references" : null
  }, null, null, null, null, null, {
    "objectId" : "1000000000000000033",
    "typeId" : "52",
    "length" : "0",
    "variableLength" : [ "1" ],
    "simplified" : false,
    "data" : [ [ ] ],
    "references" : null
  } ]
}

However, this is not what I need. I need the root data with all its child data listed in the json. It should produce a json output similar to the output of https://docs.eclipsestore.io/manual/storage/rest-interface/client-gui.html. Maybe, I need some other libs listed in https://docs.eclipsestore.io/manual/storage/rest-interface/index.html?

[hg-ms]

Oh, there is no simple API to get a json that supplies all information like seen in the screenshots.
What you see there is the output of a Vaadin application.

The App uses the modules storage-restclient and storage-restclient-jersey modules to process the data. Maybe you can also use those modules, or they might serve as example.

One of the important things is that the data received by getObject needs to be combined with the type descriptions from the storage type-dictionary to be able to interpret an object’s data.

[nimo23]

@hg-ms It would make a lot of sense to provide another official rest endpoint to receive such data. Perhaps one of the storage-restclient or storage-restclient-jersey developers can externalize this logic so that it is available in the StorageRestAdapter.

I will create an issue for that.