Skip to content

oracle/spring-cloud-oci

Repository files navigation

Spring Cloud OCI

License: UPL

Introduction

Spring Cloud for OCI, eases the integration with OCI services with the help of OCI Java SDK internally. It offers a convenient way to interact with OCI-provided services using well-known Spring idioms and APIs, such as the messaging or storage API. Developers can build their applications around the hosted services without having to care about infrastructure or maintenance. Spring Cloud for OCI contains auto-configuration support for OCI-managed services.

All Spring Cloud for OCI artifacts are made available through Maven Central. With Spring Cloud for OCI, the developers only need to add some annotations and a small number of configurations to connect Spring Cloud applications to the OCI services.

Spring Cloud OCI documentation

For a deep dive into the project, refer to the Spring Cloud OCI documentation:

Version Reference Docs API Docs
Spring Cloud OCI 1.0.0 Reference Docs API Docs

Compatibility with Spring Project Versions

This project has dependency and transitive dependencies on Spring Projects. The table below outlines the versions of Spring Cloud, Spring Boot and Spring Framework versions that are compatible with certain Spring Cloud OCI version.

Spring Cloud OCI Spring Cloud Spring Boot OCI Java SDK
1.0.0 2022.0.x 3.1.x, 3.0.x 3.24.0

Try out samples

You may checkout samples for the each service supported by Spring Cloud OCI below.

Checking out and building

If you like to clone this repo in your OCI tenancy, click on 'Open in Code Editor' button below to clone and launch OCI Code Editor for this sample.

or

To check out the project manually and build it from source, do the following:

git clone https://github.com/oracle/spring-cloud-oci.git
cd spring-cloud-oci
mvn package

To build and install jars into your local Maven cache:

mvn install

For faster builds, we recommend using Maven Daemon and using following commands:

Build:

make build

Clean:

make clean

Documentation

Java docs can be generated with below command

make javadocs

JavaDocs generated at target/site/

Contributing

This project welcomes contributions from the community. Before submitting a pull request, please review our contribution guide

Security

Please consult the security guide for our responsible security vulnerability disclosure process

License

Copyright (c) 2023 Oracle and/or its affiliates.

Released under the Universal Permissive License v1.0 as shown at https://oss.oracle.com/licenses/upl/.

About

Spring Cloud for OCI, eases the integration with OCI services and offers a convenient way to interact with OCI-provided services using well-known Spring idioms and APIs.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published