Package org.frankframework.extensions.tibco

Class GetTibcoQueues

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.pipes.TimeoutGuardPipe

org.frankframework.extensions.tibco.GetTibcoQueues

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 GetTibcoQueues
extends TimeoutGuardPipe

Returns information about Tibco queues in a XML string.

If the parameter queueName is empty then

• all Tibco queues including information about these queues are returned

else

• one message on a specific Tibco queue including information about this message is returned (without removing it)

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 The name of the queue which is used for browsing one queue, queueItem The number of the queue message which is used for browsing one queue (default is 1), showAge When set to true and pendingMsgCount>0 and receiverCount=0, the age of the current first message in the queue is shown in the queues overview (default is false), countOnly When set to true and queueName is filled, only the number of pending messages is returned (default is false), ldapUrl When present, principal descriptions are retrieved from this LDAP server

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
GetTibcoQueues()

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()
String	getPassword()
String	getQueueRegex()
String	getUrl()
String	getUsername()
boolean	isHideMessage()
boolean	isSkipTemporaryQueues()
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	setHideMessage(boolean b)	when set to true, the length of the queue message is returned instead of the queue message self (when parameter queueName is not empty)
void	setPassword(String string)	password used in authentication to host
void	setQueueRegex(String string)
void	setSkipTemporaryQueues(boolean b)	when set to true, temporary queues are skipped
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

GetTibcoQueues

public GetTibcoQueues()

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

isSkipTemporaryQueues

public boolean isSkipTemporaryQueues()

setSkipTemporaryQueues

public void setSkipTemporaryQueues(boolean b)

when set to true, temporary queues are skipped

Default value

false

isHideMessage

public boolean isHideMessage()

setHideMessage

public void setHideMessage(boolean b)

when set to true, the length of the queue message is returned instead of the queue message self (when parameter queueName is not empty)

Default value

false

getQueueRegex

public String getQueueRegex()

setQueueRegex

public void setQueueRegex(String string)

setEmsPropertiesFile

public void setEmsPropertiesFile(String propertyFile)

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