edu.internet2.middleware.grouper.privs

Class GrouperNonDbNamingAdapter

java.lang.Object

edu.internet2.middleware.grouper.privs.BaseNamingAdapter

edu.internet2.middleware.grouper.privs.GrouperNonDbNamingAdapter

All Implemented Interfaces:

NamingAdapter

Direct Known Subclasses:

GrouperNamingAdapter

public class GrouperNonDbNamingAdapter
extends BaseNamingAdapter

Field Summary

Fields

Modifier and Type	Field and Description
protected static Map<Privilege,String>	priv2list

Constructor Summary

Constructors

Constructor and Description
GrouperNonDbNamingAdapter()

Method Summary

Modifier and Type	Method and Description
Set<NamingPrivilege>	getPrivs(GrouperSession s, Stem ns, Subject subj) Get all privileges held by this subject on this stem.
Set<Stem>	getStemsWhereSubjectDoesHavePrivilege(GrouperSession grouperSession, String stemId, Stem.Scope scope, Subject subject, Privilege privilege, boolean considerAllSubject, String sqlLikeString) Get all stems where this subject does have this privilege.
Set<Stem>	getStemsWhereSubjectDoesntHavePrivilege(GrouperSession grouperSession, String stemId, Stem.Scope scope, Subject subject, Privilege privilege, boolean considerAllSubject, String sqlLikeString) Get all stems where this subject doesnt have this privilege.
Set	getStemsWhereSubjectHasPriv(GrouperSession s, Subject subj, Privilege priv) Get all stems where this subject has this privilege.
Set	getSubjectsWithPriv(GrouperSession s, Stem ns, Privilege priv) Get all subjects with this privilege on this stem.
void	grantPriv(GrouperSession s, Stem ns, Subject subj, Privilege priv, String uuid) Grant the privilege to the subject on this stem.
boolean	hasPriv(GrouperSession s, Stem ns, Subject subj, Privilege priv) Check whether the subject has this privilege on this stem.
void	privilegeCopy(GrouperSession s, Stem stem1, Stem stem2, Privilege priv) Copies privileges for subjects that have the specified privilege on stem1 to stem2.
void	privilegeCopy(GrouperSession s, 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(GrouperSession grouperSession, Subject subject) Revoke all naming privileges that this subject has.
void	revokePriv(GrouperSession s, Stem ns, Privilege priv) Revoke this privilege from everyone on this stem.
void	revokePriv(GrouperSession s, Stem ns, Subject subj, Privilege priv) Revoke the privilege from the subject on this stem.

Methods inherited from class edu.internet2.middleware.grouper.privs.BaseNamingAdapter

hqlFilterStemsNotWithPrivWhereClause, hqlFilterStemsWhereClause, hqlFilterStemsWithPrivWhereClause, postHqlFilterStems

Methods inherited from class java.lang.Object

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

Field Detail

priv2list

protected static Map<Privilege,String> priv2list

Constructor Detail

GrouperNonDbNamingAdapter

public GrouperNonDbNamingAdapter()

Method Detail

getStemsWhereSubjectDoesntHavePrivilege

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

Get all stems where this subject doesnt have this privilege.

Parameters:

grouperSession -

stemId -

scope -

subject -

privilege -

considerAllSubject -

sqlLikeString -

Returns:

stems

getSubjectsWithPriv

public Set getSubjectsWithPriv(GrouperSession s,
                               Stem ns,
                               Privilege priv)
                        throws SchemaException

Description copied from interface: NamingAdapter

Get all subjects with this privilege on this stem.

 Set stemmers = np.getSubjectsWithPriv(s, ns, NamingPrivilege.STEM_ADMIN);
 

Parameters:

s - Get privileges within this session context.

ns - Get privileges on this stem.

priv - Get this privilege.

Returns:

Set of Subject objects.

Throws:

SchemaException

See Also:

NamingAdapter.getSubjectsWithPriv(edu.internet2.middleware.grouper.GrouperSession, edu.internet2.middleware.grouper.Stem, edu.internet2.middleware.grouper.privs.Privilege)

getStemsWhereSubjectHasPriv

public Set getStemsWhereSubjectHasPriv(GrouperSession s,
                                       Subject subj,
                                       Privilege priv)
                                throws SchemaException

Get all stems where this subject has this privilege.

 try {
   Set isStemAdmin = np.getStemsWhereSubjectHasPriv(
     s, subj, NamingPrivilege.STEM_ADMIN
   );
 }
 catch (SchemaException e0) {
   // Invalid priv
 }
 

Parameters:

s - Get privileges within this session context.

subj - Get privileges for this subject.

priv - Get this privilege.

Returns:

Set of Stem objects.

Throws:

SchemaException

getPrivs

public Set<NamingPrivilege> getPrivs(GrouperSession s,
                                     Stem ns,
                                     Subject subj)

Get all privileges held by this subject on this stem.

 Set privs = np.getPrivs(s, ns, subj);
 

Parameters:

s - Get privileges within this session context.

ns - Get privileges on this stem.

subj - Get privileges for this subject.

Returns:

Set of NamingPrivilege objects.

grantPriv

public void grantPriv(GrouperSession s,
                      Stem ns,
                      Subject subj,
                      Privilege priv,
                      String uuid)
               throws GrantPrivilegeException,
                      InsufficientPrivilegeException,
                      SchemaException

Description copied from interface: NamingAdapter

Grant the privilege to the subject on this stem.

 try {
   np.grantPriv(s, ns, subj, NamingPrivilege.STEM_ADMIN);
 }
 catch (GrantPrivilegeException e0) {
   // Unable to grant the privilege
 }
 catch (InsufficientPrivilegeException e1) {
   // Not privileged to grant the privilege
 }
 

Parameters:

s - Grant privilege in this session context.

ns - Grant privilege on this stem.

subj - Grant privilege to this subject.

priv - Grant this privilege.

uuid - is uuid if known or null if assign one

Throws:

GrantPrivilegeException

InsufficientPrivilegeException

SchemaException

See Also:

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

hasPriv

public boolean hasPriv(GrouperSession s,
                       Stem ns,
                       Subject subj,
                       Privilege priv)
                throws SchemaException

Check whether the subject has this privilege on this stem.

 try {
   np.hasPriv(s, ns, subj, NamingPrivilege.STEM_ADMIN);
 }
 catch (SchemaException e) {
   // Invalid privilege
 }
 

Parameters:

s - Check privilege in this session context.

ns - Check privilege on this stem.

subj - Check privilege for this subject.

priv - Check this privilege.

Returns:

if has priv

Throws:

SchemaException

privilegeCopy

public void privilegeCopy(GrouperSession s,
                          Stem stem1,
                          Stem stem2,
                          Privilege priv)
                   throws InsufficientPrivilegeException,
                          GrantPrivilegeException,
                          SchemaException

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

Parameters:

s -

stem1 -

stem2 -

priv -

Throws:

InsufficientPrivilegeException

GrantPrivilegeException

SchemaException

privilegeCopy

public void privilegeCopy(GrouperSession s,
                          Subject subj1,
                          Subject subj2,
                          Privilege priv)
                   throws InsufficientPrivilegeException,
                          GrantPrivilegeException,
                          SchemaException

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:

s -

subj1 -

subj2 -

priv -

Throws:

InsufficientPrivilegeException

GrantPrivilegeException

SchemaException

revokePriv

public void revokePriv(GrouperSession s,
                       Stem ns,
                       Privilege priv)
                throws InsufficientPrivilegeException,
                       RevokePrivilegeException,
                       SchemaException

Revoke this privilege from everyone on this stem.

 try {
   np.revokePriv(s, ns, NamingPrivilege.STEM_ADMIN);
 }
 catch (InsufficientPrivilegeException eIP) {
   // Not privileged to revoke the privilege
 }
 catch (RevokePrivilegeException eRP) {
   // Unable to revoke the privilege
 }
 

Parameters:

s - Revoke privilege in this session context.

ns - Revoke privilege on this stem.

priv - Revoke this privilege.

Throws:

InsufficientPrivilegeException

RevokePrivilegeException

SchemaException

revokePriv

public void revokePriv(GrouperSession s,
                       Stem ns,
                       Subject subj,
                       Privilege priv)
                throws InsufficientPrivilegeException,
                       RevokePrivilegeException,
                       SchemaException

Revoke the privilege from the subject on this stem.

 try {
   np.revokePriv(s, ns, subj, NamingPrivilege.STEM_ADMIN);
 }
 catch (InsufficientPrivilegeException e0) {
   // Not privileged to grant the privilege
 }
 catch (RevokePrivilegeException e2) {
   // Unable to revoke the privilege
 }
 

Parameters:

s - Revoke privilege in this session context.

ns - Revoke privilege on this stem.

subj - Revoke privilege from this subject.

priv - Revoke this privilege.

Throws:

InsufficientPrivilegeException

RevokePrivilegeException

SchemaException

revokeAllPrivilegesForSubject

public void revokeAllPrivilegesForSubject(GrouperSession grouperSession,
                                          Subject subject)

Description copied from interface: NamingAdapter

Revoke all naming privileges that this subject has.

See Also:

NamingAdapter.revokeAllPrivilegesForSubject(edu.internet2.middleware.grouper.GrouperSession, edu.internet2.middleware.subject.Subject)

getStemsWhereSubjectDoesHavePrivilege

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

Get all stems where this subject does have this privilege.

Parameters:

grouperSession -

stemId -

scope -

subject -

privilege -

considerAllSubject -

sqlLikeString -

Returns:

stems