Package me.ehp246.aufjms.api.annotation

Annotation Interface EnableForJms.Inbound

Enclosing class:

EnableForJms

@Target({})
public static @interface EnableForJms.Inbound

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	EnableForJms.Inbound.From

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
EnableForJms.Inbound.From	value	Destination of the incoming messages.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	autoStartup	Specifies whether the listener should be started automatically.
String	concurrency	Not implemented.
String	connectionFactory	Specifies the name to pass to ConnectionFactoryProvider to eventually retrieve a Connection.
String	invocationListener	Specifies the bean name of the InvocationListener type to receive either Invoked.Completed or Invoked.Failed invocations on this EnableForJms.Inbound.
String	name	The bean name of the endpoint.
Class<?>[]	register	Registers the specified ForJmsType-annotated classes individually.
Class<?>[]	scan	Specifies the packages to scan for ForJmsType classes for this endpoint.

Element Details

value

EnableForJms.Inbound.From value

Destination of the incoming messages.

scan

Class<?>[] scan

Specifies the packages to scan for ForJmsType classes for this endpoint.

By default, the package and the sub-packages of the annotated class will be scanned.

Default:

{}

register

Class<?>[] register

Registers the specified ForJmsType-annotated classes individually.

Default:

{}

concurrency

String concurrency

Not implemented.

Default:

"0"

name

String name

The bean name of the endpoint. Must be unique if specified.

The default name would be in the form of 'inboundEndpoint-${n}' where 'n' is the index from EnableForJms.value() starting at 0.

Does not support Spring property placeholder.

Default:

""

autoStartup

String autoStartup

Specifies whether the listener should be started automatically.

Supports Spring property placeholder.

Default:

"true"

connectionFactory

String connectionFactory

Specifies the name to pass to ConnectionFactoryProvider to eventually retrieve a Connection.

Default:

""

invocationListener

String invocationListener

Specifies the bean name of the InvocationListener type to receive either Invoked.Completed or Invoked.Failed invocations on this EnableForJms.Inbound.

If the execution of a ForJmsType object on this EnableForJms.Inbound completes normally, the InvocationListener.OnCompleted.onCompleted(Completed) will be invoked.

If the execution of a ForJmsType object on this EnableForJms.Inbound throws an exception, the InvocationListener.OnFailed.onFailed(Failed) will be invoked.

If the invocation of the bean completes without an exception, the Message will be acknowledged to the broker as a success.

InvocationListener.OnFailed can throw Exception in which case the message follows broker's dead-lettering process.

The listener bean is designed to support ForJmsType objects. It applies only after a matching ForJmsType class has been found. E.g., the bean will not be invoked for basic JMSException prior to Message.getJMSType() matching, i.e., UnknownTypeException.

If a RuntimeException happens from the bean during execution, the Message will follow broker's dead-lettering process.

Supports Spring property placeholder.

Default:

""