Class GrouperService

java.lang.Object
edu.internet2.middleware.grouper.ws.soap.GrouperService

public class GrouperService extends Object
 All public methods in this class are available in the web service
 as both SOAP and REST.
 
 This is the class that Axis uses to generate the WSDL.  Also this is the 
 class that request/response objects are generated from for REST (each param
 is a field in the object, each method is an object).
 
 Each method in this class has an outer try/catch that does error handling, 
 it decodes enums and looks things up, then delegates to GrouperServiceLogic
 for the real business logic.  In that class the Lite methods delegate to the
 real methods
 
 booleans can either be T, F, true, false (case-insensitive)
 
 get wsdl from: http://localhost:8090/grouper/services/GrouperService?wsdl
 
 generate client (after wsdl copied): C:\mchyzer\isc\dev\grouper\axisJar2>wsdl2java -p edu.internet2.middleware.grouper.webservicesClient -t -uri GrouperService.wsdl
  • Constructor Details

    • GrouperService

      public GrouperService()
      default
  • Method Details

    • findGroupsLite

      public WsFindGroupsResults findGroupsLite(String clientVersion, String queryFilterType, String groupName, String stemName, String stemNameScope, String groupUuid, String groupAttributeName, String groupAttributeValue, String groupTypeName, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1)
      find a group or groups
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      queryFilterType - findGroupType is the WsQueryFilterType enum for which type of find is happening: e.g. FIND_BY_GROUP_UUID, FIND_BY_GROUP_NAME_EXACT, FIND_BY_STEM_NAME, FIND_BY_APPROXIMATE_ATTRIBUTE, FIND_BY_GROUP_NAME_APPROXIMATE, FIND_BY_TYPE, AND, OR, MINUS;
      groupName - search by group name (must match exactly), cannot use other params with this
      stemName - will return groups in this stem. can be used with various query types
      stemNameScope - if searching by stem, ONE_LEVEL is for one level, ALL_IN_SUBTREE will return all in sub tree. Required if searching by stem
      groupUuid - search by group uuid (must match exactly), cannot use other params with this
      groupAttributeName - if searching by attribute, this is name, or null for all attributes
      groupAttributeValue - if searching by attribute, this is the value
      groupTypeName - if searching by type, this is the type. not yet implemented
      actAsSubjectId - optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      actAsSubjectIdentifier - optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      actAsSubjectSourceId - optional to narrow the act as subject search to a particular source
      includeGroupDetail - T or F as for if group detail should be included
      paramName0 - reserved for future use
      paramValue0 - reserved for future use
      paramName1 - reserved for future use
      paramValue1 - reserved for future use
      Returns:
      the groups, or no groups if none found
    • findStems

      public WsFindStemsResults findStems(String clientVersion, WsStemQueryFilter wsStemQueryFilter, WsSubjectLookup actAsSubjectLookup, WsParam[] params, WsStemLookup[] wsStemLookups)
      find a stem or stems
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      wsStemQueryFilter - is the filter properties that can search by name, uuid, approximate attribute, and can do group math on multiple operations, etc
      includeStemDetail - T or F as to if the stem detail should be included (defaults to F)
      actAsSubjectLookup -
      params - optional: reserved for future use
      wsStemLookups - to pass in a list of uuids or names to lookup. Note the stems are returned in alphabetical order
      Returns:
      the stems, or no stems if none found
    • findGroups

      public WsFindGroupsResults findGroups(String clientVersion, WsQueryFilter wsQueryFilter, WsSubjectLookup actAsSubjectLookup, String includeGroupDetail, WsParam[] params, WsGroupLookup[] wsGroupLookups)
      find a group or groups
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      wsQueryFilter - is the filter properties that can search by name, uuid, attribute, type, and can do group math on multiple operations, etc
      includeGroupDetail - T or F as to if the group detail should be included (defaults to F)
      actAsSubjectLookup -
      params - optional: reserved for future use
      wsGroupLookups - if you want to just pass in a list of uuids and/or names. Note the stems are returned in alphabetical order
      Returns:
      the groups, or no groups if none found
    • getMembersLite

      public WsGetMembersLiteResult getMembersLite(String clientVersion, String groupName, String groupUuid, String memberFilter, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String fieldName, String includeGroupDetail, String includeSubjectDetail, String subjectAttributeNames, String paramName0, String paramValue0, String paramName1, String paramValue1, String sourceIds)
      get members from a group based on a filter (all, immediate only, effective only, composite)
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      groupName - to lookup the group (mutually exclusive with groupUuid)
      groupUuid - to lookup the group (mutually exclusive with groupName)
      memberFilter - must be one of All, Effective, Immediate, Composite
      includeSubjectDetail - T|F, for if the extended subject information should be returned (anything more than just the id)
      actAsSubjectId - optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      actAsSubjectSourceId - is the source to use to lookup the subject (if applicable)
      actAsSubjectIdentifier - optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      fieldName - is if the member should be added to a certain field membership of the group (certain list)
      subjectAttributeNames - are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent. Comma-separate if multiple
      includeGroupDetail - T or F as to if the group detail should be returned
      paramName0 - reserved for future use
      paramValue0 - reserved for future use
      paramName1 - reserved for future use
      paramValue1 - reserved for future use
      sourceIds - comma separated source ids or null for all
      Returns:
      the members, or no members if none found
    • getMembers

      public WsGetMembersResults getMembers(String clientVersion, WsGroupLookup[] wsGroupLookups, String memberFilter, WsSubjectLookup actAsSubjectLookup, String fieldName, String includeGroupDetail, String includeSubjectDetail, String[] subjectAttributeNames, WsParam[] params, String[] sourceIds)
      get members from a group based on a filter (all, immediate only, effective only, composite)
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      wsGroupLookups - are groups to query
      memberFilter - must be one of All, Effective, Immediate, Composite
      includeSubjectDetail - T|F, for if the extended subject information should be returned (anything more than just the id)
      actAsSubjectLookup -
      fieldName - is if the member should be added to a certain field membership of the group (certain list)
      subjectAttributeNames - are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent
      includeGroupDetail - T or F as to if the group detail should be returned
      params - optional: reserved for future use
      sourceIds - array of source ids or null if all
      Returns:
      the results
    • getGroups

      public WsGetGroupsResults getGroups(String clientVersion, WsSubjectLookup[] subjectLookups, String memberFilter, WsSubjectLookup actAsSubjectLookup, String includeGroupDetail, String includeSubjectDetail, String[] subjectAttributeNames, WsParam[] params, String fieldName, String scope, WsStemLookup wsStemLookup, String stemScope, String enabled, String pageSize, String pageNumber, String sortString, String ascending)
      get groups from members based on filter (accepts batch of members)
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      subjectLookups - subjects to be examined to get groups
      memberFilter - can be All, Effective (non immediate), Immediate (direct), Composite (if composite group with group math (union, minus, etc)
      actAsSubjectLookup - to act as a different user than the logged in user
      includeGroupDetail - T or F as to if the group detail should be included (defaults to F)
      subjectAttributeNames - are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent
      includeSubjectDetail - T|F, for if the extended subject information should be returned (anything more than just the id)
      params - optional: reserved for future use
      fieldName - is field name (list name) to search or blank for default list
      scope - is a DB pattern that will have % appended to it, or null for all. e.g. school:whatever:parent:
      wsStemLookup - is the stem to check in, or null if all. If has stem, must have stemScope
      stemScope - is ONE_LEVEL if in this stem, or ALL_IN_SUBTREE for any stem underneath. You must pass stemScope if you pass a stem
      enabled - is A for all, T or null for enabled only, F for disabled
      pageSize - page size if paging
      pageNumber - page number 1 indexed if paging
      sortString - must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension
      ascending - or null for ascending, F for descending. If you pass T or F, must pass a sort string
      Returns:
      the results
    • hasMember

      public WsHasMemberResults hasMember(String clientVersion, WsGroupLookup wsGroupLookup, WsSubjectLookup[] subjectLookups, String memberFilter, WsSubjectLookup actAsSubjectLookup, String fieldName, String includeGroupDetail, String includeSubjectDetail, String[] subjectAttributeNames, WsParam[] params)
      see if a group has members based on filter (accepts batch of members)
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      wsGroupLookup - for the group to see if the members are in there
      subjectLookups - subjects to be examined to see if in group
      memberFilter - can be All, Effective (non immediate), Immediate (direct), Composite (if composite group with group math (union, minus, etc)
      actAsSubjectLookup - to act as a different user than the logged in user
      fieldName - is if the Group.hasMember() method with field is to be called (e.g. admins, optouts, optins, etc from Field table in DB)
      txType - is the GrouperTransactionType for the request. If blank, defaults to NONE (will finish as much as possible). Generally the only values for this param that make sense are NONE (or blank), and READ_WRITE_NEW.
      includeGroupDetail - T or F as to if the group detail should be returned
      includeSubjectDetail - T|F, for if the extended subject information should be returned (anything more than just the id)
      subjectAttributeNames - are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent
      params - optional: reserved for future use
      Returns:
      the results
    • stemDeleteLite

      public WsStemDeleteLiteResult stemDeleteLite(String clientVersion, String stemName, String stemUuid, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1)
      delete a stem or many (if doesnt exist, ignore)
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      stemName - to delete the stem (mutually exclusive with stemUuid)
      stemUuid - to delete the stem (mutually exclusive with stemName)
      actAsSubjectId - optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      actAsSubjectSourceId - is source of act as subject to narrow the result and prevent duplicates
      actAsSubjectIdentifier - optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      paramName0 - reserved for future use
      paramValue0 - reserved for future use
      paramName1 - reserved for future use
      paramValue1 - reserved for future use
      Returns:
      the result of one member add
    • groupDeleteLite

      public WsGroupDeleteLiteResult groupDeleteLite(String clientVersion, String groupName, String groupUuid, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1)
      delete a group or many (if doesnt exist, ignore)
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      groupName - to delete the group (mutually exclusive with groupUuid)
      groupUuid - to delete the group (mutually exclusive with groupName)
      actAsSubjectId - optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      actAsSubjectSourceId - is source of act as subject to narrow the result and prevent duplicates
      actAsSubjectIdentifier - optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      includeGroupDetail - T or F as to if the group detail should be returned
      paramName0 - reserved for future use
      paramValue0 - reserved for future use
      paramName1 - reserved for future use
      paramValue1 - reserved for future use
      Returns:
      the result of one member add
    • groupSaveLite

      public WsGroupSaveLiteResult groupSaveLite(String clientVersion, String groupLookupUuid, String groupLookupName, String groupUuid, String groupName, String displayExtension, String description, String saveMode, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1)
      save a stem (insert or update). Note you cannot currently move an existing group.
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      groupLookupUuid - the uuid of the group to edit (mutually exclusive with groupLookupName)
      groupLookupName - the name of the group to edit (mutually exclusive with groupLookupUuid)
      groupName - to delete the group (mutually exclusive with groupUuid)
      groupUuid - to delete the group (mutually exclusive with groupName)
      description - of the group, empty will be ignored
      displayExtension - display name of the group, empty will be ignored
      saveMode - if the save should be constrained to INSERT, UPDATE, or INSERT_OR_UPDATE (default)
      actAsSubjectId - optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      actAsSubjectSourceId - is source of act as subject to narrow the result and prevent duplicates
      actAsSubjectIdentifier - optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      includeGroupDetail - T or F as to if the group detail should be returned
      paramName0 - reserved for future use
      paramValue0 - reserved for future use
      paramName1 - reserved for future use
      paramValue1 - reserved for future use
      Returns:
      the result of one member add
    • stemSaveLite

      public WsStemSaveLiteResult stemSaveLite(String clientVersion, String stemLookupUuid, String stemLookupName, String stemUuid, String stemName, String displayExtension, String description, String saveMode, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1)
      save a stem (insert or update). Note you cannot move an existing stem.
      Parameters:
      stemLookupUuid - the uuid of the stem to save (mutually exclusive with stemLookupName), null for insert
      stemLookupName - the name of the stam to save (mutually exclusive with stemLookupUuid), null for insert
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      stemName - data of stem to save
      stemUuid - uuid data of stem to save
      description - of the stem
      displayExtension - of the stem
      saveMode - if the save should be constrained to INSERT, UPDATE, or INSERT_OR_UPDATE (default)
      actAsSubjectId - optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      actAsSubjectSourceId - is source of act as subject to narrow the result and prevent duplicates
      actAsSubjectIdentifier - optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      paramName0 - reserved for future use
      paramValue0 - reserved for future use
      paramName1 - reserved for future use
      paramValue1 - reserved for future use
      Returns:
      the result of one member add
    • groupSave

      public WsGroupSaveResults groupSave(String clientVersion, WsGroupToSave[] wsGroupToSaves, WsSubjectLookup actAsSubjectLookup, String txType, String includeGroupDetail, WsParam[] params)
      save a group or many (insert or update). Note, you cannot rename an existing group.
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      wsGroupToSaves - groups to save
      actAsSubjectLookup -
      txType - is the GrouperTransactionType for the request. If blank, defaults to NONE (will finish as much as possible). Generally the only values for this param that make sense are NONE (or blank), and READ_WRITE_NEW.
      includeGroupDetail - T or F as to if the group detail should be returned
      params - optional: reserved for future use
      Returns:
      the results
    • stemSave

      public WsStemSaveResults stemSave(String clientVersion, WsStemToSave[] wsStemToSaves, WsSubjectLookup actAsSubjectLookup, String txType, WsParam[] params)
      save a stem or many (insert or update). Note, you cannot move an existing stem.
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      wsStemToSaves - stems to save
      actAsSubjectLookup -
      txType - is the GrouperTransactionType for the request. If blank, defaults to NONE (will finish as much as possible). Generally the only values for this param that make sense are NONE (or blank), and READ_WRITE_NEW.
      params - optional: reserved for future use
      Returns:
      the results
    • stemDelete

      public WsStemDeleteResults stemDelete(String clientVersion, WsStemLookup[] wsStemLookups, WsSubjectLookup actAsSubjectLookup, String txType, WsParam[] params)
      delete a stem or many (if doesnt exist, ignore)
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      stemName - name of stem to delete (mutually exclusive with uuid)
      stemUuid - uuid of stem to delete (mutually exclusive with name)
      wsStemLookups - stem lookups of stems to delete (specify name or uuid)
      actAsSubjectLookup -
      txType - is the GrouperTransactionType for the request. If blank, defaults to NONE (will finish as much as possible). Generally the only values for this param that make sense are NONE (or blank), and READ_WRITE_NEW.
      params - optional: reserved for future use
      Returns:
      the results
    • groupDelete

      public WsGroupDeleteResults groupDelete(String clientVersion, WsGroupLookup[] wsGroupLookups, WsSubjectLookup actAsSubjectLookup, String txType, String includeGroupDetail, WsParam[] params)
      delete a group or many (if doesnt exist, ignore)
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      wsGroupLookups - groups to delete
      actAsSubjectLookup -
      txType - is the GrouperTransactionType for the request. If blank, defaults to NONE (will finish as much as possible). Generally the only values for this param that make sense are NONE (or blank), and READ_WRITE_NEW.
      includeGroupDetail - T or F as to if the group detail should be returned
      params - optional: reserved for future use
      Returns:
      the results
    • addMember

      public WsAddMemberResults addMember(String clientVersion, WsGroupLookup wsGroupLookup, WsSubjectLookup[] subjectLookups, String replaceAllExisting, WsSubjectLookup actAsSubjectLookup, String fieldName, String txType, String includeGroupDetail, String includeSubjectDetail, String[] subjectAttributeNames, WsParam[] params, String disabledTime, String enabledTime)
      add member to a group (if already a direct member, ignore)
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      wsGroupLookup - group to add the members to
      subjectLookups - subjects to be added to the group
      replaceAllExisting - optional: T or F (default), if the existing groups should be replaced
      actAsSubjectLookup -
      fieldName - is if the member should be added to a certain field membership of the group (certain list)
      txType - is the GrouperTransactionType for the request. If blank, defaults to NONE (will finish as much as possible). Generally the only values for this param that make sense are NONE (or blank), and READ_WRITE_NEW.
      includeGroupDetail - T or F as to if the group detail should be returned
      subjectAttributeNames - are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent
      includeSubjectDetail - T|F, for if the extended subject information should be returned (anything more than just the id)
      params - optional: reserved for future use
      disabledTime - date this membership will be disabled, yyyy/MM/dd HH:mm:ss.SSS
      enabledTime - date this membership will be enabled (for future provisioning), yyyy/MM/dd HH:mm:ss.SSS
      Returns:
      the results
      See Also:
    • deleteMember

      public WsDeleteMemberResults deleteMember(String clientVersion, WsGroupLookup wsGroupLookup, WsSubjectLookup[] subjectLookups, WsSubjectLookup actAsSubjectLookup, String fieldName, String txType, String includeGroupDetail, String includeSubjectDetail, String[] subjectAttributeNames, WsParam[] params)
      remove member(s) from a group (if not already a direct member, ignore)
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      wsGroupLookup -
      subjectLookups - subjects to be deleted to the group
      actAsSubjectLookup -
      fieldName - is if the member should be added to a certain field membership of the group (certain list)
      txType - is the GrouperTransactionType for the request. If blank, defaults to NONE (will finish as much as possible). Generally the only values for this param that make sense are NONE (or blank), and READ_WRITE_NEW.
      includeGroupDetail - T or F as to if the group detail should be returned
      subjectAttributeNames - are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent
      includeSubjectDetail - T|F, for if the extended subject information should be returned (anything more than just the id)
      params - optional: reserved for future use
      Returns:
      the results
    • getGroupsLite

      public WsGetGroupsLiteResult getGroupsLite(String clientVersion, String subjectId, String subjectSourceId, String subjectIdentifier, String memberFilter, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeGroupDetail, String includeSubjectDetail, String subjectAttributeNames, String paramName0, String paramValue0, String paramName1, String paramValue1, String fieldName, String scope, String stemName, String stemUuid, String stemScope, String enabled, String pageSize, String pageNumber, String sortString, String ascending)
      get groups for a subject based on filter
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      subjectId - to add (mutually exclusive with subjectIdentifier)
      subjectSourceId - is source of subject to narrow the result and prevent duplicates
      subjectIdentifier - to add (mutually exclusive with subjectId)
      includeGroupDetail - T or F as to if the group detail should be included (defaults to F)
      memberFilter - can be All, Effective (non immediate), Immediate (direct), Composite (if composite group with group math (union, minus, etc)
      actAsSubjectId - optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      actAsSubjectSourceId - is source of act as subject to narrow the result and prevent duplicates
      actAsSubjectIdentifier - optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      includeSubjectDetail - T|F, for if the extended subject information should be returned (anything more than just the id)
      subjectAttributeNames - are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent (comma separated)
      paramName0 - reserved for future use
      paramValue0 - reserved for future use
      paramName1 - reserved for future use
      paramValue1 - reserved for future use
      fieldName - is field name (list name) to search or blank for default list
      scope - is a DB pattern that will have % appended to it, or null for all. e.g. school:whatever:parent:
      stemName - is the stem to check in, or null if all. If has stem, must have stemScope
      stemUuid - is the stem to check in, or null if all. If has stem, must have stemScope
      stemScope - is ONE_LEVEL if in this stem, or ALL_IN_SUBTREE for any stem underneath. You must pass stemScope if you pass a stem
      enabled - is A for all, T or blank for enabled only, F for disabled
      pageSize - page size if paging
      pageNumber - page number 1 indexed if paging
      sortString - must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension
      ascending - or null for ascending, false for descending. If you pass true or false, must pass a sort string
      Returns:
      the result of one member add
    • addMemberLite

      public WsAddMemberLiteResult addMemberLite(String clientVersion, String groupName, String groupUuid, String subjectId, String subjectSourceId, String subjectIdentifier, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String fieldName, String includeGroupDetail, String includeSubjectDetail, String subjectAttributeNames, String paramName0, String paramValue0, String paramName1, String paramValue1, String disabledTime, String enabledTime)
      add member to a group (if already a direct member, ignore)
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      groupName - to lookup the group (mutually exclusive with groupUuid)
      groupUuid - to lookup the group (mutually exclusive with groupName)
      subjectId - to add (mutually exclusive with subjectIdentifier)
      subjectSourceId - is source of subject to narrow the result and prevent duplicates
      subjectIdentifier - to add (mutually exclusive with subjectId)
      actAsSubjectId - optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      actAsSubjectSourceId - is source of act as subject to narrow the result and prevent duplicates
      actAsSubjectIdentifier - optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      fieldName - is if the member should be added to a certain field membership of the group (certain list)
      includeGroupDetail - T or F as to if the group detail should be returned
      includeSubjectDetail - T|F, for if the extended subject information should be returned (anything more than just the id)
      subjectAttributeNames - are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent. Comma-separate if multiple
      paramName0 - reserved for future use
      paramValue0 - reserved for future use
      paramName1 - reserved for future use
      paramValue1 - reserved for future use
      disabledTime - date this membership will be disabled: yyyy/MM/dd HH:mm:ss.SSS
      enabledTime - date this membership will be enabled (for future provisioning): yyyy/MM/dd HH:mm:ss.SSS
      Returns:
      the result of one member add
    • hasMemberLite

      public WsHasMemberLiteResult hasMemberLite(String clientVersion, String groupName, String groupUuid, String subjectId, String subjectSourceId, String subjectIdentifier, String memberFilter, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String fieldName, String includeGroupDetail, String includeSubjectDetail, String subjectAttributeNames, String paramName0, String paramValue0, String paramName1, String paramValue1)
      see if a group has a member (if already a direct member, ignore)
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      groupName - to lookup the group (mutually exclusive with groupUuid)
      groupUuid - to lookup the group (mutually exclusive with groupName)
      subjectId - to query (mutually exclusive with subjectIdentifier)
      subjectSourceId - is source of subject to narrow the result and prevent duplicates
      subjectIdentifier - to query (mutually exclusive with subjectId)
      includeSubjectDetail - T|F, for if the extended subject information should be returned (anything more than just the id)
      subjectAttributeNames - are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent (comma separated)
      memberFilter - can be All, Effective (non immediate), Immediate (direct), Composite (if composite group with group math (union, minus, etc)
      actAsSubjectId - optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      actAsSubjectSourceId - is source of act as subject to narrow the result and prevent duplicates
      actAsSubjectIdentifier - optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      fieldName - is if the Group.hasMember() method with field is to be called (e.g. admins, optouts, optins, etc from Field table in DB)
      includeGroupDetail - T or F as to if the group detail should be returned
      includeSubjectDetail - T|F, for if the extended subject information should be returned (anything more than just the id)
      subjectAttributeNames - are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent
      paramName0 - reserved for future use
      paramValue0 - reserved for future use
      paramName1 - reserved for future use
      paramValue1 - reserved for future use
      Returns:
      the result of one member query
    • memberChangeSubjectLite

      public WsMemberChangeSubjectLiteResult memberChangeSubjectLite(String clientVersion, String oldSubjectId, String oldSubjectSourceId, String oldSubjectIdentifier, String newSubjectId, String newSubjectSourceId, String newSubjectIdentifier, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String deleteOldMember, String includeSubjectDetail, String subjectAttributeNames, String paramName0, String paramValue0, String paramName1, String paramValue1)
      see if a group has a member (if already a direct member, ignore)
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      oldSubjectId - subject id of old member object. This is the preferred way to look up the old subject, but subjectIdentifier could also be used
      oldSubjectSourceId - source id of old member object (optional)
      oldSubjectIdentifier - subject identifier of old member object. It is preferred to lookup the old subject by id, but if identifier is used, that is ok instead (as long as subject is resolvable).
      newSubjectId - preferred way to identify the new subject id
      newSubjectSourceId - preferres way to identify the new subject id
      newSubjectIdentifier - subjectId is the preferred way to lookup the new subject, but identifier is ok to use instead
      includeSubjectDetail - T|F, for if the extended subject information should be returned (anything more than just the id) of the new subject
      subjectAttributeNames - are the additional subject attributes (data) to return of the new subject If blank, whatever is configured in the grouper-ws.properties will be sent (comma separated)
      actAsSubjectId - optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      actAsSubjectSourceId - is source of act as subject to narrow the result and prevent duplicates
      actAsSubjectIdentifier - optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      deleteOldMember - T or F as to whether the old member should be deleted (if new member does exist). This defaults to T if it is blank
      subjectAttributeNames - are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent
      paramName0 - reserved for future use
      paramValue0 - reserved for future use
      paramName1 - reserved for future use
      paramValue1 - reserved for future use
      Returns:
      the result of one member query
    • memberChangeSubject

      public WsMemberChangeSubjectResults memberChangeSubject(String clientVersion, WsMemberChangeSubject[] wsMemberChangeSubjects, WsSubjectLookup actAsSubjectLookup, String txType, String includeSubjectDetail, String[] subjectAttributeNames, WsParam[] params)
      add member to a group (if already a direct member, ignore)
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      wsMemberChangeSubjects - list of objects which describe a member change subject
      actAsSubjectLookup -
      txType - is the GrouperTransactionType for the request. If blank, defaults to NONE (will finish as much as possible). Generally the only values for this param that make sense are NONE (or blank), and READ_WRITE_NEW.
      subjectAttributeNames - are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent
      includeSubjectDetail - T|F, for if the extended subject information should be returned (anything more than just the id)
      params - optional: reserved for future use
      Returns:
      the results
      See Also:
    • deleteMemberLite

      public WsDeleteMemberLiteResult deleteMemberLite(String clientVersion, String groupName, String groupUuid, String subjectId, String subjectSourceId, String subjectIdentifier, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String fieldName, String includeGroupDetail, String includeSubjectDetail, String subjectAttributeNames, String paramName0, String paramValue0, String paramName1, String paramValue1)
      delete member to a group (if not already a direct member, ignore)
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      groupName - to lookup the group (mutually exclusive with groupUuid)
      groupUuid - to lookup the group (mutually exclusive with groupName)
      subjectId - to lookup the subject (mutually exclusive with subjectIdentifier)
      subjectSourceId - is source of subject to narrow the result and prevent duplicates
      subjectIdentifier - to lookup the subject (mutually exclusive with subjectId)
      actAsSubjectId - optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      actAsSubjectSourceId - is source of act as subject to narrow the result and prevent duplicates
      actAsSubjectIdentifier - optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      fieldName - is if the member should be added to a certain field membership of the group (certain list)
      includeGroupDetail - T or F as to if the group detail should be returned
      includeSubjectDetail - T|F, for if the extended subject information should be returned (anything more than just the id)
      subjectAttributeNames - are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent. Comma-separate if multiple
      paramName0 - reserved for future use
      paramValue0 - reserved for future use
      paramName1 - reserved for future use
      paramValue1 - reserved for future use
      Returns:
      the result of one member delete
    • findStemsLite

      public WsFindStemsResults findStemsLite(String clientVersion, String stemQueryFilterType, String stemName, String parentStemName, String parentStemNameScope, String stemUuid, String stemAttributeName, String stemAttributeValue, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1)
      find a stem or stems
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      stemQueryFilterType - findStemType is the WsFindStemType enum for which type of find is happening: e.g. FIND_BY_STEM_UUID, FIND_BY_STEM_NAME, FIND_BY_PARENT_STEM_NAME, FIND_BY_APPROXIMATE_ATTRIBUTE, FIND_BY_STEM_NAME_APPROXIMATE AND, OR, MINUS;
      stemName - search by stem name (must match exactly), cannot use other params with this
      parentStemName - will return stems in this stem. can be used with various query types
      parentStemNameScope - if searching by stem, ONE_LEVEL is for one level, ALL_IN_SUBTREE will return all in sub tree. Required if searching by stem
      stemUuid - search by stem uuid (must match exactly), cannot use other params with this
      stemAttributeName - if searching by attribute, this is name, or null for all attributes
      stemAttributeValue - if searching by attribute, this is the value
      actAsSubjectId - optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      actAsSubjectIdentifier - optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      actAsSubjectSourceId - optional to narrow the act as subject search to a particular source
      paramName0 - reserved for future use
      paramValue0 - reserved for future use
      paramName1 - reserved for future use
      paramValue1 - reserved for future use
      Returns:
      the stems, or no stems if none found
    • getGrouperPrivilegesLite

      public WsGetGrouperPrivilegesLiteResult getGrouperPrivilegesLite(String clientVersion, String subjectId, String subjectSourceId, String subjectIdentifier, String groupName, String groupUuid, String stemName, String stemUuid, String privilegeType, String privilegeName, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeSubjectDetail, String subjectAttributeNames, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1)
       see if a group has a member (if already a direct member, ignore)
       GET
       e.g. /grouperPrivileges/subjects/1234567/groups/aStem:aGroup
       e.g. /grouperPrivileges/subjects/sources/someSource/subjectId/1234567/stems/aStem1:aStem2/
       
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      subjectId - subject id of subject to search for privileges. Mutually exclusive with subjectIdentifier
      subjectSourceId - source id of subject object (optional)
      subjectIdentifier - subject identifier of subject. Mutuallyexclusive with subjectId
      groupName - if this is a group privilege. mutually exclusive with groupUuid
      groupUuid - if this is a group privilege. mutually exclusive with groupName
      stemName - if this is a stem privilege. mutually exclusive with stemUuid
      stemUuid - if this is a stem privilege. mutually exclusive with stemName
      actAsSubjectId - optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      actAsSubjectSourceId - is source of act as subject to narrow the result and prevent duplicates
      actAsSubjectIdentifier - optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      privilegeType - (e.g. "access" for groups and "naming" for stems)
      privilegeName - (e.g. for groups: read, view, update, admin, optin, optout. e.g. for stems: stem, create)
      includeSubjectDetail - T|F, for if the extended subject information should be returned (anything more than just the id)
      subjectAttributeNames - are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent (comma separated)
      includeGroupDetail - T or F as for if group detail should be included
      paramName0 - reserved for future use
      paramValue0 - reserved for future use
      paramName1 - reserved for future use
      paramValue1 - reserved for future use
      Returns:
      the result of one member query
    • assignGrouperPrivilegesLite

      public WsAssignGrouperPrivilegesLiteResult assignGrouperPrivilegesLite(String clientVersion, String subjectId, String subjectSourceId, String subjectIdentifier, String groupName, String groupUuid, String stemName, String stemUuid, String privilegeType, String privilegeName, String allowed, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeSubjectDetail, String subjectAttributeNames, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1)
       add a privilge to a stem or group (ok if already existed)
       PUT
       e.g. /grouperPrivileges/subjects/1234567/groups/aStem:aGroup
       e.g. /grouperPrivileges/subjects/sources/someSource/subjectId/1234567/stems/aStem1:aStem2/
       
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      subjectId - subject id of subject to search for privileges. Mutually exclusive with subjectIdentifier
      subjectSourceId - source id of subject object (optional)
      subjectIdentifier - subject identifier of subject. Mutuallyexclusive with subjectId
      groupName - if this is a group privilege. mutually exclusive with groupUuid
      groupUuid - if this is a group privilege. mutually exclusive with groupName
      stemName - if this is a stem privilege. mutually exclusive with stemUuid
      stemUuid - if this is a stem privilege. mutually exclusive with stemName
      actAsSubjectId - optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      actAsSubjectSourceId - is source of act as subject to narrow the result and prevent duplicates
      actAsSubjectIdentifier - optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      deleteOldMember - T or F as to whether the old member should be deleted (if new member does exist). This defaults to T if it is blank
      privilegeType - (e.g. "access" for groups and "naming" for stems)
      privilegeName - (e.g. for groups: read, view, update, admin, optin, optout. e.g. for stems: stem, create)
      allowed - T|F is this is allowing the privilege, or denying it
      includeSubjectDetail - T|F, for if the extended subject information should be returned (anything more than just the id)
      subjectAttributeNames - are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent (comma separated)
      includeGroupDetail - T or F as for if group detail should be included
      paramName0 - reserved for future use
      paramValue0 - reserved for future use
      paramName1 - reserved for future use
      paramValue1 - reserved for future use
      Returns:
      the result of one member query
    • getMemberships

      public WsGetMembershipsResults getMemberships(String clientVersion, WsGroupLookup[] wsGroupLookups, WsSubjectLookup[] wsSubjectLookups, String wsMemberFilter, WsSubjectLookup actAsSubjectLookup, String fieldName, String includeSubjectDetail, String[] subjectAttributeNames, String includeGroupDetail, WsParam[] params, String[] sourceIds, String scope, WsStemLookup wsStemLookup, String stemScope, String enabled, String[] membershipIds)
      get memberships from groups and or subjects based on a filter (all, immediate only, effective only, composite, nonimmediate).
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      wsGroupLookups - are groups to look in
      wsSubjectLookups - are subjects to look in
      wsMemberFilter - must be one of All, Effective, Immediate, Composite, NonImmediate
      includeSubjectDetail - T|F, for if the extended subject information should be returned (anything more than just the id)
      actAsSubjectLookup -
      fieldName - is if the memberships should be retrieved from a certain field membership of the group (certain list) of the group (certain list)
      subjectAttributeNames - are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent
      includeGroupDetail - T or F as to if the group detail should be returned
      params - optional: reserved for future use
      sourceIds - are sources to look in for memberships, or null if all
      scope - is a sql like string which will have a percent % concatenated to the end for group names to search in (or stem names)
      wsStemLookup - is the stem to look in for memberships
      stemScope - is StemScope to search only in one stem or in substems: ONE_LEVEL, ALL_IN_SUBTREE
      enabled - is A for all, T or null for enabled only, F for disabled
      membershipIds - are the ids to search for if they are known
      Returns:
      the results
    • getMembershipsLite

      public WsGetMembershipsResults getMembershipsLite(String clientVersion, String groupName, String groupUuid, String subjectId, String sourceId, String subjectIdentifier, String wsMemberFilter, String includeSubjectDetail, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String fieldName, String subjectAttributeNames, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1, String sourceIds, String scope, String stemName, String stemUuid, String stemScope, String enabled, String membershipIds)
      get memberships from a group based on a filter (all, immediate only, effective only, composite)
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      groupName - to lookup the group (mutually exclusive with groupUuid)
      groupUuid - to lookup the group (mutually exclusive with groupName)
      subjectId - to search for memberships in or null to not restrict
      sourceId - of subject to search for memberships, or null to not restrict
      subjectIdentifier - of subject to search for memberships, or null to not restrict
      wsMemberFilter - must be one of All, Effective, Immediate, Composite
      includeSubjectDetail - T|F, for if the extended subject information should be returned (anything more than just the id)
      actAsSubjectId - optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      actAsSubjectSourceId - is source of act as subject to narrow the result and prevent duplicates
      actAsSubjectIdentifier - optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      fieldName - is if the member should be added to a certain field membership of the group (certain list)
      subjectAttributeNames - are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent. Comma-separate if multiple
      includeGroupDetail - T or F as to if the group detail should be returned
      paramName0 - reserved for future use
      paramValue0 - reserved for future use
      paramName1 - reserved for future use
      paramValue1 - reserved for future use
      sourceIds - are comma separated sourceIds
      scope - is a sql like string which will have a percent % concatenated to the end for group names to search in (or stem names)
      stemName - to limit the search to a stem (in or under)
      stemUuid - to limit the search to a stem (in or under)
      stemScope - to specify if we are searching in or under the stem
      enabled - A for all, null or T for enabled only, F for disabled only
      membershipIds - comma separated list of membershipIds to retrieve
      Returns:
      the memberships, or none if none found
    • getSubjects

      public WsGetSubjectsResults getSubjects(String clientVersion, WsSubjectLookup[] wsSubjectLookups, String searchString, String includeSubjectDetail, String[] subjectAttributeNames, WsSubjectLookup actAsSubjectLookup, String[] sourceIds, WsGroupLookup wsGroupLookup, String wsMemberFilter, String fieldName, String includeGroupDetail, WsParam[] params)
      get subjects from searching by id or identifier or search string. Can filter by subjects which are members in a group.
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      wsSubjectLookups - are subjects to look in
      searchString - free form string query to find a list of subjects (exact behavior depends on source)
      wsMemberFilter - must be one of All, Effective, Immediate, Composite, NonImmediate
      includeSubjectDetail - T|F, for if the extended subject information should be returned (anything more than just the id)
      actAsSubjectLookup -
      fieldName - is if the memberships should be retrieved from a certain field membership of the group (certain list) of the group (certain list)
      subjectAttributeNames - are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent
      includeGroupDetail - T or F as to if the group detail should be returned
      params - optional: reserved for future use
      sourceIds - are sources to look in for memberships, or null if all
      wsGroupLookup - specify a group if the subjects must be in the group (limit of number of subjects found in list is much lower e.g. 1000)
      Returns:
      the results
    • getSubjectsLite

      public WsGetSubjectsResults getSubjectsLite(String clientVersion, String subjectId, String sourceId, String subjectIdentifier, String searchString, String includeSubjectDetail, String subjectAttributeNames, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String sourceIds, String groupName, String groupUuid, String wsMemberFilter, String fieldName, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1)
      get subjects from searching by id or identifier or search string. Can filter by subjects which are members in a group.
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      wsSubjectLookups - are subjects to look in
      subjectId - to find a subject by id
      sourceId - to find a subject by id or identifier
      subjectIdentifier - to find a subject by identifier
      searchString - free form string query to find a list of subjects (exact behavior depends on source)
      wsMemberFilter - must be one of All, Effective, Immediate, Composite, NonImmediate or null (all)
      includeSubjectDetail - T|F, for if the extended subject information should be returned (anything more than just the id)
      actAsSubjectId - optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      actAsSubjectSourceId - is source of act as subject to narrow the result and prevent duplicates
      actAsSubjectIdentifier - optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer
      fieldName - is if the memberships should be retrieved from a certain field membership of the group (certain list)
      subjectAttributeNames - are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent. Comma-separate if multiple
      includeGroupDetail - T or F as to if the group detail should be returned
      paramName0 - reserved for future use
      paramValue0 - reserved for future use
      paramName1 - reserved for future use
      paramValue1 - reserved for future use
      sourceIds - are comma separated sourceIds for a searchString
      groupName - specify a group if the subjects must be in the group (limit of number of subjects found in list is much lower e.g. 1000)
      groupUuid - specify a group if the subjects must be in the group (limit of number of subjects found in list is much lower e.g. 1000)
      Returns:
      the results or none if none found
    • assignGrouperPrivileges

      public WsAssignGrouperPrivilegesResults assignGrouperPrivileges(String clientVersion, WsSubjectLookup[] wsSubjectLookups, WsGroupLookup wsGroupLookup, WsStemLookup wsStemLookup, String privilegeType, String[] privilegeNames, String allowed, String replaceAllExisting, String txType, WsSubjectLookup actAsSubjectLookup, String includeSubjectDetail, String[] subjectAttributeNames, String includeGroupDetail, WsParam[] params)
       assign a privilege for a user/group/type/name combo
       e.g. POST /grouperPrivileges
       
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      wsSubjectLookups - are the subjects to assign the privileges to, looked up by subjectId or identifier
      wsGroupLookup - if this is a group privilege, this is the group
      wsStemLookup - if this is a stem privilege, this is the stem
      replaceAllExisting - optional: T or F (default), if the existing privilege assignments for this object should be replaced
      actAsSubjectLookup - optional: is the subject to act as (if proxying).
      privilegeType - (e.g. "access" for groups and "naming" for stems)
      privilegeNames - (e.g. for groups: read, view, update, admin, optin, optout. e.g. for stems: stem, create)
      allowed - is T to allow this privilege, F to deny this privilege
      includeSubjectDetail - T|F, for if the extended subject information should be returned (anything more than just the id)
      subjectAttributeNames - are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent (comma separated)
      includeGroupDetail - T or F as for if group detail should be included
      txType - is the GrouperTransactionType for the request. If blank, defaults to NONE (will finish as much as possible). Generally the only values for this param that make sense are NONE (or blank), and READ_WRITE_NEW.
      params - optional: reserved for future use
      Returns:
      the result of one member query
    • getAttributeAssignments

      public WsGetAttributeAssignmentsResults getAttributeAssignments(String clientVersion, String attributeAssignType, WsAttributeAssignLookup[] wsAttributeAssignLookups, WsAttributeDefLookup[] wsAttributeDefLookups, WsAttributeDefNameLookup[] wsAttributeDefNameLookups, WsGroupLookup[] wsOwnerGroupLookups, WsStemLookup[] wsOwnerStemLookups, WsSubjectLookup[] wsOwnerSubjectLookups, WsMembershipLookup[] wsOwnerMembershipLookups, WsMembershipAnyLookup[] wsOwnerMembershipAnyLookups, WsAttributeDefLookup[] wsOwnerAttributeDefLookups, String[] actions, String includeAssignmentsOnAssignments, WsSubjectLookup actAsSubjectLookup, String includeSubjectDetail, String[] subjectAttributeNames, String includeGroupDetail, WsParam[] params, String enabled)
      get attributeAssignments from groups etc based on inputs
      Parameters:
      attributeAssignType - Type of owner, from enum AttributeAssignType, e.g. group, member, stem, any_mem, imm_mem, attr_def, NOT: group_asgn, NOT: mem_asgn, NOT: stem_asgn, NOT: any_mem_asgn, NOT: imm_mem_asgn, NOT: attr_def_asgn
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      wsAttributeAssignLookups - if you know the assign ids you want, put them here
      wsOwnerGroupLookups - are groups to look in
      wsOwnerSubjectLookups - are subjects to look in
      wsAttributeDefLookups - find assignments in these attribute defs (optional)
      wsAttributeDefNameLookups - find assignments in these attribute def names (optional)
      wsOwnerStemLookups - are stems to look in
      wsOwnerMembershipLookups - to query attributes on immediate memberships
      wsOwnerMembershipAnyLookups - to query attributes in "any" memberships which are on immediate or effective memberships
      wsOwnerAttributeDefLookups - to query attributes assigned on attribute defs
      actions - to query, or none to query all actions
      includeAssignmentsOnAssignments - if this is not querying assignments on assignments directly, but the assignments and assignments on those assignments should be returned, enter true. default to false.
      includeSubjectDetail - T|F, for if the extended subject information should be returned (anything more than just the id)
      actAsSubjectLookup -
      subjectAttributeNames - are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent
      includeGroupDetail - T or F as to if the group detail should be returned
      params - optional: reserved for future use
      enabled - is A for all, T or null for enabled only, F for disabled
      Returns:
      the results
    • getAttributeAssignmentsLite

      public WsGetAttributeAssignmentsResults getAttributeAssignmentsLite(String clientVersion, String attributeAssignType, String attributeAssignId, String wsAttributeDefName, String wsAttributeDefId, String wsAttributeDefNameName, String wsAttributeDefNameId, String wsOwnerGroupName, String wsOwnerGroupId, String wsOwnerStemName, String wsOwnerStemId, String wsOwnerSubjectId, String wsOwnerSubjectSourceId, String wsOwnerSubjectIdentifier, String wsOwnerMembershipId, String wsOwnerMembershipAnyGroupName, String wsOwnerMembershipAnyGroupId, String wsOwnerMembershipAnySubjectId, String wsOwnerMembershipAnySubjectSourceId, String wsOwnerMembershipAnySubjectIdentifier, String wsOwnerAttributeDefName, String wsOwnerAttributeDefId, String action, String includeAssignmentsOnAssignments, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeSubjectDetail, String subjectAttributeNames, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1, String enabled)
      get attributeAssignments based on inputs
      Parameters:
      attributeAssignType - Type of owner, from enum AttributeAssignType, e.g. group, member, stem, any_mem, imm_mem, attr_def, NOT: group_asgn, NOT: mem_asgn, NOT: stem_asgn, NOT: any_mem_asgn, NOT: imm_mem_asgn, NOT: attr_def_asgn
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      attributeAssignId - if you know the assign id you want, put it here
      wsAttributeDefName - find assignments in this attribute def (optional)
      wsAttributeDefId - find assignments in this attribute def (optional)
      wsAttributeDefNameName - find assignments in this attribute def name (optional)
      wsAttributeDefNameId - find assignments in this attribute def name (optional)
      wsOwnerGroupName - is group name to look in
      wsOwnerGroupId - is group id to look in
      wsOwnerStemName - is stem to look in
      wsOwnerStemId - is stem to look in
      wsOwnerSubjectId - is subject to look in
      wsOwnerSubjectSourceId - is subject to look in
      wsOwnerSubjectIdentifier - is subject to look in
      wsOwnerMembershipId - to query attributes on immediate membership
      wsOwnerMembershipAnyGroupName - to query attributes in "any" membership which is on immediate or effective membership
      wsOwnerMembershipAnyGroupId - to query attributes in "any" membership which is on immediate or effective membership
      wsOwnerMembershipAnySubjectId - to query attributes in "any" membership which is on immediate or effective membership
      wsOwnerMembershipAnySubjectSourceId - to query attributes in "any" membership which is on immediate or effective membership
      wsOwnerMembershipAnySubjectIdentifier - to query attributes in "any" membership which is on immediate or effective membership
      wsOwnerAttributeDefName - to query attributes assigned on attribute def
      wsOwnerAttributeDefId - to query attributes assigned on attribute def
      action - to query, or none to query all actions
      includeAssignmentsOnAssignments - if this is not querying assignments on assignments directly, but the assignments and assignments on those assignments should be returned, enter true. default to false.
      actAsSubjectId -
      actAsSubjectSourceId -
      actAsSubjectIdentifier -
      includeSubjectDetail - T|F, for if the extended subject information should be returned (anything more than just the id)
      subjectAttributeNames - are the additional subject attributes (data) to return (comma separated) If blank, whatever is configured in the grouper-ws.properties will be sent
      includeGroupDetail - T or F as to if the group detail should be returned
      paramName0 - reserved for future use
      paramValue0 - reserved for future use
      paramName1 - reserved for future use
      paramValue1 - reserved for future use
      enabled - is A for all, T or null for enabled only, F for disabled
      Returns:
      the results
    • assignAttributes

      public WsAssignAttributesResults assignAttributes(String clientVersion, String attributeAssignType, WsAttributeDefNameLookup[] wsAttributeDefNameLookups, String attributeAssignOperation, WsAttributeAssignValue[] values, String assignmentNotes, String assignmentEnabledTime, String assignmentDisabledTime, String delegatable, String attributeAssignValueOperation, WsAttributeAssignLookup[] wsAttributeAssignLookups, WsGroupLookup[] wsOwnerGroupLookups, WsStemLookup[] wsOwnerStemLookups, WsSubjectLookup[] wsOwnerSubjectLookups, WsMembershipLookup[] wsOwnerMembershipLookups, WsMembershipAnyLookup[] wsOwnerMembershipAnyLookups, WsAttributeDefLookup[] wsOwnerAttributeDefLookups, WsAttributeAssignLookup[] wsOwnerAttributeAssignLookups, String[] actions, WsSubjectLookup actAsSubjectLookup, String includeSubjectDetail, String[] subjectAttributeNames, String includeGroupDetail, WsParam[] params, WsAttributeDefLookup[] attributeDefsToReplace, String[] actionsToReplace, String[] attributeDefTypesToReplace)
      assign attributes and values to owner objects (groups, stems, etc)
      Parameters:
      attributeAssignType - Type of owner, from enum AttributeAssignType, e.g. group, member, stem, any_mem, imm_mem, attr_def, group_asgn, mem_asgn, stem_asgn, any_mem_asgn, imm_mem_asgn, attr_def_asgn
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      wsAttributeAssignLookups - if you know the assign ids you want, put them here
      wsOwnerGroupLookups - are groups to look in
      wsOwnerSubjectLookups - are subjects to look in
      wsAttributeDefNameLookups - attribute def names to assign to the owners
      attributeAssignOperation - operation to perform for attribute on owners, from enum AttributeAssignOperation assign_attr, add_attr, remove_attr
      values - are the values to assign, replace, remove, etc. If removing, and id is specified, will only remove values with that id.
      assignmentNotes - notes on the assignment (optional)
      assignmentEnabledTime - enabled time, or null for enabled now
      assignmentDisabledTime - disabled time, or null for not disabled
      delegatable - really only for permissions, if the assignee can delegate to someone else. TRUE|FALSE|GRANT
      attributeAssignValueOperation - operation to perform for attribute value on attribute assignments: assign_value, add_value, remove_value, replace_values
      wsOwnerStemLookups - are stems to look in
      wsOwnerMembershipLookups - to query attributes on immediate memberships
      wsOwnerMembershipAnyLookups - to query attributes in "any" memberships which are on immediate or effective memberships
      wsOwnerAttributeDefLookups - to query attributes assigned on attribute defs
      wsOwnerAttributeAssignLookups - for assignment on assignment
      actions - to assign, or "assign" is the default if blank
      includeSubjectDetail - T|F, for if the extended subject information should be returned (anything more than just the id)
      actAsSubjectLookup -
      wsAttributeAssignLookups - lookups to remove etc
      subjectAttributeNames - are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent
      includeGroupDetail - T or F as to if the group detail should be returned
      params - optional: reserved for future use
      attributeDefsToReplace - if replacing attributeDefNames, then these are the related attributeDefs, if blank, then just do all
      actionsToReplace - if replacing attributeDefNames, then these are the related actions, if blank, then just do all
      attributeDefTypesToReplace - if replacing attributeDefNames, then these are the related attributeDefTypes, if blank, then just do all
      Returns:
      the results
    • assignAttributesLite

      public WsAssignAttributesLiteResults assignAttributesLite(String clientVersion, String attributeAssignType, String wsAttributeDefNameName, String wsAttributeDefNameId, String attributeAssignOperation, String valueId, String valueSystem, String valueFormatted, String assignmentNotes, String assignmentEnabledTime, String assignmentDisabledTime, String delegatable, String attributeAssignValueOperation, String wsAttributeAssignId, String wsOwnerGroupName, String wsOwnerGroupId, String wsOwnerStemName, String wsOwnerStemId, String wsOwnerSubjectId, String wsOwnerSubjectSourceId, String wsOwnerSubjectIdentifier, String wsOwnerMembershipId, String wsOwnerMembershipAnyGroupName, String wsOwnerMembershipAnyGroupId, String wsOwnerMembershipAnySubjectId, String wsOwnerMembershipAnySubjectSourceId, String wsOwnerMembershipAnySubjectIdentifier, String wsOwnerAttributeDefName, String wsOwnerAttributeDefId, String wsOwnerAttributeAssignId, String action, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeSubjectDetail, String subjectAttributeNames, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1)
      assign attributes and values to owner objects (groups, stems, etc)
      Parameters:
      attributeAssignType - Type of owner, from enum AttributeAssignType, e.g. group, member, stem, any_mem, imm_mem, attr_def, group_asgn, mem_asgn, stem_asgn, any_mem_asgn, imm_mem_asgn, attr_def_asgn
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      wsAttributeAssignId - if you know the assign id you want, put id here
      wsOwnerGroupName - is group to look in
      wsOwnerGroupId - is group to look in
      wsOwnerSubjectId - is subject to look in
      wsOwnerSubjectSourceId - is subject to look in
      wsOwnerSubjectIdentifier - is subject to look in
      wsAttributeDefNameName - attribute def name to assign to the owner
      wsAttributeDefNameId - attribute def name to assign to the owner
      attributeAssignOperation - operation to perform for attribute on owners, from enum AttributeAssignOperation assign_attr, add_attr, remove_attr
      valueId - If removing, and id is specified, will only remove values with that id.
      valueSystem - is value to add, assign, remove, etc
      valueFormatted - is value to add, assign, remove, etc though not implemented yet
      assignmentNotes - notes on the assignment (optional)
      assignmentEnabledTime - enabled time, or null for enabled now
      assignmentDisabledTime - disabled time, or null for not disabled
      delegatable - really only for permissions, if the assignee can delegate to someone else. TRUE|FALSE|GRANT
      attributeAssignValueOperation - operation to perform for attribute value on attribute assignments: assign_value, add_value, remove_value, replace_values
      wsOwnerStemName - is stem to look in
      wsOwnerStemId - is stem to look in
      wsOwnerMembershipId - to query attributes on immediate membership
      wsOwnerMembershipAnyGroupName - to query attributes in "any" membership which is on immediate or effective membership
      wsOwnerMembershipAnyGroupId - to query attributes in "any" membership which is on immediate or effective membership
      wsOwnerMembershipAnySubjectId - to query attributes in "any" membership which is on immediate or effective membership
      wsOwnerMembershipAnySubjectSourceId - to query attributes in "any" membership which is on immediate or effective membership
      wsOwnerMembershipAnySubjectIdentifier - to query attributes in "any" membership which is on immediate or effective membership
      wsOwnerAttributeDefName - to query attributes assigned on attribute def
      wsOwnerAttributeDefId - to query attributes assigned on attribute def
      wsOwnerAttributeAssignId - for assignment on assignment
      action - to assign, or "assign" is the default if blank
      includeSubjectDetail - T|F, for if the extended subject information should be returned (anything more than just the id)
      actAsSubjectId - act as this subject
      actAsSubjectSourceId - act as this subject
      actAsSubjectIdentifier - act as this subject
      wsAttributeAssignLookups - lookups to remove etc
      subjectAttributeNames - are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent
      includeGroupDetail - T or F as to if the group detail should be returned
      paramName0 - reserved for future use
      paramValue0 - reserved for future use
      paramName1 - reserved for future use
      paramValue1 - reserved for future use
      Returns:
      the results
    • getPermissionAssignments

      public WsGetPermissionAssignmentsResults getPermissionAssignments(String clientVersion, WsAttributeDefLookup[] wsAttributeDefLookups, WsAttributeDefNameLookup[] wsAttributeDefNameLookups, WsGroupLookup[] roleLookups, WsSubjectLookup[] wsSubjectLookups, String[] actions, String includePermissionAssignDetail, String includeAttributeDefNames, String includeAttributeAssignments, String includeAssignmentsOnAssignments, WsSubjectLookup actAsSubjectLookup, String includeSubjectDetail, String[] subjectAttributeNames, String includeGroupDetail, WsParam[] params, String enabled)
      get permissionAssignments from roles etc based on inputs
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      roleLookups - are roles to look in
      wsSubjectLookups - are subjects to look in
      wsAttributeDefLookups - find assignments in these attribute defs (optional)
      wsAttributeDefNameLookups - find assignments in these attribute def names (optional)
      actions - to query, or none to query all actions
      includeAttributeDefNames - T or F for if attributeDefName objects should be returned
      includeAttributeAssignments - T or F for it attribute assignments should be returned
      includeAssignmentsOnAssignments - if this is not querying assignments on assignments directly, but the assignments and assignments on those assignments should be returned, enter true. default to false.
      includePermissionAssignDetail - T or F for if the permission details should be returned
      includeSubjectDetail - T|F, for if the extended subject information should be returned (anything more than just the id)
      actAsSubjectLookup -
      subjectAttributeNames - are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent
      includeGroupDetail - T or F as to if the group detail should be returned
      params - optional: reserved for future use
      enabled - is A for all, T or null for enabled only, F for disabled
      Returns:
      the results
    • getPermissionAssignmentsLite

      public WsGetPermissionAssignmentsResults getPermissionAssignmentsLite(String clientVersion, String wsAttributeDefName, String wsAttributeDefId, String wsAttributeDefNameName, String wsAttributeDefNameId, String roleName, String roleId, String wsSubjectId, String wsSubjectSourceId, String wsSubjectIdentifier, String action, String includePermissionAssignDetail, String includeAttributeDefNames, String includeAttributeAssignments, String includeAssignmentsOnAssignments, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeSubjectDetail, String subjectAttributeNames, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1, String enabled)
      get permissionAssignments from role etc based on inputs
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      roleName - is role to look in
      roleId - is role to look in
      wsAttributeDefName - find assignments in this attribute def (optional)
      wsAttributeDefId - find assignments in this attribute def (optional)
      wsAttributeDefNameName - find assignments in this attribute def name (optional)
      wsAttributeDefNameId - find assignments in this attribute def name (optional)
      wsSubjectId - is subject to look in
      wsSubjectSourceId - is subject to look in
      wsSubjectIdentifier - is subject to look in
      action - to query, or none to query all actions
      includeAttributeDefNames - T or F for if attributeDefName objects should be returned
      includeAttributeAssignments - T or F for it attribute assignments should be returned
      includeAssignmentsOnAssignments - if this is not querying assignments on assignments directly, but the assignments and assignments on those assignments should be returned, enter true. default to false.
      includePermissionAssignDetail - T or F for if the permission details should be returned
      includeSubjectDetail - T|F, for if the extended subject information should be returned (anything more than just the id)
      actAsSubjectId - act as this subject (if allowed)
      actAsSubjectSourceId - act as this subject (if allowed)
      actAsSubjectIdentifier - act as this subject (if allowed)
      subjectAttributeNames - are the additional subject attributes (data) to return (comma separated) If blank, whatever is configured in the grouper-ws.properties will be sent
      includeGroupDetail - T or F as to if the group detail should be returned
      paramName0 - reserved for future use
      paramValue0 - reserved for future use
      paramName1 - reserved for future use
      paramValue1 - reserved for future use
      enabled - is A for all, T or null for enabled only, F for disabled
      Returns:
      the results
    • assignPermissions

      public WsAssignPermissionsResults assignPermissions(String clientVersion, String permissionType, WsAttributeDefNameLookup[] permissionDefNameLookups, String permissionAssignOperation, String assignmentNotes, String assignmentEnabledTime, String assignmentDisabledTime, String delegatable, WsAttributeAssignLookup[] wsAttributeAssignLookups, WsGroupLookup[] roleLookups, WsMembershipAnyLookup[] subjectRoleLookups, String[] actions, WsSubjectLookup actAsSubjectLookup, String includeSubjectDetail, String[] subjectAttributeNames, String includeGroupDetail, WsParam[] params, WsAttributeDefLookup[] attributeDefsToReplace, String[] actionsToReplace)
      assign permissions to roles or subjects (in the context of a role)
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      permissionType - is role or role_subject from the PermissionType enum
      roleLookups - are groups to assign to for permissionType "role"
      subjectRoleLookups - are subjects to assign to, in the context of a role (for permissionType "subject_role")
      permissionDefNameLookups - attribute def names to assign to the owners (required)
      permissionAssignOperation - operation to perform for permission on role or subject, from enum PermissionAssignOperation assign_permission, remove_permission
      assignmentNotes - notes on the assignment (optional)
      assignmentEnabledTime - enabled time, or null for enabled now
      assignmentDisabledTime - disabled time, or null for not disabled
      delegatable - if the assignee can delegate to someone else. TRUE|FALSE|GRANT
      actions - to assign, or "assign" is the default if blank
      includeSubjectDetail - T|F, for if the extended subject information should be returned (anything more than just the id)
      actAsSubjectLookup -
      wsAttributeAssignLookups - lookups to remove etc
      subjectAttributeNames - are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent
      includeGroupDetail - T or F as to if the group detail should be returned
      params - optional: reserved for future use
      attributeDefsToReplace - if replacing attributeDefNames, then these are the related attributeDefs, if blank, then just do all
      actionsToReplace - if replacing attributeDefNames, then these are the related actions, if blank, then just do all
      Returns:
      the results
    • assignPermissionsLite

      public WsAssignPermissionsLiteResults assignPermissionsLite(String clientVersion, String permissionType, String permissionDefNameName, String permissionDefNameId, String permissionAssignOperation, String assignmentNotes, String assignmentEnabledTime, String assignmentDisabledTime, String delegatable, String wsAttributeAssignId, String roleName, String roleId, String subjectRoleName, String subjectRoleId, String subjectRoleSubjectId, String subjectRoleSubjectSourceId, String subjectRoleSubjectIdentifier, String action, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String includeSubjectDetail, String subjectAttributeNames, String includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1)
      assign permissions to role or subject (in the context of a role)
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      permissionType - is role or role_subject from the PermissionType enum
      permissionDefNameName - attribute def name to assign to the owner (required)
      permissionDefNameId - attribute def name to assign to the owner (required)
      roleName - is group to assign to for permissionType "role"
      roleId - is group to assign to for permissionType "role"
      permissionAssignOperation - operation to perform for permission on role or subject, from enum PermissionAssignOperation assign_permission, remove_permission
      assignmentNotes - notes on the assignment (optional)
      assignmentEnabledTime - enabled time, or null for enabled now
      assignmentDisabledTime - disabled time, or null for not disabled
      delegatable - if the assignee can delegate to someone else. TRUE|FALSE|GRANT
      action - to assign, or "assign" is the default if blank
      includeSubjectDetail - T|F, for if the extended subject information should be returned (anything more than just the id)
      wsAttributeAssignId - lookup to remove etc
      subjectRoleName - is role name if assigning to subject, in the context of a role (for permissionType "subject_role")
      subjectRoleId - is role id if assigning to subject, in the context of a role (for permissionType "subject_role")
      subjectRoleSubjectId - is subject id if assigning to subject, in the context of a role (for permissionType "subject_role")
      subjectRoleSubjectSourceId - is subject source id if assigning to subject, in the context of a role (for permissionType "subject_role")
      subjectRoleSubjectIdentifier - is subject identifier if assigning to subject, in the context of a role (for permissionType "subject_role")
      actAsSubjectId - if acting as someone else
      actAsSubjectSourceId - if acting as someone else
      actAsSubjectIdentifier - if acting as someone else
      subjectAttributeNames - are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent
      includeGroupDetail - T or F as to if the group detail should be returned
      paramName0 - optional: reserved for future use
      paramValue0 - optional: reserved for future use
      paramName1 - optional: reserved for future use
      paramValue1 - optional: reserved for future use
      Returns:
      the results