Class NamingWrapper
java.lang.Object
edu.internet2.middleware.grouper.privs.NamingWrapper
- All Implemented Interfaces:
NamingResolver
Class implementing wrapper around
NamingAdapter
interface.
- Since:
- 1.2.1
- Version:
- $Id: NamingWrapper.java,v 1.18 2009-10-03 13:47:13 shilen Exp $
-
Constructor Summary
ConstructorDescriptionNamingWrapper
(GrouperSession session, NamingAdapter naming) Facade aroundNamingAdapter
that implementsNamingResolver
. -
Method Summary
Modifier and TypeMethodDescriptionvoid
flush cache if caching resolverget a reference to the sessiongetPrivileges
(Stem stem, Subject subject) Get all privileges subject has on group.getStemsWhereSubjectDoesHavePrivilege
(String stemId, Stem.Scope scope, Subject subject, Privilege privilege, boolean considerAllSubject, String sqlLikeString) find the stems which do have a certain privilegegetStemsWhereSubjectDoesntHavePrivilege
(String stemId, Stem.Scope scope, Subject subject, Privilege privilege, boolean considerAllSubject, String sqlLikeString) find the stems which do not have a certain privilegegetStemsWhereSubjectHasPrivilege
(Subject subject, Privilege privilege) Get all groups where subject has privilege.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 privsboolean
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 privsafter 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
-
Constructor Details
-
NamingWrapper
Facade aroundNamingAdapter
that implementsNamingResolver
.- Parameters:
session
-naming
-- Throws:
IllegalArgumentException
- if any parameter is null.- Since:
- 1.2.1
-
-
Method Details
-
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 interfaceNamingResolver
- Returns:
- the stems
- See Also:
-
flushCache
public void flushCache()Description copied from interface:NamingResolver
flush cache if caching resolver- Specified by:
flushCache
in interfaceNamingResolver
- See Also:
-
getGrouperSession
Description copied from interface:NamingResolver
get a reference to the session- Specified by:
getGrouperSession
in interfaceNamingResolver
- Returns:
- the session
- See Also:
-
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 interfaceNamingResolver
- Returns:
- set
- Throws:
IllegalArgumentException
- if any parameter is null.- Since:
- 1.2.1
- See Also:
-
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 interfaceNamingResolver
- Returns:
- set of naming privileges
- Throws:
IllegalArgumentException
- if any parameter is null.- Since:
- 1.2.1
- See Also:
-
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 interfaceNamingResolver
- Returns:
- set of subjects
- Throws:
IllegalArgumentException
- if any parameter is null.- Since:
- 1.2.1
- See Also:
-
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 interfaceNamingResolver
uuid
- if known or null- Throws:
IllegalArgumentException
- if any parameter is null.UnableToPerformException
- if the privilege could not be granted.- Since:
- 1.2.1
- See Also:
-
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 interfaceNamingResolver
- Returns:
- if has privilege
- Throws:
IllegalArgumentException
- if any parameter is null.- Since:
- 1.2.1
- See Also:
-
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 interfaceNamingResolver
- Throws:
IllegalArgumentException
- if any parameter is null.UnableToPerformException
- if the privilege could not be revoked.- Since:
- 1.2.1
- See Also:
-
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 interfaceNamingResolver
- Throws:
IllegalArgumentException
- if any parameter is null.UnableToPerformException
- if the privilege could not be revoked.- Since:
- 1.2.1
- See Also:
-
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 interfaceNamingResolver
- Throws:
IllegalArgumentException
UnableToPerformException
- See Also:
-
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. -
stop
public void stop()Description copied from interface:NamingResolver
clean up resources, session is stopped- Specified by:
stop
in interfaceNamingResolver
- See Also:
-
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 interfaceNamingResolver
- Parameters:
subject
- which needs view access to the groupshql
- is the select and part part (hql prefix)stemColumn
- is the name of the stem column to join toprivInSet
- 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:
-
postHqlFilterStems
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 interfaceNamingResolver
subject
- which needs view access to the groupsprivInSet
- 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:
-
revokeAllPrivilegesForSubject
Description copied from interface:NamingResolver
Revoke all naming privileges that this subject has.- Specified by:
revokeAllPrivilegesForSubject
in interfaceNamingResolver
- See Also:
-
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 interfaceNamingResolver
- Parameters:
subject
- which needs view access to the groupshql
- the select and current from partstemColumn
- is the name of the group column to join toprivilege
- 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:
-
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 interfaceNamingResolver
- Returns:
- the stems
- See Also:
-
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 interfaceNamingResolver
- Parameters:
subject
- which needs view access to the groupshql
- the select and current from partstemColumn
- is the name of the group column to join toprivilege
- 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:
-