com.vmware.nsx.aaa

Class UserInfoStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.aaa.UserInfoStub

All Implemented Interfaces:

UserInfo, UserInfoTypes, com.vmware.vapi.bindings.Service

public class UserInfoStub
extends com.vmware.vapi.internal.bindings.Stub
implements UserInfo

Remote stub implementation of the UserInfo API service.

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

Field Summary

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

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.nsx.aaa.UserInfoTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
UserInfo	get(java.lang.Boolean provideFlatListing, java.lang.String rootPath) This API will return the name and role information of the user invoking this API request.
void	get(java.lang.Boolean provideFlatListing, java.lang.String rootPath, com.vmware.vapi.bindings.client.AsyncCallback<UserInfo> asyncCallback) This API will return the name and role information of the user invoking this API request.
void	get(java.lang.Boolean provideFlatListing, java.lang.String rootPath, com.vmware.vapi.bindings.client.AsyncCallback<UserInfo> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) This API will return the name and role information of the user invoking this API request.
UserInfo	get(java.lang.Boolean provideFlatListing, java.lang.String rootPath, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) This API will return the name and role information of the user invoking this API request.

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

UserInfoStub

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

UserInfoStub

public UserInfoStub(com.vmware.vapi.core.ApiProvider apiProvider,
                    com.vmware.vapi.bindings.StubConfigurationBase config)

Method Detail

get

public UserInfo get(java.lang.Boolean provideFlatListing,
                    java.lang.String rootPath)

Description copied from interface: UserInfo

This API will return the name and role information of the user invoking this API request. This API is available for all NSX users no matter their authentication method (Local account, VIDM, LDAP etc). The permissions parameter of the NsxRole has been deprecated. The request parameter root_path has been introduced for multi-tenancy to get user's role at any path that the user desires. The response will contain the roles_for_paths to indicate roles at various paths.

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

Specified by:

get in interface UserInfo

Parameters:

provideFlatListing - Whether the output provides flat listing of all roles at each level or not (optional, default to false)

rootPath - Prefix path of the context (optional)

Returns:

com.vmware.nsx.model.UserInfo

get

public UserInfo get(java.lang.Boolean provideFlatListing,
                    java.lang.String rootPath,
                    com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: UserInfo

This API will return the name and role information of the user invoking this API request. This API is available for all NSX users no matter their authentication method (Local account, VIDM, LDAP etc). The permissions parameter of the NsxRole has been deprecated. The request parameter root_path has been introduced for multi-tenancy to get user's role at any path that the user desires. The response will contain the roles_for_paths to indicate roles at various paths.

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:

get in interface UserInfo

Parameters:

provideFlatListing - Whether the output provides flat listing of all roles at each level or not (optional, default to false)

rootPath - Prefix path of the context (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.UserInfo

get

public void get(java.lang.Boolean provideFlatListing,
                java.lang.String rootPath,
                com.vmware.vapi.bindings.client.AsyncCallback<UserInfo> asyncCallback)

Description copied from interface: UserInfo

This API will return the name and role information of the user invoking this API request. This API is available for all NSX users no matter their authentication method (Local account, VIDM, LDAP etc). The permissions parameter of the NsxRole has been deprecated. The request parameter root_path has been introduced for multi-tenancy to get user's role at any path that the user desires. The response will contain the roles_for_paths to indicate roles at various paths.

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

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

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

Specified by:

get in interface UserInfo

Parameters:

provideFlatListing - Whether the output provides flat listing of all roles at each level or not (optional, default to false)

rootPath - Prefix path of the context (optional)

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

get

public void get(java.lang.Boolean provideFlatListing,
                java.lang.String rootPath,
                com.vmware.vapi.bindings.client.AsyncCallback<UserInfo> asyncCallback,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: UserInfo

This API will return the name and role information of the user invoking this API request. This API is available for all NSX users no matter their authentication method (Local account, VIDM, LDAP etc). The permissions parameter of the NsxRole has been deprecated. The request parameter root_path has been introduced for multi-tenancy to get user's role at any path that the user desires. The response will contain the roles_for_paths to indicate roles at various paths.

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

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

Specified by:

get in interface UserInfo

Parameters:

provideFlatListing - Whether the output provides flat listing of all roles at each level or not (optional, default to false)

rootPath - Prefix path of the context (optional)

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

invocationConfig - Configuration for the method invocation.