systems.dmx.workspaces

Class WorkspacesPlugin

Show UML class diagram

java.lang.Object

systems.dmx.core.osgi.PluginActivator

systems.dmx.workspaces.WorkspacesPlugin

All Implemented Interfaces:

org.osgi.framework.BundleActivator, PluginContext, IntroduceAssociationTypeListener, IntroduceTopicTypeListener, PostCreateAssociationListener, PostCreateTopicListener, PreDeleteTopicListener, EventListener, WorkspacesService

public class WorkspacesPlugin
extends PluginActivator
implements WorkspacesService, IntroduceTopicTypeListener, IntroduceAssociationTypeListener, PostCreateTopicListener, PostCreateAssociationListener, PreDeleteTopicListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	WorkspacesPlugin.Messenger

Field Summary

Fields

Modifier and Type	Field and Description
private ConfigService	configService
private FacetsService	facetsService
private Logger	logger
private WorkspacesPlugin.Messenger	me
private javax.servlet.http.HttpServletRequest	request
private static boolean	SHARING_MODE_COLLABORATIVE_ENABLED
private static boolean	SHARING_MODE_COMMON_ENABLED
private static boolean	SHARING_MODE_CONFIDENTIAL_ENABLED
private static boolean	SHARING_MODE_PRIVATE_ENABLED
private static boolean	SHARING_MODE_PUBLIC_ENABLED
private TopicmapsService	topicmapsService

Fields inherited from class systems.dmx.core.osgi.PluginActivator

bundle, dmx, mf

Fields inherited from interface systems.dmx.workspaces.WorkspacesService

DMX_WORKSPACE_NAME, DMX_WORKSPACE_SHARING_MODE, DMX_WORKSPACE_URI, PROP_WORKSPACE_ID

Constructor Summary

Constructors

Constructor and Description
WorkspacesPlugin()

Method Summary

Modifier and Type	Method and Description
private void	_assignToWorkspace(DMXObject object, long workspaceId)
private void	applyWorkspaceFilter(Iterator<? extends DMXObject> objects, long workspaceId)
void	assignToWorkspace(DMXObject object, long workspaceId) Assigns the given object to the given workspace.
DirectivesResponse	assignToWorkspace(long objectId, long workspaceId)
void	assignTypeToWorkspace(DMXType type, long workspaceId) Assigns the given type and all its view configuration topics to the given workspace.
private void	checkWorkspaceId(long topicId) Checks if the topic with the specified ID exists and is a Workspace.
Topic	createWorkspace(String name, String uri, SharingMode sharingMode)
private void	deleteWorkspaceContent(long workspaceId)
List<Association>	getAssignedAssociations(long workspaceId) Returns all associations assigned to the given workspace.
List<Association>	getAssignedAssociations(long workspaceId, String assocTypeUri) Returns all associations of the given type that are assigned to the given workspace.
List<Topic>	getAssignedTopics(long workspaceId) Returns all topics assigned to the given workspace.
List<Topic>	getAssignedTopics(long workspaceId, String topicTypeUri) Returns all topics of the given type that are assigned to the given workspace.
Topic	getAssignedWorkspace(long objectId) Returns the workspace a topic or association is assigned to.
private long	getAssignedWorkspaceId(long objectId)
private Topic	getDMXWorkspace() Returns the DMX workspace or throws an exception if it doesn't exist.
Topic	getWorkspace(String uri) Returns a workspace by URI.
private String	info(DMXObject object)
void	introduceAssociationType(AssociationType assocType) Takes care the DMX standard types (and their parts) get an assignment to the DMX workspace.
void	introduceTopicType(TopicType topicType) Takes care the DMX standard types (and their parts) get an assignment to the DMX workspace.
private boolean	isDMXStandardType(DMXType type)
private boolean	isWorkspaceAssignment(Association assoc)
private boolean	isWorkspaceDescription(Topic topic)
void	postCreateAssociation(Association assoc) Assigns every created association to the current workspace.
void	postCreateTopic(Topic topic) Assigns every created topic to the current workspace.
void	preDeleteTopic(Topic topic) When a workspace is about to be deleted its entire content must be deleted.
void	preInstall()
void	shutdown()
private boolean	workspaceAssignmentIsSuppressed(DMXObject object) Returns true if standard workspace assignment is currently suppressed for the current thread.
private long	workspaceId()
private long	workspaceIdForType(DMXType type) Returns the ID of the DMX workspace or -1 to signal abortion of type introduction.

Methods inherited from class systems.dmx.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

Field Detail

SHARING_MODE_PRIVATE_ENABLED

private static final boolean SHARING_MODE_PRIVATE_ENABLED

SHARING_MODE_CONFIDENTIAL_ENABLED

private static final boolean SHARING_MODE_CONFIDENTIAL_ENABLED

SHARING_MODE_COLLABORATIVE_ENABLED

private static final boolean SHARING_MODE_COLLABORATIVE_ENABLED

SHARING_MODE_PUBLIC_ENABLED

private static final boolean SHARING_MODE_PUBLIC_ENABLED

SHARING_MODE_COMMON_ENABLED

private static final boolean SHARING_MODE_COMMON_ENABLED

facetsService

private FacetsService facetsService

topicmapsService

private TopicmapsService topicmapsService

configService

private ConfigService configService

request

@Context
private javax.servlet.http.HttpServletRequest request

me

private WorkspacesPlugin.Messenger me

logger

private Logger logger

Constructor Detail

WorkspacesPlugin

public WorkspacesPlugin()

Method Detail

createWorkspace

public Topic createWorkspace(String name,
                             String uri,
                             SharingMode sharingMode)

Specified by:

createWorkspace in interface WorkspacesService

uri - may be null

getWorkspace

public Topic getWorkspace(String uri)

Description copied from interface: WorkspacesService

Returns a workspace by URI.

Specified by:

getWorkspace in interface WorkspacesService

Returns:

The workspace (a topic of type "Workspace").

getAssignedWorkspace

public Topic getAssignedWorkspace(long objectId)

Description copied from interface: WorkspacesService

Returns the workspace a topic or association is assigned to.

Specified by:

getAssignedWorkspace in interface WorkspacesService

Returns:

The assigned workspace (a topic of type "Workspace"), or null if no workspace is assigned.

assignToWorkspace

public DirectivesResponse assignToWorkspace(long objectId,
                                            long workspaceId)

assignToWorkspace

public void assignToWorkspace(DMXObject object,
                              long workspaceId)

Description copied from interface: WorkspacesService

Assigns the given object to the given workspace.

Specified by:

assignToWorkspace in interface WorkspacesService

assignTypeToWorkspace

public void assignTypeToWorkspace(DMXType type,
                                  long workspaceId)

Description copied from interface: WorkspacesService

Assigns the given type and all its view configuration topics to the given workspace.

Specified by:

assignTypeToWorkspace in interface WorkspacesService

getAssignedTopics

public List<Topic> getAssignedTopics(long workspaceId)

Description copied from interface: WorkspacesService

Returns all topics assigned to the given workspace.

Specified by:

getAssignedTopics in interface WorkspacesService

getAssignedAssociations

public List<Association> getAssignedAssociations(long workspaceId)

Description copied from interface: WorkspacesService

Returns all associations assigned to the given workspace.

Specified by:

getAssignedAssociations in interface WorkspacesService

getAssignedTopics

public List<Topic> getAssignedTopics(long workspaceId,
                                     String topicTypeUri)

Description copied from interface: WorkspacesService

Returns all topics of the given type that are assigned to the given workspace.

Specified by:

getAssignedTopics in interface WorkspacesService

getAssignedAssociations

public List<Association> getAssignedAssociations(long workspaceId,
                                                 String assocTypeUri)

Description copied from interface: WorkspacesService

Returns all associations of the given type that are assigned to the given workspace.

Specified by:

getAssignedAssociations in interface WorkspacesService

preInstall

public void preInstall()

Specified by:

preInstall in interface PluginContext

Overrides:

preInstall in class PluginActivator

shutdown

public void shutdown()

Specified by:

shutdown in interface PluginContext

Overrides:

shutdown in class PluginActivator

introduceTopicType

public void introduceTopicType(TopicType topicType)

Takes care the DMX standard types (and their parts) get an assignment to the DMX workspace. This is important in conjunction with access control. Note: type introduction is aborted if at least one of these conditions apply: - A workspace cookie is present. In this case the type gets its workspace assignment the regular way (this plugin's post-create listeners). This happens e.g. when a type is created interactively in the Webclient. - The type is not a DMX standard type. In this case the 3rd-party plugin developer is responsible for doing the workspace assignment (in case the type is created programmatically while a migration). DM can't know to which workspace a 3rd-party type belongs to. A type is regarded a DMX standard type if its URI begins with "dmx."

Specified by:

introduceTopicType in interface IntroduceTopicTypeListener

introduceAssociationType

public void introduceAssociationType(AssociationType assocType)

Takes care the DMX standard types (and their parts) get an assignment to the DMX workspace. This is important in conjunction with access control. Note: type introduction is aborted if at least one of these conditions apply: - A workspace cookie is present. In this case the type gets its workspace assignment the regular way (this plugin's post-create listeners). This happens e.g. when a type is created interactively in the Webclient. - The type is not a DMX standard type. In this case the 3rd-party plugin developer is responsible for doing the workspace assignment (in case the type is created programmatically while a migration). DM can't know to which workspace a 3rd-party type belongs to. A type is regarded a DMX standard type if its URI begins with "dmx."

Specified by:

introduceAssociationType in interface IntroduceAssociationTypeListener

postCreateTopic

public void postCreateTopic(Topic topic)

Assigns every created topic to the current workspace.

Specified by:

postCreateTopic in interface PostCreateTopicListener

postCreateAssociation

public void postCreateAssociation(Association assoc)

Assigns every created association to the current workspace.

Specified by:

postCreateAssociation in interface PostCreateAssociationListener

preDeleteTopic

public void preDeleteTopic(Topic topic)

When a workspace is about to be deleted its entire content must be deleted.

Specified by:

preDeleteTopic in interface PreDeleteTopicListener

workspaceId

private long workspaceId()

workspaceIdForType

private long workspaceIdForType(DMXType type)

Returns the ID of the DMX workspace or -1 to signal abortion of type introduction.

getAssignedWorkspaceId

private long getAssignedWorkspaceId(long objectId)

_assignToWorkspace

private void _assignToWorkspace(DMXObject object,
                                long workspaceId)

deleteWorkspaceContent

private void deleteWorkspaceContent(long workspaceId)

isDMXStandardType

private boolean isDMXStandardType(DMXType type)

isWorkspaceDescription

private boolean isWorkspaceDescription(Topic topic)

isWorkspaceAssignment

private boolean isWorkspaceAssignment(Association assoc)

getDMXWorkspace

private Topic getDMXWorkspace()

Returns the DMX workspace or throws an exception if it doesn't exist.

applyWorkspaceFilter

private void applyWorkspaceFilter(Iterator<? extends DMXObject> objects,
                                  long workspaceId)

checkWorkspaceId

private void checkWorkspaceId(long topicId)

Checks if the topic with the specified ID exists and is a Workspace. If not, an exception is thrown. ### TODO: principle copy in AccessControlImpl.checkWorkspaceId()

workspaceAssignmentIsSuppressed

private boolean workspaceAssignmentIsSuppressed(DMXObject object)

Returns true if standard workspace assignment is currently suppressed for the current thread.

info

private String info(DMXObject object)