com.uc4.communication.requests

Class CheckUserPrivileges

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.CheckUserPrivileges

All Implemented Interfaces:

java.lang.Iterable<CheckUserPrivileges.Candidate>

public class CheckUserPrivileges
extends XMLRequest
implements java.lang.Iterable<CheckUserPrivileges.Candidate>

Checks privileges of users. For each privilege to check a new instance of CheckUserPrivileges.Candidate needs to be created. The iterator of this class can be used to get the results of the check the request has been sent to the Automation Engine.

Example:

        CheckUserPrivileges.Candidate user1 = new CheckUserPrivileges.Candidate(new UC4UserName("ANG/DEV"), Privilege.ACCESS_NOFOLDER);
    CheckUserPrivileges.Candidate user2 = new CheckUserPrivileges.Candidate(new UC4UserName("ANG/DEV"), Privilege.ILM_ACTIONS); 

    CheckUserPrivileges check = new CheckUserPrivileges(user1, user2);
    uc4.sendRequestAndWait(check);

        for (CheckUserPrivileges.Candidate c : check) {
        if (c.getResult()) {
                System.out.println("User "+c.getUser()+" holds the privilege "+c.getPrivilege());                       
        } else {
                System.out.println("User "+c.getUser()+" does not hold the privilege "+c.getPrivilege());
        }               
    }           
        

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CheckUserPrivileges.Candidate Stores the name of the user, a privilege to check and the result of the check after the request has been sent.

Constructor Summary

Constructors

Constructor and Description
CheckUserPrivileges(CheckUserPrivileges.Candidate... candidates) Creates a new CheckUserPrivileges request.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Iterator<CheckUserPrivileges.Candidate>	iterator()
int	size() Returns the number of candidates.

Methods inherited from class com.uc4.communication.requests.XMLRequest

getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckUserPrivileges

public CheckUserPrivileges(CheckUserPrivileges.Candidate... candidates)

Creates a new CheckUserPrivileges request.

Parameters:

candidates - Candidates to test

Method Detail

iterator

public java.util.Iterator<CheckUserPrivileges.Candidate> iterator()

Specified by:

iterator in interface java.lang.Iterable<CheckUserPrivileges.Candidate>

size

public int size()

Returns the number of candidates.

Returns:

Size