|
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.BaseGateway
public abstract class BaseGateway
Constructor Summary | |
---|---|
BaseGateway()
|
Method Summary | |
---|---|
GatewayExporter |
getExporter()
Returns the exporter for this gateway if settings.isExportEnabled is true and there is a possible exporter for the gateway, else null will be returned. |
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. |
protected ForumFactory |
getForumFactory()
|
protected GatewaySettings |
getGatewaySettings()
|
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 exporter for this gateway if settings.isImportEnabled is true and there is a possible importer for this gateway, else null will be returned. |
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"). |
void |
init(GatewaySettings settings,
ForumFactory forumFactory)
|
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 |
readExternal(java.io.DataInput in)
|
void |
setDisableCutOffDate(boolean disableCutOffDate)
|
void |
setExportEnabled(boolean enabled)
Sets whether this gateway should be exporting message into a forum or not. |
protected void |
setExporter(GatewayExporter exporter)
|
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. |
protected void |
setImporter(GatewayImporter importer)
|
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. |
protected abstract void |
setup()
Child classes must implement this method to create the importer and exporter instances. |
void |
writeExternal(java.io.DataOutput out)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BaseGateway()
Method Detail |
---|
public final void init(GatewaySettings settings, ForumFactory forumFactory) throws GatewayException
GatewayException
public GatewayExporter getExporter()
getExporter
in interface Gateway
public GatewayImporter getImporter()
getImporter
in interface Gateway
public Forum getForum()
Gateway
getForum
in interface Gateway
public void readExternal(java.io.DataInput in) throws java.io.IOException
readExternal
in interface com.tangosol.io.ExternalizableLite
java.io.IOException
public void writeExternal(java.io.DataOutput out) throws java.io.IOException
writeExternal
in interface com.tangosol.io.ExternalizableLite
java.io.IOException
public void setImportEnabled(boolean enabled)
Gateway
setImportEnabled
in interface Gateway
enabled
- true if we should be importingpublic void setExportEnabled(boolean enabled)
Gateway
setExportEnabled
in interface Gateway
enabled
- true if we should be exportingpublic java.lang.String getType()
Gateway
GatewayManager.Type
.
getType
in interface Gateway
public long getID()
Gateway
getID
in interface Gateway
public void setImportProperty(java.lang.String key, java.lang.String value)
Gateway
setImportProperty
in interface Gateway
key
- property keyvalue
- property valuepublic java.lang.String getImportProperty(java.lang.String key)
Gateway
getImportProperty
in interface Gateway
key
- property key
public java.util.Set getImportPropertyKeys()
Gateway
getImportPropertyKeys
in interface Gateway
public void setExportProperty(java.lang.String key, java.lang.String value)
Gateway
setExportProperty
in interface Gateway
key
- property keyvalue
- property valuepublic java.lang.String getExportProperty(java.lang.String key)
Gateway
getExportProperty
in interface Gateway
key
- property key
public java.util.Set getExportPropertyKeys()
Gateway
getExportPropertyKeys
in interface Gateway
public void setProperty(java.lang.String key, java.lang.String value)
Gateway
setProperty
in interface Gateway
key
- property keyvalue
- property valuepublic java.lang.String getProperty(java.lang.String key)
Gateway
getProperty
in interface Gateway
key
- key for the property
public java.util.Set getPropertyKeys()
Gateway
getPropertyKeys
in interface Gateway
public boolean isImportEnabled()
Gateway
isImportEnabled
in interface Gateway
public boolean isExportEnabled()
Gateway
isExportEnabled
in interface Gateway
public boolean isDisableCutOffDate()
isDisableCutOffDate
in interface Gateway
public void setDisableCutOffDate(boolean disableCutOffDate)
setDisableCutOffDate
in interface Gateway
protected abstract void setup() throws GatewayException
GatewayException
- thrown if there are problem creating the importer and exporterprotected void setImporter(GatewayImporter importer)
protected void setExporter(GatewayExporter exporter)
protected ForumFactory getForumFactory()
protected GatewaySettings getGatewaySettings()
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |