|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.gateway.MboxImporter
public class MboxImporter
A gateway for the import of messages from a Mbox file This gateway (and the provider underneath it) assumes that the Mbox is only being used by this gateway. Therefore, do not use an active mbox file.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface com.jivesoftware.forum.gateway.GatewayImporter |
---|
GatewayImporter.Stats |
Constructor Summary | |
---|---|
MboxImporter(ForumFactory factory,
Forum forum,
GatewaySettings gatewaySettings)
Create an instance |
Method Summary | |
---|---|
int |
getCurrentMessageCount()
|
java.lang.String |
getDefaultCharacterSet()
Returns the character set that will be used to decode inbound messages that have no explicit character set defined. |
java.util.Date |
getLastImport()
Returns the Last date this importer completed |
java.lang.String |
getMboxFile()
|
int |
getPercentComplete()
|
java.lang.String |
getReplyPrefixes()
Returns a comma seperated of prefixes that will be stripped from messages when attempting to find a parent message via subject line matching. |
GatewayImporter.Stats |
getStats()
|
int |
getTotalMessageCount()
|
void |
importData(java.util.Date afterDate)
Import data from the data source into the specified forum. |
boolean |
isAttachmentsEnabled()
Returns true if attachments are allowed. |
boolean |
isDebugEnabled()
Returns true if debugging is turned on for the Mbox transport layer. |
boolean |
isEmailToUserMappingEnabled()
True if email address -> user mapping is enabled, false otherwise. |
boolean |
isImportHtmlEnabled()
True if if the importation of html email is enabled, false otherwise. |
boolean |
isImporting()
|
boolean |
isSubjectParentageCheckEnabled()
Returns whether parentage checks will be done using subject line matching or not. |
void |
setAttachmentsEnabled(boolean attachmentEnabled)
Toggles attachments on or off. |
void |
setDebugEnabled(boolean debugEnabled)
Toggles Mbox transport layer debugging on or off. |
void |
setDefaultCharacterSet(java.lang.String defaultCharacterSet)
Sets the character set that will be used to decode inbound messages that have no explicit character set defined. |
void |
setEmailToUserMappingEnabled(boolean emailToUserMappingEnabled)
Sets whether email address -> user mapping is enabled, false otherwise. |
void |
setImportHtmlEnabled(boolean importHtmlEnabled)
Sets whether the importation of html email is enabled. |
void |
setImporting(boolean importing)
|
void |
setMboxFile(java.lang.String file)
|
void |
setReplyPrefixes(java.lang.String replyPrefixes)
Sets the possible prefixes that will be stripped from messages when attempting to find a parent message via subject line matching. |
void |
setSubjectParentageCheckEnabled(boolean subjectParentageCheckEnabled)
Sets whether parentage checks will be done using subject line matching or not. |
void |
stop()
Stop a running import. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MboxImporter(ForumFactory factory, Forum forum, GatewaySettings gatewaySettings) throws java.lang.IllegalStateException
java.lang.IllegalStateException
Method Detail |
---|
public void importData(java.util.Date afterDate) throws GatewayException
GatewayImporter
importData
in interface GatewayImporter
afterDate
- the oldest cutoff date for data to import.
GatewayException
public void stop() throws GatewayException
GatewayImporter
stop
in interface GatewayImporter
GatewayException
public GatewayImporter.Stats getStats()
getStats
in interface GatewayImporter
public java.lang.String getMboxFile()
public void setMboxFile(java.lang.String file)
public boolean isDebugEnabled()
public void setDebugEnabled(boolean debugEnabled)
debugEnabled
- true if debugging should be enabled.public boolean isAttachmentsEnabled()
public void setAttachmentsEnabled(boolean attachmentEnabled)
attachmentEnabled
- true if attachments should be enabled.public boolean isEmailToUserMappingEnabled()
public void setEmailToUserMappingEnabled(boolean emailToUserMappingEnabled)
emailToUserMappingEnabled
- True if email address -> user mapping is enabled,
false otherwise.public boolean isImportHtmlEnabled()
public void setImportHtmlEnabled(boolean importHtmlEnabled)
importHtmlEnabled
- True if the importation of html email is enabled,
false otherwise.public java.lang.String getDefaultCharacterSet()
public void setDefaultCharacterSet(java.lang.String defaultCharacterSet)
defaultCharacterSet
- the character set that will be used to decode inbound messages
that have no explicit character set defined.public java.lang.String getReplyPrefixes()
public void setReplyPrefixes(java.lang.String replyPrefixes)
replyPrefixes
- an comma seperated string of lowercase prefixespublic boolean isSubjectParentageCheckEnabled()
public void setSubjectParentageCheckEnabled(boolean subjectParentageCheckEnabled)
subjectParentageCheckEnabled
- true if parentage checks will be done using
subject line matching, false otherwise.public boolean isImporting()
isImporting
in interface GatewayImporter
public void setImporting(boolean importing)
setImporting
in interface GatewayImporter
public int getPercentComplete()
public int getTotalMessageCount()
public int getCurrentMessageCount()
public java.util.Date getLastImport()
GatewayImporter
getLastImport
in interface GatewayImporter
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |