com.vmware.nsx.trust_management

Interface PrincipalIdentities

All Superinterfaces:

PrincipalIdentitiesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

PrincipalIdentitiesStub

public interface PrincipalIdentities
extends com.vmware.vapi.bindings.Service, PrincipalIdentitiesTypes

Field Summary

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

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
PrincipalIdentity	create(PrincipalIdentity principalIdentity) Deprecated.
void	create(PrincipalIdentity principalIdentity, com.vmware.vapi.bindings.client.AsyncCallback<PrincipalIdentity> asyncCallback) Deprecated.
void	create(PrincipalIdentity principalIdentity, com.vmware.vapi.bindings.client.AsyncCallback<PrincipalIdentity> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
PrincipalIdentity	create(PrincipalIdentity principalIdentity, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	delete(java.lang.String principalIdentityId) Delete a principal identity.
void	delete(java.lang.String principalIdentityId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Delete a 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 principal identity.
void	delete(java.lang.String principalIdentityId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete a principal identity.
PrincipalIdentity	get(java.lang.String principalIdentityId) Get a stored principal identity
void	get(java.lang.String principalIdentityId, com.vmware.vapi.bindings.client.AsyncCallback<PrincipalIdentity> asyncCallback) Get a stored principal identity
void	get(java.lang.String principalIdentityId, com.vmware.vapi.bindings.client.AsyncCallback<PrincipalIdentity> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get a stored principal identity
PrincipalIdentity	get(java.lang.String principalIdentityId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get a stored principal identity
PrincipalIdentityList	list() Returns the list of principals registered with a certificate.
void	list(com.vmware.vapi.bindings.client.AsyncCallback<PrincipalIdentityList> asyncCallback) Returns the list of principals registered with a certificate.
void	list(com.vmware.vapi.bindings.client.AsyncCallback<PrincipalIdentityList> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the list of principals registered with a certificate.
PrincipalIdentityList	list(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the list of principals registered with a certificate.
PrincipalIdentity	updatecertificate(UpdatePrincipalIdentityCertificateRequest updatePrincipalIdentityCertificateRequest) Update a principal identity's certificate
void	updatecertificate(UpdatePrincipalIdentityCertificateRequest updatePrincipalIdentityCertificateRequest, com.vmware.vapi.bindings.client.AsyncCallback<PrincipalIdentity> asyncCallback) Update a principal identity's certificate
void	updatecertificate(UpdatePrincipalIdentityCertificateRequest updatePrincipalIdentityCertificateRequest, com.vmware.vapi.bindings.client.AsyncCallback<PrincipalIdentity> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Update a principal identity's certificate
PrincipalIdentity	updatecertificate(UpdatePrincipalIdentityCertificateRequest updatePrincipalIdentityCertificateRequest, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Update a principal identity's certificate

Method Detail

create

@Deprecated
PrincipalIdentity create(PrincipalIdentity principalIdentity)

Deprecated.

Associates a principal's name with a certificate that is used to authenticate. The combination name and node_id needs to be unique across token-based and certificate-based principal identities.
Deprecated, use POST /trust-management/principal-identities/with-certificate instead.

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

Parameters:

principalIdentity - (required)

Returns:

com.vmware.nsx.model.PrincipalIdentity

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

@Deprecated
PrincipalIdentity create(PrincipalIdentity principalIdentity,
                                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Associates a principal's name with a certificate that is used to authenticate. The combination name and node_id needs to be unique across token-based and certificate-based principal identities.
Deprecated, use POST /trust-management/principal-identities/with-certificate instead.

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:

principalIdentity - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.PrincipalIdentity

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

@Deprecated
void create(PrincipalIdentity principalIdentity,
                        com.vmware.vapi.bindings.client.AsyncCallback<PrincipalIdentity> asyncCallback)

Deprecated.

Associates a principal's name with a certificate that is used to authenticate. The combination name and node_id needs to be unique across token-based and certificate-based principal identities.
Deprecated, use POST /trust-management/principal-identities/with-certificate instead.

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

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

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

Parameters:

principalIdentity - (required)

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

create

@Deprecated
void create(PrincipalIdentity principalIdentity,
                        com.vmware.vapi.bindings.client.AsyncCallback<PrincipalIdentity> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Associates a principal's name with a certificate that is used to authenticate. The combination name and node_id needs to be unique across token-based and certificate-based principal identities.
Deprecated, use POST /trust-management/principal-identities/with-certificate instead.

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.PrincipalIdentity

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

Parameters:

principalIdentity - (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 principal identity. It does not delete the certificate.

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

Parameters:

principalIdentityId - Unique id of the 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 principal identity. It does not delete the certificate.

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 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 principal identity. It does not delete the certificate.

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 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 principal identity. It does not delete the certificate.

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 principal identity to delete (required)

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

invocationConfig - Configuration for the method invocation.

get

PrincipalIdentity get(java.lang.String principalIdentityId)

Get a stored 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.PrincipalIdentity

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

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

Get a stored 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.PrincipalIdentity

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<PrincipalIdentity> asyncCallback)

Get a stored principal identity

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

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

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<PrincipalIdentity> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get a stored 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.PrincipalIdentity

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

PrincipalIdentityList list()

Returns the list of principals registered with a certificate.

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

Returns:

com.vmware.nsx.model.PrincipalIdentityList

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

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

Returns the list of principals registered with a certificate.

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.PrincipalIdentityList

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<PrincipalIdentityList> asyncCallback)

Returns the list of principals registered with a certificate.

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

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

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<PrincipalIdentityList> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns the list of principals registered with a certificate.

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.PrincipalIdentityList

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.

updatecertificate

PrincipalIdentity updatecertificate(UpdatePrincipalIdentityCertificateRequest updatePrincipalIdentityCertificateRequest)

Update a principal identity's certificate

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

Parameters:

updatePrincipalIdentityCertificateRequest - (required)

Returns:

com.vmware.nsx.model.PrincipalIdentity

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

updatecertificate

PrincipalIdentity updatecertificate(UpdatePrincipalIdentityCertificateRequest updatePrincipalIdentityCertificateRequest,
                                    com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Update a principal identity's certificate

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:

updatePrincipalIdentityCertificateRequest - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.PrincipalIdentity

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

updatecertificate

void updatecertificate(UpdatePrincipalIdentityCertificateRequest updatePrincipalIdentityCertificateRequest,
                       com.vmware.vapi.bindings.client.AsyncCallback<PrincipalIdentity> asyncCallback)

Update a principal identity's certificate

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

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

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

Parameters:

updatePrincipalIdentityCertificateRequest - (required)

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

updatecertificate

void updatecertificate(UpdatePrincipalIdentityCertificateRequest updatePrincipalIdentityCertificateRequest,
                       com.vmware.vapi.bindings.client.AsyncCallback<PrincipalIdentity> asyncCallback,
                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Update a principal identity's certificate

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.PrincipalIdentity

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

Parameters:

updatePrincipalIdentityCertificateRequest - (required)

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

invocationConfig - Configuration for the method invocation.