Class CheckAuthorizations

java.lang.Object
com.uc4.communication.requests.XMLRequest
com.uc4.communication.requests.CheckAuthorizations
All Implemented Interfaces:
Iterable<CheckAuthorizations.Candidate>

public class CheckAuthorizations extends XMLRequest implements Iterable<CheckAuthorizations.Candidate>
Checks object or execution authorizations of the currently logged on UC4 user.

Example:

        CheckAuthorizations.Candidate check1 = new CheckAuthorizations.Candidate(new UC4UserName("JOBS.R3.NEW.26"), UserRight.Type.JOBS, 'R');
    CheckAuthorizations.Candidate check2 = new CheckAuthorizations.Candidate(new UC4UserName("JOBS.R3.NEW.26"), UserRight.Type.JOBS, 'C');

    CheckAuthorizations checkAuth = new CheckAuthorizations(check1, check2);
    uc4.sendRequestAndWait(checkAuth);

    for (CheckAuthorizations.Candidate c : checkAuth) {
        System.out.println("Access mode "+c.getAccess()+" for object "+c.getName()+ (c.getResult() ? " is allowed" : " has been denied"));
    }
  • Constructor Details

    • CheckAuthorizations

      public CheckAuthorizations(CheckAuthorizations.Candidate... candidates)
      Creates a new CheckUserAuthorizations request.
      Parameters:
      candidates - Candidates to test
  • Method Details

    • createRequest

      protected void createRequest(com.uc4.util.XMLDocument doc, Element request, ConnectionAttributes sessionInfo)
      Description copied from class: XMLRequest
      Creates the XML Document for the request. This method is used internally.
      Specified by:
      createRequest in class XMLRequest
      Parameters:
      doc - Document, used to create new Elements
      request - Request Element - classes append information to this request element
      sessionInfo - Information about the session
    • handleContent

      protected void handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
      Description copied from class: XMLRequest
      Sub classes extract the values from the XML document and provide public getter methods.
      Overrides:
      handleContent in class XMLRequest
      Parameters:
      doc - XML Document
      session - Info about the user session
    • getSrc

      protected String getSrc()
      Description copied from class: XMLRequest
      Returns the request source. This method is used internally.
      Specified by:
      getSrc in class XMLRequest
      Returns:
      Source
    • iterator

      Specified by:
      iterator in interface Iterable<CheckAuthorizations.Candidate>
    • isAllowedInClientZero

      protected boolean isAllowedInClientZero()
      Description copied from class: XMLRequest
      This method is used internally. Tests if this XMLRequest is allowed in client 0. The default implementation returns false, subclasses may override.
      Overrides:
      isAllowedInClientZero in class XMLRequest
      Returns:
      true if this request is allowed in client 0, false otherwise
    • size

      public int size()
      Returns the number of candidates.
      Returns:
      Size