Package org.nuxeo.directory.mongodb

Class MongoDBReference

java.lang.Object

org.nuxeo.ecm.directory.AbstractReference

org.nuxeo.directory.mongodb.MongoDBReference

All Implemented Interfaces:

Reference

public class MongoDBReference
extends AbstractReference

MongoDB implementation of a Reference

Since:

9.1

Field Summary

Fields

Modifier and Type	Field	Description
protected String	collection
protected String	dataFileName
static final String	GROUP_TO_GROUP_CHILD_GROUP_ID
static final String	GROUP_TO_GROUP_COLLECTION
static final String	GROUP_TO_GROUP_PARENT_GROUP_ID
protected String	sourceField
protected String	targetField
static final String	USER_TO_GROUP_COLLECTION
static final String	USER_TO_GROUP_GROUP_ID
static final String	USER_TO_GROUP_USER_ID

Fields inherited from class org.nuxeo.ecm.directory.AbstractReference

fieldName, sourceDirectory, sourceDirectoryName, targetDirectory, targetDirectoryName

Constructor Summary

Constructors

Constructor	Description
MongoDBReference(String field, String directory, String collection, String sourceField, String targetField, String dataFileName)
MongoDBReference(MongoDBReferenceDescriptor descriptor)
MongoDBReference(ReferenceDescriptor descriptor)

Method Summary

Modifier and Type	Method	Description
void	addLinks(String sourceId, List<String> targetIds)
void	addLinks(String sourceId, List<String> targetIds, Session session)	Adds the links between the source id and the target ids
void	addLinks(List<String> sourceIds, String targetId)
void	addLinks(List<String> sourceIds, String targetId, Session session)	Adds the links between the source ids and the target id
protected void	createIndexes(MongoDBSession session)
protected com.mongodb.client.MongoCollection<org.bson.Document>	getCollection(MongoDBSession session)
protected MongoDBSession	getMongoDBSession()
List<String>	getSourceIdsForTarget(String targetId)
List<String>	getTargetIdsForSource(String sourceId)
List<String>	getTargetIdsForSource(String sourceId, MongoDBSession session)	Retrieves all target ids associated to the given source id
protected void	initialize(MongoDBSession session)
protected boolean	isGroupToGroup()
protected boolean	isUserToGroup()
void	removeLinksForSource(String sourceId)
void	removeLinksForSource(String sourceId, Session session)	Removes all the links for a given source id
void	removeLinksForTarget(String targetId)
void	removeLinksForTarget(String targetId, Session session)	Removes all the links for a given target id
void	setSourceIdsForTarget(String targetId, List<String> sourceIds)
void	setSourceIdsForTarget(String targetId, List<String> sourceIds, Session session)	Sets all source ids to be associated to the given target id
void	setTargetIdsForSource(String sourceId, List<String> targetIds)
void	setTargetIdsForSource(String sourceId, List<String> targetIds, Session session)	Sets all target ids to be associated to the given source id

Methods inherited from class org.nuxeo.ecm.directory.AbstractReference

getFieldName, getSourceDirectory, getTargetDirectory, setSourceDirectoryName, setTargetDirectoryName

Methods inherited from class java.lang.Object

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

Field Details

GROUP_TO_GROUP_COLLECTION

public static final String GROUP_TO_GROUP_COLLECTION

Since:

11.5

See Also:

• Constant Field Values

GROUP_TO_GROUP_CHILD_GROUP_ID

public static final String GROUP_TO_GROUP_CHILD_GROUP_ID

Since:

11.5

See Also:

• Constant Field Values

GROUP_TO_GROUP_PARENT_GROUP_ID

public static final String GROUP_TO_GROUP_PARENT_GROUP_ID

Since:

11.5

See Also:

• Constant Field Values

USER_TO_GROUP_COLLECTION

public static final String USER_TO_GROUP_COLLECTION

Since:

11.5

See Also:

• Constant Field Values

USER_TO_GROUP_GROUP_ID

public static final String USER_TO_GROUP_GROUP_ID

Since:

11.5

See Also:

• Constant Field Values

USER_TO_GROUP_USER_ID

public static final String USER_TO_GROUP_USER_ID

Since:

11.5

See Also:

• Constant Field Values

collection

protected String collection

sourceField

protected String sourceField

targetField

protected String targetField

dataFileName

protected String dataFileName

Constructor Details

MongoDBReference

public MongoDBReference(String field,
 String directory,
 String collection,
 String sourceField,
 String targetField,
 String dataFileName)

Since:

9.2

MongoDBReference

public MongoDBReference(MongoDBReferenceDescriptor descriptor)

Since:

9.2

MongoDBReference

public MongoDBReference(ReferenceDescriptor descriptor)

Since:

9.2

Method Details

addLinks

public void addLinks(String sourceId,
 List<String> targetIds)

addLinks

public void addLinks(String sourceId,
 List<String> targetIds,
 Session session)

Description copied from interface: Reference

Adds the links between the source id and the target ids

Parameters:

sourceId - the source id

targetIds - the target ids

session - the session

addLinks

public void addLinks(List<String> sourceIds,
 String targetId,
 Session session)

Description copied from interface: Reference

Adds the links between the source ids and the target id

Parameters:

sourceIds - the source ids

targetId - the target id

session - the session

addLinks

public void addLinks(List<String> sourceIds,
 String targetId)

removeLinksForSource

public void removeLinksForSource(String sourceId)

removeLinksForSource

public void removeLinksForSource(String sourceId,
 Session session)

Description copied from interface: Reference

Removes all the links for a given source id

Parameters:

sourceId - the source id

session - the session

removeLinksForTarget

public void removeLinksForTarget(String targetId)

removeLinksForTarget

public void removeLinksForTarget(String targetId,
 Session session)

Description copied from interface: Reference

Removes all the links for a given target id

Parameters:

targetId - the target id

session - the session

getTargetIdsForSource

public List<String> getTargetIdsForSource(String sourceId)

getTargetIdsForSource

public List<String> getTargetIdsForSource(String sourceId,
 MongoDBSession session)

Retrieves all target ids associated to the given source id

Parameters:

sourceId - the source id

session - the mongoDB session

Returns:

the list of target ids

getSourceIdsForTarget

public List<String> getSourceIdsForTarget(String targetId)

setTargetIdsForSource

public void setTargetIdsForSource(String sourceId,
 List<String> targetIds)

setTargetIdsForSource

public void setTargetIdsForSource(String sourceId,
 List<String> targetIds,
 Session session)

Description copied from interface: Reference

Sets all target ids to be associated to the given source id

Parameters:

sourceId - the source id

targetIds - the target ids

session - the session

setSourceIdsForTarget

public void setSourceIdsForTarget(String targetId,
 List<String> sourceIds)

setSourceIdsForTarget

public void setSourceIdsForTarget(String targetId,
 List<String> sourceIds,
 Session session)

Description copied from interface: Reference

Sets all source ids to be associated to the given target id

Parameters:

targetId - the target id

sourceIds - the source ids

session - the session

initialize

protected void initialize(MongoDBSession session)

createIndexes

protected void createIndexes(MongoDBSession session)

isGroupToGroup

protected boolean isGroupToGroup()

isUserToGroup

protected boolean isUserToGroup()

getMongoDBSession

protected MongoDBSession getMongoDBSession()

getCollection

protected com.mongodb.client.MongoCollection<org.bson.Document> getCollection(MongoDBSession session)