systems.dmx.core.impl

Class CoreServiceImpl

Show UML class diagram

java.lang.Object

systems.dmx.core.impl.CoreServiceImpl

All Implemented Interfaces:

CoreService

public class CoreServiceImpl
extends Object
implements CoreService

Implementation of the DMX core service. Embeddable into Java applications.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) AccessControl	accessControl
(package private) org.osgi.framework.BundleContext	bundleContext
(package private) EventManager	em
private Logger	logger
(package private) ModelFactory	mf
(package private) MigrationManager	migrationManager
(package private) PersistenceLayer	pl
(package private) PluginManager	pluginManager
(package private) WebPublishingService	wpService
(package private) WebSocketsServiceImpl	wsService

Constructor Summary

Constructors

Constructor and Description
CoreServiceImpl(PersistenceLayer pl, org.osgi.framework.BundleContext bundleContext)

Method Summary

Modifier and Type	Method and Description
private void	_associateDataType(String typeUri, String dataTypeUri) Low-level method that stores an (data type) association without its "Instantiation" association.
private void	_createTopic(TopicModel model) Low-level method that stores a topic without its "Instantiation" association.
void	addAssociationPropertyIndex(String propUri)
void	addTopicPropertyIndex(String propUri)
DMXTransaction	beginTx()
AssociationImpl	createAssociation(AssociationModel model)
(package private) Association	createAssociation(String typeUri, RoleModel roleModel1, RoleModel roleModel2) Convenience method.
AssociationTypeImpl	createAssociationType(AssociationTypeModel model)
Topic	createRoleType(TopicModel model)
TopicImpl	createTopic(TopicModel model)
TopicTypeImpl	createTopicType(TopicTypeModel model)
void	deleteAssociation(long assocId)
void	deleteAssociationType(String assocTypeUri)
void	deleteTopic(long topicId)
void	deleteTopicType(String topicTypeUri)
void	dispatchEvent(String pluginUri, DMXEvent event, Object... params)
void	fireEvent(DMXEvent event, Object... params)
AccessControl	getAccessControl()
Iterable<Association>	getAllAssociations()
List<AssociationType>	getAllAssociationTypes()
Iterable<Topic>	getAllTopics()
List<TopicType>	getAllTopicTypes()
Association	getAssociation(long assocId)
Association	getAssociation(String assocTypeUri, long topic1Id, long topic2Id, String roleTypeUri1, String roleTypeUri2) Returns the association between two topics, qualified by association type and both role types.
Association	getAssociationBetweenTopicAndAssociation(String assocTypeUri, long topicId, long assocId, String topicRoleTypeUri, String assocRoleTypeUri)
Association	getAssociationByValue(String key, SimpleValue value) Looks up a single association by exact value.
List<Association>	getAssociations(long topic1Id, long topic2Id) Returns all associations between two topics.
List<Association>	getAssociations(long topic1Id, long topic2Id, String assocTypeUri) Returns the associations between two topics.
List<Association>	getAssociationsByProperty(String propUri, Object propValue)
List<Association>	getAssociationsByPropertyRange(String propUri, Number from, Number to)
List<Association>	getAssociationsByType(String assocTypeUri)
List<Association>	getAssociationsByValue(String key, SimpleValue value) Looks up associations by key and value.
AssociationTypeImpl	getAssociationType(String uri)
AssociationTypeImpl	getAssociationTypeImplicitly(long assocId) Acccesses an association type while enforcing the implicit READ permission.
Object	getDatabaseVendorObject()
ModelFactory	getModelFactory()
DMXObject	getObject(long id)
long[]	getPlayerIds(long assocId)
PluginImpl	getPlugin(String pluginUri)
List<PluginInfo>	getPluginInfo()
Object	getProperty(long id, String propUri) Returns a topic's or association's property value associated with the given property URI.
Topic	getTopic(long topicId) Accesses a topic by ID.
TopicImpl	getTopicByUri(String uri) Accesses a topic by URI.
Topic	getTopicByValue(String key, SimpleValue value) Looks up a single topic by exact value.
List<Topic>	getTopicsByProperty(String propUri, Object propValue)
List<Topic>	getTopicsByPropertyRange(String propUri, Number from, Number to)
List<Topic>	getTopicsByType(String topicTypeUri)
List<Topic>	getTopicsByValue(String key, SimpleValue value) Looks up topics by key and value.
TopicTypeImpl	getTopicType(String uri)
TopicTypeImpl	getTopicTypeImplicitly(long topicId) Acccesses a topic type while enforcing the implicit READ permission.
WebSocketsServiceImpl	getWebSocketsService()
boolean	hasProperty(long id, String propUri) Checks whether for a given topic or association a property value is associated with a given property URI.
List<Topic>	searchTopics(String searchTerm, String fieldUri) Performs a fulltext search.
private void	setupBootstrapContent()
private void	setupDB() Setups the database: 1) initializes the database.
void	shutdown()
void	updateAssociation(AssociationModel updateModel)
void	updateAssociationType(AssociationTypeModel updateModel)
void	updateTopic(TopicModel updateModel)
void	updateTopicType(TopicTypeModel updateModel)

Methods inherited from class java.lang.Object

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

Field Detail

bundleContext

org.osgi.framework.BundleContext bundleContext

pl

PersistenceLayer pl

em

EventManager em

mf

ModelFactory mf

migrationManager

MigrationManager migrationManager

pluginManager

PluginManager pluginManager

accessControl

AccessControl accessControl

wsService

WebSocketsServiceImpl wsService

wpService

WebPublishingService wpService

logger

private Logger logger

Constructor Detail

CoreServiceImpl

public CoreServiceImpl(PersistenceLayer pl,
                       org.osgi.framework.BundleContext bundleContext)

Parameters:

bundleContext - The context of the DMX Core bundle.

Method Detail

getTopic

public Topic getTopic(long topicId)

Description copied from interface: CoreService

Accesses a topic by ID.

Specified by:

getTopic in interface CoreService

Returns:

the topic.

getTopicByUri

public TopicImpl getTopicByUri(String uri)

Description copied from interface: CoreService

Accesses a topic by URI.

Specified by:

getTopicByUri in interface CoreService

Returns:

the topic, or null if no such topic exists.

getTopicByValue

public Topic getTopicByValue(String key,
                             SimpleValue value)

Description copied from interface: CoreService

Looks up a single topic by exact value.

Note: wildcards like "*" in String values are not interpreted. They are treated literally. Compare to CoreService.getTopicsByValue(String,SimpleValue)

IMPORTANT: Looking up a topic this way requires the corresponding type to be indexed with indexing mode dmx.core.key.

Specified by:

getTopicByValue in interface CoreService

Returns:

the topic, or null if no such topic exists.

getTopicsByValue

public List<Topic> getTopicsByValue(String key,
                                    SimpleValue value)

Description copied from interface: CoreService

Looks up topics by key and value.

Wildcards like "*" in String values are interpreted.

IMPORTANT: Looking up topics this way requires the corresponding type to be indexed with indexing mode dmx.core.key.

Specified by:

getTopicsByValue in interface CoreService

getTopicsByType

public List<Topic> getTopicsByType(String topicTypeUri)

Specified by:

getTopicsByType in interface CoreService

searchTopics

public List<Topic> searchTopics(String searchTerm,
                                String fieldUri)

Description copied from interface: CoreService

Performs a fulltext search.

IMPORTANT: Searching topics this way requires the corresponding type to be indexed with indexing mode dmx.core.fulltext or dmx.core.fulltext_key. ### FIXDOC

Specified by:

searchTopics in interface CoreService

fieldUri - The URI of the data field to search. If null is provided all fields are searched. ### FIXDOC ### TODO: rename parameter to "key"/"typeUri"?

getAllTopics

public Iterable<Topic> getAllTopics()

Specified by:

getAllTopics in interface CoreService

createTopic

public TopicImpl createTopic(TopicModel model)

Specified by:

createTopic in interface CoreService

updateTopic

public void updateTopic(TopicModel updateModel)

Specified by:

updateTopic in interface CoreService

deleteTopic

public void deleteTopic(long topicId)

Specified by:

deleteTopic in interface CoreService

getAssociation

public Association getAssociation(long assocId)

Specified by:

getAssociation in interface CoreService

getAssociationByValue

public Association getAssociationByValue(String key,
                                         SimpleValue value)

Description copied from interface: CoreService

Looks up a single association by exact value.

Note: wildcards like "*" in String values are not interpreted. They are treated literally. Compare to CoreService.getAssociationsByValue(String,SimpleValue)

IMPORTANT: Looking up an association this way requires the corresponding type to be indexed with indexing mode dmx.core.key.

Specified by:

getAssociationByValue in interface CoreService

Returns:

the association, or null if no such association exists.

getAssociationsByValue

public List<Association> getAssociationsByValue(String key,
                                                SimpleValue value)

Description copied from interface: CoreService

Looks up associations by key and value.

Wildcards like "*" in String values are interpreted.

IMPORTANT: Looking up associations this way requires the corresponding type to be indexed with indexing mode dmx.core.key.

Specified by:

getAssociationsByValue in interface CoreService

getAssociation

public Association getAssociation(String assocTypeUri,
                                  long topic1Id,
                                  long topic2Id,
                                  String roleTypeUri1,
                                  String roleTypeUri2)

Description copied from interface: CoreService

Returns the association between two topics, qualified by association type and both role types. If no such association exists null is returned. If more than one association exist, a runtime exception is thrown.

Specified by:

getAssociation in interface CoreService

Parameters:

assocTypeUri - Association type filter. Pass null to switch filter off.

getAssociationBetweenTopicAndAssociation

public Association getAssociationBetweenTopicAndAssociation(String assocTypeUri,
                                                            long topicId,
                                                            long assocId,
                                                            String topicRoleTypeUri,
                                                            String assocRoleTypeUri)

Specified by:

getAssociationBetweenTopicAndAssociation in interface CoreService

getAssociationsByType

public List<Association> getAssociationsByType(String assocTypeUri)

Specified by:

getAssociationsByType in interface CoreService

getAssociations

public List<Association> getAssociations(long topic1Id,
                                         long topic2Id)

Description copied from interface: CoreService

Returns all associations between two topics. If no such association exists an empty list is returned.

Specified by:

getAssociations in interface CoreService

getAssociations

public List<Association> getAssociations(long topic1Id,
                                         long topic2Id,
                                         String assocTypeUri)

Description copied from interface: CoreService

Returns the associations between two topics. If no such association exists an empty list is returned.

Specified by:

getAssociations in interface CoreService

assocTypeUri - Association type filter. Pass null to switch filter off.

getAllAssociations

public Iterable<Association> getAllAssociations()

Specified by:

getAllAssociations in interface CoreService

getPlayerIds

public long[] getPlayerIds(long assocId)

Specified by:

getPlayerIds in interface CoreService

createAssociation

public AssociationImpl createAssociation(AssociationModel model)

Specified by:

createAssociation in interface CoreService

updateAssociation

public void updateAssociation(AssociationModel updateModel)

Specified by:

updateAssociation in interface CoreService

deleteAssociation

public void deleteAssociation(long assocId)

Specified by:

deleteAssociation in interface CoreService

getTopicType

public TopicTypeImpl getTopicType(String uri)

Specified by:

getTopicType in interface CoreService

getTopicTypeImplicitly

public TopicTypeImpl getTopicTypeImplicitly(long topicId)

Description copied from interface: CoreService

Acccesses a topic type while enforcing the implicit READ permission. A user has implicit READ permission for the topic type if she has READ permission for the given topic.

Specified by:

getTopicTypeImplicitly in interface CoreService

getAllTopicTypes

public List<TopicType> getAllTopicTypes()

Specified by:

getAllTopicTypes in interface CoreService

createTopicType

public TopicTypeImpl createTopicType(TopicTypeModel model)

Specified by:

createTopicType in interface CoreService

updateTopicType

public void updateTopicType(TopicTypeModel updateModel)

Specified by:

updateTopicType in interface CoreService

deleteTopicType

public void deleteTopicType(String topicTypeUri)

Specified by:

deleteTopicType in interface CoreService

getAssociationType

public AssociationTypeImpl getAssociationType(String uri)

Specified by:

getAssociationType in interface CoreService

getAssociationTypeImplicitly

public AssociationTypeImpl getAssociationTypeImplicitly(long assocId)

Description copied from interface: CoreService

Acccesses an association type while enforcing the implicit READ permission. A user has implicit READ permission for the association type if she has READ permission for the given association.

Specified by:

getAssociationTypeImplicitly in interface CoreService

getAllAssociationTypes

public List<AssociationType> getAllAssociationTypes()

Specified by:

getAllAssociationTypes in interface CoreService

createAssociationType

public AssociationTypeImpl createAssociationType(AssociationTypeModel model)

Specified by:

createAssociationType in interface CoreService

updateAssociationType

public void updateAssociationType(AssociationTypeModel updateModel)

Specified by:

updateAssociationType in interface CoreService

deleteAssociationType

public void deleteAssociationType(String assocTypeUri)

Specified by:

deleteAssociationType in interface CoreService

createRoleType

public Topic createRoleType(TopicModel model)

Specified by:

createRoleType in interface CoreService

getObject

public DMXObject getObject(long id)

Specified by:

getObject in interface CoreService

getPlugin

public PluginImpl getPlugin(String pluginUri)

Specified by:

getPlugin in interface CoreService

getPluginInfo

public List<PluginInfo> getPluginInfo()

Specified by:

getPluginInfo in interface CoreService

fireEvent

public void fireEvent(DMXEvent event,
                      Object... params)

Specified by:

fireEvent in interface CoreService

dispatchEvent

public void dispatchEvent(String pluginUri,
                          DMXEvent event,
                          Object... params)

Specified by:

dispatchEvent in interface CoreService

getProperty

public Object getProperty(long id,
                          String propUri)

Description copied from interface: CoreService

Returns a topic's or association's property value associated with the given property URI. If there's no property value associated with the property URI an exception is thrown.

Specified by:

getProperty in interface CoreService

Parameters:

id - a topic ID, or an association ID

hasProperty

public boolean hasProperty(long id,
                           String propUri)

Description copied from interface: CoreService

Checks whether for a given topic or association a property value is associated with a given property URI.

Specified by:

hasProperty in interface CoreService

Parameters:

id - a topic ID, or an association ID

getTopicsByProperty

public List<Topic> getTopicsByProperty(String propUri,
                                       Object propValue)

Specified by:

getTopicsByProperty in interface CoreService

getTopicsByPropertyRange

public List<Topic> getTopicsByPropertyRange(String propUri,
                                            Number from,
                                            Number to)

Specified by:

getTopicsByPropertyRange in interface CoreService

getAssociationsByProperty

public List<Association> getAssociationsByProperty(String propUri,
                                                   Object propValue)

Specified by:

getAssociationsByProperty in interface CoreService

getAssociationsByPropertyRange

public List<Association> getAssociationsByPropertyRange(String propUri,
                                                        Number from,
                                                        Number to)

Specified by:

getAssociationsByPropertyRange in interface CoreService

addTopicPropertyIndex

public void addTopicPropertyIndex(String propUri)

Specified by:

addTopicPropertyIndex in interface CoreService

addAssociationPropertyIndex

public void addAssociationPropertyIndex(String propUri)

Specified by:

addAssociationPropertyIndex in interface CoreService

beginTx

public DMXTransaction beginTx()

Specified by:

beginTx in interface CoreService

getModelFactory

public ModelFactory getModelFactory()

Specified by:

getModelFactory in interface CoreService

getAccessControl

public AccessControl getAccessControl()

Specified by:

getAccessControl in interface CoreService

getWebSocketsService

public WebSocketsServiceImpl getWebSocketsService()

Specified by:

getWebSocketsService in interface CoreService

getDatabaseVendorObject

public Object getDatabaseVendorObject()

Specified by:

getDatabaseVendorObject in interface CoreService

shutdown

public void shutdown()

createAssociation

Association createAssociation(String typeUri,
                              RoleModel roleModel1,
                              RoleModel roleModel2)

Convenience method.

setupDB

private void setupDB()

Setups the database: 1) initializes the database. 2) in case of a clean install: sets up the bootstrap content. 3) runs the core migrations.

setupBootstrapContent

private void setupBootstrapContent()

_createTopic

private void _createTopic(TopicModel model)

Low-level method that stores a topic without its "Instantiation" association. Needed for bootstrapping.

_associateDataType

private void _associateDataType(String typeUri,
                                String dataTypeUri)

Low-level method that stores an (data type) association without its "Instantiation" association. Needed for bootstrapping.