com.sapportals.wcm.util.channels

Class AbstractChannel

java.lang.Object
  com.sapportals.wcm.util.channels.AbstractChannel

All Implemented Interfaces:

IChannel

public abstract class AbstractChannel
extends Object
implements IChannel

Base class for IChannel -implementations.
The AbstractChannel implements some generic behavior for loading configuration data and retrieving a standard channel description from the channel's type.

See Also:

IChannel

Field Summary

protected static Location	_log log.
protected static ResourceBundles	_res resource bundles.
static String	ENCODING encoding to use as default for messages.
protected String	m_ID The system id for this channel.
protected Properties	m_Properties The properties for this channel.

Constructor Summary

protected

AbstractChannel(String id, Properties properties) Create a channel with a specific id from the given properties.

Method Summary

boolean	equals(Object object) Checks if this channel is equal to a given channel.
String	getDescription() Get the displayable name.
String	getDescription(Locale locale) Get the displayable name for the given locale.
MimeMessage	getEmptyMessage() Get an empty mime message for this channel.
String	getID() Get the system id for this channel.
abstract String	getRecipientAddress(IRecipient recipient) Get the address for the specified recipient.
abstract String	getType() Get the type for this channel.
void	sendTo(String[] addresses, String from, MimeMessage mimemessage) Send a mime message via this channel.
void	sendTo(String[] addresses, String from, String title, String messagetext, String type) Send a message via this channel to the given addresses.
void	sendTo(String[] addresses, String from, String title, String messagetext, String type, String encoding) Send a message via this channel to the given addresses.
abstract void	sendTo(String address, String from, MimeMessage mimemessage) Send a mime message via this channel to the given recipient.
abstract void	sendTo(String address, String from, String title, String messagetext, String type) Send a message via this channel to the given address.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sapportals.wcm.util.channels.IChannel

sendTo

Field Detail

ENCODING

public static final String ENCODING

encoding to use as default for messages. The default value given can be overridden by the caller

See Also:

Constant Field Values

_log

protected static Location _log

log.

_res

protected static ResourceBundles _res

resource bundles.

m_ID

protected String m_ID

The system id for this channel.

m_Properties

protected Properties m_Properties

The properties for this channel.

Constructor Detail

AbstractChannel

protected AbstractChannel(String id,
                          Properties properties)
                   throws WcmException

Create a channel with a specific id from the given properties.

Parameters:

id - a String with the system id for this channel.

properties - a Properties with the properties for this channel.

Throws:

WcmException - if the channel could not be created.

Method Detail

getType

public abstract String getType()

Get the type for this channel.

Specified by:

getType in interface IChannel

Returns:

String is the channel's type (see ChannelFactory).

See Also:

ChannelFactory

equals

public boolean equals(Object object)

Checks if this channel is equal to a given channel.

Overrides:

equals in class Object

Parameters:

object - The object to compare this AbstractChannel against

Returns:

true if both channels are equal; false if not.

getID

public String getID()

Get the system id for this channel.

Specified by:

getID in interface IChannel

Returns:

String is the channel's id.

getDescription

public String getDescription()

Get the displayable name.

Specified by:

getDescription in interface IChannel

Returns:

String is the channel's name.

getDescription

public String getDescription(Locale locale)

Get the displayable name for the given locale.

Specified by:

getDescription in interface IChannel

Parameters:

locale - a Locale to get the localized description of this channel.

Returns:

String is the channel's name for the given locale.

getRecipientAddress

public abstract String getRecipientAddress(IRecipient recipient)
                                    throws WcmException

Get the address for the specified recipient.

Specified by:

getRecipientAddress in interface IChannel

Parameters:

recipient - a IRecipient to find the address of.

Returns:

String is the address of the given recipient for this channel.

Throws:

WcmException - if the recipient's address for this channel can't be resolved.

getEmptyMessage

public MimeMessage getEmptyMessage()
                            throws WcmException

Get an empty mime message for this channel.

Specified by:

getEmptyMessage in interface IChannel

Returns:

an empty MimeMessage for this channel.

Throws:

WcmException - if there was an error while creating the mime message.

sendTo

public abstract void sendTo(String address,
                            String from,
                            String title,
                            String messagetext,
                            String type)
                     throws WcmException

Send a message via this channel to the given address.

Specified by:

sendTo in interface IChannel

Parameters:

address - a String with the address of the recipient.

from - a String with the sender's address in the proper format for the channel.

title - a String with the title for the message.

messagetext - a String with the message text to send.

type - a String with the type of message, for example text/plain .

Throws:

WcmException - Exception raised in failure situation

sendTo

public void sendTo(String[] addresses,
                   String from,
                   String title,
                   String messagetext,
                   String type)
            throws WcmException

Send a message via this channel to the given addresses.

Specified by:

sendTo in interface IChannel

Parameters:

addresses - an array of String addresses of the recipients.

from - a String with the sender's address in the proper format for the channel.

title - a String with the title for the message.

messagetext - a String with the message text to send.

type - a String with the type of message, for example text/plain .

Throws:

WcmException - Exception raised in failure situation

sendTo

public void sendTo(String[] addresses,
                   String from,
                   String title,
                   String messagetext,
                   String type,
                   String encoding)
            throws WcmException

Send a message via this channel to the given addresses.

Specified by:

sendTo in interface IChannel

Parameters:

addresses - an array of String addresses of the recipients.

from - a String with the sender's address in the proper format for the channel.

title - a String with the title for the message.

messagetext - a String with the message text to send.

type - a String with the type of message, for example text/plain .

encoding - a String with the encoding to use for the message.

Throws:

WcmException - Exception raised in failure situation

sendTo

public abstract void sendTo(String address,
                            String from,
                            MimeMessage mimemessage)
                     throws WcmException

Send a mime message via this channel to the given recipient.

Specified by:

sendTo in interface IChannel

Parameters:

address - a String with the address of the recipient.

from - a String with the address of the recipient.

mimemessage - a MimeMessage with the mime message to send.

Throws:

WcmException - Exception raised in failure situation

sendTo

public void sendTo(String[] addresses,
                   String from,
                   MimeMessage mimemessage)
            throws WcmException

Send a mime message via this channel.

Specified by:

sendTo in interface IChannel

Parameters:

addresses - an array of String addresses of the recipients.

from - a String with the address of the recipient.

mimemessage - a MimeMessage with the mime message to send.

Throws:

WcmException - Exception raised in failure situation

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM