com.vmware.vcloud.api.rest.client

Class VcdSignLoginCredentials

java.lang.Object

com.vmware.vcloud.api.rest.client.VcdSignLoginCredentials

All Implemented Interfaces:

ClientCredentials

public class VcdSignLoginCredentials
extends Object
implements ClientCredentials

Saml Token/Org-name credentials suitable for use in authenticating with a vCD server using the vCloud API

Since:

5.6

Constructor Summary

Constructors

Constructor and Description
VcdSignLoginCredentials(String samlBearerTokenXml, String org) Construct a ClientCredentials object to generate vCD custom format SIGN Authentication header for login message to login into the specified org using the provided bearer token.
VcdSignLoginCredentials(String samlHokTokenXml, String org, PrivateKey privateKey) Construct a ClientCredentials object to generate vCD custom format SIGN Authentication header for login message to login into the specified org using the provided Holder-of-Key token and its signature generated using the specified private key.

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

VcdSignLoginCredentials

public VcdSignLoginCredentials(String samlBearerTokenXml,
                               String org)

Construct a ClientCredentials object to generate vCD custom format SIGN Authentication header for login message to login into the specified org using the provided bearer token.

Parameters:

samlBearerTokenXml - Bearer Token in xml format to be used to login.

org - The organization to log into using the specified token.

VcdSignLoginCredentials

public VcdSignLoginCredentials(String samlHokTokenXml,
                               String org,
                               PrivateKey privateKey)
                        throws GeneralSecurityException

Construct a ClientCredentials object to generate vCD custom format SIGN Authentication header for login message to login into the specified org using the provided Holder-of-Key token and its signature generated using the specified private key.

Parameters:

samlHokTokenXml - Holder-of-Key Token in xml format to be used to login.

org - The organization to log into using the specified token.

privateKey - PrivateKey to sign the token with. Signature is generated using algorithm.

Throws:

GeneralSecurityException - if there is a problem generating the signature.

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