com.vmware.vcloud.api.rest.client

Class VcdBasicLoginCredentials

java.lang.Object

com.vmware.vcloud.api.rest.client.VcdBasicLoginCredentials

All Implemented Interfaces:

ClientCredentials

public class VcdBasicLoginCredentials
extends Object
implements ClientCredentials

Username@Org/password Credentials suitable for use in authenticating with a vCD server using the vCloud API

Constructor Summary

Constructors

Constructor and Description
VcdBasicLoginCredentials(String userNameAtOrg, String password) Construct credentials from a valid vCD organization qualified username (username@orgname) and a password.
VcdBasicLoginCredentials(String userName, String orgName, String password) Construct credentials from a valid vCD user and org names and a password.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
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()
int	hashCode()
boolean	supportsSessionless() Indicates whether the ClientCredentials supports session-less requests.

Methods inherited from class java.lang.Object

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

Constructor Detail

VcdBasicLoginCredentials

public VcdBasicLoginCredentials(String userNameAtOrg,
                                String password)

Construct credentials from a valid vCD organization qualified username (username@orgname) and a password.

VcdBasicLoginCredentials

public VcdBasicLoginCredentials(String userName,
                                String orgName,
                                String password)

Construct credentials from a valid vCD user and org names and a password.

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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