com.vmware.vcenter.namespaces

Interface Access

All Superinterfaces:

AccessTypes, Service

All Known Implementing Classes:

AccessStub

public interface Access
extends Service, AccessTypes

The Access interface provides methods to manage access control of subjects on namespaces.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.namespaces.AccessTypes

AccessTypes.CreateSpec, AccessTypes.Info, AccessTypes.Role, AccessTypes.SetSpec, AccessTypes.SubjectType

Field Summary

Fields inherited from interface com.vmware.vcenter.namespaces.AccessTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
void	create(java.lang.String namespace, java.lang.String domain, java.lang.String subject, AccessTypes.SubjectType type, AccessTypes.CreateSpec spec) Set up access control for the subject on given domain on the namespace.
void	create(java.lang.String namespace, java.lang.String domain, java.lang.String subject, AccessTypes.SubjectType type, AccessTypes.CreateSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Set up access control for the subject on given domain on the namespace.
void	create(java.lang.String namespace, java.lang.String domain, java.lang.String subject, AccessTypes.SubjectType type, AccessTypes.CreateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Set up access control for the subject on given domain on the namespace.
void	create(java.lang.String namespace, java.lang.String domain, java.lang.String subject, AccessTypes.SubjectType type, AccessTypes.CreateSpec spec, InvocationConfig invocationConfig) Set up access control for the subject on given domain on the namespace.
void	delete(java.lang.String namespace, java.lang.String domain, java.lang.String subject, AccessTypes.SubjectType type) Remove access control of the subject on given domain from the namespace.
void	delete(java.lang.String namespace, java.lang.String domain, java.lang.String subject, AccessTypes.SubjectType type, AsyncCallback<java.lang.Void> asyncCallback) Remove access control of the subject on given domain from the namespace.
void	delete(java.lang.String namespace, java.lang.String domain, java.lang.String subject, AccessTypes.SubjectType type, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Remove access control of the subject on given domain from the namespace.
void	delete(java.lang.String namespace, java.lang.String domain, java.lang.String subject, AccessTypes.SubjectType type, InvocationConfig invocationConfig) Remove access control of the subject on given domain from the namespace.
AccessTypes.Info	get(java.lang.String namespace, java.lang.String domain, java.lang.String subject, AccessTypes.SubjectType type) Get the information about the access control of the subject on given domain on the namespace.
void	get(java.lang.String namespace, java.lang.String domain, java.lang.String subject, AccessTypes.SubjectType type, AsyncCallback<AccessTypes.Info> asyncCallback) Get the information about the access control of the subject on given domain on the namespace.
void	get(java.lang.String namespace, java.lang.String domain, java.lang.String subject, AccessTypes.SubjectType type, AsyncCallback<AccessTypes.Info> asyncCallback, InvocationConfig invocationConfig) Get the information about the access control of the subject on given domain on the namespace.
AccessTypes.Info	get(java.lang.String namespace, java.lang.String domain, java.lang.String subject, AccessTypes.SubjectType type, InvocationConfig invocationConfig) Get the information about the access control of the subject on given domain on the namespace.
void	set(java.lang.String namespace, java.lang.String domain, java.lang.String subject, AccessTypes.SubjectType type, AccessTypes.SetSpec spec) Set new access control on the namespace for the subject on given domain.
void	set(java.lang.String namespace, java.lang.String domain, java.lang.String subject, AccessTypes.SubjectType type, AccessTypes.SetSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Set new access control on the namespace for the subject on given domain.
void	set(java.lang.String namespace, java.lang.String domain, java.lang.String subject, AccessTypes.SubjectType type, AccessTypes.SetSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Set new access control on the namespace for the subject on given domain.
void	set(java.lang.String namespace, java.lang.String domain, java.lang.String subject, AccessTypes.SubjectType type, AccessTypes.SetSpec spec, InvocationConfig invocationConfig) Set new access control on the namespace for the subject on given domain.

Method Detail

create

void create(java.lang.String namespace,
            java.lang.String domain,
            java.lang.String subject,
            AccessTypes.SubjectType type,
            AccessTypes.CreateSpec spec)

Set up access control for the subject on given domain on the namespace.

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

Parameters:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

domain - The domain of the subject.

subject - The principal for this operation.

type - The type of subject (user or group).

spec - Information about the access control to be created.

Throws:

AlreadyExists - if the specified principal on given domain is already associated with a role on the namespace.

Error - if the system reports an error while responding to the request.

NotAllowedInCurrentState - if the namespace is marked for deletion or the associated cluster is being disabled.

NotFound - if namespace cannot be located.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix.

create

void create(java.lang.String namespace,
            java.lang.String domain,
            java.lang.String subject,
            AccessTypes.SubjectType type,
            AccessTypes.CreateSpec spec,
            InvocationConfig invocationConfig)

Set up access control for the subject on given domain on the namespace.

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:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

domain - The domain of the subject.

subject - The principal for this operation.

type - The type of subject (user or group).

spec - Information about the access control to be created.

invocationConfig - Configuration for the method invocation.

Throws:

AlreadyExists - if the specified principal on given domain is already associated with a role on the namespace.

Error - if the system reports an error while responding to the request.

NotAllowedInCurrentState - if the namespace is marked for deletion or the associated cluster is being disabled.

NotFound - if namespace cannot be located.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix.

create

void create(java.lang.String namespace,
            java.lang.String domain,
            java.lang.String subject,
            AccessTypes.SubjectType type,
            AccessTypes.CreateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback)

Set up access control for the subject on given domain on the namespace.

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

Operation Errors:
AlreadyExists - if the specified principal on given domain is already associated with a role on the namespace.
Error - if the system reports an error while responding to the request.
NotAllowedInCurrentState - if the namespace is marked for deletion or the associated cluster is being disabled.
NotFound - if namespace cannot be located.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix.

Parameters:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

domain - The domain of the subject.

subject - The principal for this operation.

type - The type of subject (user or group).

spec - Information about the access control to be created.

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

create

void create(java.lang.String namespace,
            java.lang.String domain,
            java.lang.String subject,
            AccessTypes.SubjectType type,
            AccessTypes.CreateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Set up access control for the subject on given domain on the namespace.

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:
AlreadyExists - if the specified principal on given domain is already associated with a role on the namespace.
Error - if the system reports an error while responding to the request.
NotAllowedInCurrentState - if the namespace is marked for deletion or the associated cluster is being disabled.
NotFound - if namespace cannot be located.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix.

Parameters:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

domain - The domain of the subject.

subject - The principal for this operation.

type - The type of subject (user or group).

spec - Information about the access control to be created.

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String namespace,
            java.lang.String domain,
            java.lang.String subject,
            AccessTypes.SubjectType type)

Remove access control of the subject on given domain from the namespace.

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

Parameters:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

domain - The domain of the subject.

subject - The principal for this operation.

type - The type of subject (user or group).

Throws:

Error - if the system reports an error while responding to the request.

NotAllowedInCurrentState - if the namespace is marked for deletion or the associated cluster is being disabled.

NotFound - if namespace cannot be located.

Unsupported - if the specified principal on given domain is not associated with the namespace.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix.

delete

void delete(java.lang.String namespace,
            java.lang.String domain,
            java.lang.String subject,
            AccessTypes.SubjectType type,
            InvocationConfig invocationConfig)

Remove access control of the subject on given domain from the namespace.

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:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

domain - The domain of the subject.

subject - The principal for this operation.

type - The type of subject (user or group).

invocationConfig - Configuration for the method invocation.

Throws:

Error - if the system reports an error while responding to the request.

NotAllowedInCurrentState - if the namespace is marked for deletion or the associated cluster is being disabled.

NotFound - if namespace cannot be located.

Unsupported - if the specified principal on given domain is not associated with the namespace.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix.

delete

void delete(java.lang.String namespace,
            java.lang.String domain,
            java.lang.String subject,
            AccessTypes.SubjectType type,
            AsyncCallback<java.lang.Void> asyncCallback)

Remove access control of the subject on given domain from the namespace.

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

Operation Errors:
Error - if the system reports an error while responding to the request.
NotAllowedInCurrentState - if the namespace is marked for deletion or the associated cluster is being disabled.
NotFound - if namespace cannot be located.
Unsupported - if the specified principal on given domain is not associated with the namespace.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix.

Parameters:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

domain - The domain of the subject.

subject - The principal for this operation.

type - The type of subject (user or group).

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

delete

void delete(java.lang.String namespace,
            java.lang.String domain,
            java.lang.String subject,
            AccessTypes.SubjectType type,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Remove access control of the subject on given domain from the namespace.

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:
Error - if the system reports an error while responding to the request.
NotAllowedInCurrentState - if the namespace is marked for deletion or the associated cluster is being disabled.
NotFound - if namespace cannot be located.
Unsupported - if the specified principal on given domain is not associated with the namespace.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix.

Parameters:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

domain - The domain of the subject.

subject - The principal for this operation.

type - The type of subject (user or group).

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

invocationConfig - Configuration for the method invocation.

set

void set(java.lang.String namespace,
         java.lang.String domain,
         java.lang.String subject,
         AccessTypes.SubjectType type,
         AccessTypes.SetSpec spec)

Set new access control on the namespace for the subject on given domain.

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

Parameters:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

domain - The domain of the subject.

subject - The principal for this operation.

type - The type of subject (user or group).

spec - Information about the new access control to be assigned.

Throws:

Error - if the system reports an error while responding to the request.

NotAllowedInCurrentState - if the namespace is marked for deletion or the associated cluster is being disabled.

NotFound - if namespace cannot be located.

Unsupported - if the specified principal on given domain is not associated with the namespace.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix.

set

void set(java.lang.String namespace,
         java.lang.String domain,
         java.lang.String subject,
         AccessTypes.SubjectType type,
         AccessTypes.SetSpec spec,
         InvocationConfig invocationConfig)

Set new access control on the namespace for the subject on given domain.

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:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

domain - The domain of the subject.

subject - The principal for this operation.

type - The type of subject (user or group).

spec - Information about the new access control to be assigned.

invocationConfig - Configuration for the method invocation.

Throws:

Error - if the system reports an error while responding to the request.

NotAllowedInCurrentState - if the namespace is marked for deletion or the associated cluster is being disabled.

NotFound - if namespace cannot be located.

Unsupported - if the specified principal on given domain is not associated with the namespace.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix.

set

void set(java.lang.String namespace,
         java.lang.String domain,
         java.lang.String subject,
         AccessTypes.SubjectType type,
         AccessTypes.SetSpec spec,
         AsyncCallback<java.lang.Void> asyncCallback)

Set new access control on the namespace for the subject on given domain.

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

Operation Errors:
Error - if the system reports an error while responding to the request.
NotAllowedInCurrentState - if the namespace is marked for deletion or the associated cluster is being disabled.
NotFound - if namespace cannot be located.
Unsupported - if the specified principal on given domain is not associated with the namespace.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix.

Parameters:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

domain - The domain of the subject.

subject - The principal for this operation.

type - The type of subject (user or group).

spec - Information about the new access control to be assigned.

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

set

void set(java.lang.String namespace,
         java.lang.String domain,
         java.lang.String subject,
         AccessTypes.SubjectType type,
         AccessTypes.SetSpec spec,
         AsyncCallback<java.lang.Void> asyncCallback,
         InvocationConfig invocationConfig)

Set new access control on the namespace for the subject on given domain.

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:
Error - if the system reports an error while responding to the request.
NotAllowedInCurrentState - if the namespace is marked for deletion or the associated cluster is being disabled.
NotFound - if namespace cannot be located.
Unsupported - if the specified principal on given domain is not associated with the namespace.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix.

Parameters:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

domain - The domain of the subject.

subject - The principal for this operation.

type - The type of subject (user or group).

spec - Information about the new access control to be assigned.

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

invocationConfig - Configuration for the method invocation.

get

AccessTypes.Info get(java.lang.String namespace,
                     java.lang.String domain,
                     java.lang.String subject,
                     AccessTypes.SubjectType type)

Get the information about the access control of the subject on given domain on the namespace.

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

Parameters:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

domain - The domain of the subject.

subject - The principal for this operation.

type - The type of subject (user or group).

Returns:

Information about the subject including the type and the role on the namespace.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if namespace cannot be located.

Unsupported - if the specified principal on given domain is not associated with the namespace.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have System.Read privilege.

get

AccessTypes.Info get(java.lang.String namespace,
                     java.lang.String domain,
                     java.lang.String subject,
                     AccessTypes.SubjectType type,
                     InvocationConfig invocationConfig)

Get the information about the access control of the subject on given domain on the namespace.

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:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

domain - The domain of the subject.

subject - The principal for this operation.

type - The type of subject (user or group).

invocationConfig - Configuration for the method invocation.

Returns:

Information about the subject including the type and the role on the namespace.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if namespace cannot be located.

Unsupported - if the specified principal on given domain is not associated with the namespace.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have System.Read privilege.

get

void get(java.lang.String namespace,
         java.lang.String domain,
         java.lang.String subject,
         AccessTypes.SubjectType type,
         AsyncCallback<AccessTypes.Info> asyncCallback)

Get the information about the access control of the subject on given domain on the namespace.

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

Invocation Result:
Information about the subject including the type and the role on the namespace.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if namespace cannot be located.
Unsupported - if the specified principal on given domain is not associated with the namespace.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Parameters:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

domain - The domain of the subject.

subject - The principal for this operation.

type - The type of subject (user or group).

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

get

void get(java.lang.String namespace,
         java.lang.String domain,
         java.lang.String subject,
         AccessTypes.SubjectType type,
         AsyncCallback<AccessTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Get the information about the access control of the subject on given domain on the namespace.

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:
Information about the subject including the type and the role on the namespace.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if namespace cannot be located.
Unsupported - if the specified principal on given domain is not associated with the namespace.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Parameters:

namespace - Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

domain - The domain of the subject.

subject - The principal for this operation.

type - The type of subject (user or group).

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

invocationConfig - Configuration for the method invocation.