Package org.frankframework.mongodb

Class MongoDbSender

java.lang.Object

org.frankframework.senders.AbstractSender

org.frankframework.senders.AbstractSenderWithParameters

org.frankframework.mongodb.MongoDbSender

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, HasPhysicalDestination, IConfigurable, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, NameAware, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle

@DestinationType(MONGODB)
public class MongoDbSender
extends AbstractSenderWithParameters
implements HasPhysicalDestination

Sender to perform action on a MongoDB database.

Author:

Gerrit van Brakel

Specific parameters

database Database to connect to. Overrides attribute database, collection Collection to act upon. Overrides attribute collection, filter Filter. Can contain references to parameters between '?{' and '}'. Overrides attribute filter, limit Limit to number of results returned. A value of 0 means 'no limit'. Overrides attribute limit

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MongoDbSender.MongoAction

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAMED_PARAM_END
static final String	NAMED_PARAM_START
static final String	PARAM_COLLECTION
static final String	PARAM_DATABASE
static final String	PARAM_FILTER
static final String	PARAM_LIMIT

Fields inherited from class org.frankframework.senders.AbstractSenderWithParameters

parameterNamesMustBeUnique, paramList

Fields inherited from class org.frankframework.senders.AbstractSender

log

Constructor Summary

Constructors

Constructor	Description
MongoDbSender()

Method Summary

Modifier and Type	Method	Description
protected void	addOptionalValue(ObjectBuilder builder, String name, org.bson.BsonValue bsonValue)
void	configure()	Configure this component.
protected com.mongodb.client.MongoCollection<org.bson.Document>	getCollection(com.mongodb.client.MongoDatabase mongoDatabase, ParameterValueList pvl)
protected com.mongodb.client.MongoDatabase	getDatabase(ParameterValueList pvl)
protected org.bson.Document	getDocument(String message)
protected org.bson.Document	getDocument(Message message)
protected List<org.bson.Document>	getDocuments(Message message)
protected org.bson.Document	getFilter(ParameterValueList pvl, Message message)
protected int	getLimit(ParameterValueList pvl)
String	getPhysicalDestinationName()
protected void	renderResult(com.mongodb.client.FindIterable<org.bson.Document> findResults, MessageBuilder messageBuilder)
protected void	renderResult(com.mongodb.client.result.DeleteResult deleteResult, MessageBuilder messageBuilder)
protected void	renderResult(com.mongodb.client.result.InsertManyResult insertManyResult, MessageBuilder messageBuilder)
protected void	renderResult(com.mongodb.client.result.InsertOneResult insertOneResult, MessageBuilder messageBuilder)
protected void	renderResult(com.mongodb.client.result.UpdateResult updateResult, MessageBuilder messageBuilder)
protected void	renderResult(org.bson.Document findResult, MessageBuilder messageBuilder)
SenderResult	sendMessage(Message message, PipeLineSession session)	Send a message to some destination (as configured in the Sender object).
void	setAction(MongoDbSender.MongoAction action)	Action
void	setCollection(String collection)	Collection to act upon.
void	setCountOnly(boolean countOnly)	Only for find operation: return only the count and not the full document(s)
void	setDatabase(String database)	Database to connect to.
void	setDatasourceName(String datasourceName)	The MongoDB datasource
void	setFilter(String filter)	Filter.
void	setLimit(int limit)	Limit to number of results returned.
void	setOutputFormat(DocumentFormat outputFormat)	OutputFormat
void	setPrettyPrint(boolean prettyPrint)	Format the output in easy legible way (currently only for XML)
void	start()	This method will be called to start the sender.
void	stop()	Stop/close the sender and deallocate resources.

Methods inherited from class org.frankframework.senders.AbstractSenderWithParameters

addParameter, checkStringAttributeOrParameter, consumesSessionVariable, getParameterList, getParameterOverriddenAttributeValue, getParameterOverriddenAttributeValue, getParameterValueList

Methods inherited from class org.frankframework.senders.AbstractSender

createBean, getLogPrefix, getName, isRunning, setApplicationContext, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface org.frankframework.core.FrankElement

addConfigWarning

Methods inherited from interface org.frankframework.core.HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.HasName

getName

Methods inherited from interface org.frankframework.core.ISender

isSynchronous, sendMessageOrThrow

Methods inherited from interface org.frankframework.core.NameAware

setName

Field Details

PARAM_DATABASE

public static final String PARAM_DATABASE

See Also:

• Constant Field Values

PARAM_COLLECTION

public static final String PARAM_COLLECTION

See Also:

• Constant Field Values

PARAM_FILTER

public static final String PARAM_FILTER

See Also:

• Constant Field Values

PARAM_LIMIT

public static final String PARAM_LIMIT

See Also:

• Constant Field Values

NAMED_PARAM_START

public static final String NAMED_PARAM_START

See Also:

• Constant Field Values

NAMED_PARAM_END

public static final String NAMED_PARAM_END

See Also:

• Constant Field Values

Constructor Details

MongoDbSender

public MongoDbSender()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from interface: IConfigurable

Configure this component.

configure() is called once at startup of the framework in the configure method of the owner of this IConfigurable. Purpose of this method is to check whether the static configuration of the object is correct. As much as possible class-instantiating should take place in the configure(), to improve performance.

In the case of a container, this will propagate the configure signal to all components that apply.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class AbstractSenderWithParameters

Throws:

ConfigurationException - in case it was not able to configure the component.

start

public void start()

Description copied from interface: ISender

This method will be called to start the sender. After this method is called the sendMessage method may be called. Purpose of this method is to reduce creating connections to databases etc. in the sendMessage() method.

Specified by:

start in interface ISender

Specified by:

start in interface org.springframework.context.Lifecycle

Overrides:

start in class AbstractSender

stop

public void stop()

Description copied from interface: ISender

Stop/close the sender and deallocate resources.

Specified by:

stop in interface ISender

Specified by:

stop in interface org.springframework.context.Lifecycle

Overrides:

stop in class AbstractSender

sendMessage

@Nonnull
public SenderResult sendMessage(@Nonnull
 Message message,
 @Nonnull
 PipeLineSession session)
                         throws SenderException,
TimeoutException

Description copied from interface: ISender

Send a message to some destination (as configured in the Sender object). This method may only be called after the configure() method is called.

The following table shows the difference between synchronous and a-synchronous senders:

	synchronous	a-synchronous
ISender.isSynchronous() returns	true	false
return value of sendMessage() is	the reply-message	the messageId of the message sent
the correlationID specified with sendMessage()	may be ignored	is sent with the message
a {link TimeOutException}	may be thrown if a timeout occurs waiting for a reply	should not be expected

Multiple objects may try to call this method at the same time, from different threads. Implementations of this method should therefore be thread-safe, or synchronized.

Specified by:

sendMessage in interface ISender

Throws:

SenderException

TimeoutException

renderResult

protected void renderResult(com.mongodb.client.result.InsertOneResult insertOneResult,
 MessageBuilder messageBuilder)
                     throws SAXException

Throws:

SAXException

renderResult

protected void renderResult(com.mongodb.client.result.InsertManyResult insertManyResult,
 MessageBuilder messageBuilder)
                     throws SAXException

Throws:

SAXException

renderResult

protected void renderResult(org.bson.Document findResult,
 MessageBuilder messageBuilder)
                     throws SAXException

Throws:

SAXException

renderResult

protected void renderResult(com.mongodb.client.FindIterable<org.bson.Document> findResults,
 MessageBuilder messageBuilder)
                     throws IOException,
SAXException

Throws:

IOException

SAXException

renderResult

protected void renderResult(com.mongodb.client.result.UpdateResult updateResult,
 MessageBuilder messageBuilder)
                     throws SAXException

Throws:

SAXException

renderResult

protected void renderResult(com.mongodb.client.result.DeleteResult deleteResult,
 MessageBuilder messageBuilder)
                     throws SAXException

Throws:

SAXException

addOptionalValue

protected void addOptionalValue(ObjectBuilder builder,
 String name,
 org.bson.BsonValue bsonValue)
                         throws SAXException

Throws:

SAXException

getDocument

protected org.bson.Document getDocument(Message message)
                                 throws IOException

Throws:

IOException

getDocument

protected org.bson.Document getDocument(String message)

getDocuments

protected List<org.bson.Document> getDocuments(Message message)
                                        throws IOException

Throws:

IOException

getDatabase

protected com.mongodb.client.MongoDatabase getDatabase(ParameterValueList pvl)
                                                throws SenderException

Throws:

SenderException

getCollection

protected com.mongodb.client.MongoCollection<org.bson.Document> getCollection(com.mongodb.client.MongoDatabase mongoDatabase,
 ParameterValueList pvl)
                                                                       throws SenderException

Throws:

SenderException

getFilter

protected org.bson.Document getFilter(ParameterValueList pvl,
 Message message)
                               throws IOException,
IllegalArgumentException

Throws:

IOException

IllegalArgumentException

getLimit

protected int getLimit(ParameterValueList pvl)

getPhysicalDestinationName

public String getPhysicalDestinationName()

Specified by:

getPhysicalDestinationName in interface HasPhysicalDestination

setDatasourceName

public void setDatasourceName(String datasourceName)

The MongoDB datasource

Default value

"mongodb.datasource.default"

setDatabase

public void setDatabase(String database)

Database to connect to. Can be overridden by parameter "database"

setCollection

public void setCollection(String collection)

Collection to act upon. Can be overridden by parameter "collection"

setAction

@Mandatory
public void setAction(MongoDbSender.MongoAction action)

Action

setFilter

public void setFilter(String filter)

Filter. Can contain references to parameters between "?{" and "}". Can be overridden by parameter "filter"

setLimit

public void setLimit(int limit)

Limit to number of results returned. A value of 0 means 'no limit'. Can be overridden by parameter "limit".

Default value

0

setCountOnly

public void setCountOnly(boolean countOnly)

Only for find operation: return only the count and not the full document(s)

Default value

false

setOutputFormat

public void setOutputFormat(DocumentFormat outputFormat)

OutputFormat

Default value

JSON

setPrettyPrint

public void setPrettyPrint(boolean prettyPrint)

Format the output in easy legible way (currently only for XML)