com.vmware.vcenter.tokenservice

Class TokenExchangeStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.tokenservice.TokenExchangeStub

All Implemented Interfaces:

Service, TokenExchange, TokenExchangeTypes

public class TokenExchangeStub
extends com.vmware.vapi.internal.bindings.Stub
implements TokenExchange

Remote stub implementation of the TokenExchange API service.

WARNING: Internal class, subject to change in future versions.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.tokenservice.TokenExchangeTypes

TokenExchangeTypes.ExchangeSpec, TokenExchangeTypes.Info

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, securityContext

Fields inherited from interface com.vmware.vcenter.tokenservice.TokenExchangeTypes

_VAPI_SERVICE_ID, ACCESS_TOKEN_TYPE, BEARER_TOKEN_METHOD_TYPE, ID_TOKEN_TYPE, N_A_TOKEN_METHOD_TYPE, REFRESH_TOKEN_TYPE, SAML1_TOKEN_TYPE, SAML2_TOKEN_TYPE, TOKEN_EXCHANGE_GRANT

Constructor Summary

Constructors

Constructor and Description
TokenExchangeStub(ApiProvider apiProvider, StubConfigurationBase config)
TokenExchangeStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)

Method Summary

Methods

Modifier and Type	Method and Description
TokenExchangeTypes.Info	exchange(TokenExchangeTypes.ExchangeSpec spec) Exchanges incoming token based on the spec and current client authorization data.
void	exchange(TokenExchangeTypes.ExchangeSpec spec, AsyncCallback<TokenExchangeTypes.Info> asyncCallback) Exchanges incoming token based on the spec and current client authorization data.
void	exchange(TokenExchangeTypes.ExchangeSpec spec, AsyncCallback<TokenExchangeTypes.Info> asyncCallback, InvocationConfig invocationConfig) Exchanges incoming token based on the spec and current client authorization data.
TokenExchangeTypes.Info	exchange(TokenExchangeTypes.ExchangeSpec spec, InvocationConfig invocationConfig) Exchanges incoming token based on the spec and current client authorization data.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenExchangeStub

public TokenExchangeStub(ApiProvider apiProvider,
                 com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                 StubConfigurationBase config)

TokenExchangeStub

public TokenExchangeStub(ApiProvider apiProvider,
                 StubConfigurationBase config)

Method Detail

exchange

public TokenExchangeTypes.Info exchange(TokenExchangeTypes.ExchangeSpec spec)

Description copied from interface: TokenExchange

Exchanges incoming token based on the spec and current client authorization data. Warning: This method is available as technical preview. It may be changed in a future release.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Specified by:

exchange in interface TokenExchange

Parameters:

spec - ExchangeSpec class contains arguments that define exchange process.

Returns:

TokenExchangeTypes.Info class that contains new token.

exchange

public TokenExchangeTypes.Info exchange(TokenExchangeTypes.ExchangeSpec spec,
                               InvocationConfig invocationConfig)

Description copied from interface: TokenExchange

Exchanges incoming token based on the spec and current client authorization data. Warning: This method is available as technical preview. It may be changed in a future release.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

exchange in interface TokenExchange

Parameters:

spec - ExchangeSpec class contains arguments that define exchange process.

invocationConfig - Configuration for the method invocation.

Returns:

TokenExchangeTypes.Info class that contains new token.

exchange

public void exchange(TokenExchangeTypes.ExchangeSpec spec,
            AsyncCallback<TokenExchangeTypes.Info> asyncCallback)

Description copied from interface: TokenExchange

Exchanges incoming token based on the spec and current client authorization data. Warning: This method is available as technical preview. It may be changed in a future release.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
TokenExchangeTypes.Info class that contains new token.

Operation Errors:
InvalidGrant - provided authorization grant (e.g., authorization code, resource owner credentials) or refresh token is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client.
InvalidScope - If the server is unwilling or unable to issue a token for all the target services indicated by the TokenExchangeTypes.ExchangeSpec.getResource() or TokenExchangeTypes.ExchangeSpec.getAudience() parameters.
Unauthorized - if authorization is not given to a caller.

Specified by:

exchange in interface TokenExchange

Parameters:

spec - ExchangeSpec class contains arguments that define exchange process.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

exchange

public void exchange(TokenExchangeTypes.ExchangeSpec spec,
            AsyncCallback<TokenExchangeTypes.Info> asyncCallback,
            InvocationConfig invocationConfig)

Description copied from interface: TokenExchange

Exchanges incoming token based on the spec and current client authorization data. Warning: This method is available as technical preview. It may be changed in a future release.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
TokenExchangeTypes.Info class that contains new token.

Operation Errors:
InvalidGrant - provided authorization grant (e.g., authorization code, resource owner credentials) or refresh token is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client.
InvalidScope - If the server is unwilling or unable to issue a token for all the target services indicated by the TokenExchangeTypes.ExchangeSpec.getResource() or TokenExchangeTypes.ExchangeSpec.getAudience() parameters.
Unauthorized - if authorization is not given to a caller.

Specified by:

exchange in interface TokenExchange

Parameters:

spec - ExchangeSpec class contains arguments that define exchange process.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.