edu.internet2.middleware.grouper.privs
Interface NamingResolver

All Known Implementing Classes:

CachingNamingResolver, GrouperAllNamingResolver, GrouperSystemNamingResolver, NamingResolverDecorator, NamingWrapper, ValidatingNamingResolver, WheelNamingResolver

public interface NamingResolver

Facade for the NamingAdapter interface.

Since:

1.2.1

Version:

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

Author:

blair christensen.

Method Summary

void	flushCache() flush cache if caching resolver
GrouperSession	getGrouperSession() get a reference to the session
java.util.Set<NamingPrivilege>	getPrivileges(Stem stem, edu.internet2.middleware.subject.Subject subject) Get all privileges subject has on group.
java.util.Set<Stem>	getStemsWhereSubjectDoesntHavePrivilege(java.lang.String stemId, Stem.Scope scope, edu.internet2.middleware.subject.Subject subject, Privilege privilege, boolean considerAllSubject, java.lang.String sqlLikeString) find the stems which do not have a certain privilege
java.util.Set<Stem>	getStemsWhereSubjectHasPrivilege(edu.internet2.middleware.subject.Subject subject, Privilege privilege) Get all groups where subject has privilege.
java.util.Set<edu.internet2.middleware.subject.Subject>	getSubjectsWithPrivilege(Stem stem, Privilege privilege) Get all subjects with privilege on group.
void	grantPrivilege(Stem stem, edu.internet2.middleware.subject.Subject subject, Privilege privilege, java.lang.String uuid) Grant privilege to subject on group.
boolean	hasPrivilege(Stem stem, edu.internet2.middleware.subject.Subject subject, Privilege privilege) Check whether subject has privilege on group.
boolean	hqlFilterStemsNotWithPrivWhereClause(edu.internet2.middleware.subject.Subject subject, HqlQuery hqlQuery, java.lang.StringBuilder hql, java.lang.String stemColumn, Privilege privilege, boolean considerAllSubject) for a stem query, check to make sure the subject cant see the records
boolean	hqlFilterStemsWhereClause(edu.internet2.middleware.subject.Subject subject, HqlQuery hqlQuery, java.lang.StringBuilder hql, java.lang.String stemColumn, java.util.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).
java.util.Set<Stem>	postHqlFilterStems(java.util.Set<Stem> stems, edu.internet2.middleware.subject.Subject subject, java.util.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(edu.internet2.middleware.subject.Subject subj1, edu.internet2.middleware.subject.Subject subj2, Privilege priv) Copies privileges of type priv on any subject for the given Subject subj1 to the given Subject subj2.
void	revokeAllPrivilegesForSubject(edu.internet2.middleware.subject.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, edu.internet2.middleware.subject.Subject subject, Privilege privilege) Revoke privilege from subject on group.
void	stop() clean up resources, session is stopped

Method Detail

getStemsWhereSubjectDoesntHavePrivilege

java.util.Set<Stem> getStemsWhereSubjectDoesntHavePrivilege(java.lang.String stemId,
                                                            Stem.Scope scope,
                                                            edu.internet2.middleware.subject.Subject subject,
                                                            Privilege privilege,
                                                            boolean considerAllSubject,
                                                            java.lang.String sqlLikeString)

find the stems which do not have a certain privilege

Parameters:

stemId -

scope -

subject -

privilege -

considerAllSubject -

sqlLikeString -

Returns:

the stems

flushCache

void flushCache()

flush cache if caching resolver

stop

void stop()

clean up resources, session is stopped

getStemsWhereSubjectHasPrivilege

java.util.Set<Stem> getStemsWhereSubjectHasPrivilege(edu.internet2.middleware.subject.Subject subject,
                                                     Privilege privilege)
                                                     throws java.lang.IllegalArgumentException

Get all groups where subject has privilege.

Parameters:

subject -

privilege -

Returns:

set

Throws:

java.lang.IllegalArgumentException - if any parameter is null.

Since:

1.2.1

See Also:

NamingAdapter.getStemsWhereSubjectHasPriv(GrouperSession, Subject, Privilege)

getPrivileges

java.util.Set<NamingPrivilege> getPrivileges(Stem stem,
                                             edu.internet2.middleware.subject.Subject subject)
                                             throws java.lang.IllegalArgumentException

Get all privileges subject has on group.

Parameters:

stem -

subject -

Returns:

set of naming privileges

Throws:

java.lang.IllegalArgumentException - if any parameter is null.

Since:

1.2.1

See Also:

NamingAdapter.getPrivs(GrouperSession, Stem, Subject)

getSubjectsWithPrivilege

java.util.Set<edu.internet2.middleware.subject.Subject> getSubjectsWithPrivilege(Stem stem,
                                                                                 Privilege privilege)
                                                                                 throws java.lang.IllegalArgumentException

Get all subjects with privilege on group.

Parameters:

stem -

privilege -

Returns:

set of subjects

Throws:

java.lang.IllegalArgumentException - if any parameter is null.

Since:

1.2.1

See Also:

NamingAdapter.getSubjectsWithPriv(GrouperSession, Stem, Privilege)

grantPrivilege

void grantPrivilege(Stem stem,
                    edu.internet2.middleware.subject.Subject subject,
                    Privilege privilege,
                    java.lang.String uuid)
                    throws java.lang.IllegalArgumentException,
                           UnableToPerformException

Grant privilege to subject on group.

Parameters:

stem -

subject -

privilege -

uuid - if known or null

Throws:

java.lang.IllegalArgumentException - if any parameter is null.

UnableToPerformException - if the privilege could not be granted.

Since:

1.2.1

See Also:

edu.internet2.middleware.grouper.privs.NamingAdapter#grantPriv(GrouperSession, Stem, Subject, Privilege)

hasPrivilege

boolean hasPrivilege(Stem stem,
                     edu.internet2.middleware.subject.Subject subject,
                     Privilege privilege)
                     throws java.lang.IllegalArgumentException

Check whether subject has privilege on group.

Parameters:

stem -

subject -

privilege -

Returns:

if has privilege

Throws:

java.lang.IllegalArgumentException - if any parameter is null.

Since:

1.2.1

See Also:

NamingAdapter.hasPriv(GrouperSession, Stem, Subject, Privilege)

revokePrivilege

void revokePrivilege(Stem stem,
                     Privilege privilege)
                     throws java.lang.IllegalArgumentException,
                            UnableToPerformException

Revoke privilege from all subjects on group.

Parameters:

stem -

privilege -

Throws:

java.lang.IllegalArgumentException - if any parameter is null.

UnableToPerformException - if the privilege could not be revoked.

Since:

1.2.1

See Also:

NamingAdapter.revokePriv(GrouperSession, Stem, Privilege)

revokePrivilege

void revokePrivilege(Stem stem,
                     edu.internet2.middleware.subject.Subject subject,
                     Privilege privilege)
                     throws java.lang.IllegalArgumentException,
                            UnableToPerformException

Revoke privilege from subject on group.

Parameters:

stem -

subject -

privilege -

Throws:

java.lang.IllegalArgumentException - if any parameter is null.

UnableToPerformException - if the privilege could not be revoked.

Since:

1.2.1

See Also:

NamingAdapter.revokePriv(GrouperSession, Stem, Subject, Privilege)

privilegeCopy

void privilegeCopy(Stem stem1,
                   Stem stem2,
                   Privilege priv)
                   throws java.lang.IllegalArgumentException,
                          UnableToPerformException

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

Parameters:

stem1 -

stem2 -

priv -

Throws:

java.lang.IllegalArgumentException

UnableToPerformException

privilegeCopy

void privilegeCopy(edu.internet2.middleware.subject.Subject subj1,
                   edu.internet2.middleware.subject.Subject subj2,
                   Privilege priv)
                   throws java.lang.IllegalArgumentException,
                          UnableToPerformException

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.

Parameters:

subj1 -

subj2 -

priv -

Throws:

java.lang.IllegalArgumentException

UnableToPerformException

getGrouperSession

GrouperSession getGrouperSession()

get a reference to the session

Returns:

the session

hqlFilterStemsWhereClause

boolean hqlFilterStemsWhereClause(edu.internet2.middleware.subject.Subject subject,
                                  HqlQuery hqlQuery,
                                  java.lang.StringBuilder hql,
                                  java.lang.String stemColumn,
                                  java.util.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). Note, this joins to tables, so the queries should probably be "distinct"

Parameters:

subject - which needs view access to the groups

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

hqlQuery -

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

postHqlFilterStems

java.util.Set<Stem> postHqlFilterStems(java.util.Set<Stem> stems,
                                       edu.internet2.middleware.subject.Subject subject,
                                       java.util.Set<Privilege> privInSet)

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

Parameters:

stems -

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

revokeAllPrivilegesForSubject

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

Revoke all naming privileges that this subject has.

Parameters:

subject -

hqlFilterStemsNotWithPrivWhereClause

boolean hqlFilterStemsNotWithPrivWhereClause(edu.internet2.middleware.subject.Subject subject,
                                             HqlQuery hqlQuery,
                                             java.lang.StringBuilder hql,
                                             java.lang.String stemColumn,
                                             Privilege privilege,
                                             boolean considerAllSubject)

for a stem query, check to make sure the subject cant see the records

Parameters:

subject - which needs view access to the groups

hqlQuery -

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