com.quantum.dxi.rest.rbac

Class RbacUser

java.lang.Object

Base

com.quantum.dxi.rest.rbac.RbacUser

public class RbacUser
extends Base

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

The schema that defines the RbacUser resource is defined below.

 
    <xs:element name="RbacUser">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="Name" type="xs:string"/>
        <xs:element name="Role" type="xs:string">
          <xs:annotation>
            <xs:documentation>Valid roles are: admin, operator.
              Note: The role cannot be changed with PUT. The user must be deleted, then added.
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Password" type="xs:string" minOccurs="0">
          <xs:annotation>
            <xs:documentation>
              Password is write only and not returned with GET.
              It is required when adding a user.
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="Description" type="xs:string" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
    </xs:element>
    <xs:simpleType name="RbacUserColumnNameType">
      <xs:restriction base="xs:string">
        <xs:enumeration value="Name"/>
        <xs:enumeration value="Role"/>
        <xs:enumeration value="Description"/>
      </xs:restriction>
    </xs:simpleType>
    <xs:element name="RbacUsers">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="TotalCount" type="xs:int" minOccurs="0"/>
        <xs:element ref="RbacUser" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
    </xs:element>
 
 

Constructor Summary

Constructors

Constructor and Description
RbacUser()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addUser(javax.servlet.http.HttpServletRequest request, com.quantum.dxi.dao.types.RbacUser rbacUser) POST /RbacUser
void	deleteUser(javax.servlet.http.HttpServletRequest request, String name) DELETE /RbacUser/{name}
com.quantum.dxi.dao.types.RbacUser	getUser(javax.servlet.http.HttpServletRequest request, String name) GET /RbacUser/{name}
RbacUsers	getUsers(javax.servlet.http.HttpServletRequest request, int start, int limit, String sortColumn, String sortDirection, String filterString) GET /RbacUser
com.quantum.dxi.dao.types.RbacUser	updateUser(javax.servlet.http.HttpServletRequest request, String name, com.quantum.dxi.dao.types.RbacUser rbacUser) PUT /RbacUser/{name}

Methods inherited from class java.lang.Object

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

Constructor Detail

RbacUser

public RbacUser()

Method Detail

getUsers

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

GET /RbacUser

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

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

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

Since:

1.2.2

getUser

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

GET /RbacUser/{name}

Get a specific role base access control user.

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

Since:

1.2.2

addUser

public javax.ws.rs.core.Response addUser(@Context
                                         javax.servlet.http.HttpServletRequest request,
                                         com.quantum.dxi.dao.types.RbacUser rbacUser)

POST /RbacUser

Adds a user to the role based access system.

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

Since:

1.2.2

updateUser

public com.quantum.dxi.dao.types.RbacUser updateUser(@Context
                                                     javax.servlet.http.HttpServletRequest request,
                                                     String name,
                                                     com.quantum.dxi.dao.types.RbacUser rbacUser)

PUT /RbacUser/{name}

Updates a user in the role based access system.

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

Since:

1.2.2

deleteUser

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

DELETE /RbacUser/{name}

Deletes a user from the role based access system.

Since:

1.2.2