net.sourceforge.cruisecontrol.publishers
Class SametimeAnnouncementPublisher

java.lang.Object
  extended bynet.sourceforge.cruisecontrol.publishers.EmailPublisher
      extended bynet.sourceforge.cruisecontrol.publishers.LinkEmailPublisher
          extended bynet.sourceforge.cruisecontrol.publishers.SametimeAnnouncementPublisher
All Implemented Interfaces:
Publisher, java.io.Serializable

public class SametimeAnnouncementPublisher
extends LinkEmailPublisher

Publish (simple) build results by sending a Sametime announcement.

Requires Sametime 3.0 Java Toolkit. See http://www-10.lotus.com/ldd/toolkits
In particular, requires STComm.jar

Author:
Richard Lewis-Shell
See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class net.sourceforge.cruisecontrol.publishers.EmailPublisher
EmailPublisher.Address, EmailPublisher.Alert, EmailPublisher.Always, EmailPublisher.Failure, EmailPublisher.Ignore, EmailPublisher.Success
 
Field Summary
static java.lang.String QUERY_GROUP_CONTENT_FAIL_ERROR
           
static java.lang.String QUERY_GROUP_CONTENT_FAIL_IGNORE
           
static java.lang.String QUERY_GROUP_CONTENT_FAIL_WARN
           
static java.lang.String RESOLVE_CONFLICTS_ERROR
           
static java.lang.String RESOLVE_CONFLICTS_IGNORE
           
static java.lang.String RESOLVE_CONFLICTS_RECIPIENT
           
static java.lang.String RESOLVE_CONFLICTS_WARN
           
static java.lang.String RESOLVE_FAIL_ERROR
           
static java.lang.String RESOLVE_FAIL_IGNORE
           
static java.lang.String RESOLVE_FAIL_WARN
           
 
Constructor Summary
SametimeAnnouncementPublisher()
           
 
Method Summary
protected  java.lang.String createMessage(XMLLogHelper logHelper)
          Creates the email message body.
 java.lang.String getCommunity()
           
 java.lang.String getHandleQueryGroupContentFails()
           
 java.lang.String getHandleResolveConflicts()
           
 java.lang.String getHandleResolveFails()
           
 java.lang.String getHost()
           
 java.lang.String getReturnAddress()
           
 int getSleepMillis()
           
 int getTimeout()
           
 void groupContentQueried(GroupContentEvent groupContentEvent)
           
 boolean isResolveGroups()
           
 boolean isResolveUsers()
           
 boolean isUseGroupContent()
           
 void loggedIn(LoginEvent loginEvent)
           
 void loggedOut(LoginEvent arg0)
           
 void queryGroupContentFailed(GroupContentEvent groupContentEvent)
           
 void resolveConflict(ResolveEvent resolveEvent)
           
 void resolved(ResolveEvent resolveEvent)
           
 void resolveFailed(ResolveEvent resolveEvent)
           
protected  boolean sendMail(java.lang.String toList, java.lang.String subject, java.lang.String message, boolean important)
          Sends an email message.
 void setCommunity(java.lang.String value)
           
 void setHandleQueryGroupContentFails(java.lang.String string)
           
 void setHandleResolveConflicts(java.lang.String value)
           
 void setHandleResolveFails(java.lang.String value)
           
 void setHost(java.lang.String value)
           
 void setResolveGroups(boolean value)
           
 void setResolveUsers(boolean value)
           
 void setSleepMillis(int value)
           
 void setTimeout(int value)
           
 void setUseGroupContent(boolean value)
           
 void validate()
          Called after the configuration is read to make sure that all the mandatory parameters were specified..
 
Methods inherited from class net.sourceforge.cruisecontrol.publishers.EmailPublisher
add, add, addContentToMessage, createAlert, createAlertUserList, createAlertUserSet, createAlways, createEmailString, createFailure, createIgnore, createSubject, createSuccess, createUserList, createUserSet, getBuildResultsURL, getDefaultSuffix, getEmailMapper, getFromAddress, getMailHost, getMailPort, getMailProperties, getPassword, getReturnName, getSubjectPrefix, getUsername, matchRegExpr, publish, setBuildResultsURL, setDefaultSuffix, setFailAsImportant, setMailHost, setMailPort, setPassword, setReportSuccess, setReturnAddress, setReturnName, setSkipUsers, setSpamWhileBroken, setSubjectPrefix, setUsername, setUseSSL, shouldSend
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RESOLVE_CONFLICTS_RECIPIENT

public static final java.lang.String RESOLVE_CONFLICTS_RECIPIENT
See Also:
Constant Field Values

RESOLVE_CONFLICTS_IGNORE

public static final java.lang.String RESOLVE_CONFLICTS_IGNORE
See Also:
Constant Field Values

RESOLVE_CONFLICTS_WARN

public static final java.lang.String RESOLVE_CONFLICTS_WARN
See Also:
Constant Field Values

RESOLVE_CONFLICTS_ERROR

public static final java.lang.String RESOLVE_CONFLICTS_ERROR
See Also:
Constant Field Values

RESOLVE_FAIL_IGNORE

public static final java.lang.String RESOLVE_FAIL_IGNORE
See Also:
Constant Field Values

RESOLVE_FAIL_WARN

public static final java.lang.String RESOLVE_FAIL_WARN
See Also:
Constant Field Values

RESOLVE_FAIL_ERROR

public static final java.lang.String RESOLVE_FAIL_ERROR
See Also:
Constant Field Values

QUERY_GROUP_CONTENT_FAIL_IGNORE

public static final java.lang.String QUERY_GROUP_CONTENT_FAIL_IGNORE
See Also:
Constant Field Values

QUERY_GROUP_CONTENT_FAIL_WARN

public static final java.lang.String QUERY_GROUP_CONTENT_FAIL_WARN
See Also:
Constant Field Values

QUERY_GROUP_CONTENT_FAIL_ERROR

public static final java.lang.String QUERY_GROUP_CONTENT_FAIL_ERROR
See Also:
Constant Field Values
Constructor Detail

SametimeAnnouncementPublisher

public SametimeAnnouncementPublisher()
Method Detail

getHost

public java.lang.String getHost()

setHost

public void setHost(java.lang.String value)

getCommunity

public java.lang.String getCommunity()

setCommunity

public void setCommunity(java.lang.String value)

isResolveUsers

public boolean isResolveUsers()

setResolveUsers

public void setResolveUsers(boolean value)

isResolveGroups

public boolean isResolveGroups()

setResolveGroups

public void setResolveGroups(boolean value)

isUseGroupContent

public boolean isUseGroupContent()

setUseGroupContent

public void setUseGroupContent(boolean value)

getHandleQueryGroupContentFails

public java.lang.String getHandleQueryGroupContentFails()

getHandleResolveConflicts

public java.lang.String getHandleResolveConflicts()

getHandleResolveFails

public java.lang.String getHandleResolveFails()

setHandleQueryGroupContentFails

public void setHandleQueryGroupContentFails(java.lang.String string)

setHandleResolveConflicts

public void setHandleResolveConflicts(java.lang.String value)

setHandleResolveFails

public void setHandleResolveFails(java.lang.String value)

getTimeout

public int getTimeout()

getSleepMillis

public int getSleepMillis()

setTimeout

public void setTimeout(int value)

setSleepMillis

public void setSleepMillis(int value)

getReturnAddress

public java.lang.String getReturnAddress()
Overrides:
getReturnAddress in class EmailPublisher

validate

public void validate()
              throws CruiseControlException
Description copied from interface: Publisher
Called after the configuration is read to make sure that all the mandatory parameters were specified..

Specified by:
validate in interface Publisher
Overrides:
validate in class LinkEmailPublisher
Throws:
CruiseControlException

createMessage

protected java.lang.String createMessage(XMLLogHelper logHelper)
Description copied from class: LinkEmailPublisher
Creates the email message body. This implementation of EmailPublisher just creates a message that is a link to a web page with the details of the build.

Overrides:
createMessage in class LinkEmailPublisher
Returns:
String the link that makes up the body of the email message

sendMail

protected boolean sendMail(java.lang.String toList,
                           java.lang.String subject,
                           java.lang.String message,
                           boolean important)
                    throws CruiseControlException
Description copied from class: EmailPublisher
Sends an email message.

Overrides:
sendMail in class EmailPublisher
Parameters:
toList - comma delimited String of email addresses
subject - subject line for the message
message - body of the message
Returns:
Boolean value indicating if an email was sent.
Throws:
CruiseControlException

loggedIn

public void loggedIn(LoginEvent loginEvent)

loggedOut

public void loggedOut(LoginEvent arg0)

resolveConflict

public void resolveConflict(ResolveEvent resolveEvent)

resolved

public void resolved(ResolveEvent resolveEvent)

resolveFailed

public void resolveFailed(ResolveEvent resolveEvent)

groupContentQueried

public void groupContentQueried(GroupContentEvent groupContentEvent)

queryGroupContentFailed

public void queryGroupContentFailed(GroupContentEvent groupContentEvent)