Annotation Interface StompPublisher

@Target(TYPE) @Retention(SOURCE) public @interface StompPublisher

Annotation to mark a class as a STOMP publisher.

Instances of classes annotated with @StompPublisher can contain methods annotated with Topic to send messages to specific STOMP destinations. The annotation processor will generate a class that implements the publisher interface, providing methods to send messages to the defined topics. The class has the same name as the annotated interface, with the suffix "Impl" added. It can be instantiated using a constructor that takes a StompClient as a parameter.

The destinationPrefix element allows specifying a common prefix for all destinations used by the publisher. This prefix will be prepended to the destination values defined in the @Topic annotations on the publisher's methods.

The packageName and typeName elements can be used to customize the generated publisher class's package and type names when code generation is involved.

Since:
1.0.0
See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    destinationPrefix
    The common destination prefix for all topics used by this publisher.
    String
    packageName
    The package name for the generated publisher class.
    String
    typeName
    The type name for the generated publisher class.

  • Element Details

    • destinationPrefix

      String destinationPrefix

      The common destination prefix for all topics used by this publisher. This prefix will be prepended to the destination values defined in the Topic annotations on the publisher's methods.

      Default is an empty string, meaning no prefix is applied.

      Returns:
      the destination prefix string
      Since:
      1.0.0
      See Also:
      Default:
      ""

    • packageName

      String packageName
      The package name for the generated publisher class. If not specified, the package of the annotated interface is used.
      Returns:
      the package name
      Since:
      1.0.0
      Default:
      ""

    • typeName

      String typeName
      The type name for the generated publisher class. If not specified, the name of the annotated interface with "Impl" suffix is used.
      Returns:
      the type name
      Since:
      1.0.0
      Default:
      ""