com.vmware.vcloud.api.rest.client

Class VcdMultisiteLoginCredentials

java.lang.Object

com.vmware.vcloud.api.rest.client.VcdMultisiteLoginCredentials

All Implemented Interfaces:

ClientCredentials

public class VcdMultisiteLoginCredentials
extends Object
implements ClientCredentials

Certificate based credentials for signing the body of a multisite request. Unlike most ClientCredentials, the credentials here are inserted by the MultisiteAuthorizationFilter when we also know the body of the message. Signature string created in partial compliance with https://tools.ietf.org/html/draft-cavage-http-signatures-06 Steps for signature:\n 1. During creation of the request getHeaderValue() is used to add to the Authorization header.\n 2. When sending the request, the MultisiteAuthorizationFilter intercepts the request. 3. The authorization header is crafted using {@link #createMultisiteAuthorizationHeader(String, String, String, String, byte[]) and inserted by the filter.

Since:

8.22

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTH_TYPE
static String	MULTISITE_BASIC_AUTH_HEADER_TEMPLATE
static String	MULTISITE_BASIC_AUTH_USERORG_TEMPLATE
static String	MULTISITE_SSO_AUTH_HEADER_TEMPLATE

Constructor Summary

Constructors

Constructor and Description
VcdMultisiteLoginCredentials(UUID localSiteId, UUID localOrgId, String ssoCredentials, String pemEncodedKey) Construct the multisite credentials with the key to sign with and the SSO credentials of the user the multisite request is made on behalf of
VcdMultisiteLoginCredentials(UUID localSiteId, UUID localOrgId, String userName, String orgName, String pemEncodedKey) Construct the multisite credentials with the key to sign with and basic credentials of the user the multisite request is made on behalf of

Method Summary

Modifier and Type	Method and Description
String	createMultisiteAuthorizationHeader(String date, String method, String path, byte[] contentBytes) Create the multisite authorization header from the provided information
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

Field Detail

AUTH_TYPE

public static final String AUTH_TYPE

See Also:

Constant Field Values

MULTISITE_BASIC_AUTH_HEADER_TEMPLATE

public static final String MULTISITE_BASIC_AUTH_HEADER_TEMPLATE

See Also:

Constant Field Values

MULTISITE_SSO_AUTH_HEADER_TEMPLATE

public static final String MULTISITE_SSO_AUTH_HEADER_TEMPLATE

See Also:

Constant Field Values

MULTISITE_BASIC_AUTH_USERORG_TEMPLATE

public static final String MULTISITE_BASIC_AUTH_USERORG_TEMPLATE

See Also:

Constant Field Values

Constructor Detail

VcdMultisiteLoginCredentials

public VcdMultisiteLoginCredentials(UUID localSiteId,
                                    UUID localOrgId,
                                    String userName,
                                    String orgName,
                                    String pemEncodedKey)
                             throws IOException

Construct the multisite credentials with the key to sign with and basic credentials of the user the multisite request is made on behalf of

Parameters:

localSiteId - local site UUID

localOrgId - local Org UUID

userName - UserName to login with

orgName - org to log into

privateKey - Private key to sign the contents with

Throws:

IOException

VcdMultisiteLoginCredentials

public VcdMultisiteLoginCredentials(UUID localSiteId,
                                    UUID localOrgId,
                                    String ssoCredentials,
                                    String pemEncodedKey)
                             throws IOException

Construct the multisite credentials with the key to sign with and the SSO credentials of the user the multisite request is made on behalf of

Parameters:

localSiteId - local site UUID

localOrgId - local Org UUID

ssoCredentials - User sso credentials for whom the multi-site request is being made

privateKey - Private key to sign the contents with

Throws:

IOException

Method Detail

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

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

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

createMultisiteAuthorizationHeader

public String createMultisiteAuthorizationHeader(String date,
                                                 String method,
                                                 String path,
                                                 byte[] contentBytes)

Create the multisite authorization header from the provided information

Parameters:

date - Current date in RFC_1123_DATE_TIME format

method - Rest method

path - path of the request (e.g. '/cloud/org')

host - Destination of the request

contentBytes - Byte array of the content

Returns:

Authorization header string