Package org.frankframework.extensions.tibco

Class SendTibcoMessage

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.pipes.TimeoutGuardPipe

org.frankframework.extensions.tibco.SendTibcoMessage

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, HasTransactionAttribute, IConfigurable, IForwardTarget, IPipe, IScopeProvider, IWithParameters, NameAware, EventThrowing, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle

public class SendTibcoMessage
extends TimeoutGuardPipe

Sends a message to a Tibco queue.

Author:

Peter Leeuwenburgh

Specific parameters

url When a parameter with name url is present, it is used instead of the url specified by the attribute, authAlias When a parameter with name authAlias is present, it is used instead of the authAlias specified by the attribute, username When a parameter with name userName is present, it is used instead of the userName specified by the attribute, password When a parameter with name password is present, it is used instead of the password specified by the attribute, queueName When a parameter with name queueName is present, it is used instead of the queueName specified by the attribute, messageProtocol When a parameter with name messageProtocol is present, it is used instead of the messageProtocol specified by the attribute, replyTimeout When a parameter with name replyTimeout is present, it is used instead of the replyTimeout specified by the attribute, When a parameter with name soapAction is present, it is used instead of the soapAction specified by the attribute

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SendTibcoMessage.MessageProtocol

Field Summary

Fields inherited from class org.frankframework.pipes.AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class org.frankframework.core.TransactionAttributes

log

Fields inherited from interface org.frankframework.core.IPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor	Description
SendTibcoMessage()

Method Summary

Modifier and Type	Method	Description
void	configure()	Checks for correct configuration of forward.
PipeRunResult	doPipeWithTimeoutGuarded(Message input, PipeLineSession session)	doPipe wrapped around a TimeoutGuard
String	getAuthAlias()
SendTibcoMessage.MessageProtocol	getMessageProtocol()
String	getPassword()
String	getQueueName()
int	getReplyTimeout()
String	getSoapAction()
String	getUrl()
String	getUsername()
void	setAuthAlias(String string)	alias used to obtain credentials for authentication to host
void	setEmsPropertiesFile(String propertyFile)	Location to a jndi.properties file for additional EMS (SSL) properties
void	setMessageProtocol(SendTibcoMessage.MessageProtocol string)	Protocol of Tibco service to be called
void	setPassword(String string)	password used in authentication to host
void	setQueueName(String string)	The name of the queue which is used for browsing one queue
void	setReplyTimeout(int i)	Maximum time in milliseconds to wait for a reply. 0 means no timeout.
void	setSoapAction(String string)	If empty then derived from queueName (if $messagingLayer='P2P' then '$applicationFunction' else '$operationName_$operationVersion)
void	setUrl(String string)	URL or base of URL to be used.
void	setUsername(String string)	username used in authentication to host

Methods inherited from class org.frankframework.pipes.TimeoutGuardPipe

doPipe, getTimeout, isThrowException, killPipe, setThrowException, setTimeout

Methods inherited from class org.frankframework.pipes.FixedForwardPipe

getParameterValue, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe

Methods inherited from class org.frankframework.pipes.AbstractPipe

addForward, addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getParameterList, hasRegisteredForward, isRunning, registerEvent, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, sizeStatisticsEnabled, start, stop, throwEvent

Methods inherited from class org.frankframework.core.TransactionAttributes

configureTransactionAttributes, isTransacted, isTransacted, setTransacted, setTransactionTimeout

Methods inherited from class java.lang.Object

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

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.HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Methods inherited from interface org.frankframework.core.IForwardTarget

getName

Methods inherited from interface org.frankframework.core.IPipe

getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getLocker, getLogIntermediaryResults, getMaxThreads, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, setPipeLine, throwEvent

Constructor Details

SendTibcoMessage

public SendTibcoMessage()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from class: FixedForwardPipe

Checks for correct configuration of forward.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class FixedForwardPipe

Throws:

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

doPipeWithTimeoutGuarded

public PipeRunResult doPipeWithTimeoutGuarded(Message input,
 PipeLineSession session)
                                       throws PipeRunException

Description copied from class: TimeoutGuardPipe

doPipe wrapped around a TimeoutGuard

Specified by:

doPipeWithTimeoutGuarded in class TimeoutGuardPipe

Throws:

PipeRunException

getUrl

public String getUrl()

setUrl

public void setUrl(String string)

URL or base of URL to be used. When multiple URLs are defined (comma separated list), the first URL is used of which the server has an active state

getAuthAlias

public String getAuthAlias()

setAuthAlias

public void setAuthAlias(String string)

alias used to obtain credentials for authentication to host

getUsername

public String getUsername()

setUsername

public void setUsername(String string)

username used in authentication to host

getPassword

public String getPassword()

setPassword

public void setPassword(String string)

password used in authentication to host

getQueueName

public String getQueueName()

setQueueName

public void setQueueName(String string)

The name of the queue which is used for browsing one queue

getMessageProtocol

public SendTibcoMessage.MessageProtocol getMessageProtocol()

setMessageProtocol

public void setMessageProtocol(SendTibcoMessage.MessageProtocol string)

Protocol of Tibco service to be called

getReplyTimeout

public int getReplyTimeout()

setReplyTimeout

public void setReplyTimeout(int i)

Maximum time in milliseconds to wait for a reply. 0 means no timeout. (Only for messageProtocol=RR)

Default value

5000

setSoapAction

public void setSoapAction(String string)

If empty then derived from queueName (if $messagingLayer='P2P' then '$applicationFunction' else '$operationName_$operationVersion)

getSoapAction

public String getSoapAction()

setEmsPropertiesFile

public void setEmsPropertiesFile(String propertyFile)

Location to a jndi.properties file for additional EMS (SSL) properties