de.deepamehta.accesscontrol

Class AccessControlPlugin

java.lang.Object

de.deepamehta.core.osgi.PluginActivator

de.deepamehta.accesscontrol.AccessControlPlugin

All Implemented Interfaces:

AccessControlService, de.deepamehta.config.ConfigCustomizer, de.deepamehta.core.osgi.PluginContext, de.deepamehta.core.service.event.CheckAssociationReadAccessListener, de.deepamehta.core.service.event.CheckAssociationWriteAccessListener, de.deepamehta.core.service.event.CheckTopicReadAccessListener, de.deepamehta.core.service.event.CheckTopicWriteAccessListener, de.deepamehta.core.service.event.PostCreateAssociationListener, de.deepamehta.core.service.event.PostCreateTopicListener, de.deepamehta.core.service.event.PostUpdateAssociationListener, de.deepamehta.core.service.event.PostUpdateTopicListener, de.deepamehta.core.service.event.PreCreateTopicListener, de.deepamehta.core.service.event.PreUpdateTopicListener, de.deepamehta.core.service.event.ServiceRequestFilterListener, de.deepamehta.core.service.event.StaticResourceFilterListener, de.deepamehta.core.service.EventListener, de.deepamehta.files.event.CheckDiskQuotaListener, org.osgi.framework.BundleActivator

public class AccessControlPlugin
extends de.deepamehta.core.osgi.PluginActivator
implements AccessControlService, de.deepamehta.config.ConfigCustomizer, de.deepamehta.core.service.event.CheckTopicReadAccessListener, de.deepamehta.core.service.event.CheckTopicWriteAccessListener, de.deepamehta.core.service.event.CheckAssociationReadAccessListener, de.deepamehta.core.service.event.CheckAssociationWriteAccessListener, de.deepamehta.core.service.event.PreCreateTopicListener, de.deepamehta.core.service.event.PreUpdateTopicListener, de.deepamehta.core.service.event.PostCreateTopicListener, de.deepamehta.core.service.event.PostCreateAssociationListener, de.deepamehta.core.service.event.PostUpdateTopicListener, de.deepamehta.core.service.event.PostUpdateAssociationListener, de.deepamehta.core.service.event.ServiceRequestFilterListener, de.deepamehta.core.service.event.StaticResourceFilterListener, de.deepamehta.files.event.CheckDiskQuotaListener

Field Summary

Fields inherited from class de.deepamehta.core.osgi.PluginActivator

bundle, dm4, mf

Fields inherited from interface de.deepamehta.accesscontrol.AccessControlService

ADMIN_INITIAL_PASSWORD, ADMIN_USERNAME, ADMINISTRATION_WORKSPACE_NAME, ADMINISTRATION_WORKSPACE_SHARING_MODE, ADMINISTRATION_WORKSPACE_URI, DEFAULT_PRIVATE_WORKSPACE_NAME, SYSTEM_WORKSPACE_NAME, SYSTEM_WORKSPACE_SHARING_MODE, SYSTEM_WORKSPACE_URI

Constructor Summary

Constructors

Constructor and Description
AccessControlPlugin()

Method Summary

Modifier and Type	Method and Description
void	checkAssociationReadAccess(long assocId)
void	checkAssociationWriteAccess(long assocId)
void	checkDiskQuota(String username, long fileSize, long diskQuota)
void	checkTopicReadAccess(long topicId)
void	checkTopicWriteAccess(long topicId)
void	createMembership(String username, long workspaceId)
de.deepamehta.core.Topic	createUserAccount(de.deepamehta.core.service.accesscontrol.Credentials cred)
de.deepamehta.core.Topic	createUsername(String username) Creates a Username topic and a private workspace.
de.deepamehta.core.service.accesscontrol.Permissions	getAssociationPermissions(long assocId)
Collection<de.deepamehta.core.Association>	getAssociationsByCreator(String username)
Collection<de.deepamehta.core.Association>	getAssociationsByOwner(String username)
Set<String>	getAuthorizationMethods()
de.deepamehta.core.model.TopicModel	getConfigValue(de.deepamehta.core.Topic topic)
String	getCreator(long objectId) Returns the creator of a topic or an association.
String	getModifier(long objectId) Returns the modifier of a topic or an association.
de.deepamehta.core.Topic	getPrivateWorkspace() Returns the private workspace of the logged in user.
de.deepamehta.core.service.accesscontrol.Permissions	getTopicPermissions(long topicId)
Collection<de.deepamehta.core.Topic>	getTopicsByCreator(String username)
Collection<de.deepamehta.core.Topic>	getTopicsByOwner(String username)
String	getUsername() Returns the username of the logged in user.
de.deepamehta.core.Topic	getUsernameTopic() Returns the "Username" topic of the logged in user.
de.deepamehta.core.Topic	getUsernameTopic(String username) Returns the "Username" topic for the specified username.
String	getWorkspaceOwner(long workspaceId) Returns the owner of a workspace.
boolean	isMember(String username, long workspaceId) Checks if a user is a member of the given workspace.
void	login() Checks weather the credentials in the authorization string match an existing User Account, and if so, creates an HTTP session.
void	logout() Logs the user out.
void	postCreateAssociation(de.deepamehta.core.Association assoc)
void	postCreateTopic(de.deepamehta.core.Topic topic)
void	postUpdateAssociation(de.deepamehta.core.Association assoc, de.deepamehta.core.model.AssociationModel updateModel, de.deepamehta.core.model.AssociationModel oldAssoc)
void	postUpdateTopic(de.deepamehta.core.Topic topic, de.deepamehta.core.model.TopicModel updateModel, de.deepamehta.core.model.TopicModel oldTopic)
void	preCreateTopic(de.deepamehta.core.model.TopicModel model)
void	preInstall()
void	preUpdateTopic(de.deepamehta.core.Topic topic, de.deepamehta.core.model.TopicModel updateModel)
void	registerAuthorizationMethod(String name, AuthorizationMethod am)
void	serviceRequestFilter(com.sun.jersey.spi.container.ContainerRequest containerRequest)
void	setWorkspaceOwner(de.deepamehta.core.Topic workspace, String username) Sets the owner of a workspace.
void	shutdown()
void	staticResourceFilter(javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse)
void	unregisterAuthorizationMethod(String name)

Methods inherited from class de.deepamehta.core.osgi.PluginActivator

getBundleContext, getPluginName, getStaticResource, getUri, init, publishFileSystem, serviceArrived, serviceGone, setCoreService, start, stop, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AccessControlPlugin

public AccessControlPlugin()

Method Detail

login

public void login()

Description copied from interface: AccessControlService

Checks weather the credentials in the authorization string match an existing User Account, and if so, creates an HTTP session. ### FIXDOC

Specified by:

login in interface AccessControlService

logout

public void logout()

Description copied from interface: AccessControlService

Logs the user out. That is invalidating the session associated with the JSESSION ID cookie. For a "non-private" DM installation the response is 204 No Content. For a "private" DM installation the response is 401 Authorization Required. In this case the webclient is supposed to shutdown the DM GUI then. The webclient of a "private" DM installation must only be visible/usable when logged in.

Specified by:

logout in interface AccessControlService

getUsername

public String getUsername()

Description copied from interface: AccessControlService

Returns the username of the logged in user.

Specified by:

getUsername in interface AccessControlService

Returns:

The username, or null if no user is logged in.

getUsernameTopic

public de.deepamehta.core.Topic getUsernameTopic()

Description copied from interface: AccessControlService

Returns the "Username" topic of the logged in user.

Specified by:

getUsernameTopic in interface AccessControlService

Returns:

The "Username" topic (type dm4.accesscontrol.username), or null if no user is logged in.

getPrivateWorkspace

public de.deepamehta.core.Topic getPrivateWorkspace()

Description copied from interface: AccessControlService

Returns the private workspace of the logged in user.

Note: a user can have more than one private workspace. This method returns only the first one.

Specified by:

getPrivateWorkspace in interface AccessControlService

Returns:

IllegalStateException if no user is logged in.

createUserAccount

public de.deepamehta.core.Topic createUserAccount(de.deepamehta.core.service.accesscontrol.Credentials cred)

Specified by:

createUserAccount in interface AccessControlService

Returns:

The "Username" topic of the created user account.

createUsername

public de.deepamehta.core.Topic createUsername(String username)

Description copied from interface: AccessControlService

Creates a Username topic and a private workspace.

Specified by:

createUsername in interface AccessControlService

Returns:

created "Username" topic.

getUsernameTopic

public de.deepamehta.core.Topic getUsernameTopic(String username)

Description copied from interface: AccessControlService

Returns the "Username" topic for the specified username.

Specified by:

getUsernameTopic in interface AccessControlService

Parameters:

username - a username. Must not be null.

Returns:

The "Username" topic (type dm4.accesscontrol.username), or null if no such username exists.

getWorkspaceOwner

public String getWorkspaceOwner(long workspaceId)

Description copied from interface: AccessControlService

Returns the owner of a workspace.

Specified by:

getWorkspaceOwner in interface AccessControlService

Returns:

The username of the owner, or null if no owner is set. ### TODO: should throw an exception instead of returning null

setWorkspaceOwner

public void setWorkspaceOwner(de.deepamehta.core.Topic workspace,
                              String username)

Description copied from interface: AccessControlService

Sets the owner of a workspace. ### TODO: should take an ID instead a topic. ### Core service must be extended with a property setter.

Specified by:

setWorkspaceOwner in interface AccessControlService

createMembership

public void createMembership(String username,
                             long workspaceId)

Specified by:

createMembership in interface AccessControlService

isMember

public boolean isMember(String username,
                        long workspaceId)

Description copied from interface: AccessControlService

Checks if a user is a member of the given workspace.

Specified by:

isMember in interface AccessControlService

Parameters:

username - the user. If null is passed, false is returned. If an unknown username is passed an exception is thrown.

workspaceId - the workspace.

Returns:

true if the user is a member, false otherwise.

getTopicPermissions

public de.deepamehta.core.service.accesscontrol.Permissions getTopicPermissions(long topicId)

Specified by:

getTopicPermissions in interface AccessControlService

Returns:

A Permissions object with one entry: dm4.accesscontrol.operation.write.

getAssociationPermissions

public de.deepamehta.core.service.accesscontrol.Permissions getAssociationPermissions(long assocId)

Specified by:

getAssociationPermissions in interface AccessControlService

Returns:

A Permissions object with one entry: dm4.accesscontrol.operation.write.

getCreator

public String getCreator(long objectId)

Description copied from interface: AccessControlService

Returns the creator of a topic or an association.

Specified by:

getCreator in interface AccessControlService

Returns:

The username of the creator, or null if no creator is set.

getModifier

public String getModifier(long objectId)

Description copied from interface: AccessControlService

Returns the modifier of a topic or an association.

Specified by:

getModifier in interface AccessControlService

Returns:

The username of the modifier, or null if no modifier is set.

getTopicsByCreator

public Collection<de.deepamehta.core.Topic> getTopicsByCreator(String username)

Specified by:

getTopicsByCreator in interface AccessControlService

getTopicsByOwner

public Collection<de.deepamehta.core.Topic> getTopicsByOwner(String username)

Specified by:

getTopicsByOwner in interface AccessControlService

getAssociationsByCreator

public Collection<de.deepamehta.core.Association> getAssociationsByCreator(String username)

Specified by:

getAssociationsByCreator in interface AccessControlService

getAssociationsByOwner

public Collection<de.deepamehta.core.Association> getAssociationsByOwner(String username)

Specified by:

getAssociationsByOwner in interface AccessControlService

registerAuthorizationMethod

public void registerAuthorizationMethod(String name,
                                        AuthorizationMethod am)

Specified by:

registerAuthorizationMethod in interface AccessControlService

unregisterAuthorizationMethod

public void unregisterAuthorizationMethod(String name)

Specified by:

unregisterAuthorizationMethod in interface AccessControlService

getAuthorizationMethods

public Set<String> getAuthorizationMethods()

Specified by:

getAuthorizationMethods in interface AccessControlService

preInstall

public void preInstall()

Specified by:

preInstall in interface de.deepamehta.core.osgi.PluginContext

Overrides:

preInstall in class de.deepamehta.core.osgi.PluginActivator

shutdown

public void shutdown()

Specified by:

shutdown in interface de.deepamehta.core.osgi.PluginContext

Overrides:

shutdown in class de.deepamehta.core.osgi.PluginActivator

getConfigValue

public de.deepamehta.core.model.TopicModel getConfigValue(de.deepamehta.core.Topic topic)

Specified by:

getConfigValue in interface de.deepamehta.config.ConfigCustomizer

checkTopicReadAccess

public void checkTopicReadAccess(long topicId)

Specified by:

checkTopicReadAccess in interface de.deepamehta.core.service.event.CheckTopicReadAccessListener

checkTopicWriteAccess

public void checkTopicWriteAccess(long topicId)

Specified by:

checkTopicWriteAccess in interface de.deepamehta.core.service.event.CheckTopicWriteAccessListener

checkAssociationReadAccess

public void checkAssociationReadAccess(long assocId)

Specified by:

checkAssociationReadAccess in interface de.deepamehta.core.service.event.CheckAssociationReadAccessListener

checkAssociationWriteAccess

public void checkAssociationWriteAccess(long assocId)

Specified by:

checkAssociationWriteAccess in interface de.deepamehta.core.service.event.CheckAssociationWriteAccessListener

preCreateTopic

public void preCreateTopic(de.deepamehta.core.model.TopicModel model)

Specified by:

preCreateTopic in interface de.deepamehta.core.service.event.PreCreateTopicListener

postCreateTopic

public void postCreateTopic(de.deepamehta.core.Topic topic)

Specified by:

postCreateTopic in interface de.deepamehta.core.service.event.PostCreateTopicListener

postCreateAssociation

public void postCreateAssociation(de.deepamehta.core.Association assoc)

Specified by:

postCreateAssociation in interface de.deepamehta.core.service.event.PostCreateAssociationListener

preUpdateTopic

public void preUpdateTopic(de.deepamehta.core.Topic topic,
                           de.deepamehta.core.model.TopicModel updateModel)

Specified by:

preUpdateTopic in interface de.deepamehta.core.service.event.PreUpdateTopicListener

postUpdateTopic

public void postUpdateTopic(de.deepamehta.core.Topic topic,
                            de.deepamehta.core.model.TopicModel updateModel,
                            de.deepamehta.core.model.TopicModel oldTopic)

Specified by:

postUpdateTopic in interface de.deepamehta.core.service.event.PostUpdateTopicListener

postUpdateAssociation

public void postUpdateAssociation(de.deepamehta.core.Association assoc,
                                  de.deepamehta.core.model.AssociationModel updateModel,
                                  de.deepamehta.core.model.AssociationModel oldAssoc)

Specified by:

postUpdateAssociation in interface de.deepamehta.core.service.event.PostUpdateAssociationListener

serviceRequestFilter

public void serviceRequestFilter(com.sun.jersey.spi.container.ContainerRequest containerRequest)

Specified by:

serviceRequestFilter in interface de.deepamehta.core.service.event.ServiceRequestFilterListener

staticResourceFilter

public void staticResourceFilter(javax.servlet.http.HttpServletRequest servletRequest,
                                 javax.servlet.http.HttpServletResponse servletResponse)

Specified by:

staticResourceFilter in interface de.deepamehta.core.service.event.StaticResourceFilterListener

checkDiskQuota

public void checkDiskQuota(String username,
                           long fileSize,
                           long diskQuota)

Specified by:

checkDiskQuota in interface de.deepamehta.files.event.CheckDiskQuotaListener