edu.internet2.middleware.grouper.privs

Class NamingResolverDecorator

java.lang.Object

edu.internet2.middleware.grouper.privs.NamingResolverDecorator

All Implemented Interfaces:

NamingResolver

Direct Known Subclasses:

CachingNamingResolver, GrouperAllNamingResolver, GrouperSystemNamingResolver, ValidatingNamingResolver, WheelNamingResolver

public abstract class NamingResolverDecorator
extends Object
implements NamingResolver

Decorator for NamingResolver.

Since:

1.2.1

Version:

$Id: NamingResolverDecorator.java,v 1.3 2009-09-21 06:14:26 mchyzer Exp $

Constructor Summary

Constructors

Constructor and Description
NamingResolverDecorator(NamingResolver resolver)

Method Summary

Modifier and Type	Method and Description
void	flushCache() flush cache if caching resolver
NamingResolver	getDecoratedResolver()
GrouperSession	getGrouperSession() get a reference to the session
Set<NamingPrivilege>	getPrivileges(Stem stem, Subject subject) Get all privileges subject has on group.
Set<Stem>	getStemsWhereSubjectDoesHavePrivilege(String stemId, Stem.Scope scope, Subject subject, Privilege privilege, boolean considerAllSubject, String sqlLikeString) find the stems which do have a certain privilege
Set<Stem>	getStemsWhereSubjectDoesntHavePrivilege(String stemId, Stem.Scope scope, Subject subject, Privilege privilege, boolean considerAllSubject, String sqlLikeString) find the stems which do not have a certain privilege
Set<Stem>	getStemsWhereSubjectHasPrivilege(Subject subject, Privilege privilege) Get all groups where subject has privilege.
Set<Subject>	getSubjectsWithPrivilege(Stem stem, Privilege privilege) Get all subjects with privilege on group.
void	grantPrivilege(Stem stem, Subject subject, Privilege privilege, String uuid) Grant privilege to subject on group.
boolean	hasPrivilege(Stem stem, Subject subject, Privilege privilege) Check whether subject has privilege on group.
boolean	hqlFilterStemsNotWithPrivWhereClause(Subject subject, HqlQuery hqlQuery, StringBuilder hql, String stemColumn, Privilege privilege, boolean considerAllSubject) for a stem query, check to make sure the subject doesnt have privs
boolean	hqlFilterStemsWhereClause(Subject subject, HqlQuery hqlQuery, StringBuilder hql, String stemColumn, Set<Privilege> privInSet) for a stem query, check to make sure the subject can see the records (if filtering HQL, you can do the postHqlFilterGroups instead if you like).
boolean	hqlFilterStemsWithPrivWhereClause(Subject subject, HqlQuery hqlQuery, StringBuilder hql, String stemColumn, Privilege privilege, boolean considerAllSubject) for a stem query, check to make sure the subject has privs
Set<Stem>	postHqlFilterStems(Set<Stem> stems, Subject subject, Set<Privilege> privInSet) after HQL is run, filter stems.
void	privilegeCopy(Stem stem1, Stem stem2, Privilege priv) Copies privileges for subjects that have the specified privilege on stem1 to stem2.
void	privilegeCopy(Subject subj1, Subject subj2, Privilege priv) Copies privileges of type priv on any subject for the given Subject subj1 to the given Subject subj2.
void	revokeAllPrivilegesForSubject(Subject subject) Revoke all naming privileges that this subject has.
void	revokePrivilege(Stem stem, Privilege privilege) Revoke privilege from all subjects on group.
void	revokePrivilege(Stem stem, Subject subject, Privilege privilege) Revoke privilege from subject on group.
void	stop() clean up resources, session is stopped

Methods inherited from class java.lang.Object

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

Constructor Detail

NamingResolverDecorator

public NamingResolverDecorator(NamingResolver resolver)
                        throws IllegalArgumentException

Parameters:

resolver - NamingResolver to decorate.

Throws:

IllegalArgumentException - if resolver is null.

Since:

1.2.1

Method Detail

flushCache

public void flushCache()

Description copied from interface: NamingResolver

flush cache if caching resolver

Specified by:

flushCache in interface NamingResolver

See Also:

NamingResolver.flushCache()

getDecoratedResolver

public NamingResolver getDecoratedResolver()
                                    throws IllegalStateException

Returns:

Decorated NamingResolver.

Throws:

IllegalStateException - if no decorated NamingResolver.

Since:

1.2.1

getGrouperSession

public GrouperSession getGrouperSession()

Description copied from interface: NamingResolver

get a reference to the session

Specified by:

getGrouperSession in interface NamingResolver

Returns:

the session

See Also:

NamingResolver.getGrouperSession()

getPrivileges

public Set<NamingPrivilege> getPrivileges(Stem stem,
                                          Subject subject)
                                   throws IllegalArgumentException

Description copied from interface: NamingResolver

Get all privileges subject has on group.

Specified by:

getPrivileges in interface NamingResolver

Returns:

set of naming privileges

Throws:

IllegalArgumentException - if any parameter is null.

See Also:

NamingResolver.getPrivileges(edu.internet2.middleware.grouper.Stem, edu.internet2.middleware.subject.Subject)

getStemsWhereSubjectHasPrivilege

public Set<Stem> getStemsWhereSubjectHasPrivilege(Subject subject,
                                                  Privilege privilege)
                                           throws IllegalArgumentException

Description copied from interface: NamingResolver

Get all groups where subject has privilege.

Specified by:

getStemsWhereSubjectHasPrivilege in interface NamingResolver

Returns:

set

Throws:

IllegalArgumentException - if any parameter is null.

See Also:

NamingResolver.getStemsWhereSubjectHasPrivilege(edu.internet2.middleware.subject.Subject, edu.internet2.middleware.grouper.privs.Privilege)

getSubjectsWithPrivilege

public Set<Subject> getSubjectsWithPrivilege(Stem stem,
                                             Privilege privilege)
                                      throws IllegalArgumentException

Description copied from interface: NamingResolver

Get all subjects with privilege on group.

Specified by:

getSubjectsWithPrivilege in interface NamingResolver

Returns:

set of subjects

Throws:

IllegalArgumentException - if any parameter is null.

See Also:

NamingResolver.getSubjectsWithPrivilege(edu.internet2.middleware.grouper.Stem, edu.internet2.middleware.grouper.privs.Privilege)

grantPrivilege

public void grantPrivilege(Stem stem,
                           Subject subject,
                           Privilege privilege,
                           String uuid)
                    throws IllegalArgumentException,
                           UnableToPerformException

Description copied from interface: NamingResolver

Grant privilege to subject on group.

Specified by:

grantPrivilege in interface NamingResolver

uuid - if known or null

Throws:

IllegalArgumentException - if any parameter is null.

UnableToPerformException - if the privilege could not be granted.

See Also:

NamingResolver.grantPrivilege(edu.internet2.middleware.grouper.Stem, edu.internet2.middleware.subject.Subject, edu.internet2.middleware.grouper.privs.Privilege, String)

hasPrivilege

public boolean hasPrivilege(Stem stem,
                            Subject subject,
                            Privilege privilege)
                     throws IllegalArgumentException

Description copied from interface: NamingResolver

Check whether subject has privilege on group.

Specified by:

hasPrivilege in interface NamingResolver

Returns:

if has privilege

Throws:

IllegalArgumentException - if any parameter is null.

See Also:

NamingResolver.hasPrivilege(edu.internet2.middleware.grouper.Stem, edu.internet2.middleware.subject.Subject, edu.internet2.middleware.grouper.privs.Privilege)

hqlFilterStemsWhereClause

public boolean hqlFilterStemsWhereClause(Subject subject,
                                         HqlQuery hqlQuery,
                                         StringBuilder hql,
                                         String stemColumn,
                                         Set<Privilege> privInSet)

Description copied from interface: NamingResolver

for a stem query, check to make sure the subject can see the records (if filtering HQL, you can do the postHqlFilterGroups instead if you like). Note, this joins to tables, so the queries should probably be "distinct"

Specified by:

hqlFilterStemsWhereClause in interface NamingResolver

Parameters:

subject - which needs view access to the groups

hql - is the select and part part (hql prefix)

stemColumn - is the name of the stem column to join to

privInSet - find a privilege which is in this set (e.g. for view, send all access privs). There are pre-canned sets in AccessAdapter

Returns:

if the query was changed

See Also:

NamingResolver.hqlFilterStemsWhereClause(edu.internet2.middleware.subject.Subject, edu.internet2.middleware.grouper.hibernate.HqlQuery, java.lang.StringBuilder, java.lang.String, java.util.Set)

postHqlFilterStems

public Set<Stem> postHqlFilterStems(Set<Stem> stems,
                                    Subject subject,
                                    Set<Privilege> privInSet)

Description copied from interface: NamingResolver

after HQL is run, filter stems. If you are filtering in HQL, then dont filter here

Specified by:

postHqlFilterStems in interface NamingResolver

subject - which needs view access to the groups

privInSet - find a privilege which is in this set (e.g. for view, send all access privs). There are pre-canned sets in NamingPrivilege

Returns:

the set of filtered groups

See Also:

NamingResolver.postHqlFilterStems(java.util.Set, edu.internet2.middleware.subject.Subject, java.util.Set)

privilegeCopy

public void privilegeCopy(Stem stem1,
                          Stem stem2,
                          Privilege priv)
                   throws IllegalArgumentException,
                          UnableToPerformException

Description copied from interface: NamingResolver

Copies privileges for subjects that have the specified privilege on stem1 to stem2.

Specified by:

privilegeCopy in interface NamingResolver

Throws:

IllegalArgumentException

UnableToPerformException

See Also:

NamingResolver.privilegeCopy(edu.internet2.middleware.grouper.Stem, edu.internet2.middleware.grouper.Stem, edu.internet2.middleware.grouper.privs.Privilege)

privilegeCopy

public void privilegeCopy(Subject subj1,
                          Subject subj2,
                          Privilege priv)
                   throws IllegalArgumentException,
                          UnableToPerformException

Description copied from interface: NamingResolver

Copies privileges of type priv on any subject for the given Subject subj1 to the given Subject subj2. For instance, if subj1 has STEM privilege to Stem x, this method will result with subj2 having STEM privilege to Stem x.

Specified by:

privilegeCopy in interface NamingResolver

Throws:

IllegalArgumentException

UnableToPerformException

See Also:

NamingResolver.privilegeCopy(edu.internet2.middleware.subject.Subject, edu.internet2.middleware.subject.Subject, edu.internet2.middleware.grouper.privs.Privilege)

revokeAllPrivilegesForSubject

public void revokeAllPrivilegesForSubject(Subject subject)

Description copied from interface: NamingResolver

Revoke all naming privileges that this subject has.

Specified by:

revokeAllPrivilegesForSubject in interface NamingResolver

See Also:

NamingResolver.revokeAllPrivilegesForSubject(edu.internet2.middleware.subject.Subject)

revokePrivilege

public void revokePrivilege(Stem stem,
                            Privilege privilege)
                     throws IllegalArgumentException,
                            UnableToPerformException

Description copied from interface: NamingResolver

Revoke privilege from all subjects on group.

Specified by:

revokePrivilege in interface NamingResolver

Throws:

IllegalArgumentException - if any parameter is null.

UnableToPerformException - if the privilege could not be revoked.

See Also:

NamingResolver.revokePrivilege(edu.internet2.middleware.grouper.Stem, edu.internet2.middleware.grouper.privs.Privilege)

revokePrivilege

public void revokePrivilege(Stem stem,
                            Subject subject,
                            Privilege privilege)
                     throws IllegalArgumentException,
                            UnableToPerformException

Description copied from interface: NamingResolver

Revoke privilege from subject on group.

Specified by:

revokePrivilege in interface NamingResolver

Throws:

IllegalArgumentException - if any parameter is null.

UnableToPerformException - if the privilege could not be revoked.

See Also:

NamingResolver.revokePrivilege(edu.internet2.middleware.grouper.Stem, edu.internet2.middleware.subject.Subject, edu.internet2.middleware.grouper.privs.Privilege)

stop

public void stop()

Description copied from interface: NamingResolver

clean up resources, session is stopped

Specified by:

stop in interface NamingResolver

See Also:

NamingResolver.stop()

getStemsWhereSubjectDoesntHavePrivilege

public Set<Stem> getStemsWhereSubjectDoesntHavePrivilege(String stemId,
                                                         Stem.Scope scope,
                                                         Subject subject,
                                                         Privilege privilege,
                                                         boolean considerAllSubject,
                                                         String sqlLikeString)

Description copied from interface: NamingResolver

find the stems which do not have a certain privilege

Specified by:

getStemsWhereSubjectDoesntHavePrivilege in interface NamingResolver

Returns:

the stems

See Also:

NamingResolver#getStemsWhereSubjectDoesntHavePrivilege(String, Scope, Subject, Privilege, boolean, String)

hqlFilterStemsNotWithPrivWhereClause

public boolean hqlFilterStemsNotWithPrivWhereClause(Subject subject,
                                                    HqlQuery hqlQuery,
                                                    StringBuilder hql,
                                                    String stemColumn,
                                                    Privilege privilege,
                                                    boolean considerAllSubject)

Description copied from interface: NamingResolver

for a stem query, check to make sure the subject doesnt have privs

Specified by:

hqlFilterStemsNotWithPrivWhereClause in interface NamingResolver

Parameters:

subject - which needs view access to the groups

hql - the select and current from part

stemColumn - is the name of the group column to join to

privilege - find a privilege which is in this set (e.g. stem or create)

considerAllSubject - if true, then consider GrouperAll when seeign if subject has priv, else do not

Returns:

if the statement was changed

See Also:

edu.internet2.middleware.grouper.privs.NamingResolver#hqlFilterStemsWhereClause(edu.internet2.middleware.subject.Subject, edu.internet2.middleware.grouper.hibernate.HqlQuery, java.lang.StringBuilder, java.lang.String, Privilege)

getStemsWhereSubjectDoesHavePrivilege

public Set<Stem> getStemsWhereSubjectDoesHavePrivilege(String stemId,
                                                       Stem.Scope scope,
                                                       Subject subject,
                                                       Privilege privilege,
                                                       boolean considerAllSubject,
                                                       String sqlLikeString)

Description copied from interface: NamingResolver

find the stems which do have a certain privilege

Specified by:

getStemsWhereSubjectDoesHavePrivilege in interface NamingResolver

Returns:

the stems

See Also:

NamingResolver#getStemsWhereSubjectDoesHavePrivilege(String, Scope, Subject, Privilege, boolean, String)

hqlFilterStemsWithPrivWhereClause

public boolean hqlFilterStemsWithPrivWhereClause(Subject subject,
                                                 HqlQuery hqlQuery,
                                                 StringBuilder hql,
                                                 String stemColumn,
                                                 Privilege privilege,
                                                 boolean considerAllSubject)

Description copied from interface: NamingResolver

for a stem query, check to make sure the subject has privs

Specified by:

hqlFilterStemsWithPrivWhereClause in interface NamingResolver

Parameters:

subject - which needs view access to the groups

hql - the select and current from part

stemColumn - is the name of the group column to join to

privilege - find a privilege which is in this set (e.g. stem or create)

considerAllSubject - if true, then consider GrouperAll when seeign if subject has priv, else do not

Returns:

if the statement was changed

See Also:

NamingResolver.hqlFilterStemsWithPrivWhereClause(Subject, HqlQuery, StringBuilder, String, Privilege, boolean)