Package com.vmware.nsx.trust_management

Interface TokenPrincipalIdentities

All Superinterfaces:

com.vmware.vapi.bindings.Service, TokenPrincipalIdentitiesTypes

All Known Implementing Classes:

TokenPrincipalIdentitiesStub

public interface TokenPrincipalIdentities
extends com.vmware.vapi.bindings.Service, TokenPrincipalIdentitiesTypes

Field Summary

Fields inherited from interface com.vmware.nsx.trust_management.TokenPrincipalIdentitiesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method	Description
TokenBasedPrincipalIdentity	create(TokenBasedPrincipalIdentity tokenBasedPrincipalIdentity)	Register a principal identity that is going to be authenticated through a token.
void	create(TokenBasedPrincipalIdentity tokenBasedPrincipalIdentity, com.vmware.vapi.bindings.client.AsyncCallback<TokenBasedPrincipalIdentity> asyncCallback)	Register a principal identity that is going to be authenticated through a token.
void	create(TokenBasedPrincipalIdentity tokenBasedPrincipalIdentity, com.vmware.vapi.bindings.client.AsyncCallback<TokenBasedPrincipalIdentity> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Register a principal identity that is going to be authenticated through a token.
TokenBasedPrincipalIdentity	create(TokenBasedPrincipalIdentity tokenBasedPrincipalIdentity, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Register a principal identity that is going to be authenticated through a token.
void	delete(java.lang.String principalIdentityId)	Delete a token-based principal identity.
void	delete(java.lang.String principalIdentityId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)	Delete a token-based principal identity.
void	delete(java.lang.String principalIdentityId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Delete a token-based principal identity.
void	delete(java.lang.String principalIdentityId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Delete a token-based principal identity.
TokenBasedPrincipalIdentity	get(java.lang.String principalIdentityId)	Get a stored token-based principal identity
void	get(java.lang.String principalIdentityId, com.vmware.vapi.bindings.client.AsyncCallback<TokenBasedPrincipalIdentity> asyncCallback)	Get a stored token-based principal identity
void	get(java.lang.String principalIdentityId, com.vmware.vapi.bindings.client.AsyncCallback<TokenBasedPrincipalIdentity> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Get a stored token-based principal identity
TokenBasedPrincipalIdentity	get(java.lang.String principalIdentityId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Get a stored token-based principal identity
TokenBasedPrincipalIdentityListResult	list()	Return the list of token-based principal identities.
void	list(com.vmware.vapi.bindings.client.AsyncCallback<TokenBasedPrincipalIdentityListResult> asyncCallback)	Return the list of token-based principal identities.
void	list(com.vmware.vapi.bindings.client.AsyncCallback<TokenBasedPrincipalIdentityListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Return the list of token-based principal identities.
TokenBasedPrincipalIdentityListResult	list(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Return the list of token-based principal identities.

Method Detail

create

TokenBasedPrincipalIdentity create(TokenBasedPrincipalIdentity tokenBasedPrincipalIdentity)

Register a principal identity that is going to be authenticated through a token. The combination name and node_id needs to be unique across token-based and certificate-based principal identities.

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

Parameters:

tokenBasedPrincipalIdentity - (required)

Returns:

com.vmware.nsx.model.TokenBasedPrincipalIdentity

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

create

TokenBasedPrincipalIdentity create(TokenBasedPrincipalIdentity tokenBasedPrincipalIdentity,
                                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Register a principal identity that is going to be authenticated through a token. The combination name and node_id needs to be unique across token-based and certificate-based principal identities.

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

Parameters:

tokenBasedPrincipalIdentity - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.TokenBasedPrincipalIdentity

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

create

void create(TokenBasedPrincipalIdentity tokenBasedPrincipalIdentity,
            com.vmware.vapi.bindings.client.AsyncCallback<TokenBasedPrincipalIdentity> asyncCallback)

Register a principal identity that is going to be authenticated through a token. The combination name and node_id needs to be unique across token-based and certificate-based principal identities.

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

Invocation Result:
com.vmware.nsx.model.TokenBasedPrincipalIdentity

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

tokenBasedPrincipalIdentity - (required)

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

create

void create(TokenBasedPrincipalIdentity tokenBasedPrincipalIdentity,
            com.vmware.vapi.bindings.client.AsyncCallback<TokenBasedPrincipalIdentity> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Register a principal identity that is going to be authenticated through a token. The combination name and node_id needs to be unique across token-based and certificate-based principal identities.

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:
com.vmware.nsx.model.TokenBasedPrincipalIdentity

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

tokenBasedPrincipalIdentity - (required)

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String principalIdentityId)

Delete a token-based principal identity.

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

Parameters:

principalIdentityId - Unique id of the token-based principal identity to delete (required)

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

delete

void delete(java.lang.String principalIdentityId,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Delete a token-based principal identity.

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

Parameters:

principalIdentityId - Unique id of the token-based principal identity to delete (required)

invocationConfig - Configuration for the method invocation.

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

delete

void delete(java.lang.String principalIdentityId,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Delete a token-based principal identity.

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

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

principalIdentityId - Unique id of the token-based principal identity to delete (required)

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

delete

void delete(java.lang.String principalIdentityId,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Delete a token-based principal identity.

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

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

principalIdentityId - Unique id of the token-based principal identity to delete (required)

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

invocationConfig - Configuration for the method invocation.

get

TokenBasedPrincipalIdentity get(java.lang.String principalIdentityId)

Get a stored token-based principal identity

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

Parameters:

principalIdentityId - ID of the principal identity to get (required)

Returns:

com.vmware.nsx.model.TokenBasedPrincipalIdentity

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

TokenBasedPrincipalIdentity get(java.lang.String principalIdentityId,
                                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get a stored token-based principal identity

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

Parameters:

principalIdentityId - ID of the principal identity to get (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.TokenBasedPrincipalIdentity

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

void get(java.lang.String principalIdentityId,
         com.vmware.vapi.bindings.client.AsyncCallback<TokenBasedPrincipalIdentity> asyncCallback)

Get a stored token-based principal identity

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

Invocation Result:
com.vmware.nsx.model.TokenBasedPrincipalIdentity

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

principalIdentityId - ID of the principal identity to get (required)

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

get

void get(java.lang.String principalIdentityId,
         com.vmware.vapi.bindings.client.AsyncCallback<TokenBasedPrincipalIdentity> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get a stored token-based principal identity

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:
com.vmware.nsx.model.TokenBasedPrincipalIdentity

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

principalIdentityId - ID of the principal identity to get (required)

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

invocationConfig - Configuration for the method invocation.

list

TokenBasedPrincipalIdentityListResult list()

Return the list of token-based principal identities. | These don't have certificate or role information.

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

Returns:

com.vmware.nsx.model.TokenBasedPrincipalIdentityListResult

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

TokenBasedPrincipalIdentityListResult list(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Return the list of token-based principal identities. | These don't have certificate or role information.

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

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.TokenBasedPrincipalIdentityListResult

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

void list(com.vmware.vapi.bindings.client.AsyncCallback<TokenBasedPrincipalIdentityListResult> asyncCallback)

Return the list of token-based principal identities. | These don't have certificate or role information.

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

Invocation Result:
com.vmware.nsx.model.TokenBasedPrincipalIdentityListResult

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

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

list

void list(com.vmware.vapi.bindings.client.AsyncCallback<TokenBasedPrincipalIdentityListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Return the list of token-based principal identities. | These don't have certificate or role information.

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:
com.vmware.nsx.model.TokenBasedPrincipalIdentityListResult

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

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

invocationConfig - Configuration for the method invocation.