com.hpe.adm.nga.sdk.authentication

Class Authentication

java.lang.Object

com.hpe.adm.nga.sdk.authentication.Authentication

Direct Known Subclasses:

BasicAuthentication, JSONAuthentication

public abstract class Authentication
extends Object

Interface of Authentication , hold contract functions.
Provided implementations: SimpleUserAuthentication, SimpleClientAuthentication, SimpleBasicAuthentication
Note that the default implementations keep the credentials in memory.

Method Summary

Modifier and Type	Method and Description
Optional<APIMode>	getAPIMode() Returns the API Mode header that is added to all calls to the REST API.
boolean	isBasicAuthentication() Returns whether this authentication type supports basic authentication

Methods inherited from class java.lang.Object

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

Method Detail

getAPIMode

public final Optional<APIMode> getAPIMode()

Returns the API Mode header that is added to all calls to the REST API. This usually refers to whether this should use the technical preview or not (however other non-documented modes are possible) See the REST API documentation for further information This will only be used if it is non-empty

Returns:

The API mode header. If none is sent then this should be null

isBasicAuthentication

public final boolean isBasicAuthentication()

Returns whether this authentication type supports basic authentication

Returns:

Supports basic authentication