TokenResult

java.lang.Object
- com.vmware.oauth2.TokenResult

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class TokenResult
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
The TokenResult class contains data that represents successful access-token response as defined in RFC 6749 and extended in RFC 8693. This class was added in vSphere API 8.0.3.0.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TokenResult.Builder
Builder class for TokenResult.

Nested Classes
Modifier and Type	Class and Description
`static class`	`TokenResult.Builder` Builder class for `TokenResult`.

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`BEARER_TOKEN_METHOD_TYPE` Constant field indicating that the security token is a bearer token.

Constructor Summary

Constructors
Modifier Constructor and Description

TokenResult()
Default constructor.

protected TokenResult(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`TokenResult()` Default constructor.
`protected`	`TokenResult(com.vmware.vapi.data.StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends com.vmware.vapi.bindings.Structure> T`	`_convertTo(java.lang.Class<T> clazz)`
`java.lang.String`	`_getCanonicalName()`
`static java.lang.String`	`_getCanonicalTypeName()` Returns the canonical type name.
`static com.vmware.vapi.bindings.type.StructType`	`_getClassType()` WARNING: Internal method, subject to change in future versions.
`com.vmware.vapi.data.StructValue`	`_getDataValue()`
`com.vmware.vapi.data.DataValue`	`_getDynamicField(java.lang.String fieldName)`
`java.util.Set<java.lang.String>`	`_getDynamicFieldNames()`
`com.vmware.vapi.bindings.type.StructType`	`_getType()`
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)`
`static TokenResult`	`_newInstance(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
`static TokenResult`	`_newInstance2(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`void`	`_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)`
`protected void`	`_updateDataValue(com.vmware.vapi.data.StructValue structValue)`
`void`	`_validate()`
`boolean`	`equals(java.lang.Object obj)`
`char[]`	`getAccessToken()` The access token issued by the authorization server.
`java.lang.Long`	`getExpiresIn()` The validity lifetime, in seconds, of the token issued by the server.
`java.lang.String`	`getIssuedTokenType()` An identifier which indicates the type of the access token in the `getAccessToken()` property.
`char[]`	`getRefreshToken()` The refresh token, which can be used to obtain new access tokens.
`java.lang.String`	`getScope()` Scope of the issued access token.
`java.lang.String`	`getTokenType()` A case-insensitive value specifying the method of using the access token issued.
`int`	`hashCode()`
`void`	`setAccessToken(char[] accessToken)` The access token issued by the authorization server.
`void`	`setExpiresIn(java.lang.Long expiresIn)` The validity lifetime, in seconds, of the token issued by the server.
`void`	`setIssuedTokenType(java.lang.String issuedTokenType)` An identifier which indicates the type of the access token in the `getAccessToken()` property.
`void`	`setRefreshToken(char[] refreshToken)` The refresh token, which can be used to obtain new access tokens.
`void`	`setScope(java.lang.String scope)` Scope of the issued access token.
`void`	`setTokenType(java.lang.String tokenType)` A case-insensitive value specifying the method of using the access token issued.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - BEARER_TOKEN_METHOD_TYPE
```
public static final java.lang.String BEARER_TOKEN_METHOD_TYPE
```
    Constant field indicating that the security token is a bearer token. This constant field was added in vSphere API 8.0.3.0.
    
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - TokenResult
```
public TokenResult()
```
    Default constructor.
  - TokenResult
```
protected TokenResult(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getAccessToken
```
public char[] getAccessToken()
```
    The access token issued by the authorization server. This property was added in vSphere API 8.0.3.0.
    
    Returns:
    
    The current value of the property.
  - setAccessToken
```
public void setAccessToken(char[] accessToken)
```
    The access token issued by the authorization server. This property was added in vSphere API 8.0.3.0.
    
    Parameters:
    
    accessToken - New value for the property.
  - getTokenType
```
public java.lang.String getTokenType()
```
    A case-insensitive value specifying the method of using the access token issued. This property was added in vSphere API 8.0.3.0.
    
    Returns:
    
    The current value of the property.
  - setTokenType
```
public void setTokenType(java.lang.String tokenType)
```
    A case-insensitive value specifying the method of using the access token issued. This property was added in vSphere API 8.0.3.0.
    
    Parameters:
    
    tokenType - New value for the property.
  - getExpiresIn
```
public java.lang.Long getExpiresIn()
```
    The validity lifetime, in seconds, of the token issued by the server. This property was added in vSphere API 8.0.3.0. null if not applicable for issued token.
    
    Returns:
    
    The current value of the property.
  - setExpiresIn
```
public void setExpiresIn(java.lang.Long expiresIn)
```
    The validity lifetime, in seconds, of the token issued by the server. This property was added in vSphere API 8.0.3.0. null if not applicable for issued token.
    
    Parameters:
    
    expiresIn - New value for the property.
  - getScope
```
public java.lang.String getScope()
```
    Scope of the issued access token.
    The value of the scope parameter is expressed as a list of space- delimited, case-sensitive strings. The strings are defined by the authorization server. If the value contains multiple space-delimited strings, their order does not matter, and each string adds an additional access range to the requested scope.
    . This property was added in vSphere API 8.0.3.0. null if the scope of the issued security token is identical to the scope requested by the client.
    
    Returns:
    
    The current value of the property.
  - setScope
```
public void setScope(java.lang.String scope)
```
    Scope of the issued access token.
    The value of the scope parameter is expressed as a list of space- delimited, case-sensitive strings. The strings are defined by the authorization server. If the value contains multiple space-delimited strings, their order does not matter, and each string adds an additional access range to the requested scope.
    . This property was added in vSphere API 8.0.3.0. null if the scope of the issued security token is identical to the scope requested by the client.
    
    Parameters:
    
    scope - New value for the property.
  - getRefreshToken
```
public char[] getRefreshToken()
```
    The refresh token, which can be used to obtain new access tokens. This property was added in vSphere API 8.0.3.0. null if not applicable to the specific request.
    
    Returns:
    
    The current value of the property.
  - setRefreshToken
```
public void setRefreshToken(char[] refreshToken)
```
    The refresh token, which can be used to obtain new access tokens. This property was added in vSphere API 8.0.3.0. null if not applicable to the specific request.
    
    Parameters:
    
    refreshToken - New value for the property.
  - getIssuedTokenType
```
public java.lang.String getIssuedTokenType()
```
    An identifier which indicates the type of the access token in the getAccessToken() property. This property was added in vSphere API 8.0.3.0. null if not the result of a token-exchange invocation; otherwise, required.
    
    Returns:
    
    The current value of the property.
  - setIssuedTokenType
```
public void setIssuedTokenType(java.lang.String issuedTokenType)
```
    An identifier which indicates the type of the access token in the getAccessToken() property. This property was added in vSphere API 8.0.3.0. null if not the result of a token-exchange invocation; otherwise, required.
    
    Parameters:
    
    issuedTokenType - New value for the property.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Specified by:
    
    _getType in interface com.vmware.vapi.bindings.StaticStructure
  - _getDataValue
```
public com.vmware.vapi.data.StructValue _getDataValue()
```
    Specified by:
    
    _getDataValue in interface com.vmware.vapi.bindings.Structure
  - _updateDataValue
```
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Specified by:
    
    _validate in interface com.vmware.vapi.bindings.StaticStructure
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface com.vmware.vapi.bindings.StaticStructure
    
    Overrides:
    
    toString in class java.lang.Object
  - _hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
```
    Specified by:
    
    _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure
  - _convertTo
```
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
```
    Specified by:
    
    _convertTo in interface com.vmware.vapi.bindings.Structure
  - _setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)
```
    Specified by:
    
    _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicField
```
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
```
    Specified by:
    
    _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
    Specified by:
    
    _getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure
  - _getClassType
```
public static com.vmware.vapi.bindings.type.StructType _getClassType()
```
    WARNING: Internal method, subject to change in future versions.
    
    Returns:
    
    StructType instance representing the static bindings type for this Structure.
  - _getCanonicalName
```
public java.lang.String _getCanonicalName()
```
    Specified by:
    
    _getCanonicalName in interface com.vmware.vapi.bindings.Structure
  - _getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
    Returns the canonical type name. See _getCanonicalName().
    
    Returns:
    
    canonical type name
  - _newInstance
```
public static TokenResult _newInstance(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Returns new instance of this binding class and injects the provided data value.
    WARNING: The returned object is not fully initialized.
    
    Parameters:
    
    structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.
    
    Returns:
    
    the static bindings StructType
  - _newInstance2
```
public static TokenResult _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class TokenResult

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BEARER_TOKEN_METHOD_TYPE

__dynamicStructureFields

Constructor Detail

TokenResult

TokenResult

Method Detail

getAccessToken

setAccessToken

getTokenType

setTokenType

getExpiresIn

setExpiresIn

getScope

setScope

getRefreshToken

setRefreshToken

getIssuedTokenType

setIssuedTokenType

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2