com.vmware.vcloud.api.rest.client

Class VcdBearerLoginCredentials

java.lang.Object

com.vmware.vcloud.api.rest.client.VcdBearerLoginCredentials

All Implemented Interfaces:

ClientCredentials

public final class VcdBearerLoginCredentials
extends Object
implements ClientCredentials

Bearer Token credentials suitable for use in authenticating with a vCD server using the vCloud API.

Since:

9.0

Constructor Summary

Constructors

Constructor and Description
VcdBearerLoginCredentials(String oAuthBearerToken, String org) Construct a VcdBearerLoginCredentials object using an OAuth Bearer token and VCD org name

Method Summary

Modifier and Type	Method and Description
String	getHeaderName() Returns the name of the HTTP header used for authentication in a REST request
String	getHeaderValue() Renders client authentication credentials in a form suitable to be used as the value in a header whose name is returned by ClientCredentials.getHeaderName()
boolean	supportsSessionless() Indicates whether the ClientCredentials supports session-less requests.

Methods inherited from class java.lang.Object

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

Constructor Detail

VcdBearerLoginCredentials

public VcdBearerLoginCredentials(String oAuthBearerToken,
                                 String org)

Construct a VcdBearerLoginCredentials object using an OAuth Bearer token and VCD org name

Parameters:

oAuthBearerToken - Bearer Token supplied by an OAuth IDP

org - The VCD organization name.

Method Detail

getHeaderValue

public String getHeaderValue()

Description copied from interface: ClientCredentials

Renders client authentication credentials in a form suitable to be used as the value in a header whose name is returned by ClientCredentials.getHeaderName()

Specified by:

getHeaderValue in interface ClientCredentials

getHeaderName

public String getHeaderName()

Description copied from interface: ClientCredentials

Returns the name of the HTTP header used for authentication in a REST request

Specified by:

getHeaderName in interface ClientCredentials

supportsSessionless

public boolean supportsSessionless()

Description copied from interface: ClientCredentials

Indicates whether the ClientCredentials supports session-less requests. No explicit login is required for session-less ClientCredentials.

Specified by:

supportsSessionless in interface ClientCredentials

Returns:

true if ClientCredentials supports session-less requests