Package com.evolveum.midpoint.notifications.api.transports

Interface Transport<C extends GeneralTransportConfigurationType>

Type Parameters:
C - configuration type related to the transport
public interface Transport<C extends GeneralTransportConfigurationType>
Contract for a message transport instance, which is mostly SPI type contract. Transport should not be used directly, TransportService should be used instead.

  • Method Details

    • configure

      void configure(@NotNull C configuration, @NotNull @NotNull TransportSupport transportSupport)
      Configures transport instance - this must be fast and exception free. This is not the place to start any connections or sessions; this is called after sysconfig is changed.
      Parameters:
      configuration - portion of the configuration relevant to this transport
      transportSupport - support object with dependencies

    • send

      void send(Message message, @Deprecated String transportName, SendingContext ctx, OperationResult parentResult)
      Sends the message via this transport. TODO: * transportName is used only by some legacy transports when key:subname style is used, it will be removed; * event should be delivered differently, for other message sources (e.g. report email) there is no event, but there may be other object of interest (the report itself?); * it would be best to deliver some "context" information to facilitate customizations on various levels, e.g. to inform that notifications need to be redirected to different file than configured in the transport config.

    • getDefaultRecipientAddress

      String getDefaultRecipientAddress(FocusType recipient)

    • getName

      String getName()

    • getConfiguration

      C getConfiguration()