extensions/entitystore-riak/src/docs/es-riak.txt

///////////////////////////////////////////////////////////////
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
///////////////////////////////////////////////////////////////

[[extension-es-riak,Riak EntityStore]]
= Riak EntityStore =

[devstatus]
--------------
source=extensions/entitystore-riak/dev-status.xml
--------------

EntityStore service backed by a http://basho.com/[Riak] bucket.

The EntityStore only supports accessing Riak using protocol buffers.
HTTP is not supported since the 2.x serie of the Riak Java client.
See the Riak documentation.

include::../../build/docs/buildinfo/artifact.txt[]

== Assembly ==

Assembly is done using the provided Assembler:

[snippet,java]
----
source=extensions/entitystore-riak/src/test/java/org/apache/polygene/entitystore/riak/RiakMapEntityStoreTest.java
tag=assembly
----

== Configuration ==

Here are the available configuration properties:

[snippet,java]
----
source=extensions/entitystore-riak/src/main/java/org/apache/polygene/entitystore/riak/RiakEntityStoreConfiguration.java
tag=config
----

All authentication related properties are optional.
By default no authentication is used.
As soon as you provide a `username`, authentication is set up.
Please note that you should then at least provide `truststoreType`, `truststorePath` and `truststorePassword`.
To use client certificate authentication, set `keystoreType`, `keystorePath`, `keystorePassword` and `keyPassword`.