com.quantum.dxi.rest.rbac

Class RbacGroup

java.lang.Object

Base

com.quantum.dxi.rest.rbac.RbacGroup

public class RbacGroup
extends Base

The RbacGroup resource represents access control groups on the system. The RbacGroup service includes interfaces for getting and updating the access control groups.

The schema that defines the RbacGoup resource is defined below.

 
    <xs:element name="RbacGroup">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="Name" type="xs:string"/>
        <xs:element name="Description" type="xs:string" minOccurs="0"/>
        <xs:element name="Users" type="StringListScalarType" minOccurs="0"/>
        <xs:element name="Resources" type="RbacResourceNameListScalarType" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
    </xs:element>
    <xs:simpleType name="RbacGroupColumnNameType">
      <xs:restriction base="xs:string">
        <xs:enumeration value="Name"/>
        <xs:enumeration value="Description"/>
      </xs:restriction>
    </xs:simpleType>
    <xs:element name="RbacGroups">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="TotalCount" type="xs:int" minOccurs="0"/>
        <xs:element ref="RbacGroup" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
    </xs:element>
    <xs:complexType name="RbacResourceNameType">
      <xs:sequence>
        <xs:element name="Type" type="xs:string"/>
        <xs:element name="Name" type="xs:string"/>
      </xs:sequence>
    </xs:complexType>
    <xs:element name="RbacResourceNameListScalar" type="RbacResourceNameListScalarType"/>
    <xs:complexType name="RbacResourceNameListScalarType">
      <xs:complexContent>
          <xs:extension base="ScalarType">
              <xs:sequence>
                  <xs:element name="Value" type="RbacResourceNameType" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
          </xs:extension>
      </xs:complexContent>
    </xs:complexType>
    <xs:complexType name="RbacResourceNameType">
       <xs:sequence>
         <xs:element name="Type" type="xs:string"/>
         <xs:element name="Name" type="xs:string"/>
       </xs:sequence>
   </xs:complexType>
 <xs:element name="RbacResourceNameListScalar" type="RbacResourceNameListScalarType"/>
 <xs:complexType name="RbacResourceNameListScalarType">
     <xs:complexContent>
         <xs:extension base="ScalarType">
             <xs:sequence>
                 <xs:element name="Value" type="RbacResourceNameType" minOccurs="0" maxOccurs="unbounded"/>
             </xs:sequence>
         </xs:extension>
     </xs:complexContent>
 </xs:complexType>
 
 

Constructor Summary

Constructors

Constructor and Description
RbacGroup()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addGroup(javax.servlet.http.HttpServletRequest request, com.quantum.dxi.dao.types.RbacGroup rbacGroup) POST /RbacGroup
RbacResourceNameListScalarType	addGroupAccess(javax.servlet.http.HttpServletRequest request, String groupName, RbacResourceNameListScalarType resourceNames) PUT /RbacGroup/{groupName}/addAccess
StringListScalarType	addGroupUsers(javax.servlet.http.HttpServletRequest request, String groupName, StringListScalarType userNames) PUT /RbacGroup/{groupName}/addUsers
void	deleteGroup(javax.servlet.http.HttpServletRequest request, String name) DELETE /RbacGroup/{name}
RbacResourceNameListScalarType	deleteGroupAccess(javax.servlet.http.HttpServletRequest request, String groupName, RbacResourceNameListScalarType resourceNames) PUT /RbacGroup/{groupName}/deleteAccess
StringListScalarType	deleteGroupUsers(javax.servlet.http.HttpServletRequest request, String groupName, StringListScalarType userNames) PUT /RbacGroup/{groupName}/deleteUsers
com.quantum.dxi.dao.types.RbacGroup	getGroup(javax.servlet.http.HttpServletRequest request, String name) GET /RbacGroup/{name}
RbacGroups	getGroups(javax.servlet.http.HttpServletRequest request, int start, int limit, String sortColumn, String sortDirection, String filterString) GET /RbacGroup
com.quantum.dxi.dao.types.RbacGroup	updateGroup(javax.servlet.http.HttpServletRequest request, String name, com.quantum.dxi.dao.types.RbacGroup rbacGroup) PUT /RbacGroup/{name}

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RbacGroup

public RbacGroup()

Method Detail

getGroups

public RbacGroups getGroups(@Context
                            javax.servlet.http.HttpServletRequest request,
                            int start,
                            int limit,
                            String sortColumn,
                            String sortDirection,
                            String filterString)

GET /RbacGroup

Get the list of role base access control groups on the system.

The method supports the table query parameters. Column names for sorting and filtering are defined in <xs:simpleType name="RbacGroupColumnNameType">

Response Entity type: <xs:element name="RbacGroups">

Since:

1.2.2

getGroup

public com.quantum.dxi.dao.types.RbacGroup getGroup(@Context
                                                    javax.servlet.http.HttpServletRequest request,
                                                    String name)

GET /RbacGroup/{name}

Get a specific role base access control group.

Response Entity type: <xs:element name="RbacGroup">

Since:

1.2.2

addGroup

public javax.ws.rs.core.Response addGroup(@Context
                                          javax.servlet.http.HttpServletRequest request,
                                          com.quantum.dxi.dao.types.RbacGroup rbacGroup)

POST /RbacGroup

Adds a group to the role based access system.

Response Entity type: <xs:element name="RbacGroup">

Since:

1.2.2

updateGroup

public com.quantum.dxi.dao.types.RbacGroup updateGroup(@Context
                                                       javax.servlet.http.HttpServletRequest request,
                                                       String name,
                                                       com.quantum.dxi.dao.types.RbacGroup rbacGroup)

PUT /RbacGroup/{name}

Updates a group in the role based access system.

If a list of users is specified, it will replace the current list.
If a list of users is not specified, the current list is unchanged.
To delete all users, use PUT /RbacGroup/{groupName}/deleteUsers.

If a list of access to resources is specified, it will replace the current list.
If a list of access to resources is not specified, the current list is unchanged.
To delete access to all resources, use PUT /RbacGroup/{groupName}/deleteAccess.

Response Entity type: <xs:element name="RbacGroup">

Since:

1.2.2

deleteGroup

public void deleteGroup(@Context
                        javax.servlet.http.HttpServletRequest request,
                        String name)

DELETE /RbacGroup/{name}

Deletes a group from the role based access system.

Since:

1.2.2

addGroupUsers

public StringListScalarType addGroupUsers(@Context
                                          javax.servlet.http.HttpServletRequest request,
                                          String groupName,
                                          StringListScalarType userNames)

PUT /RbacGroup/{groupName}/addUsers

Adds a list of users to an access control group. Returns the updated list of users in the group.

Since:

1.2.2

deleteGroupUsers

public StringListScalarType deleteGroupUsers(@Context
                                             javax.servlet.http.HttpServletRequest request,
                                             String groupName,
                                             StringListScalarType userNames)

PUT /RbacGroup/{groupName}/deleteUsers

Deletes a list of users from an access control group. Returns the updated list of users in the group.

Since:

1.2.2

addGroupAccess

public RbacResourceNameListScalarType addGroupAccess(@Context
                                                     javax.servlet.http.HttpServletRequest request,
                                                     String groupName,
                                                     RbacResourceNameListScalarType resourceNames)

PUT /RbacGroup/{groupName}/addAccess

Adds an access control group to the access list of the specified resources. Returns the updated list of resources to which the group has access.

Since:

1.2.2

deleteGroupAccess

public RbacResourceNameListScalarType deleteGroupAccess(@Context
                                                        javax.servlet.http.HttpServletRequest request,
                                                        String groupName,
                                                        RbacResourceNameListScalarType resourceNames)

PUT /RbacGroup/{groupName}/deleteAccess

Deletes an access control group from the access list of the specified resources. Returns the updated list of resources to which the group has access.

Since:

1.2.2