com.adaptris.core.iron

Class IronConsumer

java.lang.Object

com.adaptris.core.AdaptrisMessageWorkerImp

com.adaptris.core.AdaptrisMessageConsumerImp

com.adaptris.core.AdaptrisPollingConsumer

com.adaptris.core.iron.IronConsumer

All Implemented Interfaces:

AdaptrisComponent, AdaptrisMessageConsumer, AdaptrisMessageWorker, ComponentLifecycle, ComponentLifecycleExtension, MessageEventGenerator, StateManagedComponent

@ComponentProfile(summary="Receive Messages from IronMQ",
                  tag="consumer,ironmq",
                  recommended=com.adaptris.core.NullConnection.class)
public class IronConsumer
extends AdaptrisPollingConsumer

An Interlok Adapter consumer implementation for IronMQ.

This class wraps an Iron Client.

In the adapter configuration file this class is aliased as ironmq-consumer which is the preferred alternative to the fully qualified classname when building your configuration.

License Required: STANDARD

Nested Class Summary

Nested classes/interfaces inherited from class com.adaptris.core.AdaptrisPollingConsumer

AdaptrisPollingConsumer.LockOperator

Field Summary

Fields inherited from interface com.adaptris.core.MessageEventGenerator

CONFIRMATION_ID_KEY

Constructor Summary

Constructors

Constructor and Description
IronConsumer() Basic constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCloud() The Iron MQ cloud to communicate with.
java.lang.String	getProject() The Iron MQ project to communicate with.
java.lang.Integer	getReceiveMessages() Get the number of message read at a time from the broker.
java.lang.Integer	getTimeout() The message's timeout in seconds.
java.lang.String	getToken() The Iron MQ project token.
protected void	prepareConsumer()
protected int	processMessages()
void	setCloud(java.lang.String cloud) The Iron MQ cloud to communicate with.
void	setProject(java.lang.String project) The Iron MQ project to communicate with.
void	setReceiveMessages(java.lang.Integer receiveMessages) Set the number of message read at a time from the broker.
void	setTimeout(java.lang.Integer timeout) The message's timeout in seconds.
void	setToken(java.lang.String token) The Iron MQ project token.

Methods inherited from class com.adaptris.core.AdaptrisPollingConsumer

close, continueProcessingMessages, getMaxMessagesPerPoll, getPoller, getReacquireLockBetweenMessages, init, prepare, releaseLock, setMaxMessagesPerPoll, setPoller, setReacquireLockBetweenMessages, start, stop

Methods inherited from class com.adaptris.core.AdaptrisMessageConsumerImp

changeState, getDestination, registerAdaptrisMessageListener, renameThread, requestClose, requestInit, requestStart, requestStop, retrieveAdaptrisMessageListener, retrieveComponentState, setDestination

Methods inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

createName, createQualifier, decode, encode, getEncoder, getIsTrackingEndpoint, getMessageFactory, getUniqueId, handleConnectionException, isTrackingEndpoint, registerConnection, registerEncoderMessageFactory, retrieveConnection, setEncoder, setIsTrackingEndpoint, setMessageFactory, setUniqueId, withMessageFactory

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.core.AdaptrisMessageConsumer

consumeLocationKey

Methods inherited from interface com.adaptris.core.AdaptrisMessageWorker

decode, encode, getEncoder, getMessageFactory, handleConnectionException, registerConnection, retrieveConnection, setEncoder, setMessageFactory

Methods inherited from interface com.adaptris.core.AdaptrisComponent

getUniqueId

Methods inherited from interface com.adaptris.core.MessageEventGenerator

createName, createQualifier, isTrackingEndpoint

Constructor Detail

IronConsumer

public IronConsumer()

Basic constructor.

Method Detail

processMessages

protected int processMessages()

Specified by:

processMessages in class AdaptrisPollingConsumer

prepareConsumer

protected void prepareConsumer()
                        throws CoreException

Specified by:

prepareConsumer in class AdaptrisPollingConsumer

Throws:

CoreException

getCloud

public java.lang.String getCloud()

The Iron MQ cloud to communicate with.

Returns:

cloud

setCloud

public void setCloud(java.lang.String cloud)

The Iron MQ cloud to communicate with.

Parameters:

cloud - Generally ironAWSUSEast

getProject

public java.lang.String getProject()

The Iron MQ project to communicate with.

Returns:

project

setProject

public void setProject(java.lang.String project)

The Iron MQ project to communicate with.

Parameters:

project -

getToken

public java.lang.String getToken()

The Iron MQ project token.

Returns:

token

setToken

public void setToken(java.lang.String token)

The Iron MQ project token.

Parameters:

token - may be encoded using Password.encode(String, String)

getTimeout

public java.lang.Integer getTimeout()

The message's timeout in seconds.

Returns:

timeout in seconds

setTimeout

public void setTimeout(java.lang.Integer timeout)

The message's timeout in seconds.

Parameters:

timeout - in seconds

getReceiveMessages

public java.lang.Integer getReceiveMessages()

Get the number of message read at a time from the broker.

Returns:

receiveMessages

setReceiveMessages

public void setReceiveMessages(java.lang.Integer receiveMessages)

Set the number of message read at a time from the broker.

Parameters:

receiveMessages -