com.vmware.vcenter.tokenservice

Class TokenExchangeTypes.ExchangeSpec.Builder

java.lang.Object

com.vmware.vcenter.tokenservice.TokenExchangeTypes.ExchangeSpec.Builder

Enclosing class:

TokenExchangeTypes.ExchangeSpec

public static final class TokenExchangeTypes.ExchangeSpec.Builder
extends java.lang.Object

Builder class for TokenExchangeTypes.ExchangeSpec.

Constructor Summary

Constructors

Constructor and Description
Builder(java.lang.String grantType, java.lang.String subjectToken, java.lang.String subjectTokenType) Constructor with parameters for the required properties of TokenExchangeTypes.ExchangeSpec.

Method Summary

Modifier and Type	Method and Description
TokenExchangeTypes.ExchangeSpec	build()
TokenExchangeTypes.ExchangeSpec.Builder	setActorToken(java.lang.String actorToken) A security token that represents the identity of the acting party.
TokenExchangeTypes.ExchangeSpec.Builder	setActorTokenType(java.lang.String actorTokenType) An identifier, that indicates the type of the security token in the TokenExchangeTypes.ExchangeSpec.getActorToken() parameter.
TokenExchangeTypes.ExchangeSpec.Builder	setAudience(java.lang.String audience) The logical name of the target service where the client intends to use the requested security token.
TokenExchangeTypes.ExchangeSpec.Builder	setRequestedTokenType(java.lang.String requestedTokenType) An identifier for the type of the requested security token.
TokenExchangeTypes.ExchangeSpec.Builder	setResource(java.lang.String resource) Indicates the location of the target service or resource where the client intends to use the requested security token.
TokenExchangeTypes.ExchangeSpec.Builder	setScope(java.lang.String scope) A list of space-delimited, case-sensitive strings, that allow the client to specify the desired scope of the requested security token in the context of the service or resource where the token will be used.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(java.lang.String grantType,
               java.lang.String subjectToken,
               java.lang.String subjectTokenType)

Constructor with parameters for the required properties of TokenExchangeTypes.ExchangeSpec.

Method Detail

setResource

public TokenExchangeTypes.ExchangeSpec.Builder setResource(java.lang.String resource)

Indicates the location of the target service or resource where the client intends to use the requested security token. if can be inferred from other arguments or not needed for specific case of exchange.

Parameters:

resource - New value for the property.

setAudience

public TokenExchangeTypes.ExchangeSpec.Builder setAudience(java.lang.String audience)

The logical name of the target service where the client intends to use the requested security token. This serves a purpose similar to the TokenExchangeTypes.ExchangeSpec.getResource() parameter, but with the client providing a logical name rather than a location. if can be inferred from other arguments or not needed for specific case of exchange.

Parameters:

audience - New value for the property.

setScope

public TokenExchangeTypes.ExchangeSpec.Builder setScope(java.lang.String scope)

A list of space-delimited, case-sensitive strings, that allow the client to specify the desired scope of the requested security token in the context of the service or resource where the token will be used. if can be inferred from other arguments or not needed for specific case of exchange.

Parameters:

scope - New value for the property.

setRequestedTokenType

public TokenExchangeTypes.ExchangeSpec.Builder setRequestedTokenType(java.lang.String requestedTokenType)

An identifier for the type of the requested security token. If the requested type is unspecified, the issued token type is at the discretion of the server and may be dictated by knowledge of the requirements of the service or resource indicated by the TokenExchangeTypes.ExchangeSpec.getResource() or TokenExchangeTypes.ExchangeSpec.getAudience() parameter. if can be inferred from other arguments or not needed for specific case of exchange.

Parameters:

requestedTokenType - New value for the property.

setActorToken

public TokenExchangeTypes.ExchangeSpec.Builder setActorToken(java.lang.String actorToken)

A security token that represents the identity of the acting party. Typically, this will be the party that is authorized to use the requested security token and act on behalf of the subject. if not needed for specific case of exchange.

Parameters:

actorToken - New value for the property.

setActorTokenType

public TokenExchangeTypes.ExchangeSpec.Builder setActorTokenType(java.lang.String actorTokenType)

An identifier, that indicates the type of the security token in the TokenExchangeTypes.ExchangeSpec.getActorToken() parameter. if TokenExchangeTypes.ExchangeSpec.getActorToken() parameter is not present.

Parameters:

actorTokenType - New value for the property.

build

public TokenExchangeTypes.ExchangeSpec build()