edu.internet2.middleware.grouper.privs
Class Privilege

java.lang.Object
  edu.internet2.middleware.grouper.privs.Privilege

All Implemented Interfaces:

java.io.Serializable

public class Privilege
extends java.lang.Object
implements java.io.Serializable

Privilege schema specification. Access the constants for Groups from AccessPrivilege and Stems from NamingPrivilege.

Version:

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

Author:

blair christensen.

See Also:

Serialized Form

Field Summary

static long

serialVersionUID constant

Method Summary

static java.util.Set<Privilege>	convertFieldsToPrivileges(java.util.Collection<Field> fields) convert a list to a privilege for any type of privilege
static java.util.Set<Privilege>	convertNamesToPrivileges(java.util.Collection<java.lang.String> privilegeNames) convert a list of privilege names or field names to a privilege for any type of privilege
static java.util.Collection<Field>	convertPrivilegesToFields(java.util.Collection<Privilege> privileges) convert a collection of privileges to a collection of fields
boolean	equals(java.lang.Object obj) string equals
static java.util.Set<Privilege>	getAccessPrivs()
static java.util.Set<Privilege>	getAttributeDefPrivs() get attribute def privs
Field	getField() return the list name
java.util.Collection<Privilege>	getImpliedPrivileges() get the privilege that this privilege implied (including this privilege for instance if the privilege is UPDATE, then return UPDATE and ADMIN
java.util.Collection<Privilege>	getInheritedPrivileges() get the inherited privileges for this privilege (including this privilege for instance if the privilege is UPDATE, then return UPDATE and ADMIN
static Privilege	getInstance(java.lang.String name)
static Privilege	getInstance(java.lang.String name, boolean exceptionIfNotFound)
static java.util.Set<Privilege>	getInstances(java.lang.String namesCommaSeparated)
java.lang.String	getListName() return the list name
java.lang.String	getName()
static java.util.Set<Privilege>	getNamingPrivs() get stem (naming) privs
int	hashCode() generate hash code
boolean	isAccess() see if privilege involves group
static boolean	isAccess(Privilege p)
boolean	isAttributeDef() see if privilege involves attribute def
static boolean	isAttributeDef(Privilege p)
boolean	isNaming() see if privilege involves stem
static boolean	isNaming(Privilege p)
static Privilege	listToPriv(java.lang.String list, boolean exceptionOnNotFound) convert a list to a privilege for any type of privilege
static java.lang.String	stringValue(java.util.Set<Privilege> privileges) convert privileges to string comma separated
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

constant

See Also:

Constant Field Values

Method Detail

isAccess

public boolean isAccess()

see if privilege involves group

Returns:

if involves groups

isNaming

public boolean isNaming()

see if privilege involves stem

Returns:

if involves stems

isAttributeDef

public boolean isAttributeDef()

see if privilege involves attribute def

Returns:

if involves attribute def

listToPriv

public static Privilege listToPriv(java.lang.String list,
                                   boolean exceptionOnNotFound)

convert a list to a privilege for any type of privilege

Parameters:

list -

Returns:

the privilege

convertFieldsToPrivileges

public static java.util.Set<Privilege> convertFieldsToPrivileges(java.util.Collection<Field> fields)

convert a list to a privilege for any type of privilege

Parameters:

fields -

Returns:

the privilege

convertNamesToPrivileges

public static java.util.Set<Privilege> convertNamesToPrivileges(java.util.Collection<java.lang.String> privilegeNames)

convert a list of privilege names or field names to a privilege for any type of privilege

Parameters:

privilegeNames -

Returns:

the privilege

convertPrivilegesToFields

public static java.util.Collection<Field> convertPrivilegesToFields(java.util.Collection<Privilege> privileges)

convert a collection of privileges to a collection of fields

Parameters:

privileges -

Returns:

the fields

hashCode

public int hashCode()

generate hash code

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

string equals

Overrides:

equals in class java.lang.Object

Returns:

if equal

getInheritedPrivileges

public java.util.Collection<Privilege> getInheritedPrivileges()

get the inherited privileges for this privilege (including this privilege for instance if the privilege is UPDATE, then return UPDATE and ADMIN

Returns:

the inherited privileges

getImpliedPrivileges

public java.util.Collection<Privilege> getImpliedPrivileges()

get the privilege that this privilege implied (including this privilege for instance if the privilege is UPDATE, then return UPDATE and ADMIN

Returns:

the inherited privileges

getListName

public java.lang.String getListName()

return the list name

Returns:

the list name

getField

public Field getField()
               throws SchemaException

return the list name

Returns:

the list name

Throws:

SchemaException

getAccessPrivs

public static java.util.Set<Privilege> getAccessPrivs()

Returns:

access (group) privs

getInstances

public static java.util.Set<Privilege> getInstances(java.lang.String namesCommaSeparated)

Parameters:

namesCommaSeparated -

Returns:

the privileges

stringValue

public static java.lang.String stringValue(java.util.Set<Privilege> privileges)

convert privileges to string comma separated

Parameters:

privileges -

Returns:

the privileges

getInstance

public static Privilege getInstance(java.lang.String name)

Parameters:

name -

Returns:

priv

getInstance

public static Privilege getInstance(java.lang.String name,
                                    boolean exceptionIfNotFound)

Parameters:

name -

exceptionIfNotFound -

Returns:

priv

getNamingPrivs

public static java.util.Set<Privilege> getNamingPrivs()

get stem (naming) privs

Returns:

set

getAttributeDefPrivs

public static java.util.Set<Privilege> getAttributeDefPrivs()

get attribute def privs

Returns:

attr def privs

isAccess

public static boolean isAccess(Privilege p)

Parameters:

p -

Returns:

if access

isNaming

public static boolean isNaming(Privilege p)

Parameters:

p -

Returns:

if naming (stem)

isAttributeDef

public static boolean isAttributeDef(Privilege p)

Parameters:

p -

Returns:

if attribute def

getName

public java.lang.String getName()

Returns:

name

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()