io.micronaut.microstream.rest

Class MicroStreamRestController

java.lang.Object

io.micronaut.microstream.rest.MicroStreamRestController

@Requires(bean=one.microstream.storage.types.StorageManager.class) @Requires(bean=EmbeddedStorageConfigurationProvider.class)
 @Controller(value="/${microstream.rest.path:microstream}")
public class MicroStreamRestController
extends java.lang.Object

MicroStream REST controller for a single StorageManager.

Since:

1.0.0

Author:

Tim Yates

Constructor Summary

Constructors

Constructor and Description
MicroStreamRestController(MicroStreamRestService service) A default controller to expose the expected MicroStream REST API per storage manager.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDictionary() Get storage type dictionary.
java.lang.String	getDictionary(java.lang.String name) Get storage type dictionary.
one.microstream.storage.restadapter.types.ViewerStorageFileStatistics	getFilesStatistics() Get statistics for all storage files.
one.microstream.storage.restadapter.types.ViewerStorageFileStatistics	getFilesStatistics(java.lang.String name) Get statistics for all storage files.
one.microstream.storage.restadapter.types.ViewerObjectDescription	getObject(java.lang.String oid, java.lang.Long valueLength, java.lang.Long fixedOffset, java.lang.Long fixedLength, java.lang.Long variableOffset, java.lang.Long variableLength, java.lang.Boolean references) Get an object by its id.
one.microstream.storage.restadapter.types.ViewerObjectDescription	getObject(java.lang.String name, java.lang.String oid, java.lang.Long valueLength, java.lang.Long fixedOffset, java.lang.Long fixedLength, java.lang.Long variableOffset, java.lang.Long variableLength, java.lang.Boolean references) Get an object by its id.
RootObject	getRoot() Get the user defined root.
RootObject	getRoot(java.lang.String name) Get the user defined root.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MicroStreamRestController

public MicroStreamRestController(MicroStreamRestService service)

A default controller to expose the expected MicroStream REST API per storage manager.

Parameters:

service - the service to query MicroStream via the relevant StorageRestAdapter

Method Detail

getRoot

@Get(value="/root")
public RootObject getRoot()

Get the user defined root.

Returns:

the root object

getRoot

@Get(value="/{name}/root")
public RootObject getRoot(@PathVariable
                                                     java.lang.String name)

Get the user defined root.

Parameters:

name - the name of the storage adapter

Returns:

the root object

getDictionary

@Get(value="/dictionary")
public java.lang.String getDictionary()

Get storage type dictionary.

Returns:

storage type dictionary as a single string

getDictionary

@Get(value="/{name}/dictionary")
public java.lang.String getDictionary(@PathVariable
                                                                       java.lang.String name)

Get storage type dictionary.

Parameters:

name - the name of the storage adapter

Returns:

storage type dictionary as a single string

getObject

@Get(value="/object/{oid}")
public one.microstream.storage.restadapter.types.ViewerObjectDescription getObject(@PathVariable
                                                                                                               java.lang.String oid,
                                                                                                               @Nullable @QueryValue
                                                                                                               java.lang.Long valueLength,
                                                                                                               @Nullable @QueryValue
                                                                                                               java.lang.Long fixedOffset,
                                                                                                               @Nullable @QueryValue
                                                                                                               java.lang.Long fixedLength,
                                                                                                               @Nullable @QueryValue
                                                                                                               java.lang.Long variableOffset,
                                                                                                               @Nullable @QueryValue
                                                                                                               java.lang.Long variableLength,
                                                                                                               @Nullable @QueryValue
                                                                                                               java.lang.Boolean references)

Get an object by its id.

Parameters:

oid - object id of the requested object

valueLength - limit size of returned value elements to this value

fixedOffset - index of the first fix sized element to fetch

fixedLength - number of fix sized elements to be fetched

variableOffset - index of the first element in variable sized collections to be fetched

variableLength - number of elements to be fetched from variable sized collections

references - resolve top level references and return them with this request

Returns:

the object

getObject

@Get(value="/{name}/object/{oid}")
public one.microstream.storage.restadapter.types.ViewerObjectDescription getObject(@PathVariable
                                                                                                                      java.lang.String name,
                                                                                                                      @PathVariable
                                                                                                                      java.lang.String oid,
                                                                                                                      @Nullable @QueryValue
                                                                                                                      java.lang.Long valueLength,
                                                                                                                      @Nullable @QueryValue
                                                                                                                      java.lang.Long fixedOffset,
                                                                                                                      @Nullable @QueryValue
                                                                                                                      java.lang.Long fixedLength,
                                                                                                                      @Nullable @QueryValue
                                                                                                                      java.lang.Long variableOffset,
                                                                                                                      @Nullable @QueryValue
                                                                                                                      java.lang.Long variableLength,
                                                                                                                      @Nullable @QueryValue
                                                                                                                      java.lang.Boolean references)

Get an object by its id.

Parameters:

name - the name of the storage adapter

oid - object id of the requested object

valueLength - limit size of returned value elements to this value

fixedOffset - index of the first fix sized element to fetch

fixedLength - number of fix sized elements to be fetched

variableOffset - index of the first element in variable sized collections to be fetched

variableLength - number of elements to be fetched from variable sized collections

references - resolve top level references and return them with this request

Returns:

the object

getFilesStatistics

@Get(value="/maintenance/filesStatistics")
public one.microstream.storage.restadapter.types.ViewerStorageFileStatistics getFilesStatistics()

Get statistics for all storage files.

Returns:

the statistics as json

getFilesStatistics

@Get(value="/{name}/maintenance/filesStatistics")
public one.microstream.storage.restadapter.types.ViewerStorageFileStatistics getFilesStatistics(@PathVariable
                                                                                                                                                  java.lang.String name)

Get statistics for all storage files.

Parameters:

name - the name of the storage adapter

Returns:

the statistics as json