edu.internet2.middleware.grouper.app.usdu
Class USDU

java.lang.Object
  edu.internet2.middleware.grouper.app.usdu.USDU

public class USDU
extends java.lang.Object

The Unresolvable Subject Deletion Utility finds and optionally deletes members whose subjects can not be resolved by their source. Documentation is available via the 'Unresolvable Subject Deletion Utility' on the Grouper Product wiki https://wiki.internet2.edu/confluence/display/GrouperWG/Grouper+Product

Constructor Summary

USDU()

Method Summary

static void	deleteUnresolvableMember(Member member, Group group, Field field) Delete unresolvable member from group and field.
static void	deleteUnresolvableMember(Member member, Group group, Privilege privilege) Revoke unresolvable member's privilege from group.
static void	deleteUnresolvableMember(Member member, Stem stem, Privilege privilege) Revoke unresolvable member's privilege from stem.
static java.util.Set<Member>	getUnresolvableMembers(GrouperSession s, edu.internet2.middleware.subject.Source source) Find members whose subjects can not be found by their source.
static boolean	isMemberResolvable(GrouperSession s, Member member) Check if this member's subject can be found in a source.
static void	main(java.lang.String[] args) Run USDU.
static void	resolveMember(GrouperSession s, java.lang.String uuid, boolean delete) Find and optionally delete memberships and privileges for the unresolvable subject with given member uuid.
static void	resolveMembers(GrouperSession s, boolean delete) Find and optionally delete memberships and privileges for unresolvable subjects from all sources.
static void	resolveMembers(GrouperSession s, edu.internet2.middleware.subject.Source source, boolean delete) Find and optionally delete memberships and privileges for unresolvable subjects from the specified source.

Methods inherited from class java.lang.Object

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

Constructor Detail

USDU

public USDU()

Method Detail

main

public static void main(java.lang.String[] args)

Run USDU.

 // to print usage
 usdu.sh
 // or
 usdu.bat
 

Parameters:

args -

Since:

1.3.0

resolveMember

public static void resolveMember(GrouperSession s,
                                 java.lang.String uuid,
                                 boolean delete)
                          throws java.lang.IllegalArgumentException,
                                 InsufficientPrivilegeException,
                                 GroupNotFoundException,
                                 MemberDeleteException,
                                 MemberNotFoundException,
                                 RevokePrivilegeException,
                                 SchemaException,
                                 edu.internet2.middleware.subject.SourceUnavailableException,
                                 StemNotFoundException

Find and optionally delete memberships and privileges for the unresolvable subject with given member uuid.

Parameters:

s - the Grouper session

uuid - the uuid of the member

delete - if true will delete memberships and privileges

Throws:

java.lang.IllegalArgumentException

InsufficientPrivilegeException

GroupNotFoundException

MemberDeleteException

MemberNotFoundException

RevokePrivilegeException

SchemaException

edu.internet2.middleware.subject.SourceUnavailableException

StemNotFoundException

resolveMembers

public static void resolveMembers(GrouperSession s,
                                  boolean delete)
                           throws java.lang.IllegalArgumentException,
                                  InsufficientPrivilegeException,
                                  GroupNotFoundException,
                                  MemberDeleteException,
                                  MemberNotFoundException,
                                  RevokePrivilegeException,
                                  SchemaException,
                                  edu.internet2.middleware.subject.SourceUnavailableException,
                                  StemNotFoundException

Find and optionally delete memberships and privileges for unresolvable subjects from all sources.

Parameters:

s - the Grouper session

delete - if true will delete memberships and privileges

Throws:

java.lang.IllegalArgumentException

InsufficientPrivilegeException

GroupNotFoundException

MemberDeleteException

MemberNotFoundException

RevokePrivilegeException

SchemaException

edu.internet2.middleware.subject.SourceUnavailableException

StemNotFoundException

resolveMembers

public static void resolveMembers(GrouperSession s,
                                  edu.internet2.middleware.subject.Source source,
                                  boolean delete)
                           throws java.lang.IllegalArgumentException,
                                  InsufficientPrivilegeException,
                                  GroupNotFoundException,
                                  MemberDeleteException,
                                  MemberNotFoundException,
                                  RevokePrivilegeException,
                                  SchemaException,
                                  edu.internet2.middleware.subject.SourceUnavailableException,
                                  StemNotFoundException

Find and optionally delete memberships and privileges for unresolvable subjects from the specified source.

Parameters:

s - the Grouper session

source -

delete - if true will delete memberships and privileges

Throws:

java.lang.IllegalArgumentException

InsufficientPrivilegeException

GroupNotFoundException

MemberDeleteException

MemberNotFoundException

RevokePrivilegeException

SchemaException

edu.internet2.middleware.subject.SourceUnavailableException

StemNotFoundException

deleteUnresolvableMember

public static void deleteUnresolvableMember(Member member,
                                            Group group,
                                            Field field)
                                     throws java.lang.IllegalArgumentException,
                                            InsufficientPrivilegeException,
                                            MemberDeleteException,
                                            edu.internet2.middleware.subject.SourceUnavailableException,
                                            SchemaException

Delete unresolvable member from group and field.

Parameters:

member -

group -

field -

Throws:

java.lang.IllegalArgumentException

InsufficientPrivilegeException

MemberDeleteException

edu.internet2.middleware.subject.SourceUnavailableException

SchemaException

deleteUnresolvableMember

public static void deleteUnresolvableMember(Member member,
                                            Group group,
                                            Privilege privilege)
                                     throws java.lang.IllegalArgumentException,
                                            InsufficientPrivilegeException,
                                            RevokePrivilegeException,
                                            SchemaException,
                                            edu.internet2.middleware.subject.SourceUnavailableException

Revoke unresolvable member's privilege from group.

Parameters:

member -

group -

privilege -

Throws:

java.lang.IllegalArgumentException

InsufficientPrivilegeException

RevokePrivilegeException

SchemaException

edu.internet2.middleware.subject.SourceUnavailableException

deleteUnresolvableMember

public static void deleteUnresolvableMember(Member member,
                                            Stem stem,
                                            Privilege privilege)
                                     throws java.lang.IllegalArgumentException,
                                            InsufficientPrivilegeException,
                                            RevokePrivilegeException,
                                            SchemaException,
                                            edu.internet2.middleware.subject.SourceUnavailableException

Revoke unresolvable member's privilege from stem.

Parameters:

member -

stem -

privilege -

Throws:

java.lang.IllegalArgumentException

InsufficientPrivilegeException

RevokePrivilegeException

SchemaException

edu.internet2.middleware.subject.SourceUnavailableException

getUnresolvableMembers

public static java.util.Set<Member> getUnresolvableMembers(GrouperSession s,
                                                           edu.internet2.middleware.subject.Source source)

Find members whose subjects can not be found by their source.

Parameters:

s - GrouperSession

source - if null will find members from all sources

Returns:

unresolvable members

isMemberResolvable

public static boolean isMemberResolvable(GrouperSession s,
                                         Member member)

Check if this member's subject can be found in a source.

Parameters:

s -

member -

Returns:

Boolean true if member's subject is found in source