com.hpe.adm.nga.sdk.network.google

Class GoogleHttpClient

java.lang.Object

com.hpe.adm.nga.sdk.network.google.GoogleHttpClient

All Implemented Interfaces:

OctaneHttpClient

public class GoogleHttpClient
extends Object
implements OctaneHttpClient

HTTP Client using Google's API

This will be refactored in future releases to enable the use of different underlying APIs

Field Summary

Fields

Modifier and Type	Field and Description
protected Date	lastSuccessfulAuthTimestamp
protected Authentication	lastUsedAuthentication
protected String	lwssoValue
protected String	octaneUserValue
protected com.google.api.client.http.HttpRequestFactory	requestFactory
protected com.google.api.client.http.HttpRequestInitializer	requestInitializer Request initializer called on every request made by the requestFactory
protected String	urlDomain

Fields inherited from interface com.hpe.adm.nga.sdk.network.OctaneHttpClient

LWSSO_COOKIE_KEY, OAUTH_AUTH_URL, OAUTH_SIGNOUT_URL, OCTANE_USER_COOKIE_KEY

Constructor Summary

Constructors

Constructor and Description
GoogleHttpClient(String urlDomain, Authentication authentication)
GoogleHttpClient(String urlDomain, Authentication authentication, Octane.OctaneCustomSettings settings) Constructor accepting custom settings for the underlying http transport layer

Method Summary

Modifier and Type	Method and Description
boolean	authenticate() Authenticate with the Octane server using an implementation of the JSONAuthentication class.
protected OctaneHttpResponse	convertHttpResponseToOctaneHttpResponse(com.google.api.client.http.HttpResponse httpResponse) Convert google implementation of HttpResponse to an implementation abstract OctaneHttpResponse
protected com.google.api.client.http.HttpRequest	convertOctaneRequestToGoogleHttpRequest(OctaneHttpRequest octaneHttpRequest) Convert the abstract OctaneHttpRequestRequest object to a specific HttpRequest for the google http client
OctaneHttpResponse	execute(OctaneHttpRequest octaneHttpRequest)
static int	getHttpRequestRetryCount()
void	signOut() Signs out and removes cookies

Methods inherited from class java.lang.Object

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

Field Detail

requestFactory

protected com.google.api.client.http.HttpRequestFactory requestFactory

lwssoValue

protected String lwssoValue

octaneUserValue

protected String octaneUserValue

urlDomain

protected final String urlDomain

lastUsedAuthentication

protected Authentication lastUsedAuthentication

lastSuccessfulAuthTimestamp

protected Date lastSuccessfulAuthTimestamp

requestInitializer

protected com.google.api.client.http.HttpRequestInitializer requestInitializer

Request initializer called on every request made by the requestFactory

Constructor Detail

GoogleHttpClient

public GoogleHttpClient(String urlDomain,
                        Authentication authentication)

GoogleHttpClient

public GoogleHttpClient(String urlDomain,
                        Authentication authentication,
                        Octane.OctaneCustomSettings settings)
                 throws RuntimeException

Constructor accepting custom settings for the underlying http transport layer

Parameters:

urlDomain - the Octane domain

settings - the object containing he custom settings

Throws:

RuntimeException - in case of an underlying security exception

Method Detail

authenticate

public boolean authenticate()

Description copied from interface: OctaneHttpClient

Authenticate with the Octane server using an implementation of the JSONAuthentication class. If basic authentication is being used then the authentication is an inherent part of execute and therefore authentication does not need to be called explicitly. True will be returned in this case

Specified by:

authenticate in interface OctaneHttpClient

Returns:

- Returns true if the authentication succeeded, false otherwise.

signOut

public void signOut()

Description copied from interface: OctaneHttpClient

Signs out and removes cookies

Specified by:

signOut in interface OctaneHttpClient

convertOctaneRequestToGoogleHttpRequest

protected com.google.api.client.http.HttpRequest convertOctaneRequestToGoogleHttpRequest(OctaneHttpRequest octaneHttpRequest)

Convert the abstract OctaneHttpRequestRequest object to a specific HttpRequest for the google http client

Parameters:

octaneHttpRequest - input OctaneHttpRequest

Returns:

HttpRequest

convertHttpResponseToOctaneHttpResponse

protected OctaneHttpResponse convertHttpResponseToOctaneHttpResponse(com.google.api.client.http.HttpResponse httpResponse)

Convert google implementation of HttpResponse to an implementation abstract OctaneHttpResponse

Parameters:

httpResponse - implementation specific HttpResponse

Returns:

OctaneHttpResponse created from the impl response object

execute

public OctaneHttpResponse execute(OctaneHttpRequest octaneHttpRequest)

Specified by:

execute in interface OctaneHttpClient

getHttpRequestRetryCount

public static int getHttpRequestRetryCount()