|
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 |
public interface Gateway
A Gateway synchronizes a forum and an external data source such as a NNTP newsgroup, or mailing list (through a POP3 account and SMTP). Each gateway must know how to import data from the external source as new messages that are added to an existing forum, and how to export individual messages to the source.
Configuring Gateways:GatewayManager.create(Gateway)
or
GatewayManager.update(Gateway)
depending on wether the gateway already exists and just wanting
to update it or if you are creating a new gateway.
CAVEATS:GatewayManager.update(com.jivesoftware.forum.gateway.Gateway)
to persist these values. Changes to the values will however
change the behavior of the gateway if it currently being ran in a background import/export
task.
GatewayManager
Method Summary | |
---|---|
GatewayExporter |
getExporter()
Returns the the GatewayExporter object associated with this Gateway
instance. |
java.lang.String |
getExportProperty(java.lang.String key)
Returns an extended property associated with the exporter. |
java.util.Set |
getExportPropertyKeys()
Returns all extended exporter property keys |
Forum |
getForum()
Returns forum object that this gateway is exporting/importing messages to/from. |
long |
getID()
The unique id of the gateway, this will only be a value greater than zero if the gateway is a persistent gateway. |
GatewayImporter |
getImporter()
Returns the the GatewayImporter object associated with this Gateway
instance. |
java.lang.String |
getImportProperty(java.lang.String key)
Returns an extended property associated with the importer. |
java.util.Set |
getImportPropertyKeys()
Returns all extended importer property keys |
java.lang.String |
getProperty(java.lang.String key)
The value of a gateway extended property. |
java.util.Set |
getPropertyKeys()
All extended property keys for this gateway |
java.lang.String |
getType()
Returns the type of gateway (ie "POP"). |
boolean |
isDisableCutOffDate()
|
boolean |
isExportEnabled()
Returns true if exporting is enabled in this gateway. |
boolean |
isImportEnabled()
Returns true if importing is enabled in this gateway. |
void |
setDisableCutOffDate(boolean disableCutOffDate)
|
void |
setExportEnabled(boolean enabled)
Sets whether this gateway should be exporting message into a forum or not. |
void |
setExportProperty(java.lang.String key,
java.lang.String value)
Sets an extended property to be associated with the exporter. |
void |
setImportEnabled(boolean enabled)
Sets whether this gateway should be importing message into a forum or not. |
void |
setImportProperty(java.lang.String key,
java.lang.String value)
Sets an extended property to be associated with the importer. |
void |
setProperty(java.lang.String key,
java.lang.String value)
Sets an extended property for this gateway. |
Method Detail |
---|
long getID()
GatewayExporter getExporter()
GatewayExporter
object associated with this Gateway
instance. If this gateway does not have an exporter object then null will be returned.
GatewayImporter getImporter()
GatewayImporter
object associated with this Gateway
instance. If this gateway does not have an importer object then null will be returned.
Forum getForum()
java.lang.String getType()
GatewayManager.Type
.
void setImportEnabled(boolean enabled)
enabled
- true if we should be importingvoid setExportEnabled(boolean enabled)
enabled
- true if we should be exportingvoid setImportProperty(java.lang.String key, java.lang.String value)
key
- property keyvalue
- property valuejava.lang.String getImportProperty(java.lang.String key)
key
- property key
java.util.Set getImportPropertyKeys()
void setExportProperty(java.lang.String key, java.lang.String value)
key
- property keyvalue
- property valuejava.lang.String getExportProperty(java.lang.String key)
key
- property key
java.util.Set getExportPropertyKeys()
void setProperty(java.lang.String key, java.lang.String value)
key
- property keyvalue
- property valuejava.lang.String getProperty(java.lang.String key)
key
- key for the property
java.util.Set getPropertyKeys()
boolean isExportEnabled()
boolean isImportEnabled()
boolean isDisableCutOffDate()
void setDisableCutOffDate(boolean disableCutOffDate)
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |