|
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 GatewayManager
Manages all gateways in the system.
There are two kinds of gateways, persistent and nonpersitent. Persistent gateways are gateways that have been set into the manager using the create(Gateway) method, this gateways exporters and importers are ran all the time by background tasks. When the server goes done, these gateways will be recreated. To create a persistent gateway:
Gateway gateway = gatewayManager.createGatewayInstance(forum, "TYPE");
... configure ...
gatewayManager.create(gateway);
Non-persistent gateways are created to perform a one time import or export.
To do a one time import:
Gateway gateway = gatewayManager.createGatewayInstance(forum, "TYPE");
... configure ...
gatewayManager.executeOnce(gateway, date);
Gateway
Nested Class Summary | |
---|---|
static class |
GatewayManager.Type
Possbile values for gateways types. |
Field Summary | |
---|---|
static java.lang.String |
GATEWAY_EXPORT_RETRY
Property placed on messages that should be rexported |
Method Summary | |
---|---|
void |
create(Gateway gateway)
Allows you to add a new gateway to the system |
Gateway |
createGatewayInstance(Forum forum,
java.lang.String type)
Used to create and return an instance of a gateway based off the gateway settings, this gateway won't be installed as a new persistent gateway. |
void |
executeOnce(Gateway gateway,
java.util.Date afterDate)
Used to execute a import/export on a gateway immediately, the gateway does not need to be a persistent gateway. |
Gateway |
getGateway(long gatewayID)
Returns a gateway by its id. |
java.util.Collection |
getGateways()
Returns all the gateways, this collection is unmodifiable. |
java.util.Collection |
getGateways(Forum forum)
Returns all the gateways for a forum. |
GlobalGatewaySettings |
getGlobalGatewaySettings()
Returns the global settings for gateways. |
void |
remove(Forum forum)
Deletes all gateways for this context by removing their properties and stopping them from running. |
void |
remove(Gateway gateway)
Delete a specific gateway |
void |
update(Gateway gateway)
This method must be called if gateway settings changes are to be persisted. |
void |
update(GlobalGatewaySettings globalGatewaySettings)
Updates the global gateway setting. |
Field Detail |
---|
static final java.lang.String GATEWAY_EXPORT_RETRY
Method Detail |
---|
void create(Gateway gateway) throws UnauthorizedException
gateway
- The gatway to add
UnauthorizedException
void update(Gateway gateway) throws UnauthorizedException
gateway
- gateway who settings to persist
UnauthorizedException
void update(GlobalGatewaySettings globalGatewaySettings)
globalGatewaySettings
- globals settings to updatevoid remove(Forum forum) throws UnauthorizedException
UnauthorizedException
void remove(Gateway gateway) throws UnauthorizedException
UnauthorizedException
java.util.Collection getGateways(Forum forum) throws UnauthorizedException
forum
- forum to grab gateways for
UnauthorizedException
java.util.Collection getGateways() throws UnauthorizedException
UnauthorizedException
Gateway getGateway(long gatewayID) throws UnauthorizedException
gatewayID
- unique id of the gateway
UnauthorizedException
- Thrown if the user does not have access rights for acquiring
a gateway object.GlobalGatewaySettings getGlobalGatewaySettings()
Gateway createGatewayInstance(Forum forum, java.lang.String type) throws UnauthorizedException
forum
- forum to create this gateway fortype
- type of gateway to create
UnauthorizedException
void executeOnce(Gateway gateway, java.util.Date afterDate) throws UnauthorizedException
gateway
- gateway to executeafterDate
- acquire messages after this date
UnauthorizedException
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |