Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
com.sapportals.wcm.util.channels

Class AbstractChannel

java.lang.Object
  extended bycom.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 - TBD: Description of the incoming method parameter
properties - TBD: Description of the incoming method parameter
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.

Parameters:
object - TBD: Description of the incoming method parameter
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 - TBD: Description of the incoming method parameter
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 - TBD: Description of the incoming method parameter
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 - TBD: Description of the incoming method parameter
from - TBD: Description of the incoming method parameter
title - TBD: Description of the incoming method parameter
messagetext - TBD: Description of the incoming method parameter
type - TBD: Description of the incoming method parameter
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 - TBD: Description of the incoming method parameter
from - TBD: Description of the incoming method parameter
title - TBD: Description of the incoming method parameter
messagetext - TBD: Description of the incoming method parameter
type - TBD: Description of the incoming method parameter
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 - TBD: Description of the incoming method parameter
from - TBD: Description of the incoming method parameter
title - TBD: Description of the incoming method parameter
messagetext - TBD: Description of the incoming method parameter
type - TBD: Description of the incoming method parameter
encoding - TBD: Description of the incoming method parameter
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 - TBD: Description of the incoming method parameter
from - TBD: Description of the incoming method parameter
mimemessage - TBD: Description of the incoming method parameter
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 - TBD: Description of the incoming method parameter
from - TBD: Description of the incoming method parameter
mimemessage - TBD: Description of the incoming method parameter
Throws:
WcmException - Exception raised in failure situation
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright 2006 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. MaxDB is a trademark of MySQL AB, Sweden. SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.