Index (RoStore Client 2.0.1 API)

A B C D F G H I J K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

ApiKeys - Class in org.rostore.client: Class is used to access and modify the api keys on the storage.
ApiKeys(RoStoreClient) - Constructor for class org.rostore.client.ApiKeys

B

BINARY - Enum constant in enum class org.rostore.client.ContentType

C

ClientException - Exception Class in org.rostore.client: The exception is thrown by rostore client, in case of any issue in the communication with the remote rostore service.
ClientException(String, RequestProperties) - Constructor for exception class org.rostore.client.ClientException
ClientException(String, RequestProperties, String, String) - Constructor for exception class org.rostore.client.ClientException
ClientException(String, RequestProperties, String, String, Throwable) - Constructor for exception class org.rostore.client.ClientException
ClientException(String, RequestProperties, Throwable) - Constructor for exception class org.rostore.client.ClientException
contentType(String) - Method in class org.rostore.client.RequestProperties
ContentType - Enum Class in org.rostore.client: Specify a content-type header for the request to the remote rostore service.
create(String) - Method in class org.rostore.client.RoStoreClient: Creates a base request properties for the given path
create(K, V, Long, Long) - Static method in class org.rostore.client.VersionedObject: Creates a versioned object (general case)
create(ContainerMeta) - Method in class org.rostore.client.GeneralContainer: Creates a new container
create(ContainerMeta) - Method in class org.rostore.client.MappedContainer: Creates a new container
createDeserialized(VersionedObject<K, V1>, V2) - Static method in class org.rostore.client.VersionedObject
createEternal(K, V, Long) - Static method in class org.rostore.client.VersionedObject: Creates an eternal versioned object
createNewVersioned(K, V, Long) - Static method in class org.rostore.client.VersionedObject: Creates first version of the entity with the expiration timestamp
createNewVersionedEternal(K, V) - Static method in class org.rostore.client.VersionedObject: Creates first version of eternal object
createUnversionedEternal(K, V) - Static method in class org.rostore.client.VersionedObject: Creates an eternal unversioned object

D

DefaultKeySerializer<K> - Class in org.rostore.client: A default key serializer.
delete(RequestProperties) - Method in class org.rostore.client.RoStoreClient: Executes a delete command

F

fromObject(V, K) - Method in class org.rostore.client.mapper.JsonMapper: Serialization function
fromObject(V, K) - Method in interface org.rostore.client.mapper.Mapper: Serialization function
fromObject(V, K) - Method in class org.rostore.client.mapper.NativeMapper: Serialization function
fromObject(V, K) - Method in class org.rostore.client.mapper.StringMapper: Serialization function

G

GeneralContainer<K> - Class in org.rostore.client: Represents a simple rostore container.
GeneralContainer(RoStoreClient, String, KeySerializer<K>) - Constructor for class org.rostore.client.GeneralContainer
get(String) - Method in class org.rostore.client.ApiKeys: Get the api-key permissions by the key
get(K, Class<V>) - Method in class org.rostore.client.MappedContainer: Retrieves the object from the storage
get(K, EnumSet<RecordOption>, Function<InputStream, V>) - Method in class org.rostore.client.GeneralContainer
get(K, Function<InputStream, V>) - Method in class org.rostore.client.GeneralContainer
get(RequestProperties, Function<CloseableHttpResponse, T>) - Method in class org.rostore.client.RoStoreClient: Executes a get request on the rostore
getApiKey() - Method in class org.rostore.client.RoStoreClientProperties: Returns the api key used to access the rostore
getApiKeys() - Method in class org.rostore.client.RoStoreClient: Returns object that manage the api keys
getBaseUrl() - Method in class org.rostore.client.RoStoreClientProperties: Returns the base url of the rostore instance, e.g.
getBytes(RequestProperties) - Method in class org.rostore.client.RoStoreClient: Executes the request on rostore and return the response as byte array
getConnectionManager() - Method in class org.rostore.client.RoStoreClient
getConnectTimeout() - Method in class org.rostore.client.RoStoreClientProperties
getContentType() - Method in class org.rostore.client.mapper.JsonMapper: The content type of the input stream
getContentType() - Method in interface org.rostore.client.mapper.Mapper: The content type of the input stream
getContentType() - Method in class org.rostore.client.mapper.NativeMapper: The content type of the input stream
getContentType() - Method in class org.rostore.client.mapper.StringMapper: The content type of the input stream
getContentType() - Method in class org.rostore.client.RequestProperties: Content type of the request (header).
getContinuationKey() - Method in class org.rostore.client.StringKeyList: Provides a continuation key for the next call
getEOL() - Method in class org.rostore.client.RequestProperties: The Unix End of Live - used to set the expiration of the key.
getEOLHeader(CloseableHttpResponse) - Method in class org.rostore.client.RoStoreClient: Extracts eol header from the server response
getGeneralContainer(String) - Method in class org.rostore.client.RoStoreClient: Creates object GeneralContainer.
getGeneralContainer(String, KeySerializer<K>) - Method in class org.rostore.client.RoStoreClient: Creates object GeneralContainer.
getInputStream(CloseableHttpResponse) - Static method in class org.rostore.client.RoStoreClient
getJsonMapper() - Method in class org.rostore.client.RoStoreClient
getKey() - Method in class org.rostore.client.VersionedObject: Returns the key's object
getKeyPath(K) - Method in class org.rostore.client.GeneralContainer
getKeys() - Method in class org.rostore.client.StringKeyList: List of keys.
getMappedContainer(String, Mapper) - Method in class org.rostore.client.RoStoreClient: Creates a new light-weight object that represents access to the container.
getMappedContainer(String, Mapper, KeySerializer<K>) - Method in class org.rostore.client.RoStoreClient: Creates a new light-weight object that represents access to the container.
getMapperProperties() - Method in class org.rostore.client.mapper.NativeMapper
getMaxConnectionsPerRoute() - Method in class org.rostore.client.RoStoreClientProperties
getMaxTotalConnections() - Method in class org.rostore.client.RoStoreClientProperties
getMediaType() - Method in enum class org.rostore.client.ContentType
getMeta() - Method in class org.rostore.client.GeneralContainer: Returns the container's metadata
getName() - Method in class org.rostore.client.GeneralContainer
getName() - Method in class org.rostore.client.MappedContainer
getNativeMapper() - Method in class org.rostore.client.RoStoreClient
getObjectClass() - Method in class org.rostore.client.VersionedObject: Get the Class of the object
getPath() - Method in class org.rostore.client.RequestProperties: The REST path to execute.
getProperties() - Method in class org.rostore.client.RoStoreClient: Returns the rostore connection properties
getRecordOptions() - Method in class org.rostore.client.RequestProperties
getRequestProperties() - Method in exception class org.rostore.client.ClientException
getRequestTimeout() - Method in class org.rostore.client.RoStoreClientProperties
getRoStoreClientProperties() - Method in class org.rostore.client.RequestProperties: Properties of the RoStoreClient to be used in the request.
getServerMessage() - Method in exception class org.rostore.client.ClientException
getString(RequestProperties) - Method in class org.rostore.client.RoStoreClient: Executes the request on rostore and return the response as string (UTF-8)
getTrackingId() - Method in exception class org.rostore.client.ClientException
getUnixEOL() - Method in class org.rostore.client.VersionedObject
getUpdateRetries() - Method in class org.rostore.client.RoStoreClientProperties
getUpdateTimeoutMax() - Method in class org.rostore.client.RoStoreClientProperties
getValue() - Method in class org.rostore.client.VersionedObject: Get the value
getVersion() - Method in class org.rostore.client.VersionedObject: Get the object's version.
getVersionHeader(CloseableHttpResponse) - Static method in class org.rostore.client.RoStoreClient: Extracts version header from the server response
getWrapped(K, EnumSet<RecordOption>, Function<VersionedObject<K, InputStream>, VersionedObject<K, V>>) - Method in class org.rostore.client.GeneralContainer

H

HEADER_API_KEY - Static variable in class org.rostore.client.RoStoreClient
HEADER_CONTENT_TYPE - Static variable in class org.rostore.client.RoStoreClient
HEADER_EOL - Static variable in class org.rostore.client.RoStoreClient
HEADER_OPTIONS - Static variable in class org.rostore.client.RoStoreClient
HEADER_TRACKING_ID - Static variable in class org.rostore.client.RoStoreClient
HEADER_VERSION - Static variable in class org.rostore.client.RoStoreClient

I

INSTANCE - Static variable in class org.rostore.client.DefaultKeySerializer
isMore() - Method in class org.rostore.client.StringKeyList
isVersioned() - Method in class org.rostore.client.VersionedObject: Gets is the object versioned or not

J

JSON - Enum constant in enum class org.rostore.client.ContentType
JsonMapper - Class in org.rostore.client.mapper: This one uses the ObjectMapper to serialize / deserialize the content of the store
JsonMapper(ObjectMapper) - Constructor for class org.rostore.client.mapper.JsonMapper

K

KeyExpirationUpdateFunction - Interface in org.rostore.client: This interface (function) provides a flexible way to define a new expiration policy for the given object
KeySerializer<K> - Interface in org.rostore.client: Interface specifies the logic for key object serialization

L

listApiKeys(String) - Method in class org.rostore.client.ApiKeys: Lists all api keys.
listContainers() - Method in class org.rostore.client.RoStoreClient: Get the list of all container names on the remote service
listKeys(String, String) - Method in class org.rostore.client.GeneralContainer: Lists the keys within the container.

M

MappedContainer<K> - Class in org.rostore.client: Encapsulates access to the container that uses specific serializer / deserializer.
MappedContainer(RoStoreClient, String, Mapper, KeySerializer<K>) - Constructor for class org.rostore.client.MappedContainer
Mapper - Interface in org.rostore.client.mapper: Provides serialization / deserialization for mapping of the underlying objects

N

NativeMapper - Class in org.rostore.client.mapper: This one uses the native serializer of the ro-store
NativeMapper(MapperProperties) - Constructor for class org.rostore.client.mapper.NativeMapper
noExpiration - Static variable in interface org.rostore.client.KeyExpirationUpdateFunction

O

options(EnumSet<RecordOption>) - Method in class org.rostore.client.RequestProperties
org.rostore.client - package org.rostore.client: RoStore java client classes
org.rostore.client.mapper - package org.rostore.client.mapper: Serializer/Deserializer used in the client.

P

path(String) - Method in class org.rostore.client.RequestProperties
PATH__MAPPER_PROPERTIES - Static variable in class org.rostore.client.RoStoreClient
PATH__PING - Static variable in class org.rostore.client.RoStoreClient
PATH__SHUTDOWN - Static variable in class org.rostore.client.RoStoreClient
PATH__VERSION - Static variable in class org.rostore.client.RoStoreClient
ping() - Method in class org.rostore.client.RoStoreClient: Checks that the server is up and running
post(RequestProperties, InputStream, Function<CloseableHttpResponse, T>) - Method in class org.rostore.client.RoStoreClient: Executes a post request on the rostore
post(VersionedObject<String, ApiKeyPermissions>) - Method in class org.rostore.client.ApiKeys: Creates a new api-key and associate the permissions with it
post(VersionedObject<K, InputStream>) - Method in class org.rostore.client.GeneralContainer
post(VersionedObject<K, InputStream>, EnumSet<RecordOption>) - Method in class org.rostore.client.GeneralContainer
post(VersionedObject<K, V>) - Method in class org.rostore.client.MappedContainer: Creates a new key-value pair.
post(VersionedObject<K, V>, EnumSet<RecordOption>) - Method in class org.rostore.client.MappedContainer: Creates a new key-value pair.
post(VersionedObject<K, V>, EnumSet<RecordOption>, Function<V, InputStream>) - Method in class org.rostore.client.GeneralContainer
post(VersionedObject<K, V>, Function<V, InputStream>) - Method in class org.rostore.client.GeneralContainer
put(RequestProperties, InputStream, Function<CloseableHttpResponse, T>) - Method in class org.rostore.client.RoStoreClient: Executes a put request on the rostore
put(VersionedObject<String, ApiKeyPermissions>) - Method in class org.rostore.client.ApiKeys: Updates given api-key

R

remove() - Method in class org.rostore.client.GeneralContainer: Removes container from rostore
remove() - Method in class org.rostore.client.MappedContainer
removeKey(K) - Method in class org.rostore.client.MappedContainer: Remove a key from the storage
removeKey(K, long) - Method in class org.rostore.client.MappedContainer: Remove a key from the storage
removeKey(K, long, EnumSet<RecordOption>) - Method in class org.rostore.client.GeneralContainer
removeKey(K, long, EnumSet<RecordOption>) - Method in class org.rostore.client.MappedContainer: Remove a key from the storage
RequestProperties - Class in org.rostore.client: This is a backbone class that contains all the data needed to execute a REST request against the remote rostore instance.
RequestProperties(RoStoreClientProperties) - Constructor for class org.rostore.client.RequestProperties
RoStoreClient - Class in org.rostore.client: The major object to access the remote rostore service.
RoStoreClient(TrustManager[], RoStoreClientProperties) - Constructor for class org.rostore.client.RoStoreClient: Creates a new rostore client
RoStoreClient(RoStoreClientProperties) - Constructor for class org.rostore.client.RoStoreClient
RoStoreClientProperties - Class in org.rostore.client: Properties that define connection to the remote rostore service
RoStoreClientProperties(String, String) - Constructor for class org.rostore.client.RoStoreClientProperties

S

setConnectTimeout(Duration) - Method in class org.rostore.client.RoStoreClientProperties
setKeys(List<String>) - Method in class org.rostore.client.StringKeyList
setMaxConnectionsPerRoute(int) - Method in class org.rostore.client.RoStoreClientProperties
setMaxTotalConnections(int) - Method in class org.rostore.client.RoStoreClientProperties
setMore(boolean) - Method in class org.rostore.client.StringKeyList
setRequestTimeout(Duration) - Method in class org.rostore.client.RoStoreClientProperties
setUpdateRetries(int) - Method in class org.rostore.client.RoStoreClientProperties
setUpdateTimeoutMax(Duration) - Method in class org.rostore.client.RoStoreClientProperties
shutdown() - Method in class org.rostore.client.RoStoreClient: Stops the server
StringKeyList - Class in org.rostore.client: The class represents the result of key listing operation.
StringKeyList() - Constructor for class org.rostore.client.StringKeyList
StringMapper - Class in org.rostore.client.mapper: This one can only work with the keys of type String.
StringMapper() - Constructor for class org.rostore.client.mapper.StringMapper

T

toObject(InputStream, Class<V>, K) - Method in class org.rostore.client.mapper.JsonMapper: Deserialization function
toObject(InputStream, Class<V>, K) - Method in interface org.rostore.client.mapper.Mapper: Deserialization function
toObject(InputStream, Class<V>, K) - Method in class org.rostore.client.mapper.NativeMapper: Deserialization function
toObject(InputStream, Class<V>, K) - Method in class org.rostore.client.mapper.StringMapper: Deserialization function
toString() - Method in class org.rostore.client.VersionedObject
toString(K) - Method in class org.rostore.client.DefaultKeySerializer
toString(K) - Method in interface org.rostore.client.KeySerializer: Transforms the key object to the string
trackingId() - Method in class org.rostore.client.RequestProperties
trackingId(String) - Method in class org.rostore.client.RequestProperties

U

unixEol(Long) - Method in class org.rostore.client.RequestProperties
unixEol(VersionedObject<K, V>) - Method in interface org.rostore.client.KeyExpirationUpdateFunction
update(VersionedObject<K, V>, Function<V, V>) - Method in class org.rostore.client.MappedContainer: Updates a versioned key-value pair.
update(VersionedObject<K, V>, Function<V, V>, Function<V, InputStream>, Function<InputStream, V>) - Method in class org.rostore.client.GeneralContainer: Updates the given entity
update(VersionedObject<K, V>, Function<V, V>, KeyExpirationUpdateFunction) - Method in class org.rostore.client.MappedContainer: Updates a versioned key-value pair.
update(VersionedObject<K, V>, KeyExpirationUpdateFunction, Function<V, V>, Function<V, InputStream>, Function<InputStream, V>) - Method in class org.rostore.client.GeneralContainer: Updates the given entity

V

valueOf(String) - Static method in enum class org.rostore.client.ContentType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.rostore.client.ContentType: Returns an array containing the constants of this enum class, in the order they are declared.
version() - Method in class org.rostore.client.RequestProperties
version(Long) - Method in class org.rostore.client.RequestProperties
VersionConflictException - Exception Class in org.rostore.client: Exception is thrown on post/put when the version in e input is not as expected by the server.
VersionConflictException(String, RequestProperties) - Constructor for exception class org.rostore.client.VersionConflictException
VersionedObject<K,V> - Class in org.rostore.client: Versioned object, containing the object itself, and metadata: ttl information and version

W

WrappedClientException - Exception Class in org.rostore.client
WrappedClientException(String, Exception) - Constructor for exception class org.rostore.client.WrappedClientException

A B C D F G H I J K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form