public interface Access extends Service, AccessTypes
Access
interface provides methods to manage access control of
subjects on namespaces.AccessTypes.CreateSpec, AccessTypes.Info, AccessTypes.Role, AccessTypes.SetSpec, AccessTypes.SubjectType
_VAPI_SERVICE_ID
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.
|
void create(java.lang.String namespace, java.lang.String domain, java.lang.String subject, AccessTypes.SubjectType type, AccessTypes.CreateSpec spec)
Synchronous method overload. Result of the invocation will be reported as a method return value.
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.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.InvalidArgument
- if spec
contains any errors or if an invalid type
is specified.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.Unsupported
- if the specified principal on given domain is not associated with the namespace,
or when the user or group does not come from vSphere SSO and the OWNER role is
being granted.void create(java.lang.String namespace, java.lang.String domain, java.lang.String subject, AccessTypes.SubjectType type, AccessTypes.CreateSpec spec, InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
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.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.InvalidArgument
- if spec
contains any errors or if an invalid type
is specified.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.Unsupported
- if the specified principal on given domain is not associated with the namespace,
or when the user or group does not come from vSphere SSO and the OWNER role is
being granted.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)
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.
InvalidArgument
- if spec
contains any errors or if an invalid type
is specified.
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.
Unsupported
- if the specified principal on given domain is not associated with the namespace,
or when the user or group does not come from vSphere SSO and the OWNER role is
being granted.
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.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)
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.
InvalidArgument
- if spec
contains any errors or if an invalid type
is specified.
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.
Unsupported
- if the specified principal on given domain is not associated with the namespace,
or when the user or group does not come from vSphere SSO and the OWNER role is
being granted.
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.void delete(java.lang.String namespace, java.lang.String domain, java.lang.String subject, AccessTypes.SubjectType type)
Synchronous method overload. Result of the invocation will be reported as a method return value.
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).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.void delete(java.lang.String namespace, java.lang.String domain, java.lang.String subject, AccessTypes.SubjectType type, InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
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.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.void delete(java.lang.String namespace, java.lang.String domain, java.lang.String subject, AccessTypes.SubjectType type, AsyncCallback<java.lang.Void> asyncCallback)
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.
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.void delete(java.lang.String namespace, java.lang.String domain, java.lang.String subject, AccessTypes.SubjectType type, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
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.
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.void set(java.lang.String namespace, java.lang.String domain, java.lang.String subject, AccessTypes.SubjectType type, AccessTypes.SetSpec spec)
Synchronous method overload. Result of the invocation will be reported as a method return value.
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.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,
or when changing to OWNER permission for a user or group coming from an external
identity provider.InvalidArgument
- if spec
contains any errors or if an invalid type
is specified.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.void set(java.lang.String namespace, java.lang.String domain, java.lang.String subject, AccessTypes.SubjectType type, AccessTypes.SetSpec spec, InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
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.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,
or when changing to OWNER permission for a user or group coming from an external
identity provider.InvalidArgument
- if spec
contains any errors or if an invalid type
is specified.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.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)
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,
or when changing to OWNER permission for a user or group coming from an external
identity provider.
InvalidArgument
- if spec
contains any errors or if an invalid type
is specified.
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.
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.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)
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,
or when changing to OWNER permission for a user or group coming from an external
identity provider.
InvalidArgument
- if spec
contains any errors or if an invalid type
is specified.
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.
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.AccessTypes.Info get(java.lang.String namespace, java.lang.String domain, java.lang.String subject, AccessTypes.SubjectType type)
Synchronous method overload. Result of the invocation will be reported as a method return value.
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).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.AccessTypes.Info get(java.lang.String namespace, java.lang.String domain, java.lang.String subject, AccessTypes.SubjectType type, InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
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.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.void get(java.lang.String namespace, java.lang.String domain, java.lang.String subject, AccessTypes.SubjectType type, AsyncCallback<AccessTypes.Info> asyncCallback)
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.
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.void get(java.lang.String namespace, java.lang.String domain, java.lang.String subject, AccessTypes.SubjectType type, AsyncCallback<AccessTypes.Info> asyncCallback, InvocationConfig invocationConfig)
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.
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.