ryan_harg/testcontainers-infinispan
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated user documentation

Browse source
This commit is contained in:
Reinhard Prechtl 2017-12-22 15:48:42 +01:00
parent 587e7d1d0d
commit a21b64c31c
1 changed files with 23 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -12,14 +12,37 @@ Feel free to suggest changes!
# Usage # Usage
## Instantiation of the Infinispan container
Here's simple example how you can use the `InfinispanContainer`. Here's simple example how you can use the `InfinispanContainer`.
``` ```
@ClassRule @ClassRule
public static InfinispanContainer infinispan = new InfinispanContainer() public static InfinispanContainer infinispan = new InfinispanContainer()
.withProtocolVersion(ProtocolVersion.PROTOCOL_VERSION_26);
```
## Cache creation
You can create simple local caches that need to be available for your tests. If you run an up-to-date Infinispan container (>9.1.0) then caches can be created
using the API of the `RemoteCacheManager` provided by the Infinispan client library. Simple configure some caches that the `InfinispanContainer` should create for you.
They will automatically be created once the container has started.
```
new InfinispanContainer()
.withProtocolVersion(ProtocolVersion.PROTOCOL_VERSION_26) .withProtocolVersion(ProtocolVersion.PROTOCOL_VERSION_26)
.withCaches("testCache"); .withCaches("testCache");
```
If you run an Infinispan server version prior to `9.1.0`, you can link a configuration file that contains the necessary caches into the container:
``` ```
new InfinispanContainer("jboss/infinispan-server:9.0.3.Final")
.withProtocolVersion(ProtocolVersion.PROTOCOL_VERSION_26)
.withStandaloneConfiguration("infinispan-standalone.xml")
```
## CacheManager retrieval
If you want, you can retrieve a `RemoteCacheManager` from the container: If you want, you can retrieve a `RemoteCacheManager` from the container:
``` ```
infinispan.getCacheManager() infinispan.getCacheManager()