ACCS Application Cache Java Client API

A Java Client API to access ACCS Application Cache.

License	Common Development and Distribution License 1.0 ("CDDL")
Categories	Caching Data CLI User Interface
GroupId	com.oracle.cloud.caching
ArtifactId	cache-client-api
Last Version	1.0.0
Release Date	Mar 15, 2017
Type	jar
Description	ACCS Application Cache Java Client API A Java Client API to access ACCS Application Cache.

Download cache-client-api

Filename	Size
cache-client-api-1.0.0.pom
cache-client-api-1.0.0.jar	40 KB
cache-client-api-1.0.0-sources.jar	42 KB
cache-client-api-1.0.0-javadoc.jar	213 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.oracle.cloud.caching/cache-client-api/ -->
<dependency>
    <groupId>com.oracle.cloud.caching</groupId>
    <artifactId>cache-client-api</artifactId>
    <version>1.0.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.oracle.cloud.caching/cache-client-api/
implementation 'com.oracle.cloud.caching:cache-client-api:1.0.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.oracle.cloud.caching/cache-client-api/
implementation ("com.oracle.cloud.caching:cache-client-api:1.0.0")

Apache Buildr

'com.oracle.cloud.caching:cache-client-api:jar:1.0.0'

Apache Ivy

<dependency org="com.oracle.cloud.caching" name="cache-client-api" rev="1.0.0">
  <artifact name="cache-client-api" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.oracle.cloud.caching', module='cache-client-api', version='1.0.0')
)

Scala SBT

libraryDependencies += "com.oracle.cloud.caching" % "cache-client-api" % "1.0.0"

Leiningen

[com.oracle.cloud.caching/cache-client-api "1.0.0"]

Dependencies

compile (3)

Group / Artifact	Type	Version
com.oracle.cloud.caching : cache-client-protocol	jar	1.0.0
org.glassfish.jersey.core : jersey-client	jar	2.22.1
io.dropwizard.metrics : metrics-core	jar	3.1.0

Project Modules

There are no modules declared in this project.

Java Client Caching SDK for Oracle Application Container Cloud Service

This project contains the source code for the Java client library
to allow apps access caches in the Application Container Cloud Service (ACCS) of Oracle's Cloud Platform.

To create an Application Cache, see the documentation

Prerequisites

Install these before building the Java client library:

1. Java SE Development Kit (JDK)

   • Java SE Downloads
   • Install the latest Java SE JDK available

2. Maven 3.2.5 or above installed and configured

   • Download instructions
   • Installation instructions

Build Instructions

Build the Java client by running these commands:

• Clone the repository

git clone https://github.com/oracle/accs-caching-java-sdk.git

• Change to the directory

cd accs-caching-java-sdk

• Build the client

mvn clean install

If you do not wish to run the local functional tests, run this command:

mvn clean install -DskipTests

If you wish to create a 'shaded' jar, run this command:

mvn clean install -DskipTests -P shade

Running the examples

The directory cache-client-examples contains two sub-projects that show how to use the client API.

Deployable ACCS example

The sub-directory cache-client-examples/appcache-example contains an example using the client API which can be deployed to ACCS.

LocalSessionProvider Example

The sub-directory cache-client-examples/local-session-provider-example contains an example showing how to use the the client API (including full API functionality) against a LocalSessionProvider without having to deploy to ACCS.

Referencing the API from Maven Projects

To add a dependency on the cache-client-api in your Maven projects, include this dependency.

   ```
    <dependency>
        <groupId>com.oracle.cloud.caching</groupId>
        <artifactId>cache-client-api</artifactId>
        <version>1.0.0</version>
    </dependency>
   ```

Further Information

For further information on using the Java API within your applications deployed on ACCS, see the documentation.

Contributing

This is an open source project and we welcome contributions. See CONTRIBUTING for details.

License

You may not use the identified files except in compliance with the Universal Permissive License (UPL), Version 1.0 (the "License.")

You may obtain a copy of the License at https://opensource.org/licenses/UPL. A copy of the license is also reproduced in LICENSE.md

Oracle

Open Source at Oracle

Versions

Version
1.0.0 Mar 15, 2017