*** This API provides Binary Compatibility only, not Source Compatibility ***

com.sas.services.publish.alerts
Interface AlertTransportInterface

All Known Subinterfaces:

DAVAlertTransportInterface, MailAlertTransportInterface

public interface AlertTransportInterface

The AlertTransportInterface provides common behavior for delivery transports when sending alert notification messages. An alert delivery transport is a method of delivering an alert notification. How the notification is delivered is transport-specific.

Since:

1.1.4

Method Summary

LoggerInterface	getLogger() Returns the logger that is being used by the Publish Services to log publish activities.
void	send(TemplateInterface template) Send the alert notification.
void	setLogger(LoggerInterface logger) Set the logger to be used by the Publish Services when logging publish activities.

Method Detail

send

public void send(TemplateInterface template)
          throws TransportException,
                 IllegalArgumentException

Send the alert notification. Merge variables can be provided with the template information. The delivery transport will perform the template substitutions, and then delivery the resulting alert notification.

Parameters:

template - The template.

Throws:

TransportException - If an error occurs sending the alert notification.

IllegalArgumentException - If a null template is specified.

setLogger

public void setLogger(LoggerInterface logger)

Set the logger to be used by the Publish Services when logging publish activities.

Parameters:

logger - The logger.

getLogger

public LoggerInterface getLogger()

Returns the logger that is being used by the Publish Services to log publish activities.

Returns:

LoggerInterface The logger that is being used by the publish services for logging purposes.

*** This API provides Binary Compatibility only, not Source Compatibility ***