Package edu.internet2.middleware.grouper.ws

Class GrouperServiceLogic

java.lang.Object
edu.internet2.middleware.grouper.ws.GrouperServiceLogic
public class GrouperServiceLogic extends Object
Meant to be delegate from GrouperService which has the same params (and names) with enums translated (for Simple objects like Field) for each Javadoc viewing.

  • Constructor Details

    • GrouperServiceLogic

      public GrouperServiceLogic()

  • Method Details

    • addMember

      public static WsAddMemberResults addMember(GrouperVersion clientVersion, WsGroupLookup wsGroupLookup, WsSubjectLookup[] subjectLookups, boolean replaceAllExisting, WsSubjectLookup actAsSubjectLookup, Field fieldName, GrouperTransactionType txType, boolean includeGroupDetail, boolean includeSubjectDetail, String[] subjectAttributeNames, WsParam[] params, Timestamp disabledTime, Timestamp enabledTime, boolean addExternalSubjectIfNotFound)
      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). by fieldName
      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
      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
      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
      addExternalSubjectIfNotFound - T or F, if this is a search by id or identifier, with no source, or the external source, and the subject is not found, then add an external subject (if the user is allowed
      Returns:
      the results. return the subject lookup only if there are problems retrieving the subject.
      See Also:

    • addMemberLite

      public static WsAddMemberLiteResult addMemberLite(GrouperVersion clientVersion, String groupName, String groupUuid, String subjectId, String subjectSourceId, String subjectIdentifier, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, Field fieldName, boolean includeGroupDetail, boolean includeSubjectDetail, String subjectAttributeNames, String paramName0, String paramValue0, String paramName1, String paramValue1, Timestamp disabledTime, Timestamp enabledTime, boolean addExternalSubjectIfNotFound)
      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 actAsSubjectIdentifier
      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 actAsSubjectIdentifier
      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
      addExternalSubjectIfNotFound - T or F, if this is a search by id or identifier, with no source, or the external source, and the subject is not found, then add an external subject (if the user is allowed
      Returns:
      the result of one member add

    • deleteMember

      public static WsDeleteMemberResults deleteMember(GrouperVersion clientVersion, WsGroupLookup wsGroupLookup, WsSubjectLookup[] subjectLookups, WsSubjectLookup actAsSubjectLookup, Field fieldName, GrouperTransactionType txType, boolean includeGroupDetail, boolean 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
      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

    • deleteMemberLite

      public static WsDeleteMemberLiteResult deleteMemberLite(GrouperVersion clientVersion, String groupName, String groupUuid, String subjectId, String subjectSourceId, String subjectIdentifier, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, Field fieldName, boolean includeGroupDetail, boolean 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 actAsSubjectIdentifier
      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 actAsSubjectIdentifier
      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

    • findGroups

      public static WsFindGroupsResults findGroups(GrouperVersion clientVersion, WsQueryFilter wsQueryFilter, WsSubjectLookup actAsSubjectLookup, boolean 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 groups are returned in alphabetical order
      Returns:
      the groups, or no groups if none found

    • findGroupsLite

      public static WsFindGroupsResults findGroupsLite(GrouperVersion clientVersion, WsQueryFilterType queryFilterType, String groupName, String stemName, StemScope stemNameScope, String groupUuid, String groupAttributeName, String groupAttributeValue, GroupType groupTypeName, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, boolean includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1, String pageSize, String pageNumber, String sortString, String ascending, String typeOfGroups, String pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, String pageCursorFieldIncludesLastRetrieved, String enabled)
      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 (context in query type)
      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 actAsSubjectIdentifier
      actAsSubjectIdentifier - optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifier
      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
      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
      pageIsCursor - true means cursor based paging
      pageLastCursorField - field based on which paging needs to occur
      pageLastCursorFieldType - type of last cursor field (eg: string, int, timestamp, etc)
      pageCursorFieldIncludesLastRetrieved - should the result has last retrieved item
      typeOfGroups - is comma separated TypeOfGroups to find, e.g. group, role, entity
      enabled - enabled is A for all, T or null for enabled only, F for disabled
      Returns:
      the groups, or no groups if none found

    • findStems

      public static WsFindStemsResults findStems(GrouperVersion 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
      actAsSubjectLookup - to act as a different user than the logged in user
      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

    • findStemsLite

      public static WsFindStemsResults findStemsLite(GrouperVersion clientVersion, WsStemQueryFilterType stemQueryFilterType, String stemName, String parentStemName, StemScope 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_EXACT, FIND_BY_PARENT_STEM_NAME, FIND_BY_APPROXIMATE_ATTRIBUTE, 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 actAsSubjectIdentifier
      actAsSubjectIdentifier - optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifier
      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

    • getGroups

      public static WsGetGroupsResults getGroups(GrouperVersion clientVersion, WsSubjectLookup[] subjectLookups, WsMemberFilter memberFilter, WsSubjectLookup actAsSubjectLookup, boolean includeGroupDetail, boolean includeSubjectDetail, String[] subjectAttributeNames, WsParam[] params, String fieldName, String scope, WsStemLookup wsStemLookup, StemScope stemScope, String enabled, Integer pageSize, Integer pageNumber, String sortString, Boolean ascending, Timestamp pointInTimeFrom, Timestamp pointInTimeTo, Boolean pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, Boolean pageCursorFieldIncludesLastRetrieved)
      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
      subjectLookup -
      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
      includeGroupDetail - T or F as to if the group detail should be included (defaults to F)
      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
      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 if in this stem, or in 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, false for descending. If you pass true or false, must pass a sort string
      pageIsCursor - true means cursor based paging
      pageLastCursorField - field based on which paging needs to occur
      pageLastCursorFieldType - type of last cursor field (eg: string, int, timestamp, etc)
      pageCursorFieldIncludesLastRetrieved - should the result has last retrieved item
      pointInTimeFrom - To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo. This parameter specifies the start of the range of the point in time query. If this is specified but pointInTimeTo is not specified, then the point in time query range will be from the time specified to now.
      pointInTimeTo - To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom. This parameter specifies the end of the range of the point in time query. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range. If this is specified but pointInTimeFrom is not specified, then the point in time query range will be from the minimum point in time to the time specified.
      Returns:
      the results

    • getGroupsLite

      public static WsGetGroupsLiteResult getGroupsLite(GrouperVersion clientVersion, String subjectId, String subjectSourceId, String subjectIdentifier, WsMemberFilter memberFilter, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, boolean includeGroupDetail, boolean includeSubjectDetail, String subjectAttributeNames, String paramName0, String paramValue0, String paramName1, String paramValue1, String fieldName, String scope, String stemName, String stemUuid, StemScope stemScope, String enabled, Integer pageSize, Integer pageNumber, String sortString, Boolean ascending, Timestamp pointInTimeFrom, Timestamp pointInTimeTo, Boolean pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, Boolean pageCursorFieldIncludesLastRetrieved)
      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 actAsSubjectIdentifier
      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 actAsSubjectIdentifier
      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)
      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 if in this stem, or in 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, false for descending. If you pass true or false, must pass a sort string
      pageIsCursor - true means cursor based paging
      pageLastCursorField - field based on which paging needs to occur
      pageLastCursorFieldType - type of last cursor field (eg: string, int, timestamp, etc)
      pageCursorFieldIncludesLastRetrieved - should the result has last retrieved item
      pointInTimeFrom - To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo. This parameter specifies the start of the range of the point in time query. If this is specified but pointInTimeTo is not specified, then the point in time query range will be from the time specified to now.
      pointInTimeTo - To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom. This parameter specifies the end of the range of the point in time query. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range. If this is specified but pointInTimeFrom is not specified, then the point in time query range will be from the minimum point in time to the time specified.
      Returns:
      the result of one member add

    • getMembers

      public static WsGetMembersResults getMembers(GrouperVersion clientVersion, WsGroupLookup[] wsGroupLookups, WsMemberFilter memberFilter, WsSubjectLookup actAsSubjectLookup, Field fieldName, boolean includeGroupDetail, boolean includeSubjectDetail, String[] subjectAttributeNames, WsParam[] params, String[] sourceIds, Timestamp pointInTimeFrom, Timestamp pointInTimeTo, Integer pageSize, Integer pageNumber, String sortString, Boolean ascending, Boolean pointInTimeRetrieve, Boolean pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, Boolean pageCursorFieldIncludesLastRetrieved)
      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 check members for
      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 - are source ids of members to retrieve
      pointInTimeRetrieve - true means pull point in time retrieve, false otherwise
      pointInTimeFrom - To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo. This parameter specifies the start of the range of the point in time query. If this is specified but pointInTimeTo is not specified, then the point in time query range will be from the time specified to now.
      pointInTimeTo - To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom. This parameter specifies the end of the range of the point in time query. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range. If this is specified but pointInTimeFrom is not specified, then the point in time query range will be from the minimum point in time to the time specified.
      pageSize - page size if paging
      pageNumber - page number 1 indexed if paging
      sortString - must be an hql query field, e.g. can sort on uuid, subjectId, sourceId, sourceString0, sortString1, sortString2, sortString3, sortString4, name, description
      ascending - T or null for ascending, F for descending.
      pageIsCursor - true means cursor based paging
      pageLastCursorField - field based on which paging needs to occur
      pageLastCursorFieldType - type of last cursor field (eg: string, int, timestamp, etc)
      pageCursorFieldIncludesLastRetrieved - should the result has last retrieved item
      Returns:
      the results

    • getMemberships

      public static WsGetMembershipsResults getMemberships(GrouperVersion clientVersion, WsGroupLookup[] wsGroupLookups, WsSubjectLookup[] wsSubjectLookups, WsMemberFilter wsMemberFilter, WsSubjectLookup actAsSubjectLookup, Field fieldName, boolean includeSubjectDetail, String[] subjectAttributeNames, boolean includeGroupDetail, WsParam[] params, String[] sourceIds, String scope, WsStemLookup wsStemLookup, StemScope stemScope, String enabled, String[] membershipIds, WsStemLookup[] wsOwnerStemLookups, WsAttributeDefLookup[] wsOwnerAttributeDefLookups, FieldType fieldType, ServiceRole serviceRole, WsAttributeDefNameLookup serviceLookup, Integer pageSize, Integer pageNumber, String sortString, Boolean ascending, Integer pageSizeForMember, Integer pageNumberForMember, String sortStringForMember, Boolean ascendingForMember, Boolean pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, Boolean pageCursorFieldIncludesLastRetrieved, Boolean pageIsCursorForMember, String pageLastCursorFieldForMember, String pageLastCursorFieldTypeForMember, Boolean pageCursorFieldIncludesLastRetrievedForMember, Boolean pointInTimeRetrieve, Timestamp pointInTimeFrom, Timestamp pointInTimeTo)
      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
      wsOwnerStemLookups - stem lookups if looking for memberships on certain stems
      wsOwnerAttributeDefLookups - attribute definition lookups if looking for memberships on certain attribute definitions
      fieldType - is the type of field to look at, e.g. list (default, memberships), access (privs on groups), attribute_def (privs on attribute definitions), naming (privs on folders)
      serviceRole - to filter attributes that a user has a certain role
      serviceLookup - if filtering by users in a service, then this is the service to look in
      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 - T or null for ascending, F for descending.
      pageIsCursor - true means cursor based paging
      pageLastCursorField - field based on which paging needs to occur
      pageLastCursorFieldType - type of last cursor field (eg: string, int, timestamp, etc)
      pageCursorFieldIncludesLastRetrieved - should the result has last retrieved item
      pageSizeForMember - page size if paging in the members part
      pageNumberForMember - page number 1 indexed if paging in the members part
      sortStringForMember - must be an hql query field, e.g. can sort on uuid, subjectId, sourceId, sourceString0, sortString1, sortString2, sortString3, sortString4, name, description in the members part
      ascendingForMember - T or null for ascending, F for descending in the members part
      pageIsCursorForMember - true means cursor based paging
      pageLastCursorFieldForMember - field based on which paging needs to occur
      pageLastCursorFieldTypeForMember - type of last cursor field (eg: string, int, timestamp, etc)
      pageCursorFieldIncludesLastRetrievedForMember - should the result has last retrieved item
      pointInTimeRetrieve - true means retrieve point in time records
      pointInTimeFrom - To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo. This parameter specifies the start of the range of the point in time query. If this is specified but pointInTimeTo is not specified, then the point in time query range will be from the time specified to now.
      pointInTimeTo - To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom. This parameter specifies the end of the range of the point in time query. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range. If this is specified but pointInTimeFrom is not specified, then the point in time query range will be from the minimum point in time to the time specified.
      Returns:
      the results

    • getMembershipsLite

      public static WsGetMembershipsResults getMembershipsLite(GrouperVersion clientVersion, String groupName, String groupUuid, String subjectId, String sourceId, String subjectIdentifier, WsMemberFilter wsMemberFilter, boolean includeSubjectDetail, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, Field fieldName, String subjectAttributeNames, boolean includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1, String sourceIds, String scope, String stemName, String stemUuid, StemScope stemScope, String enabled, String membershipIds, String ownerStemName, String ownerStemUuid, String nameOfOwnerAttributeDef, String ownerAttributeDefUuid, FieldType fieldType, ServiceRole serviceRole, String serviceId, String serviceName, Integer pageSize, Integer pageNumber, String sortString, Boolean ascending, Integer pageSizeForMember, Integer pageNumberForMember, String sortStringForMember, Boolean ascendingForMember, Boolean pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, Boolean pageCursorFieldIncludesLastRetrieved, Boolean pageIsCursorForMember, String pageLastCursorFieldForMember, String pageLastCursorFieldTypeForMember, Boolean pageCursorFieldIncludesLastRetrievedForMember, Boolean pointInTimeRetrieve, Timestamp pointInTimeFrom, Timestamp pointInTimeTo)
      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 actAsSubjectIdentifier
      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 actAsSubjectIdentifier
      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
      ownerStemName - if looking for privileges on stems, put the stem name to look for here
      ownerStemUuid - if looking for privileges on stems, put the stem uuid here
      nameOfOwnerAttributeDef - if looking for privileges on attribute definitions, put the name of the attribute definition here
      ownerAttributeDefUuid - if looking for privileges on attribute definitions, put the uuid of the attribute definition here
      fieldType - is the type of field to look at, e.g. list (default, memberships), access (privs on groups), attribute_def (privs on attribute definitions), naming (privs on folders)
      serviceRole - to filter attributes that a user has a certain role
      serviceId - if filtering by users in a service, then this is the service to look in, mutually exclusive with serviceName
      serviceName - if filtering by users in a service, then this is the service to look in, mutually exclusive with serviceId
      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 - T or null for ascending, F for descending.
      pageIsCursor - true means cursor based paging
      pageLastCursorField - field based on which paging needs to occur
      pageLastCursorFieldType - type of last cursor field (eg: string, int, timestamp, etc)
      pageCursorFieldIncludesLastRetrieved - should the result has last retrieved item
      pageSizeForMember - page size if paging in the members part
      pageNumberForMember - page number 1 indexed if paging in the members part
      sortStringForMember - must be an hql query field, e.g. can sort on uuid, subjectId, sourceId, sourceString0, sortString1, sortString2, sortString3, sortString4, name, description in the members part
      ascendingForMember - T or null for ascending, F for descending in the members part
      pageIsCursorForMember - true means cursor based paging
      pageLastCursorFieldForMember - field based on which paging needs to occur
      pageLastCursorFieldTypeForMember - type of last cursor field (eg: string, int, timestamp, etc)
      pageCursorFieldIncludesLastRetrievedForMember - should the result has last retrieved item
      pointInTimeRetrieve - true means retrieve point in time records
      pointInTimeFrom - To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo. This parameter specifies the start of the range of the point in time query. If this is specified but pointInTimeTo is not specified, then the point in time query range will be from the time specified to now.
      pointInTimeTo - To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom. This parameter specifies the end of the range of the point in time query. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range. If this is specified but pointInTimeFrom is not specified, then the point in time query range will be from the minimum point in time to the time specified.
      Returns:
      the memberships, or none if none found

    • getMembersLite

      public static WsGetMembersLiteResult getMembersLite(GrouperVersion clientVersion, String groupName, String groupUuid, WsMemberFilter memberFilter, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, Field fieldName, boolean includeGroupDetail, boolean includeSubjectDetail, String subjectAttributeNames, String paramName0, String paramValue0, String paramName1, String paramValue1, String sourceIds, Timestamp pointInTimeFrom, Timestamp pointInTimeTo, Integer pageSize, Integer pageNumber, String sortString, Boolean ascending, Boolean pointInTimeRetrieve, Boolean pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, Boolean pageCursorFieldIncludesLastRetrieved)
      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 actAsSubjectIdentifier
      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 actAsSubjectIdentifier
      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 of sources to get members from
      pointInTimeRetrieve - true means retrieve point in time records
      pointInTimeFrom - To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo. This parameter specifies the start of the range of the point in time query. If this is specified but pointInTimeTo is not specified, then the point in time query range will be from the time specified to now.
      pointInTimeTo - To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom. This parameter specifies the end of the range of the point in time query. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range. If this is specified but pointInTimeFrom is not specified, then the point in time query range will be from the minimum point in time to the time specified.
      pageSize - page size if paging
      pageNumber - page number 1 indexed if paging
      sortString - must be an hql query field, e.g. can sort on uuid, subjectId, sourceId, name, description, sortString0, sortString1, sortString2, sortString3, sortString4
      ascending - T or null for ascending, F for descending.
      pageIsCursor - true means cursor based paging
      pageLastCursorField - field based on which paging needs to occur
      pageLastCursorFieldType - type of last cursor field (eg: string, int, timestamp, etc)
      pageCursorFieldIncludesLastRetrieved - should the result has last retrieved item
      Returns:
      the members, or no members if none found

    • groupDelete

      public static WsGroupDeleteResults groupDelete(GrouperVersion clientVersion, WsGroupLookup[] wsGroupLookups, WsSubjectLookup actAsSubjectLookup, GrouperTransactionType txType, boolean 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

    • groupDeleteLite

      public static WsGroupDeleteLiteResult groupDeleteLite(GrouperVersion clientVersion, String groupName, String groupUuid, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, boolean 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 actAsSubjectIdentifier
      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 actAsSubjectIdentifier
      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

    • groupSave

      public static WsGroupSaveResults groupSave(GrouperVersion clientVersion, WsGroupToSave[] wsGroupToSaves, WsSubjectLookup actAsSubjectLookup, GrouperTransactionType txType, boolean 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

    • externalSubjectSave

      public static WsExternalSubjectSaveResults externalSubjectSave(GrouperVersion clientVersion, WsExternalSubjectToSave[] wsExternalSubjectToSaves, WsSubjectLookup actAsSubjectLookup, GrouperTransactionType txType, WsParam[] params)
      save an external subject (insert or update).
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      wsExternalSubjectToSaves - external subjects 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
      Since:
      2.3.0.patch

    • hasMember

      public static WsHasMemberResults hasMember(GrouperVersion clientVersion, WsGroupLookup wsGroupLookup, WsSubjectLookup[] subjectLookups, WsMemberFilter memberFilter, WsSubjectLookup actAsSubjectLookup, Field fieldName, boolean includeGroupDetail, boolean includeSubjectDetail, String[] subjectAttributeNames, WsParam[] params, Timestamp pointInTimeFrom, Timestamp pointInTimeTo)
      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)
      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
      pointInTimeFrom - To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo. This parameter specifies the start of the range of the point in time query. If this is specified but pointInTimeTo is not specified, then the point in time query range will be from the time specified to now.
      pointInTimeTo - To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom. This parameter specifies the end of the range of the point in time query. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range. If this is specified but pointInTimeFrom is not specified, then the point in time query range will be from the minimum point in time to the time specified.
      Returns:
      the results

    • hasMemberLite

      public static WsHasMemberLiteResult hasMemberLite(GrouperVersion clientVersion, String groupName, String groupUuid, String subjectId, String subjectSourceId, String subjectIdentifier, WsMemberFilter memberFilter, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, Field fieldName, boolean includeGroupDetail, boolean includeSubjectDetail, String subjectAttributeNames, String paramName0, String paramValue0, String paramName1, String paramValue1, Timestamp pointInTimeFrom, Timestamp pointInTimeTo)
      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
      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 actAsSubjectIdentifier
      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 actAsSubjectIdentifier
      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
      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)
      paramName0 - reserved for future use
      paramValue0 - reserved for future use
      paramName1 - reserved for future use
      paramValue1 - reserved for future use
      pointInTimeFrom - To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo. This parameter specifies the start of the range of the point in time query. If this is specified but pointInTimeTo is not specified, then the point in time query range will be from the time specified to now.
      pointInTimeTo - To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom. This parameter specifies the end of the range of the point in time query. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range. If this is specified but pointInTimeFrom is not specified, then the point in time query range will be from the minimum point in time to the time specified.
      Returns:
      the result of one member query

    • memberChangeSubjectLite

      public static WsMemberChangeSubjectLiteResult memberChangeSubjectLite(GrouperVersion clientVersion, String oldSubjectId, String oldSubjectSourceId, String oldSubjectIdentifier, String newSubjectId, String newSubjectSourceId, String newSubjectIdentifier, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, boolean deleteOldMember, boolean 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
      actAsSubjectId - optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifier
      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 actAsSubjectIdentifier
      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
      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
      Returns:
      the result of one member query

    • memberChangeSubject

      public static WsMemberChangeSubjectResults memberChangeSubject(GrouperVersion clientVersion, WsMemberChangeSubject[] wsMemberChangeSubjects, WsSubjectLookup actAsSubjectLookup, GrouperTransactionType txType, boolean includeSubjectDetail, String[] subjectAttributeNames, WsParam[] params)
      change the subject in a member or some members
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      wsMemberChangeSubjects - objects that describe one member renaming
      actAsSubjectLookup - to act as a different user than the logged in user
      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
      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.
      Returns:
      the results

    • stemDelete

      public static WsStemDeleteResults stemDelete(GrouperVersion clientVersion, WsStemLookup[] wsStemLookups, WsSubjectLookup actAsSubjectLookup, GrouperTransactionType 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

    • stemDeleteLite

      public static WsStemDeleteLiteResult stemDeleteLite(GrouperVersion 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 actAsSubjectIdentifier
      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 actAsSubjectIdentifier
      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

    • stemSave

      public static WsStemSaveResults stemSave(GrouperVersion clientVersion, WsStemToSave[] wsStemToSaves, WsSubjectLookup actAsSubjectLookup, GrouperTransactionType txType, WsParam[] params)
      save a stem or many (insert or update). Note, you cannot rename 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

    • stemSaveLite

      public static WsStemSaveLiteResult stemSaveLite(GrouperVersion clientVersion, String stemLookupUuid, String stemLookupName, String stemUuid, String stemName, String displayExtension, String description, SaveMode saveMode, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1)
      save a stem (insert or update). Note you cannot rename 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 actAsSubjectIdentifier
      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 actAsSubjectIdentifier
      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 static WsGroupSaveLiteResult groupSaveLite(GrouperVersion clientVersion, String groupLookupUuid, String groupLookupName, String groupUuid, String groupName, String displayExtension, String description, SaveMode saveMode, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, boolean includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1, TypeOfGroup typeOfGroup, String alternateName, Timestamp disabledTime, Timestamp enabledTime)
      save a group (insert or update). Note you cannot rename an existing group.
      Parameters:
      groupLookupUuid - the uuid of the group to save (mutually exclusive with groupLookupName), null for insert
      groupLookupName - the name of the stam to save (mutually exclusive with groupLookupUuid), null for insert
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      groupName - data of group to save
      groupUuid - uuid data of group to save
      description - of the group
      displayExtension - of the group
      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 actAsSubjectIdentifier
      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 actAsSubjectIdentifier
      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
      typeOfGroup - type of group can be an enum of TypeOfGroup, e.g. group, role, entity
      alternateName - the alternate name of the group
      disabledTime -
      enabledTime -
      Returns:
      the result of one member add

    • getGrouperPrivilegesLite

      public static WsGetGrouperPrivilegesLiteResult getGrouperPrivilegesLite(GrouperVersion clientVersion, String subjectId, String subjectSourceId, String subjectIdentifier, String groupName, String groupUuid, String stemName, String stemUuid, PrivilegeType privilegeType, Privilege privilegeName, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, boolean includeSubjectDetail, String subjectAttributeNames, boolean includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1)
       get grouper privileges for a group or folder
 e.g. /grouperPrivileges/subjects/1234567/groups/aStem:aGroup/types/access/names/update
 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 actAsSubjectIdentifier
      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 actAsSubjectIdentifier
      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

    • removePrivsNotAllowedToSee

      public static void removePrivsNotAllowedToSee(Set<GrouperPrivilege> privileges)
      remove privileges not allowed to see
      Parameters:
      privileges -

    • removePrivsNotAllowedToSee

      public static void removePrivsNotAllowedToSee(TreeSet<GrouperPrivilege> privileges)
      remove privileges not allowed to see
      Parameters:
      privileges -

    • assignGrouperPrivilegesLite

      public static WsAssignGrouperPrivilegesLiteResult assignGrouperPrivilegesLite(GrouperVersion clientVersion, String subjectId, String subjectSourceId, String subjectIdentifier, String groupName, String groupUuid, String stemName, String stemUuid, PrivilegeType privilegeType, Privilege privilegeName, boolean allowed, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, boolean includeSubjectDetail, String subjectAttributeNames, boolean includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1)
       assign a privilege for a user/group/type/name combo
 e.g. /grouperPrivileges/subjects/1234567/groups/aStem:aGroup/types/access/names/update
 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 actAsSubjectIdentifier
      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 actAsSubjectIdentifier
      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 - 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
      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

    • getSubjects

      public static WsGetSubjectsResults getSubjects(GrouperVersion clientVersion, WsSubjectLookup[] wsSubjectLookups, String searchString, boolean includeSubjectDetail, String[] subjectAttributeNames, WsSubjectLookup actAsSubjectLookup, String[] sourceIds, WsGroupLookup wsGroupLookup, WsMemberFilter wsMemberFilter, Field fieldName, boolean 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)
      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 static WsGetSubjectsResults getSubjectsLite(GrouperVersion clientVersion, String subjectId, String sourceId, String subjectIdentifier, String searchString, boolean includeSubjectDetail, String subjectAttributeNames, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String sourceIds, String groupName, String groupUuid, WsMemberFilter wsMemberFilter, Field fieldName, boolean 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 actAsSubjectIdentifier
      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 actAsSubjectIdentifier
      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 static WsAssignGrouperPrivilegesResults assignGrouperPrivileges(GrouperVersion clientVersion, WsSubjectLookup[] wsSubjectLookups, WsGroupLookup wsGroupLookup, WsStemLookup wsStemLookup, PrivilegeType privilegeType, Privilege[] privilegeNames, boolean allowed, boolean replaceAllExisting, GrouperTransactionType txType, WsSubjectLookup actAsSubjectLookup, boolean includeSubjectDetail, String[] subjectAttributeNames, boolean 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 replaceAllExisting is T, then allowed must be set to T. This will assign the provided privilege(s) to the provided subject(s), and remove it from all other subjects who are assigned. If F or blank, assign or remove (depending on value provided in 'allowed') the provided privilege(s) from the provided subject(s)
      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 static WsGetAttributeAssignmentsResults getAttributeAssignments(GrouperVersion clientVersion, AttributeAssignType attributeAssignType, WsAttributeAssignLookup[] wsAttributeAssignLookups, WsAttributeDefLookup[] wsAttributeDefLookups, WsAttributeDefNameLookup[] wsAttributeDefNameLookups, WsGroupLookup[] wsOwnerGroupLookups, WsStemLookup[] wsOwnerStemLookups, WsSubjectLookup[] wsOwnerSubjectLookups, WsMembershipLookup[] wsOwnerMembershipLookups, WsMembershipAnyLookup[] wsOwnerMembershipAnyLookups, WsAttributeDefLookup[] wsOwnerAttributeDefLookups, String[] actions, boolean includeAssignmentsOnAssignments, WsSubjectLookup actAsSubjectLookup, boolean includeSubjectDetail, String[] subjectAttributeNames, boolean includeGroupDetail, WsParam[] params, String enabled, AttributeDefValueType attributeDefValueType, Object theValue, boolean includeAssignmentsFromAssignments, AttributeDefType attributeDefType, WsAttributeAssignLookup[] wsAssignAssignOwnerAttributeAssignLookups, WsAttributeDefLookup[] wsAssignAssignOwnerAttributeDefLookups, WsAttributeDefNameLookup[] wsAssignAssignOwnerAttributeDefNameLookups, String[] wsAssignAssignOwnerActions)
      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
      attributeDefValueType - required if sending theValue, can be: floating, integer, memberId, string, timestamp
      theValue - value if you are passing in one attributeDefNameLookup
      includeAssignmentsFromAssignments - T|F if you are finding an assignment that is an assignmentOnAssignment, then get the assignment which tells you the owner as well
      attributeDefType - null for all, or specify an AttributeDefType e.g. attr, limit, service, type, limit, perm
      wsAssignAssignOwnerAttributeAssignLookups - if looking for assignments on assignments, this is the assignment the assignment is assigned to
      wsAssignAssignOwnerAttributeDefLookups - if looking for assignments on assignments, this is the attribute definition of the assignment the assignment is assigned to
      wsAssignAssignOwnerAttributeDefNameLookups - if looking for assignments on assignments, this is the attribute def name of the assignment the assignment is assigned to
      wsAssignAssignOwnerActions - if looking for assignments on assignments, this are the actions of the assignment the assignment is assigned to
      Returns:
      the results

    • getAttributeAssignmentsLite

      public static WsGetAttributeAssignmentsResults getAttributeAssignmentsLite(GrouperVersion clientVersion, AttributeAssignType 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, boolean includeAssignmentsOnAssignments, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, boolean includeSubjectDetail, String subjectAttributeNames, boolean includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1, String enabled, AttributeDefValueType attributeDefValueType, Object theValue, boolean includeAssignmentsFromAssignments, AttributeDefType attributeDefType, String wsAssignAssignOwnerAttributeAssignId, String wsAssignAssignOwnerIdOfAttributeDef, String wsAssignAssignOwnerNameOfAttributeDef, String wsAssignAssignOwnerIdOfAttributeDefName, String wsAssignAssignOwnerNameOfAttributeDefName, String wsAssignAssignOwnerAction)
      get attributeAssignments from group and or subject 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 - act as this subject
      actAsSubjectSourceId - act as this subject
      actAsSubjectIdentifier - act as this subject
      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
      attributeDefValueType - required if sending theValue, can be: floating, integer, memberId, string, timestamp
      theValue - value if you are passing in one attributeDefNameLookup
      includeAssignmentsFromAssignments - T|F if you are finding an assignment that is an assignmentOnAssignment, then get the assignment which tells you the owner as well
      attributeDefType - null for all, or specify an AttributeDefType e.g. attr, limit, service, type, limit, perm
      wsAssignAssignOwnerAttributeAssignId - if looking for assignments on assignments, this is the assignment the assignment is assigned to
      wsAssignAssignOwnerIdOfAttributeDef - if looking for assignments on assignments, this is the attribute definition of the assignment the assignment is assigned to
      wsAssignAssignOwnerNameOfAttributeDef - if looking for assignments on assignments, this is the attribute definition of the assignment the assignment is assigned to
      wsAssignAssignOwnerIdOfAttributeDefName - if looking for assignments on assignments, this is the attribute def name of the assignment the assignment is assigned to
      wsAssignAssignOwnerNameOfAttributeDefName - if looking for assignments on assignments, this is the attribute def name of the assignment the assignment is assigned to
      wsAssignAssignOwnerAction - if looking for assignments on assignments, this is the action of the assignment the assignment is assigned to
      Returns:
      the results

    • getAttributeAssignActions

      public static WsGetAttributeAssignActionsResults getAttributeAssignActions(GrouperVersion clientVersion, WsAttributeDefLookup[] wsAttributeDefLookups, String[] actions, WsSubjectLookup actAsSubjectLookup, WsParam[] params)
      get attributeAssignActions from attribute definitions, actions, etc
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      wsAttributeDefLookups - find assignments in these attribute defs
      actions - to query, or none to query all actions
      actAsSubjectLookup -
      params - optional: reserved for future use
      Returns:
      the results

    • getAttributeAssignActionsLite

      public static WsGetAttributeAssignActionsResults getAttributeAssignActionsLite(GrouperVersion clientVersion, String wsNameOfAttributeDef, String wsIdOfAttributeDef, String wsIdIndexOfAttributeDef, String action, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1)
      get attributeAssignActions from attribute definition
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      wsNameOfAttributeDef - find assignments in this attribute def
      wsIdOfAttributeDef - find assignments in this attribute def (optional)
      wsIdIndexOfAttributeDef - find assignments in this attribute def (optional)
      action - to query, or none to query all actions
      actAsSubjectId - act as this subject
      actAsSubjectSourceId - act as this subject
      actAsSubjectIdentifier - act as this subject
      paramName0 - reserved for future use
      paramValue0 - reserved for future use
      paramName1 - reserved for future use
      paramValue1 - reserved for future use
      Returns:
      the results

    • assignAttributes

      public static WsAssignAttributesResults assignAttributes(GrouperVersion clientVersion, AttributeAssignType attributeAssignType, WsAttributeDefNameLookup[] wsAttributeDefNameLookups, AttributeAssignOperation attributeAssignOperation, WsAttributeAssignValue[] values, String assignmentNotes, Timestamp assignmentEnabledTime, Timestamp assignmentDisabledTime, AttributeAssignDelegatable delegatable, AttributeAssignValueOperation attributeAssignValueOperation, WsAttributeAssignLookup[] wsAttributeAssignLookups, WsGroupLookup[] wsOwnerGroupLookups, WsStemLookup[] wsOwnerStemLookups, WsSubjectLookup[] wsOwnerSubjectLookups, WsMembershipLookup[] wsOwnerMembershipLookups, WsMembershipAnyLookup[] wsOwnerMembershipAnyLookups, WsAttributeDefLookup[] wsOwnerAttributeDefLookups, WsAttributeAssignLookup[] wsOwnerAttributeAssignLookups, String[] actions, WsSubjectLookup actAsSubjectLookup, boolean includeSubjectDetail, String[] subjectAttributeNames, boolean 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 static WsAssignAttributesLiteResults assignAttributesLite(GrouperVersion clientVersion, AttributeAssignType attributeAssignType, String wsAttributeDefNameName, String wsAttributeDefNameId, AttributeAssignOperation attributeAssignOperation, String valueId, String valueSystem, String valueFormatted, String assignmentNotes, Timestamp assignmentEnabledTime, Timestamp assignmentDisabledTime, AttributeAssignDelegatable delegatable, AttributeAssignValueOperation 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, boolean includeSubjectDetail, String subjectAttributeNames, boolean 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

    • attributeDefSave

      public static WsAttributeDefSaveResults attributeDefSave(GrouperVersion clientVersion, WsAttributeDefToSave[] wsAttributeDefsToSave, WsSubjectLookup actAsSubjectLookup, GrouperTransactionType txType, WsParam[] params)
      save an AttributeDef or many (insert or update). Note, you cannot rename an existing AttributeDef.
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      wsAttributeDefsToSave - AttributeDefs 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

    • attributeDefSaveLite

      public static WsAttributeDefSaveLiteResult attributeDefSaveLite(GrouperVersion clientVersion, String attributeDefLookupUuid, String attributeDefLookupName, String uuidOfAttributeDef, String nameOfAttributeDef, Boolean assignToAttributeDef, Boolean assignToAttributeDefAssignment, Boolean assignToEffectiveMembership, Boolean assignToEffectiveMembershipAssignment, Boolean assignToGroup, Boolean assignToGroupAssignment, Boolean assignToImmediateMembership, Boolean assignToImmediateMembershipAssignment, Boolean assignToMember, Boolean assignToMemberAssignment, Boolean assignToStem, Boolean assignToStemAssignment, String attributeDefType, String multiAssignable, String multiValued, String valueType, String description, SaveMode saveMode, Boolean createParentStemsIfNotExist, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1)
      save an AttributeDef (insert or update). Note you cannot currently move an existing AttributeDef.
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      attributeDefLookupUuid - to lookup the attributeDef (mutually exclusive with attributeDefName)
      attributeDefLookupName - to lookup the attributeDef (mutually exclusive with attributeDefUuid)
      uuidOfAttributeDef - the uuid of the attributeDef to edit
      nameOfAttributeDef - the name of the attributeDefName to edit
      assignToAttributeDef -
      assignToAttributeDefAssignment -
      assignToEffectiveMembership -
      assignToEffectiveMembershipAssignment -
      assignToGroup -
      assignToGroupAssignment -
      assignToImmediateMembership -
      assignToImmediateMembershipAssignment -
      assignToMember -
      assignToMemberAssignment -
      assignToStem -
      assignToStemAssignment -
      attributeDefType - type of attribute def, from enum AttributeDefType, e.g. attr, domain, type, limit, perm
      multiAssignable - T of F for if can be assigned multiple times to one object
      multiValued - T or F, if has values, if can assign multiple values to one assignment
      valueType - what type of value on assignments: AttributeDefValueType: e.g. integer, timestamp, string, floating, marker, memberId
      description - of the attributeDef, empty will be ignored
      saveMode - if the save should be constrained to INSERT, UPDATE, or INSERT_OR_UPDATE (default)
      createParentStemsIfNotExist - T or F (default F) if parent stems should be created if not exist
      actAsSubjectId - optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifier
      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 actAsSubjectIdentifier
      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

    • attributeDefDelete

      public static WsAttributeDefDeleteResults attributeDefDelete(GrouperVersion clientVersion, WsAttributeDefLookup[] wsAttributeDefLookups, GrouperTransactionType txType, WsSubjectLookup actAsSubjectLookup, WsParam[] params)
      delete attribute defs
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      wsAttributeDefLookups - find assignments in these attribute defs
      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.
      actAsSubjectLookup -
      params - optional: reserved for future use
      Returns:
      the results

    • attributeDefDeleteLite

      public static WsAttributeDefDeleteLiteResult attributeDefDeleteLite(GrouperVersion clientVersion, String wsNameOfAttributeDef, String wsIdOfAttributeDef, String wsIdIndexOfAttributeDef, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1)
      remove attribute definition based on name, id or uuid
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      wsNameOfAttributeDef - find assignments in this attribute def
      wsIdOfAttributeDef - find assignments in this attribute def (optional)
      wsIdIndexOfAttributeDef - find assignments in this attribute def (optional)
      actAsSubjectId - act as this subject
      actAsSubjectSourceId - act as this subject
      actAsSubjectIdentifier - act as this subject
      paramName0 - reserved for future use
      paramValue0 - reserved for future use
      paramName1 - reserved for future use
      paramValue1 - reserved for future use
      Returns:
      the results

    • findAttributeDefs

      public static WsFindAttributeDefsResults findAttributeDefs(GrouperVersion clientVersion, String scope, Boolean splitScope, WsAttributeDefLookup[] wsAttributeDefLookups, String privilegeName, StemScope stemScope, String parentStemId, Boolean findByUuidOrName, Integer pageSize, Integer pageNumber, String sortString, Boolean ascending, WsSubjectLookup actAsSubjectLookup, WsParam[] params, Boolean pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, Boolean pageCursorFieldIncludesLastRetrieved)
      find an attribute def or attribute defs. Each additional parameter sent will narow the search, except the lookups will just lookup whatever is sent.
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      scope - search string with % as wildcards will search name, display name, description
      splitScope - T or F, if T will split the scope by whitespace, and find attribute defs with each token. e.g. if you have a scope of "pto permissions", and split scope T, it will return school:apps:pto_app:internal:the_permissions:whatever
      wsAttributeDefLookups - find attributeDefs associated with these attribute defs lookups
      privilegeName - privilegeName or null. null will default to ATTR_VIEW
      stemScope - is if in this stem, or in any stem underneath. You must pass stemScope if you pass a stem
      parentStemId - search in this stem
      findByUuidOrName -
      actAsSubjectLookup - if searching as someone else, pass in that subject here, note the caller must be allowed to act as that other subject
      params - optional: reserved for future use
      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.
      pageIsCursor - true means cursor based paging
      pageLastCursorField - field based on which paging needs to occur
      pageLastCursorFieldType - type of last cursor field (eg: string, int, timestamp, etc)
      pageCursorFieldIncludesLastRetrieved - should the result has last retrieved item
      Returns:
      the attribute defs, or no attribute def if none found

    • findAttributeDefsLite

      public static WsFindAttributeDefsResults findAttributeDefsLite(GrouperVersion clientVersion, String scope, Boolean splitScope, String uuidOfAttributeDef, String nameOfAttributeDef, String idIndexOfAttributeDef, String privilegeName, StemScope stemScope, String parentStemId, Boolean findByUuidOrName, Integer pageSize, Integer pageNumber, String sortString, Boolean ascending, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1, Boolean pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, Boolean pageCursorFieldIncludesLastRetrieved)
      find an attribute def name attribute defs. Each additional parameter sent will narow the search, except the lookups will just lookup whatever is sent.
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      scope - search string with % as wildcards will search name, display name, description
      splitScope - T or F, if T will split the scope by whitespace, and find attribute defs with each token. e.g. if you have a scope of "pto permissions", and split scope T, it will return school:apps:pto_app:internal:the_permissions:whatever
      uuidOfAttributeDef - find attribute defs associated with this attribute def uuid, mutually exclusive with nameOfAttributeDef
      nameOfAttributeDef - find attribute defs associated with this attribute def name, mutually exclusive with idOfAttributeDef
      idIndexOfAttributeDef - find attribute defs associated with this attribute def id index
      privilegeName - privilegeName or null. null will default to ATTR_VIEW
      stemScope - is if in this stem, or in any stem underneath. You must pass stemScope if you pass a stem
      parentStemId - search in this stem
      findByUuidOrName -
      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.
      pageIsCursor - true means cursor based paging
      pageLastCursorField - field based on which paging needs to occur
      pageLastCursorFieldType - type of last cursor field (eg: string, int, timestamp, etc)
      pageCursorFieldIncludesLastRetrieved - should the result has last retrieved item
      actAsSubjectId - optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifier
      actAsSubjectIdentifier - optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifier
      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 attribute defs, or no attribute defs if none found

    • assignAttributeDefActions

      public static WsAttributeDefAssignActionResults assignAttributeDefActions(GrouperVersion clientVersion, WsAttributeDefLookup wsAttributeDefLookup, String[] actions, boolean assign, Boolean replaceAllExisting, WsSubjectLookup actAsSubjectLookup, WsParam[] params)
      add/remove/replace actions from Attribute Defs
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      wsAttributeDefLookup - attribute def to be modified
      actions - to assign
      assign - T to assign, or F to remove assignment
      replaceAllExisting - T if assigning, if this list should replace all existing actions
      actAsSubjectLookup -
      params - optional: reserved for future use
      Returns:
      the results

    • getPermissionAssignments

      public static WsGetPermissionAssignmentsResults getPermissionAssignments(GrouperVersion clientVersion, WsAttributeDefLookup[] wsAttributeDefLookups, WsAttributeDefNameLookup[] wsAttributeDefNameLookups, WsGroupLookup[] roleLookups, WsSubjectLookup[] wsSubjectLookups, String[] actions, boolean includePermissionAssignDetail, boolean includeAttributeDefNames, boolean includeAttributeAssignments, boolean includeAssignmentsOnAssignments, WsSubjectLookup actAsSubjectLookup, boolean includeSubjectDetail, String[] subjectAttributeNames, boolean includeGroupDetail, WsParam[] params, String enabled, Timestamp pointInTimeFrom, Timestamp pointInTimeTo, boolean immediateOnly, PermissionEntry.PermissionType permissionType, PermissionProcessor permissionProcessor, WsPermissionEnvVar[] limitEnvVars, boolean includeLimits)
      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
      pointInTimeFrom - To query permissions at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo. This parameter specifies the start of the range of the point in time query. If this is specified but pointInTimeTo is not specified, then the point in time query range will be from the time specified to now.
      pointInTimeTo - To query permissions at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom. This parameter specifies the end of the range of the point in time query. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range. If this is specified but pointInTimeFrom is not specified, then the point in time query range will be from the minimum point in time to the time specified.
      immediateOnly - T of F (defaults to F) if we should filter out non immediate permissions
      permissionType - are we looking for role permissions or subject permissions? from enum PermissionType: role, or role_subject. defaults to role_subject permissions
      permissionProcessor - if we should find the best answer, or process limits, etc. From the enum PermissionProcessor. example values are: FILTER_REDUNDANT_PERMISSIONS, FILTER_REDUNDANT_PERMISSIONS_AND_PROCESS_LIMITS, FILTER_REDUNDANT_PERMISSIONS_AND_ROLES, FILTER_REDUNDANT_PERMISSIONS_AND_ROLES_AND_PROCESS_LIMITS, PROCESS_LIMITS
      limitEnvVars - limitEnvVars if processing limits, pass in a set of limits. The name is the name of the variable, and the value is the value. Note, you can typecast the values by putting a valid type in parens in front of the param name. e.g. name: (int)amount, value: 50
      includeLimits - T or F (default to F) for if limits should be returned with the results. Note that the attributeDefs, attributeDefNames, and attributeAssignments will be added to those lists
      Returns:
      the results

    • getPermissionAssignmentsLite

      public static WsGetPermissionAssignmentsResults getPermissionAssignmentsLite(GrouperVersion clientVersion, String wsAttributeDefName, String wsAttributeDefId, String wsAttributeDefNameName, String wsAttributeDefNameId, String roleName, String roleId, String wsSubjectId, String wsSubjectSourceId, String wsSubjectIdentifier, String action, boolean includePermissionAssignDetail, boolean includeAttributeDefNames, boolean includeAttributeAssignments, boolean includeAssignmentsOnAssignments, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, boolean includeSubjectDetail, String subjectAttributeNames, boolean includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1, String enabled, Timestamp pointInTimeFrom, Timestamp pointInTimeTo, boolean immediateOnly, PermissionEntry.PermissionType permissionType, PermissionProcessor permissionProcessor, String limitEnvVarName0, String limitEnvVarValue0, String limitEnvVarType0, String limitEnvVarName1, String limitEnvVarValue1, String limitEnvVarType1, boolean includeLimits)
      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
      pointInTimeFrom - To query permissions at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo. This parameter specifies the start of the range of the point in time query. If this is specified but pointInTimeTo is not specified, then the point in time query range will be from the time specified to now.
      pointInTimeTo - To query permissions at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom. This parameter specifies the end of the range of the point in time query. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range. If this is specified but pointInTimeFrom is not specified, then the point in time query range will be from the minimum point in time to the time specified.
      immediateOnly - T of F (defaults to F) if we should filter out non immediate permissions
      permissionType - are we looking for role permissions or subject permissions? from enum PermissionType: role, or role_subject. defaults to role_subject permissions
      permissionProcessor - if we should find the best answer, or process limits, etc. From the enum PermissionProcessor. example values are: FILTER_REDUNDANT_PERMISSIONS, FILTER_REDUNDANT_PERMISSIONS_AND_PROCESS_LIMITS, FILTER_REDUNDANT_PERMISSIONS_AND_ROLES, FILTER_REDUNDANT_PERMISSIONS_AND_ROLES_AND_PROCESS_LIMITS, PROCESS_LIMITS
      limitEnvVarName0 - limitEnvVars if processing limits, pass in a set of limits. The name is the name of the variable, and the value is the value. Note, you can typecast the values by putting a valid type in parens in front of the param name. e.g. name: (int)amount, value: 50
      limitEnvVarValue0 - first limit env var value
      limitEnvVarType0 - first limit env var type
      limitEnvVarName1 - second limit env var name
      limitEnvVarValue1 - second limit env var value
      limitEnvVarType1 - second limit env var type
      includeLimits - T or F (default to F) for if limits should be returned with the results. Note that the attributeDefs, attributeDefNames, and attributeAssignments will be added to those lists
      Returns:
      the results

    • assignPermissions

      public static WsAssignPermissionsResults assignPermissions(GrouperVersion clientVersion, PermissionEntry.PermissionType permissionType, WsAttributeDefNameLookup[] permissionDefNameLookups, PermissionAssignOperation permissionAssignOperation, String assignmentNotes, Timestamp assignmentEnabledTime, Timestamp assignmentDisabledTime, AttributeAssignDelegatable delegatable, WsAttributeAssignLookup[] wsAttributeAssignLookups, WsGroupLookup[] roleLookups, WsMembershipAnyLookup[] subjectRoleLookups, String[] actions, WsSubjectLookup actAsSubjectLookup, boolean includeSubjectDetail, String[] subjectAttributeNames, boolean includeGroupDetail, WsParam[] params, WsAttributeDefLookup[] attributeDefsToReplace, String[] actionsToReplace, Boolean disallowed)
      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
      disallowed - is disallowed
      Returns:
      the results

    • assignPermissionsLite

      public static WsAssignPermissionsLiteResults assignPermissionsLite(GrouperVersion clientVersion, PermissionEntry.PermissionType permissionType, String permissionDefNameName, String permissionDefNameId, PermissionAssignOperation permissionAssignOperation, String assignmentNotes, Timestamp assignmentEnabledTime, Timestamp assignmentDisabledTime, AttributeAssignDelegatable 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, boolean includeSubjectDetail, String subjectAttributeNames, boolean includeGroupDetail, String paramName0, String paramValue0, String paramName1, String paramValue1, Boolean disallowed)
      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
      disallowed - if the assignment is a disallow
      Returns:
      the results

    • assignAttributeDefNameInheritance

      public static WsAssignAttributeDefNameInheritanceResults assignAttributeDefNameInheritance(GrouperVersion clientVersion, WsAttributeDefNameLookup wsAttributeDefNameLookup, WsAttributeDefNameLookup[] relatedWsAttributeDefNameLookups, boolean assign, Boolean replaceAllExisting, WsSubjectLookup actAsSubjectLookup, GrouperTransactionType txType, WsParam[] params)
      assign or unassign attribute def name permission inheritance
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      wsAttributeDefNameLookup - attributeDefName which is the container for the inherited attribute def names
      relatedWsAttributeDefNameLookups - one or many attribute def names to add or remove from inheritance from the container
      assign - T to assign, or F to remove assignment
      replaceAllExisting - T if assigning, if this list should replace all existing immediately inherited attribute def names
      actAsSubjectLookup - if searching as someone else, pass in that subject here, note the caller must be allowed to act as that other subject
      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

    • assignAttributeDefNameInheritanceLite

      public static WsAssignAttributeDefNameInheritanceResults assignAttributeDefNameInheritanceLite(GrouperVersion clientVersion, String attributeDefNameUuid, String attributeDefNameName, String relatedAttributeDefNameUuid, String relatedAttributeDefNameName, boolean assign, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1)
      assign or unassign attribute def name permission inheritance
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      attributeDefNameUuid - id of attributeDefName which is the container for the inherited attribute def names, mutually exclusive with attributeDefNameName
      attributeDefNameName - name of attributeDefName which is the container for the inherited attribute def names, mutually exclusive with attributeDefNameId
      relatedAttributeDefNameUuid - id of attribute def name to add or remove from inheritance from the container
      relatedAttributeDefNameName - name of attribute def name to add or remove from inheritance from the container
      assign - T to assign, or F to remove assignment
      replaceAllExisting - T if assigning, if this list should replace all existing immediately inherited attribute def names
      actAsSubjectId - optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifier
      actAsSubjectIdentifier - optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifier
      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 result

    • attributeDefNameDelete

      public static WsAttributeDefNameDeleteResults attributeDefNameDelete(GrouperVersion clientVersion, WsAttributeDefNameLookup[] wsAttributeDefNameLookups, WsSubjectLookup actAsSubjectLookup, GrouperTransactionType txType, WsParam[] params)
      delete an AttributeDefName or many.
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      wsAttributeDefNameLookups - AttributeDefNames 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.
      params - optional: reserved for future use
      Returns:
      the results

    • attributeDefNameDeleteLite

      public static WsAttributeDefNameDeleteLiteResult attributeDefNameDeleteLite(GrouperVersion clientVersion, String attributeDefNameUuid, String attributeDefNameName, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1)
      delete an AttributeDefName
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      attributeDefNameUuid - the uuid of the attributeDefName to delete (mutually exclusive with attributeDefNameName)
      attributeDefNameName - the name of the attributeDefName to delete (mutually exclusive with attributeDefNameUuid)
      actAsSubjectId - optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifier
      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 actAsSubjectIdentifier
      paramName0 - reserved for future use
      paramValue0 - reserved for future use
      paramName1 - reserved for future use
      paramValue1 - reserved for future use
      typeOfGroup - type of group can be an enum of TypeOfGroup, e.g. group, role, entity
      Returns:
      the result of one member add

    • attributeDefNameSave

      public static WsAttributeDefNameSaveResults attributeDefNameSave(GrouperVersion clientVersion, WsAttributeDefNameToSave[] wsAttributeDefNameToSaves, WsSubjectLookup actAsSubjectLookup, GrouperTransactionType txType, WsParam[] params)
      save an AttributeDefName or many (insert or update). Note, you cannot rename an existing AttributeDefName.
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      wsAttributeDefNameToSaves - AttributeDefNames 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

    • attributeDefNameSaveLite

      public static WsAttributeDefNameSaveLiteResult attributeDefNameSaveLite(GrouperVersion clientVersion, String attributeDefNameLookupUuid, String attributeDefNameLookupName, String attributeDefLookupUuid, String attributeDefLookupName, String attributeDefNameUuid, String attributeDefNameName, String displayExtension, String description, SaveMode saveMode, Boolean createParentStemsIfNotExist, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1)
      save an AttributeDefName (insert or update). Note you cannot currently move an existing AttributeDefName.
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      attributeDefNameLookupUuid - the uuid of the attributeDefName to edit (mutually exclusive with attributeDefNameLookupName)
      attributeDefNameLookupName - the name of the attributeDefName to edit (mutually exclusive with attributeDefNameLookupUuid)
      attributeDefLookupName - to lookup the attributeDef (mutually exclusive with attributeDefUuid)
      attributeDefLookupUuid - to lookup the attributeDef (mutually exclusive with attributeDefName)
      attributeDefNameName - to lookup the attributeDefName (mutually exclusive with attributeDefNameUuid)
      attributeDefNameUuid - to lookup the attributeDefName (mutually exclusive with attributeDefNameName)
      description - of the attributeDefName, empty will be ignored
      displayExtension - display name of the attributeDefName, empty will be ignored
      saveMode - if the save should be constrained to INSERT, UPDATE, or INSERT_OR_UPDATE (default)
      createParentStemsIfNotExist - T or F (default F) if parent stems should be created if not exist
      actAsSubjectId - optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifier
      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 actAsSubjectIdentifier
      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

    • findAttributeDefNames

      public static WsFindAttributeDefNamesResults findAttributeDefNames(GrouperVersion clientVersion, String scope, Boolean splitScope, WsAttributeDefLookup wsAttributeDefLookup, AttributeAssignType attributeAssignType, AttributeDefType attributeDefType, WsAttributeDefNameLookup[] wsAttributeDefNameLookups, Integer pageSize, Integer pageNumber, String sortString, Boolean ascending, WsInheritanceSetRelation wsInheritanceSetRelation, WsSubjectLookup actAsSubjectLookup, WsParam[] params, WsSubjectLookup wsSubjectLookup, ServiceRole serviceRole, Boolean pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, Boolean pageCursorFieldIncludesLastRetrieved)
      find an attribute def name or attribute def names. Each additional parameter sent will narow the search, except the lookups will just lookup whatever is sent.
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      scope - search string with % as wildcards will search name, display name, description
      splitScope - T or F, if T will split the scope by whitespace, and find attribute def names with each token. e.g. if you have a scope of "pto permissions", and split scope T, it will return school:apps:pto_app:internal:the_permissions:whatever
      wsAttributeDefLookup - find names associated with this attribute definition
      attributeAssignType - where can the attribute definition be assigned, e.g. any_mem, any_mem_asgn, attr_def, attr_def_asgn, group, group_asgn, imm_mem, imm_mem_asgn, mem_asgn, member, stem, stem_asgn
      attributeDefType - type of attribute definition, e.g. attr, domain, limit, perm, type
      actAsSubjectLookup - if searching as someone else, pass in that subject here, note the caller must be allowed to act as that other subject
      params - optional: reserved for future use
      wsAttributeDefNameLookups - if you want to just pass in a list of uuids and/or names.
      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.
      pageIsCursor - true means cursor based paging
      pageLastCursorField - field based on which paging needs to occur
      pageLastCursorFieldType - type of last cursor field (eg: string, int, timestamp, etc)
      pageCursorFieldIncludesLastRetrieved - should the result has last retrieved item
      wsInheritanceSetRelation - if there is one wsAttributeDefNameLookup, and this is specified, then find the attribute def names which are related to the lookup by this relation, e.g. IMPLIED_BY_THIS, IMPLIED_BY_THIS_IMMEDIATE, THAT_IMPLY_THIS, THAT_IMPLY_THIS_IMMEDIATE
      wsSubjectLookup - subject if looking for privileges or service role
      serviceRole - to filter attributes that a user has a certain role
      Returns:
      the attribute def names, or no attribute def names if none found

    • findAttributeDefNamesLite

      public static WsFindAttributeDefNamesResults findAttributeDefNamesLite(GrouperVersion clientVersion, String scope, Boolean splitScope, String uuidOfAttributeDef, String nameOfAttributeDef, AttributeAssignType attributeAssignType, AttributeDefType attributeDefType, String attributeDefNameUuid, String attributeDefNameName, Integer pageSize, Integer pageNumber, String sortString, Boolean ascending, WsInheritanceSetRelation wsInheritanceSetRelation, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1, String subjectId, String subjectSourceId, String subjectIdentifier, ServiceRole serviceRole, Boolean pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, Boolean pageCursorFieldIncludesLastRetrieved)
      find an attribute def name or attribute def names. Each additional parameter sent will narow the search, except the lookups will just lookup whatever is sent.
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      scope - search string with % as wildcards will search name, display name, description
      splitScope - T or F, if T will split the scope by whitespace, and find attribute def names with each token. e.g. if you have a scope of "pto permissions", and split scope T, it will return school:apps:pto_app:internal:the_permissions:whatever
      uuidOfAttributeDef - find names associated with this attribute definition, mutually exclusive with nameOfAttributeDef
      nameOfAttributeDef - find names associated with this attribute definition, mutually exclusive with idOfAttributeDef
      wsAttributeDefLookup - find names associated with this attribute definition
      attributeAssignType - where can the attribute definition be assigned, e.g. any_mem, any_mem_asgn, attr_def, attr_def_asgn, group, group_asgn, imm_mem, imm_mem_asgn, mem_asgn, member, stem, stem_asgn
      attributeDefType - type of attribute definition, e.g. attr, domain, limit, perm, type
      attributeDefNameUuid - to lookup an attribute def name by id, mutually exclusive with attributeDefNameName
      attributeDefNameName - to lookup an attribute def name by name, mutually exclusive with attributeDefNameId
      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.
      pageIsCursor - true means cursor based paging
      pageLastCursorField - field based on which paging needs to occur
      pageLastCursorFieldType - type of last cursor field (eg: string, int, timestamp, etc)
      pageCursorFieldIncludesLastRetrieved - should the result has last retrieved item
      wsInheritanceSetRelation - if there is one wsAttributeDefNameLookup, and this is specified, then find the attribute def names which are related to the lookup by this relation, e.g. IMPLIED_BY_THIS, IMPLIED_BY_THIS_IMMEDIATE, THAT_IMPLY_THIS, THAT_IMPLY_THIS_IMMEDIATE
      actAsSubjectId - optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifier
      actAsSubjectIdentifier - optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifier
      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
      subjectId - subject id if looking for privileges or service role
      subjectSourceId - subject source id if looking for privileges or service role
      subjectIdentifier - subject identifier if looking for privileges or service role
      serviceRole - to filter attributes that a user has a certain role
      Returns:
      the attribute def names, or no attribute def names if none found

    • assignAttributesBatch

      public static WsAssignAttributesBatchResults assignAttributesBatch(GrouperVersion clientVersion, WsAssignAttributeBatchEntry[] wsAssignAttributeBatchEntries, WsSubjectLookup actAsSubjectLookup, boolean includeSubjectDetail, GrouperTransactionType txType, String[] subjectAttributeNames, boolean includeGroupDetail, WsParam[] params)
      assign attributes and values to owner objects (groups, stems, etc), doing multiple operations in one batch
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      includeSubjectDetail - T|F, for if the extended subject information should be returned (anything more than just the id)
      wsAssignAttributeBatchEntries - batch of attribute assignments
      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
      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.
      Returns:
      the results

    • sendMessage

      public static WsMessageResults sendMessage(GrouperVersion clientVersion, edu.internet2.middleware.grouperClient.messaging.GrouperMessageQueueType queueType, String queueOrTopicName, String messageSystemName, String routingKey, String exchangeType, Map<String,Object> queueArguments, Boolean autocreateObjects, WsMessage[] messages, WsSubjectLookup actAsSubjectLookup, WsParam[] params)
      Parameters:
      clientVersion -
      queueType - - queue or topic (required)
      queueOrTopicName - - queue or topic to send to (required)
      messageSystemName - - if there are multiple messaging systems, specify which one (optional)
      routingKey - - valid for only rabbitmq. ignored otherwise.
      queueArguments -
      autocreateObjects - - create queue/topic if not there already.
      messages - - payload to be sent (required)
      actAsSubjectLookup -
      params -
      Returns:
      the results

    • receiveMessage

      public static WsMessageResults receiveMessage(GrouperVersion clientVersion, edu.internet2.middleware.grouperClient.messaging.GrouperMessageQueueType queueType, String queueOrTopicName, String messageSystemName, String routingKey, String exchangeType, Map<String,Object> queueArguments, Boolean autocreateObjects, Integer blockMillis, Integer maxMessagesToReceiveAtOnce, WsSubjectLookup actAsSubjectLookup, WsParam[] params)
      Parameters:
      clientVersion -
      queueOrTopicName - - queue or topic to receive from (required)
      messageSystemName - - if there are multiple messaging systems, specify which one (optional)
      routingKey - - valid for rabbitmq, ignored otherwise.
      autocreateObjects - - create queue/topic if not there already
      blockMillis - - the millis to block waiting for messages, max of 20000 (optional)
      maxMessagesToReceiveAtOnce - - max number of messages to receive at once, though can't be more than the server maximum (optional)
      actAsSubjectLookup -
      params -
      Returns:
      the results

    • acknowledge

      public static WsMessageAcknowledgeResults acknowledge(GrouperVersion clientVersion, String queueOrTopicName, String messageSystemName, edu.internet2.middleware.grouperClient.messaging.GrouperMessageAcknowledgeType acknowledgeType, String[] messageIds, String anotherQueueOrTopicName, edu.internet2.middleware.grouperClient.messaging.GrouperMessageQueueType anotherQueueType, WsSubjectLookup actAsSubjectLookup, WsParam[] params)
      Parameters:
      clientVersion -
      queueOrTopicName - - queue or topic to receive from (required)
      messageSystemName - - if there are multiple messaging systems, specify which one (optional)
      acknowledgeType - specify what to do with the messages (required)
      messageIds - - messageIds to be marked as processed (required)
      anotherQueueOrTopicName - - required if acknowledgeType is SEND_TO_ANOTHER_TOPIC_OR_QUEUE
      anotherQueueType - - required if acknowledgeType is SEND_TO_ANOTHER_TOPIC_OR_QUEUE
      actAsSubjectLookup -
      params -
      Returns:
      the results

    • externalSubjectDelete

      public static WsExternalSubjectDeleteResults externalSubjectDelete(GrouperVersion clientVersion, WsExternalSubjectLookup[] wsExternalSubjectLookups, WsSubjectLookup actAsSubjectLookup, GrouperTransactionType txType, WsParam[] params)
      delete an external subject or many (if doesnt exist, ignore)
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      wsExternalSubjectLookups - 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.
      params - optional: reserved for future use
      Returns:
      the results

    • findExternalSubjects

      public static WsFindExternalSubjectsResults findExternalSubjects(GrouperVersion clientVersion, WsExternalSubjectLookup[] wsExternalSubjectLookups, WsSubjectLookup actAsSubjectLookup, WsParam[] params)
      find a external subjects
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      actAsSubjectLookup -
      params - optional: reserved for future use
      wsExternalSubjectLookups - if you want to just pass in a list of uuids and/or names
      Returns:
      the external subjects, or no external subjects if none found

    • getAuditEntriesLite

      public static WsGetAuditEntriesResults getAuditEntriesLite(GrouperVersion clientVersion, String actAsSubjectId, String actAsSubjectSourceId, String actAsSubjectIdentifier, String auditType, String auditActionId, String wsGroupName, String wsGroupId, String wsStemName, String wsStemId, String wsAttributeDefName, String wsAttributeDefId, String wsAttributeDefNameName, String wsAttributeDefNameId, String wsSubjectId, String wsSubjectSourceId, String wsSubjectIdentifier, String actionsPerformedByWsSubjectId, String actionsPerformedByWsSubjectSourceId, String actionsPerformedByWsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1, Integer pageSize, String sortString, Boolean ascending, Boolean pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, Boolean pageCursorFieldIncludesLastRetrieved, Timestamp fromDate, Timestamp toDate)
      get audit entries
      Parameters:
      clientVersion -
      actAsSubjectId -
      actAsSubjectSourceId -
      actAsSubjectIdentifier -
      auditType -
      auditActionId -
      wsGroupName -
      wsGroupId -
      wsStemName -
      wsStemId -
      wsAttributeDefName -
      wsAttributeDefId -
      wsAttributeDefNameName -
      wsAttributeDefNameId -
      wsSubjectId -
      wsSubjectSourceId -
      wsSubjectIdentifier -
      actionsPerformedByWsSubjectId -
      actionsPerformedByWsSubjectSourceId -
      actionsPerformedByWsSubjectIdentifier -
      paramName0 -
      paramValue0 -
      paramName1 -
      paramValue1 -
      pageSize -
      sortString -
      ascending -
      pageIsCursor - true means cursor based paging
      pageLastCursorField - field based on which paging needs to occur
      pageLastCursorFieldType - type of last cursor field (eg: string, int, timestamp, etc)
      pageCursorFieldIncludesLastRetrieved - should the result has last retrieved item
      fromDate -
      toDate -
      Returns:
      audit entries result

    • getAuditEntries

      public static WsGetAuditEntriesResults getAuditEntries(GrouperVersion clientVersion, WsSubjectLookup actAsSubjectLookup, String auditType, String auditActionId, WsGroupLookup wsGroupLookup, WsStemLookup wsStemLookup, WsAttributeDefLookup wsAttributeDefLookup, WsAttributeDefNameLookup wsAttributeDefNameLookup, WsSubjectLookup wsSubjectLookup, WsSubjectLookup actionsPerformedByWsSubjectLookup, WsParam[] params, Integer pageSize, String sortString, Boolean ascending, Boolean pageIsCursor, String pageLastCursorField, String pageLastCursorFieldType, Boolean pageCursorFieldIncludesLastRetrieved, Timestamp fromDate, Timestamp toDate)
      get audit entries
      Parameters:
      clientVersion -
      actAsSubjectLookup -
      auditType -
      auditActionId -
      wsGroupLookup -
      wsStemLookup -
      wsAttributeDefLookup -
      wsAttributeDefNameLookup -
      wsSubjectLookup -
      actionsPerformedByWsSubjectLookup -
      params -
      pageSize -
      sortString -
      ascending -
      pageIsCursor - true means cursor based paging
      pageLastCursorField - field based on which paging needs to occur
      pageLastCursorFieldType - type of last cursor field (eg: string, int, timestamp, etc)
      pageCursorFieldIncludesLastRetrieved - should the result has last retrieved item
      fromDate -
      toDate -
      Returns:
      audit entries result

    • executeGshTemplate

      public static WsGshTemplateExecResult executeGshTemplate(GrouperVersion clientVersion, String configId, GshTemplateOwnerType ownerType, WsGroupLookup ownerGroupLookup, WsStemLookup ownerStemLookup, WsGshTemplateInput[] inputs, Map<String,Object> wsInput, WsSubjectLookup gshTemplateActAsSubjectLookup, WsSubjectLookup actAsSubjectLookup, WsParam[] params)
      execute gsh template
      Parameters:
      clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      configId - configId of the template to execute
      ownerType - stem or group
      wsInput - is a map from the arbitrary input
      ownerGroupLookup - owner group when ownerType is group
      ownerStemLookup - owner stem when ownerType is stem
      inputs - name/value pairs to inject into the template at runtime
      params - optional: reserved for future use
      Returns:
      the results