Class NoRetries
- java.lang.Object
-
- com.adaptris.core.NoRetries
-
- All Implemented Interfaces:
AdaptrisComponent
,ComponentLifecycle
,ComponentLifecycleExtension
,FailedMessageRetrier
@ComponentProfile(summary="The default NO-OP failed message retrier implementation", tag="error-handling,base") public class NoRetries extends java.lang.Object implements FailedMessageRetrier
This is a dummy for marshalling purposes.In the adapter configuration file this class is aliased as no-retries which is the preferred alternative to the fully qualified classname when building your configuration.
-
-
Constructor Summary
Constructors Constructor Description NoRetries()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addWorkflow(Workflow workflow)
Add a Workflow to the internal register of workflowsvoid
clearWorkflows()
Clear the internal store of workflows.void
close()
Closes the component.java.lang.String
getUniqueId()
Get the unique-id that is associated with this component.void
init()
Initialises the component.void
prepare()
Prepare for initialisation.java.util.Collection<java.lang.String>
registeredWorkflowIds()
Return the list of workflow-ids registered.void
setUniqueId(java.lang.String uniqueId)
void
start()
Starts the component.void
stop()
Stop the component
-
-
-
Method Detail
-
addWorkflow
public void addWorkflow(Workflow workflow)
Description copied from interface:FailedMessageRetrier
Add a Workflow to the internal register of workflowsAdd a Workflow to the internal store. If the generated key is not unique aCoreException is thrown.
- Specified by:
addWorkflow
in interfaceFailedMessageRetrier
- Parameters:
workflow
- the workflow to add
-
close
public void close()
Description copied from interface:ComponentLifecycle
Closes the component.A closed component should release any connections it uses, etc. and clean up completely. Throwing a
RuntimeException
may cause unintended consequences- Specified by:
close
in interfaceComponentLifecycle
-
init
public void init() throws CoreException
Description copied from interface:ComponentLifecycle
Initialises the component.Component initialisation includes config verification, creation of connections etc.
- Specified by:
init
in interfaceComponentLifecycle
- Throws:
CoreException
- wrapping any underlyingException
s
-
start
public void start() throws CoreException
Description copied from interface:ComponentLifecycle
Starts the component.Once a component is started it should be ready to process messages. In the case of
AdaptrisMessageConsumer
, calling start will begin message delivery.- Specified by:
start
in interfaceComponentLifecycle
- Throws:
CoreException
- wrapping any underlyingException
s
-
stop
public void stop()
Description copied from interface:ComponentLifecycle
Stop the componentA stopped component is not expected to be ready to process messages. In the case of
AdaptrisMessageConsumer
, calling stop will pause message delivery. Throwing aRuntimeException
may cause unintended consequences- Specified by:
stop
in interfaceComponentLifecycle
-
clearWorkflows
public void clearWorkflows()
Description copied from interface:FailedMessageRetrier
Clear the internal store of workflows.- Specified by:
clearWorkflows
in interfaceFailedMessageRetrier
-
registeredWorkflowIds
public java.util.Collection<java.lang.String> registeredWorkflowIds()
Description copied from interface:FailedMessageRetrier
Return the list of workflow-ids registered.- Specified by:
registeredWorkflowIds
in interfaceFailedMessageRetrier
- Returns:
- collection containing a list of all the workflow unique-ids.
-
prepare
public void prepare() throws CoreException
Description copied from interface:ComponentLifecycleExtension
Prepare for initialisation.- Specified by:
prepare
in interfaceComponentLifecycleExtension
- Throws:
CoreException
-
getUniqueId
public java.lang.String getUniqueId()
Description copied from interface:AdaptrisComponent
Get the unique-id that is associated with this component.- Specified by:
getUniqueId
in interfaceAdaptrisComponent
- Returns:
- the unique-id
-
setUniqueId
public void setUniqueId(java.lang.String uniqueId)
-
-