com.vmware.vcenter.authentication

Class TokenStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.authentication.TokenStub

All Implemented Interfaces:

Service, Token, TokenTypes

public class TokenStub
extends com.vmware.vapi.internal.bindings.Stub
implements Token

Remote stub implementation of the Token API service.

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.authentication.TokenTypes

TokenTypes.IssueSpec

Field Summary

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

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.vcenter.authentication.TokenTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
TokenInfo	issue(TokenTypes.IssueSpec spec) Provides a token endpoint as defined in RFC 6749.
void	issue(TokenTypes.IssueSpec spec, AsyncCallback<TokenInfo> asyncCallback) Provides a token endpoint as defined in RFC 6749.
void	issue(TokenTypes.IssueSpec spec, AsyncCallback<TokenInfo> asyncCallback, InvocationConfig invocationConfig) Provides a token endpoint as defined in RFC 6749.
TokenInfo	issue(TokenTypes.IssueSpec spec, InvocationConfig invocationConfig) Provides a token endpoint as defined in RFC 6749.

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

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenStub

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

TokenStub

public TokenStub(ApiProvider apiProvider,
                 StubConfigurationBase config)

Method Detail

issue

public TokenInfo issue(TokenTypes.IssueSpec spec)

Description copied from interface: Token

Provides a token endpoint as defined in RFC 6749.

Supported grant types:

• urn:ietf:params:oauth:grant-type:token-exchange - Exchanges incoming token based on the spec and current client authorization data.

This method supercedes com.vmware.vcenter.tokenservice.TokenExchange#exchange. The REST rendering of the newer operation matches RFC8693's definition for both input and output of the method.

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

Specified by:

issue in interface Token

Parameters:

spec - IssueSpec class containing arguments that define the exchange process.

Returns:

TokenInfo class that contains a newly issued token.

issue

public TokenInfo issue(TokenTypes.IssueSpec spec,
                       InvocationConfig invocationConfig)

Description copied from interface: Token

Provides a token endpoint as defined in RFC 6749.

Supported grant types:

• urn:ietf:params:oauth:grant-type:token-exchange - Exchanges incoming token based on the spec and current client authorization data.

This method supercedes com.vmware.vcenter.tokenservice.TokenExchange#exchange. The REST rendering of the newer operation matches RFC8693's definition for both input and output of the method.

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:

issue in interface Token

Parameters:

spec - IssueSpec class containing arguments that define the exchange process.

invocationConfig - Configuration for the method invocation.

Returns:

TokenInfo class that contains a newly issued token.

issue

public void issue(TokenTypes.IssueSpec spec,
                  AsyncCallback<TokenInfo> asyncCallback)

Description copied from interface: Token

Provides a token endpoint as defined in RFC 6749.

Supported grant types:

• urn:ietf:params:oauth:grant-type:token-exchange - Exchanges incoming token based on the spec and current client authorization data.

This method supercedes com.vmware.vcenter.tokenservice.TokenExchange#exchange. The REST rendering of the newer operation matches RFC8693's definition for both input and output of the method.

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

Invocation Result:
TokenInfo class that contains a newly issued token.

Operation Errors:
InvalidRequest - if TokenTypes.IssueSpec is missing a required property, includes an unsupported property value (other than TokenTypes.IssueSpec.getGrantType()).
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 TokenTypes.IssueSpec.getResource() or TokenTypes.IssueSpec.getAudience() properties.

Specified by:

issue in interface Token

Parameters:

spec - IssueSpec class containing arguments that define the exchange process.

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

issue

public void issue(TokenTypes.IssueSpec spec,
                  AsyncCallback<TokenInfo> asyncCallback,
                  InvocationConfig invocationConfig)

Description copied from interface: Token

Provides a token endpoint as defined in RFC 6749.

Supported grant types:

• urn:ietf:params:oauth:grant-type:token-exchange - Exchanges incoming token based on the spec and current client authorization data.

This method supercedes com.vmware.vcenter.tokenservice.TokenExchange#exchange. The REST rendering of the newer operation matches RFC8693's definition for both input and output of the method.

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:
TokenInfo class that contains a newly issued token.

Operation Errors:
InvalidRequest - if TokenTypes.IssueSpec is missing a required property, includes an unsupported property value (other than TokenTypes.IssueSpec.getGrantType()).
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 TokenTypes.IssueSpec.getResource() or TokenTypes.IssueSpec.getAudience() properties.

Specified by:

issue in interface Token

Parameters:

spec - IssueSpec class containing arguments that define the exchange process.

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

invocationConfig - Configuration for the method invocation.