com.hpe.adm.nga.sdk

Class SiteAdmin.Builder

java.lang.Object

com.hpe.adm.nga.sdk.SiteAdmin.Builder

Enclosing class:

SiteAdmin

public static class SiteAdmin.Builder
extends Object

This class is used to create an SiteAdmin instance for site admin 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.
Once the correct context has been built up use the build() method to create the SiteAdmin instance

Field Summary

Fields

Modifier and Type	Field and Description
protected OctaneHttpClient	octaneHttpClient
protected String	urlDomain

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
SiteAdmin	build() The main build procedure which creates the SiteAdmin object and authenticates against the server
protected SiteAdmin	getSiteAdmin()
SiteAdmin.Builder	Server(String domain) Sets the domain and the port.
SiteAdmin.Builder	Server(String domain, int port) Sets the domain and the port.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

urlDomain

protected String urlDomain

octaneHttpClient

protected OctaneHttpClient octaneHttpClient

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

Server

public SiteAdmin.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 SiteAdmin.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

build

public SiteAdmin build()

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

Returns:

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

getSiteAdmin

protected SiteAdmin getSiteAdmin()

toString

public String toString()

Overrides:

toString in class Object