org.mmbase.security.implementation.cloudcontext.builders
Class Contexts

java.lang.Object
  org.mmbase.util.functions.FunctionProvider
      org.mmbase.module.core.MMTable
          org.mmbase.module.core.MMObjectBuilder
              org.mmbase.security.implementation.cloudcontext.builders.Contexts

All Implemented Interfaces:

EventListener, NodeEventListener, RelationEventListener

Direct Known Subclasses:

PeopleContexts

public class Contexts

extends MMObjectBuilder

Representation of a 'context', which can be read as a valid value of the 'owner' field of any object in MMBase. Rights are distributed using this thing. This is part of cloud context security, so the 'context' values need to be present in the cloud.

Version:

$Id: Contexts.java,v 1.47 2006/07/06 11:51:33 michiel Exp $

Author:

Eduard Witteveen, Pierre van Rooden, Michiel Meeuwissen

See Also:

Verify, Authorization

Nested Class Summary

protected static class

Contexts.OperationsCache

Field Summary

protected static Cache	allowingContextsCache
static Parameter[]	ALLOWS_PARAMETERS
protected static Cache	contextCache
static Parameter[]	GRANT_PARAMETERS
protected static Map	invalidableObjects
static Parameter[]	MAY_PARAMETERS
static Parameter[]	MAYGRANT_PARAMETERS
static Parameter[]	MAYREVOKE_PARAMETERS
protected static Contexts.OperationsCache	operationsCache
static Parameter	PARAMETER_GROUPORUSER
static Parameter	PARAMETER_OPERATION
static Parameter[]	PARENTSALLOW_PARAMETERS
static Parameter[]	REVOKE_PARAMETERS

Fields inherited from class org.mmbase.module.core.MMObjectBuilder

AGE_PARAMETERS, broadCastChanges, DEFAULT_ALINEA, DEFAULT_EOL, description, descriptions, EVENT_TYPE_LOCAL, EVENT_TYPE_REMOTE, FIELD_NUMBER, FIELD_OBJECT_TYPE, FIELD_OWNER, fields, genericBlobCache, getFunctions, GUI_PARAMETERS, guiFunction, infoFunction, internalVersion, nodeCache, oType, searchAge, SYSTEM_OWNER, TEMPNODE_DEFAULT_SIZE, temporaryNodes, TMP_FIELD_NUMBER, virtual, WRAP_PARAMETERS, wrapFunction

Fields inherited from class org.mmbase.module.core.MMTable

maxNodesFromQuery, mmb, storageConnector, tableName

Fields inherited from class org.mmbase.util.functions.FunctionProvider

functions

Constructor Summary

Contexts()

Method Summary

protected boolean	allows(MMObjectNode contextNode, MMObjectNode groupOrUserNode, Operation operation) Wether users of the given group may do operation on a node of given context (so no following)
Authorization.QueryCheck	check(User userContext, Query query, Operation operation) Implements check function with same arguments of Authorisation security implementation
protected Object	executeFunction(MMObjectNode node, String function, List args) Executes a function on the field of a node, and returns the result.
protected SortedSet	getAllContexts() Returns a Set (of Strings) of all existing contexts
protected SortedSet	getAllowingContexts(User user, Operation operation)
static Contexts	getBuilder() Staticly receives the MMObjectBuilder instance (casted to Contexts).
String	getContext(User user, int nodeId) Returns this Context node as a String (so the name field)
protected MMObjectNode	getContextNode(String context)
protected SortedSet	getDisallowingContexts(User user, Operation operation) Returns a Set (of Strings) of all existing contexts for which the given operation is not allowed for the given user.
protected MMObjectNode	getGroupOrUserNode(Parameters a)
protected Set	getGroupsAndUsers(MMObjectNode contextNode, Operation operation)
protected Collection	getGroupsOrUsers(MMObjectNode contextNode, Operation operation, MMObjectBuilder groupsOrUsers)
SortedSet	getPossibleContexts(User user, int nodeId) Wraps getPossibleContexts of Authorisation implementation Verify.
protected MMObjectNode	getUserNode(UserContext user) util
protected boolean	grant(MMObjectNode contextNode, MMObjectNode groupOrUserNode, Operation operation, MMObjectNode user)
boolean	init() Initializes this builder The property 'mmb' needs to be set for the builder before this method can be called.
protected boolean	isOwnNode(User user, MMObjectNode node) Returns wether the given node is an 'own' node.
protected boolean	mayDo(MMObjectNode user, MMObjectNode contextNode, Operation operation, boolean checkOwnRights)
boolean	mayDo(User user, int nodeId, int sourceNodeId, int destinationNodeId, Operation operation) Implements check function with same arguments of Authorisation security implementation.
boolean	mayDo(User user, int nodeId, Operation operation) Implements check function with same arguments of Authorisation security implementation
protected boolean	mayDo(User user, MMObjectNode contextNode, Operation operation) Returns wether user may do operation on a node with given context.
protected boolean	mayGrant(MMObjectNode contextNode, MMObjectNode groupOrUserNode, Operation operation, MMObjectNode user)
protected boolean	mayRevoke(MMObjectNode contextNode, MMObjectNode groupOrUserNode, Operation operation, MMObjectNode user)
protected boolean	parentsAllow(MMObjectNode contextNode, MMObjectNode groupOrUserNode, Operation operation) Wether users of the given group may do operation on a node of given context, because (one of) the parents of this group allow it.
protected boolean	revoke(MMObjectNode contextNode, MMObjectNode groupOrUserNode, Operation operation, MMObjectNode user)
MMObjectNode	setContext(User user, int nodeId, String context) Sets the context of a node to a certain String Value
void	setDefaults(MMObjectNode node) Makes sure unique values and not-null's are filed
String	toString(MMObjectNode n) Implements for MMObjectNode

Methods inherited from class org.mmbase.module.core.MMObjectBuilder

addEventListener, addField, addLocalObserver, addRemoteObserver, broadcastChanges, checkAddTmpField, clearBlobCache, commit, create, createAlias, createAlias, delete, equals, equals, executeFunction, fieldLocalChanged, getAncestors, getBlobCache, getClassName, getConfigFile, getConfigResource, getDataTypeCollector, getDBKey, getDBState, getDBType, getDefaultTeaser, getDefaultUrl, getDescendants, getDescription, getDescription, getDescriptions, getEditFields, getEmptyNode, getField, getFieldNames, getFields, getFields, getFunction, getFunctionParameters, getFunctions, getGUIIndicator, getGUIIndicator, getGUIIndicator, getHardNode, getHardNode, getHTML, getInitParameter, getInitParameters, getInternalVersion, getList, getLocaleGUIIndicator, getLocaleGUIIndicator, getMachineName, getMaintainer, getNewNode, getNewTmpNode, getNextField, getNextField, getNode, getNode, getNode, getNodeFromCache, getNodeGUIIndicator, getNumber, getObjectType, getObjectValue, getParentBuilder, getPluralName, getPluralName, getPluralNames, getRelations_main, getSearchAge, getShort, getShortedByte, getShortedText, getSingularName, getSingularName, getSingularNames, getSmartPath, getSortedFields, getSortedListFields, getTmpNode, getURLEncode, getValue, getVersion, getWAP, getXMLPath, hasField, hashCode, hashCode, hostname_function, insert, insert, isExtensionOf, isNodeCached, isVirtual, newFunctionInstance, nodeLocalChanged, nodeRemoteChanged, notify, notify, preCommit, process, putTmpNode, removeEventListener, removeField, removeLocalObserver, removeNode, removeRelations, removeRemoteObserver, removeSyncNodes, removeTmpNode, replace, safeCache, sendFieldChangeSignal, setDescription, setDescriptions, setFields, setInitParameter, setMaintainer, setParentBuilder, setPluralNames, setSearchAge, setSingularNames, setUniqueValue, setUniqueValue, setValue, setValue, setVersion, setXMLPath, testValidData, toString, update, updateFields, wrap

Methods inherited from class org.mmbase.module.core.MMTable

count, count, created, getFullTableName, getMMBase, getNode, getNodes, getNodes, getNodes, getNodeType, getStorageConnector, getTableName, search, searchVector, setMMBase, setTableName, size

Methods inherited from class org.mmbase.util.functions.FunctionProvider

addFunction, createParameters, getFunction, getFunctions, getFunctionValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PARAMETER_OPERATION

public static final Parameter PARAMETER_OPERATION

PARAMETER_GROUPORUSER

public static final Parameter PARAMETER_GROUPORUSER

ALLOWS_PARAMETERS

public static final Parameter[] ALLOWS_PARAMETERS

PARENTSALLOW_PARAMETERS

public static final Parameter[] PARENTSALLOW_PARAMETERS

GRANT_PARAMETERS

public static final Parameter[] GRANT_PARAMETERS

REVOKE_PARAMETERS

public static final Parameter[] REVOKE_PARAMETERS

MAYGRANT_PARAMETERS

public static final Parameter[] MAYGRANT_PARAMETERS

MAYREVOKE_PARAMETERS

public static final Parameter[] MAYREVOKE_PARAMETERS

MAY_PARAMETERS

public static final Parameter[] MAY_PARAMETERS

contextCache

protected static Cache contextCache

allowingContextsCache

protected static Cache allowingContextsCache

operationsCache

protected static Contexts.OperationsCache operationsCache

invalidableObjects

protected static Map invalidableObjects

Constructor Detail

Contexts

public Contexts()

Method Detail

init

public boolean init()

Description copied from class: MMObjectBuilder

Initializes this builder The property 'mmb' needs to be set for the builder before this method can be called. The method retrieves data from the TypeDef builder, or adds data to that builder if the current builder is not yet registered.

Overrides:

init in class MMObjectBuilder

Returns:

true if init was completed, false if uncompleted.

See Also:

MMObjectBuilder.create()

Warning: No Java Documentation Available.

getBuilder

public static Contexts getBuilder()

Staticly receives the MMObjectBuilder instance (casted to Contexts). A utility function.

mayDo

public boolean mayDo(User user,
                     int nodeId,
                     int sourceNodeId,
                     int destinationNodeId,
                     Operation operation)
              throws SecurityException

Implements check function with same arguments of Authorisation security implementation.

Throws:

SecurityException

See Also:

Verify.check(UserContext, int, int, int, Operation)

mayDo

public boolean mayDo(User user,
                     int nodeId,
                     Operation operation)
              throws SecurityException

Implements check function with same arguments of Authorisation security implementation

Throws:

SecurityException

See Also:

Verify.check(UserContext, int, Operation)

isOwnNode

protected boolean isOwnNode(User user,
                            MMObjectNode node)

Returns wether the given node is an 'own' node. It should return true if the node is representing the mmbaseusers object which represents the current user. Extensions could e.g. also implement returning true for the associated people node.

mayDo

protected boolean mayDo(User user,
                        MMObjectNode contextNode,
                        Operation operation)

Returns wether user may do operation on a node with given context.

mayDo

protected boolean mayDo(MMObjectNode user,
                        MMObjectNode contextNode,
                        Operation operation,
                        boolean checkOwnRights)

getAllContexts

protected SortedSet getAllContexts()

Returns a Set (of Strings) of all existing contexts

getDisallowingContexts

protected SortedSet getDisallowingContexts(User user,
                                           Operation operation)

Returns a Set (of Strings) of all existing contexts for which the given operation is not allowed for the given user.

getAllowingContexts

protected SortedSet getAllowingContexts(User user,
                                        Operation operation)

check

public Authorization.QueryCheck check(User userContext,
                                      Query query,
                                      Operation operation)

Implements check function with same arguments of Authorisation security implementation

See Also:

Verify.check(UserContext, Query, Operation)

getGroupsOrUsers

protected Collection getGroupsOrUsers(MMObjectNode contextNode,
                                      Operation operation,
                                      MMObjectBuilder groupsOrUsers)

Returns:

A Collection of groups or users which are allowed for the given operation (not recursively)

getGroupsAndUsers

protected Set getGroupsAndUsers(MMObjectNode contextNode,
                                Operation operation)

Returns:

a Set of all groups and users which are allowed for the given operation (not recursively).

getContextNode

protected final MMObjectNode getContextNode(String context)

getContext

public String getContext(User user,
                         int nodeId)
                  throws SecurityException

Returns this Context node as a String (so the name field)

Throws:

SecurityException

setContext

public MMObjectNode setContext(User user,
                               int nodeId,
                               String context)
                        throws SecurityException

Sets the context of a node to a certain String Value

Parameters:

user - The user doing this.

nodeId - The number of the node which' context must be changed

context - The String describing the desired new context

Returns:

The MMObjectNode

Throws:

SecurityException

getPossibleContexts

public SortedSet getPossibleContexts(User user,
                                     int nodeId)
                              throws SecurityException

Wraps getPossibleContexts of Authorisation implementation Verify.

Throws:

SecurityException

See Also:

Verify.getPossibleContexts(org.mmbase.security.UserContext, int)

To Do:

Perhaps we need a possibleContextCache.

allows

protected boolean allows(MMObjectNode contextNode,
                         MMObjectNode groupOrUserNode,
                         Operation operation)

Wether users of the given group may do operation on a node of given context (so no following)

Returns:

boolean

parentsAllow

protected boolean parentsAllow(MMObjectNode contextNode,
                               MMObjectNode groupOrUserNode,
                               Operation operation)

Wether users of the given group may do operation on a node of given context, because (one of) the parents of this group allow it.

Returns:

boolean

mayGrant

protected boolean mayGrant(MMObjectNode contextNode,
                           MMObjectNode groupOrUserNode,
                           Operation operation,
                           MMObjectNode user)

grant

protected boolean grant(MMObjectNode contextNode,
                        MMObjectNode groupOrUserNode,
                        Operation operation,
                        MMObjectNode user)

setDefaults

public void setDefaults(MMObjectNode node)

Makes sure unique values and not-null's are filed

Overrides:

setDefaults in class MMObjectBuilder

Parameters:

node - The node to set the defaults of.

mayRevoke

protected boolean mayRevoke(MMObjectNode contextNode,
                            MMObjectNode groupOrUserNode,
                            Operation operation,
                            MMObjectNode user)

To Do:

untested

revoke

protected boolean revoke(MMObjectNode contextNode,
                         MMObjectNode groupOrUserNode,
                         Operation operation,
                         MMObjectNode user)

getUserNode

protected MMObjectNode getUserNode(UserContext user)

util

getGroupOrUserNode

protected MMObjectNode getGroupOrUserNode(Parameters a)

executeFunction

protected Object executeFunction(MMObjectNode node,
                                 String function,
                                 List args)

Description copied from class: MMObjectBuilder

Executes a function on the field of a node, and returns the result. This method is called by the builder's MMObjectBuilder.getValue(org.mmbase.module.core.MMObjectNode, java.lang.String) method. Derived builders should override this method to provide additional functions.

Overrides:

executeFunction in class MMObjectBuilder

See Also:

MMObjectBuilder.executeFunction(org.mmbase.module.core.MMObjectNode, java.lang.String, java.util.List)

toString

public String toString(MMObjectNode n)

Description copied from class: MMObjectBuilder

Implements for MMObjectNode

Overrides:

toString in class MMObjectBuilder