se.integrations.oci.adoc Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of helidon-docs
There is a newer version: 4.1.4
///////////////////////////////////////////////////////////////////////////////

    Copyright (c) 2021, 2024 Oracle and/or its affiliates.

    Licensed 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.

///////////////////////////////////////////////////////////////////////////////

= Oracle Cloud Infrastructure
:description: Helidon OCI Integration
:keywords: oci, Oracle Cloud Infrastructure
:feature-name: OCI Integration
:rootdir: {docdir}/../..

include::{rootdir}/includes/se.adoc[]

== Contents

- <>
- <>
- <>
- <>

== Overview

Helidon SE OCI Integration provides easy access to Oracle Cloud Infrastructure using the OCI Java SDK.

== Usage

It is recommended that you use the OCI Java SDK directly, in particular the Async clients. All you need to do is configure and create an OCI SDK Client object. The configuration primarily
consists of setting up authenticate with OCI.

=== Configuring the OCI SDK Client

Authentication with OCI is abstracted through `AuthenticationDetailsProvider`.

If your environment is already set up to work with the OCI SDK or
the OCI command line, then it is very likely you do not need to do any additional
configuration. It is recommended that you do this first, and verify your configuration
by using the link:{oci-javasdk-url}[OCI CLI] to access the service.

[source,java]
----
include::{sourcedir}/se/integrations/OciSnippets.java[tag=snippet_1, indent=0]
----

You also need to add the following dependency to your application for this

[source,xml]
----

    com.oracle.oci.sdk
    oci-java-sdk-common-httpclient-jersey3
    runtime

----

=== Accessing OCI Services

Once you have authentication with OCI configured, you can use it to access any OCI service
supported by the OCI SDK. You will need to add dependencies for the specific
ODI SDK clients you will use.

== Examples

This example describes how to access OCI Object Storage.

As mentioned above in <>, you need to add a dependency on the OCI SDK
Object Storage API:

[source,xml]
----

    com.oracle.oci.sdk
    oci-java-sdk-objectstorage

----

=== Creating an Object Storage Client

Now you can create OCI SDK Clients.

[source,java]
----
include::{sourcedir}/se/integrations/OciSnippets.java[tag=snippet_2, indent=0]
----

=== Using the Object Storage client

Once you have created an ObjectStorage client you can use it as described in:

* link:{oci-javasdk-objstore-javadoc-base-url}/package-summary.html[OCI SDK Object Storage Javadocs]
* link:{oci-objstore-url}[OCI Object Storage Overview]

== References

* link:{helidon-github-tree-url}/examples/integrations/oci[OCI SDK Usage Examples]
* link:https://docs.oracle.com/en-us/iaas/Content/home.htm[OCI Documentation]