Class Auth


public class Auth extends XenAPIObject
Management of remote authentication services First published in XenServer 5.5.
Author:
Cloud Software Group, Inc.
  • Constructor Details

    • Auth

      public Auth()
  • Method Details

    • toWireString

      public String toWireString()
      Specified by:
      toWireString in class XenAPIObject
    • getSubjectIdentifier

      public static String getSubjectIdentifier(Connection c, String subjectName) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      This call queries the external directory service to obtain the subject_identifier as a string from the human-readable subject_name Minimum allowed role: read-only First published in XenServer 5.5.
      Parameters:
      c - The connection the call is made on
      subjectName - The human-readable subject_name, such as a username or a groupname
      Returns:
      the subject_identifier obtained from the external directory service
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getSubjectInformationFromIdentifier

      public static Map<String,String> getSubjectInformationFromIdentifier(Connection c, String subjectIdentifier) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      This call queries the external directory service to obtain the user information (e.g. username, organization etc) from the specified subject_identifier Minimum allowed role: read-only First published in XenServer 5.5.
      Parameters:
      c - The connection the call is made on
      subjectIdentifier - A string containing the subject_identifier, unique in the external directory service
      Returns:
      key-value pairs containing at least a key called subject_name
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.
    • getGroupMembership

      public static Set<String> getGroupMembership(Connection c, String subjectIdentifier) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
      This calls queries the external directory service to obtain the transitively-closed set of groups that the the subject_identifier is member of. Minimum allowed role: read-only First published in XenServer 5.5.
      Parameters:
      c - The connection the call is made on
      subjectIdentifier - A string containing the subject_identifier, unique in the external directory service
      Returns:
      set of subject_identifiers that provides the group membership of subject_identifier passed as argument, it contains, recursively, all groups a subject_identifier is member of.
      Throws:
      Types.BadServerResponse - Thrown if the response from the server contains an invalid status.
      Types.XenAPIException - Thrown if the call failed.
      org.apache.xmlrpc.XmlRpcException - Thrown if the result of an asynchronous call could not be parsed.