com.jivesoftware.forum.database
Class EmailWatchMessageWrapper

java.lang.Object
  com.jivesoftware.forum.database.EmailWatchMessageWrapper

All Implemented Interfaces:

JiveObject, Watchable, ForumMessage, JiveContentObject, Taggable

public class EmailWatchMessageWrapper
extends java.lang.Object
implements ForumMessage

Field Summary

Fields inherited from interface com.jivesoftware.forum.JiveContentObject

PLAIN_STRATEGY

Constructor Summary

EmailWatchMessageWrapper(ForumMessage wrappedMessage)

Method Summary

Attachment	createAttachment(java.lang.String name, java.lang.String contentType, java.io.InputStream data) Creates a new attachment for this message.
void	deleteAttachment(Attachment attachment) Deletes an attachment that belongs to this message.
void	deleteProperty(java.lang.String name) Deletes an extended property.
boolean	equals(java.lang.Object o)
int	getAttachmentCount() Returns the number of attachments this message has.
java.util.Iterator	getAttachments() Returns an Iterator for all the attachments of this message.
java.lang.String	getBody() Returns the message body.
java.util.Date	getCreationDate() Returns the date this message was created.
Forum	getForum() Returns the forum this message belongs to.
int	getForumIndex() Returns the index of this message in the forum.
ForumThread	getForumThread() Returns the thread this message belongs to.
long	getID() Retrieve the unique identifier for the jive object.
int	getModerationValue() Returns the number of moderation points this message has.
java.util.Date	getModificationDate() Returns the date this message was last modified.
int	getObjectType() Return the object type of the jive object.
ForumMessage	getParentMessage() Returns the parent message of this message or null if this message is the root message of a thread.
java.lang.String	getPlainBody() Returns the message body with no html markup applied.
java.lang.String	getPlainSubject() Returns the message subject with no html markup applied.
java.util.Collection	getProperties(java.lang.String parentName) Return all immediate children property values of a parent property as an unmodifiable Collection of String values.
java.lang.String	getProperty(java.lang.String name) Returns an extended property of this message.
java.util.Iterator	getPropertyNames() Returns an Iterator of String values for all the names of the message properties.
java.lang.String	getSubject() Returns the message subject.
TagDelegator	getTagDelegator() Retrieve a tag delegator to manage message tags.
java.lang.String	getUnfilteredBody() Returns the message body, bypassing any active filters.
java.lang.String	getUnfilteredProperty(java.lang.String name) Returns an extended property of this message, bypassing any filters.
java.lang.String	getUnfilteredSubject() Returns the message subject, bypassing any active filters.
User	getUser() Returns the User that authored this message.
int	hashCode()
boolean	isAnonymous() Returns true if this message was posted anonymously.
boolean	isAuthorized(long permissionType) Returns true if the handle on this object has the permission specified.
boolean	isHtml() Returns true if this body of this message contains HTML.
void	setBody(java.lang.String body) Sets the body of this message.
void	setCreationDate(java.util.Date creationDate) Sets the creation date of this message.
void	setModerationValue(int value, AuthToken authToken) Sets the number of moderation points this message has.
void	setModificationDate(java.util.Date modificationDate) Sets the date this message was last modified.
void	setProperty(java.lang.String name, java.lang.String value) Sets an extended property of this message.
void	setSubject(java.lang.String subject) Sets the subject of this message.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailWatchMessageWrapper

public EmailWatchMessageWrapper(ForumMessage wrappedMessage)

Method Detail

getID

public long getID()

Description copied from interface: JiveObject

Retrieve the unique identifier for the jive object.

Specified by:

getID in interface JiveObject

Specified by:

getID in interface ForumMessage

Returns:

the unique identifier for the jive object.

getForumIndex

public int getForumIndex()

Description copied from interface: ForumMessage

Returns the index of this message in the forum. The forum index is a sequential, incrementing value assigned to a message when it is added to a forum. Therefore, ordering messages by forum index is generally equivalent to ordering by creation date. There are exceptions to this rule, however; for example, when a message is moved from one forum to another it will get the next available forum index so will be out of creation date order.

Once a forum index is assigned to a message, that value is never re-used. Therefore, there will be gaps in the forum index values as messages are deleted, archived, or moved.

Forum index values are primarily provided to support an NNTP-centric view of forums, since the NNTP protocol requires article numbers (forum indexes) inside a newsgroup (forum).

Specified by:

getForumIndex in interface ForumMessage

Returns:

the forumIndex of this message.

getCreationDate

public java.util.Date getCreationDate()

Description copied from interface: ForumMessage

Returns the date this message was created.

Specified by:

getCreationDate in interface ForumMessage

Specified by:

getCreationDate in interface JiveContentObject

Returns:

the date this message was created.

setCreationDate

public void setCreationDate(java.util.Date creationDate)
                     throws UnauthorizedException

Description copied from interface: ForumMessage

Sets the creation date of this message. In most cases, the creation date will default to when the message was entered into the system. However, the creation date needs to be set manually when importing messages. In other words, skin authors should ignore this method since it only intended for system maintenance.

Specified by:

setCreationDate in interface ForumMessage

Parameters:

creationDate - the date this message was created.

Throws:

UnauthorizedException - if does not have ADMIN permissions.

getModificationDate

public java.util.Date getModificationDate()

Description copied from interface: ForumMessage

Returns the date this message was last modified. When a message is first created, the date returned by this method is identical to the creation date. The modified date is updated every time a message property is updated, such as the message body.

Specified by:

getModificationDate in interface ForumMessage

Specified by:

getModificationDate in interface JiveContentObject

Returns:

the date this message was last modified.

setModificationDate

public void setModificationDate(java.util.Date modificationDate)
                         throws UnauthorizedException

Description copied from interface: ForumMessage

Sets the date this message was last modified. In most cases, last modifed will default to when the message data was last changed. However, the last modified date needs to be set manually when importing messages. In other words, skin authors should ignore this method since it only intended for system maintenance.

Specified by:

setModificationDate in interface ForumMessage

Parameters:

modificationDate - the date this message was modified.

Throws:

UnauthorizedException - if not allowed to edit the message.

getSubject

public java.lang.String getSubject()

Description copied from interface: ForumMessage

Returns the message subject. If message filters are active, the subject returned will be a filtered one. Because filters often provide security functionality, this method is the preferred way to get the subject of a message.

Specified by:

getSubject in interface ForumMessage

Specified by:

getSubject in interface JiveContentObject

Returns:

the subject of this message.

getPlainSubject

public java.lang.String getPlainSubject()

Description copied from interface: ForumMessage

Returns the message subject with no html markup applied. If message filters are active, the subject returned will be a filtered one with no html markup applied.

Specified by:

getPlainSubject in interface ForumMessage

Specified by:

getPlainSubject in interface JiveContentObject

Returns:

the subject of the message with no html markup applied

getUnfilteredSubject

public java.lang.String getUnfilteredSubject()

Description copied from interface: ForumMessage

Returns the message subject, bypassing any active filters. Because filters often provide security, this method should be used with caution. In particular, you should avoid showing unfiltered data in an environment where embedded HTML might be interpreted.

Unfiltered content is necessary for a few reasons. One is when saving Jive content to another persistence mechanism such as an XML format. Another is when you need to skip filter formatting, such as when a user is responding to another user's message.

Specified by:

getUnfilteredSubject in interface ForumMessage

Specified by:

getUnfilteredSubject in interface JiveContentObject

Returns:

the subject of this message.

setSubject

public void setSubject(java.lang.String subject)
                throws UnauthorizedException

Description copied from interface: ForumMessage

Sets the subject of this message.

Specified by:

setSubject in interface ForumMessage

Parameters:

subject - the subject of this message.

Throws:

UnauthorizedException - if not allowed to edit this message.

getBody

public java.lang.String getBody()

Description copied from interface: ForumMessage

Returns the message body. If message filters are active, the body returned will be a filtered one. Because filters often provide security functionality such as stripping out HTML and Javascript, this method is the preferred way to get the body of a message.

Specified by:

getBody in interface ForumMessage

Specified by:

getBody in interface JiveContentObject

Returns:

the body of this message.

getPlainBody

public java.lang.String getPlainBody()

Description copied from interface: ForumMessage

Returns the message body with no html markup applied. If message filters are active, the body returned will be a filtered one with no html markup applied.

Specified by:

getPlainBody in interface ForumMessage

Specified by:

getPlainBody in interface JiveContentObject

Returns:

the body of the message with no html markup applied

getUnfilteredBody

public java.lang.String getUnfilteredBody()

Description copied from interface: ForumMessage

Returns the message body, bypassing any active filters. Because filters often provide security, this method should be used with caution. In particular, you should avoid showing unfiltered data in an environment where embedded HTML might be interpreted.

Unfiltered content is necessary for a few reasons. One is when saving Jive content to another persistence mechanism such as an XML format. Another is when you need to skip filter formatting, such as when a user is responding to another user's message.

Specified by:

getUnfilteredBody in interface ForumMessage

Specified by:

getUnfilteredBody in interface JiveContentObject

Returns:

the unfiltered body of this message.

setBody

public void setBody(java.lang.String body)
             throws UnauthorizedException

Description copied from interface: ForumMessage

Sets the body of this message.

Specified by:

setBody in interface ForumMessage

Parameters:

body - the body of this message.

Throws:

UnauthorizedException - if does not allowed to edit this message.

getUser

public User getUser()

Description copied from interface: ForumMessage

Returns the User that authored this message. If the message was created anonymously, this method will return null.

Specified by:

getUser in interface ForumMessage

Specified by:

getUser in interface JiveContentObject

Returns:

the author of the message.

getParentMessage

public ForumMessage getParentMessage()

Description copied from interface: ForumMessage

Returns the parent message of this message or null if this message is the root message of a thread. See TreeWalker for similiar functionality.

Specified by:

getParentMessage in interface ForumMessage

Returns:

the parent message of this message or null if this message is a root message

createAttachment

public Attachment createAttachment(java.lang.String name,
                                   java.lang.String contentType,
                                   java.io.InputStream data)
                            throws AttachmentException,
                                   UnauthorizedException

Description copied from interface: ForumMessage

Creates a new attachment for this message. Each attachment has a name, content type and binary data. Rules about who can create attachments and what kind attachments are allowed are controlled via an AttachmentManager.

Specified by:

createAttachment in interface ForumMessage

Parameters:

name - the name of the new attachment, usually the file name.

contentType - the content type of the attachment.

data - an InputStream that contains the binary data of the attachment. The stream will never be closed so you must close it manually after calling this method.

Returns:

an Attachment object representing the new attachment created.

Throws:

AttachmentException - if an error occured while creating the attachment. Errors can occur because the attachment is too large or because the message already has too many attachments.

UnauthorizedException - if not allowed to create attachments.

See Also:

Attachment, AttachmentManager

getAttachmentCount

public int getAttachmentCount()

Description copied from interface: ForumMessage

Returns the number of attachments this message has.

Specified by:

getAttachmentCount in interface ForumMessage

Returns:

the number of attachments this message has.

deleteAttachment

public void deleteAttachment(Attachment attachment)
                      throws AttachmentException,
                             UnauthorizedException

Description copied from interface: ForumMessage

Deletes an attachment that belongs to this message. Only administrators or the creator of this message are allowed to call this method.

Specified by:

deleteAttachment in interface ForumMessage

Parameters:

attachment - the attachment to delete.

Throws:

AttachmentException - if there was an error deleting the attachment.

UnauthorizedException - if not authorized to delete the attachment.

getAttachments

public java.util.Iterator getAttachments()

Description copied from interface: ForumMessage

Returns an Iterator for all the attachments of this message.

Specified by:

getAttachments in interface ForumMessage

Returns:

an Iterator for the message's attachments.

See Also:

Attachment

getModerationValue

public int getModerationValue()

Description copied from interface: ForumMessage

Returns the number of moderation points this message has. The default moderation value is determined by the forum this message belongs to: Forum.getModerationDefaultMessageValue()

If the moderation value is less than JiveConstants.FORUM_MODERATION_VISIBLE then the message will not be displayed by default.

Specified by:

getModerationValue in interface ForumMessage

Returns:

the number of moderation points the message has.

setModerationValue

public void setModerationValue(int value,
                               AuthToken authToken)
                        throws UnauthorizedException

Description copied from interface: ForumMessage

Sets the number of moderation points this message has. If the moderation value is less than than JiveConstants.FORUM_MODERATION_VISIBLE, then a number of things will happen:

• The message will not be visible in the thread by default.
• The thread and forum of the message will not have their modified date's updated.
• The message will not be exported to installed gateways.
• Watch updates will not be triggered.

When calling this method results in a message to go from below the minimum visible threshold to above, then the actions listed above will all be executed. Any change of the moderation value also results in the modified date of the message being updated.

Only administrators and moderators can call this method.

The authToken token of the user must be passed into this method as a paramater for moderation auditing purposes.

Specified by:

setModerationValue in interface ForumMessage

Parameters:

value - the number of moderation points for the message.

authToken - the AuthToken token of the user that is making the moderation decision.

Throws:

UnauthorizedException - if does not have ADMIN, MODERATE_MESSAGES or MODERATE_THREADS permissions.

See Also:

Gateway, WatchManager

getProperty

public java.lang.String getProperty(java.lang.String name)

Description copied from interface: ForumMessage

Returns an extended property of this message. Each message can have an arbitrary number of extended properties. This lets particular skins or filters provide enhanced functionality that is not part of the base interface.

For security reasons, you should enable an HTML filter in case properties contain malicious HTML code.

Specified by:

getProperty in interface ForumMessage

Parameters:

name - the name of the property to get.

Returns:

the value of the property.

getProperties

public java.util.Collection getProperties(java.lang.String parentName)

Description copied from interface: ForumMessage

Return all immediate children property values of a parent property as an unmodifiable Collection of String values. A parent/child relationship is denoted by the "." character. For example, given the properties X.Y.A, X.Y.B, X.Y.C and X.Y.C.D, then the immediate child properties of X.Y are X.Y.A, X.Y.B, and X.Y.C (the value of X.Y.C.D would not be returned using this method).

Specified by:

getProperties in interface ForumMessage

Parameters:

parentName - the name of the parent property to return the children for.

Returns:

all Collection of all child property values for the given parent.

getUnfilteredProperty

public java.lang.String getUnfilteredProperty(java.lang.String name)

Description copied from interface: ForumMessage

Returns an extended property of this message, bypassing any filters. Each message can have an arbitrary number of extended properties. This lets particular skins or filters provide enhanced functionality that is not part of the base interface.

Because properties are not filtered before being returned, this method should be used with caution. In particular, you should avoid showing unfiltered data in an environment where embedded HTML might be interpreted.

Specified by:

getUnfilteredProperty in interface ForumMessage

Parameters:

name - the name of the property to get.

Returns:

the value of the property.

setProperty

public void setProperty(java.lang.String name,
                        java.lang.String value)
                 throws UnauthorizedException

Description copied from interface: ForumMessage

Sets an extended property of this message. Each message can have an arbitrary number of extended properties. This lets particular skins or filters provide enhanced functionality that is not part of the base interface.

Specified by:

setProperty in interface ForumMessage

Parameters:

name - the name of the property to set.

value - the new value for the property.

Throws:

UnauthorizedException - if not allowed to edit the message.

deleteProperty

public void deleteProperty(java.lang.String name)
                    throws UnauthorizedException

Description copied from interface: ForumMessage

Deletes an extended property. If the property specified by name does not exist, this method will do nothing.

Specified by:

deleteProperty in interface ForumMessage

Parameters:

name - the name of the property to delete.

Throws:

UnauthorizedException - if not allowed to edit the message.

getPropertyNames

public java.util.Iterator getPropertyNames()

Description copied from interface: ForumMessage

Returns an Iterator of String values for all the names of the message properties.

Specified by:

getPropertyNames in interface ForumMessage

Returns:

an Iterator for the names of all message properties.

isAnonymous

public boolean isAnonymous()

Description copied from interface: ForumMessage

Returns true if this message was posted anonymously. This is a convenience method for: message.getUser() != null.

Specified by:

isAnonymous in interface ForumMessage

Returns:

true if this message was posted anonymously.

getForumThread

public ForumThread getForumThread()

Description copied from interface: ForumMessage

Returns the thread this message belongs to.

Specified by:

getForumThread in interface ForumMessage

Returns:

the thread this message belongs to.

getForum

public Forum getForum()

Description copied from interface: ForumMessage

Returns the forum this message belongs to.

Specified by:

getForum in interface ForumMessage

Returns:

the forum this message belongs to.

isAuthorized

public boolean isAuthorized(long permissionType)

Description copied from interface: ForumMessage

Returns true if the handle on this object has the permission specified. For example, if a forum administrator has a handle on this object, then calling isAuthorized(ForumPermissions.FORUM_ADMIN) would return true.

A list of possible permissions can be found in the ForumPermissions class. Certain methods of this class are restricted to certain permissions as specified in the method comments.

Specified by:

isAuthorized in interface ForumMessage

Parameters:

permissionType - permissionType a permission type.

Returns:

true if the handle on the object has the specified permission.

See Also:

ForumPermissions

isHtml

public boolean isHtml()

Description copied from interface: ForumMessage

Returns true if this body of this message contains HTML. This is determined by the DbForumMessage.PROP_CONTENT_TYPE extended property being set to DbForumMessage.TEXT_HTML.

Specified by:

isHtml in interface ForumMessage

Returns:

true if the content type is text/html

getTagDelegator

public TagDelegator getTagDelegator()

Description copied from interface: ForumMessage

Retrieve a tag delegator to manage message tags. Attempting to retrieve a tag delegator prior to the message being created will result in an IllegalStateArgument being thrown.

Specified by:

getTagDelegator in interface ForumMessage

Returns:

a tag delegator to manage thread tags.

getObjectType

public int getObjectType()

Description copied from interface: JiveObject

Return the object type of the jive object.

Specified by:

getObjectType in interface JiveObject

Returns:

the object type of the jive object.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object