com.hpe.adm.nga.sdk

Class Octane.Builder

java.lang.Object

com.hpe.adm.nga.sdk.Octane.Builder

Enclosing class:

Octane

public static class Octane.Builder
extends Object

This class is used to create an Octane instance for normal API usage. It is initialised using the correct Authentication
The Builder class uses the builder pattern. This builds up the correct Octane REST API context. It is not necessary to add a sharedspace or workspace and will work with entities under that context.
Use the workspace and sharedspace methods only once otherwise the behaviour cannot be guaranteed!
Once the correct context has been built up use the build() method to create the Octane instance

Constructor Summary

Constructors

Constructor and Description
Builder(Authentication authentication) Creates a new Builder object using the correct authentication
Builder(Authentication authentication, OctaneHttpClient octaneHttpClient) Creates a new Builder object using the correct authentication

Method Summary

Modifier and Type	Method and Description
Octane	build() The main build procedure which creates the Octane object and authenticates against the server
Octane.Builder	OctaneClassFactoryClassName(String octaneClassFactoryClassName) Sets the OctaneClassFactoryName.
Octane.Builder	OctaneHttpClient(OctaneHttpClient octaneHttpClient) Sets the OctaneHttpClient instance.
Octane.Builder	Server(String domain) Sets the domain and the port.
Octane.Builder	Server(String domain, int port) Sets the domain and the port.
Octane.Builder	settings(Octane.OctaneCustomSettings settings) Configure a settings provider with custom settings like: readTimeout
Octane.Builder	sharedSpace(long ssID) Sets the shared_space id to be a long
Octane.Builder	sharedSpace(UUID ssID) Sets the shared_space id to be a UUID object
String	toString()
Octane.Builder	workSpace(long lId) Sets the workspace id to be a long.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Builder

public Builder(Authentication authentication)

Creates a new Builder object using the correct authentication

Parameters:

authentication - - Authentication object. Cannot be null

Throws:

NullPointerException - if the authentication object is null

Builder

public Builder(Authentication authentication,
               OctaneHttpClient octaneHttpClient)

Creates a new Builder object using the correct authentication

Parameters:

authentication - - Authentication object. Cannot be null

octaneHttpClient - - Implementation of OctaneHttpClient. Cannot be null

Throws:

AssertionError - if the authentication or octaneHttpClient is null

Method Detail

sharedSpace

public Octane.Builder sharedSpace(UUID ssID)

Sets the shared_space id to be a UUID object

Parameters:

ssID - - sharedSpace id

Returns:

this instance

Throws:

NullPointerException - if ssID is null

sharedSpace

public Octane.Builder sharedSpace(long ssID)

Sets the shared_space id to be a long

Parameters:

ssID - - sharedSpace id

Returns:

this instance

workSpace

public Octane.Builder workSpace(long lId)

Sets the workspace id to be a long.

This can be set to be Octane.NO_WORKSPACE_ID which means that the context is set to be the space admin to get the list of workspaces
If this is not set and the space id is set the context is assumed to be the space admin

Parameters:

lId - - workSpace id

Returns:

this instance

Server

public Octane.Builder Server(String domain,
                             int port)

Sets the domain and the port. The domain should include the full http scheme (http/https)
eg http://octane.server.com

Parameters:

domain - - domain name including http scheme

port - - port number

Returns:

this object

Throws:

NullPointerException - if the domain is null

Server

public Octane.Builder Server(String domain)

Sets the domain and the port. The domain should include the full http scheme (http/https)
eg http://octane.server.com

Parameters:

domain - - domain name including http scheme

Returns:

this object

Throws:

NullPointerException - if the domain is null

OctaneClassFactoryClassName

public Octane.Builder OctaneClassFactoryClassName(String octaneClassFactoryClassName)

Sets the OctaneClassFactoryName. See OctaneClassFactory for more details

Parameters:

octaneClassFactoryClassName - The name of the OctaneClassFactory to use

Returns:

An instance of this builder object

OctaneHttpClient

public Octane.Builder OctaneHttpClient(OctaneHttpClient octaneHttpClient)

Sets the OctaneHttpClient instance.

Parameters:

octaneHttpClient - The instance to use

Returns:

An instance of this builder object

settings

public Octane.Builder settings(Octane.OctaneCustomSettings settings)

Configure a settings provider with custom settings like: readTimeout

Parameters:

settings - - a plain java object with timeout settings(for now)

Returns:

An instance of this builder object

build

public Octane build()

The main build procedure which creates the Octane object and authenticates against the server

Returns:

a new Octane instance which has the set context and is correctly authenticated

toString

public String toString()

Overrides:

toString in class Object