|
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.GatewayManagerProxy
public class GatewayManagerProxy
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface com.jivesoftware.forum.gateway.GatewayManager |
---|
GatewayManager.Type |
Field Summary |
---|
Fields inherited from interface com.jivesoftware.forum.gateway.GatewayManager |
---|
GATEWAY_EXPORT_RETRY |
Constructor Summary | |
---|---|
GatewayManagerProxy(GatewayManager gatewayManager,
AuthToken auth,
Permissions permissions)
|
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. |
protected boolean |
permCheck()
|
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GatewayManagerProxy(GatewayManager gatewayManager, AuthToken auth, Permissions permissions)
Method Detail |
---|
public void create(Gateway gateway) throws UnauthorizedException
GatewayManager
create
in interface GatewayManager
gateway
- The gatway to add
UnauthorizedException
public void update(Gateway gateway) throws UnauthorizedException
GatewayManager
update
in interface GatewayManager
gateway
- gateway who settings to persist
UnauthorizedException
public void remove(Forum forum) throws UnauthorizedException
GatewayManager
remove
in interface GatewayManager
UnauthorizedException
public java.util.Collection getGateways(Forum forum) throws UnauthorizedException
GatewayManager
getGateways
in interface GatewayManager
forum
- forum to grab gateways for
UnauthorizedException
public java.util.Collection getGateways() throws UnauthorizedException
GatewayManager
getGateways
in interface GatewayManager
UnauthorizedException
public void update(GlobalGatewaySettings globalGatewaySettings)
GatewayManager
update
in interface GatewayManager
globalGatewaySettings
- globals settings to updatepublic GlobalGatewaySettings getGlobalGatewaySettings()
GatewayManager
getGlobalGatewaySettings
in interface GatewayManager
public void executeOnce(Gateway gateway, java.util.Date afterDate) throws UnauthorizedException
GatewayManager
executeOnce
in interface GatewayManager
gateway
- gateway to executeafterDate
- acquire messages after this date
UnauthorizedException
public Gateway getGateway(long gatewayID) throws UnauthorizedException
GatewayManager
getGateway
in interface GatewayManager
gatewayID
- unique id of the gateway
UnauthorizedException
- Thrown if the user does not have access rights for acquiring
a gateway object.public Gateway createGatewayInstance(Forum forum, java.lang.String type) throws UnauthorizedException
GatewayManager
createGatewayInstance
in interface GatewayManager
forum
- forum to create this gateway fortype
- type of gateway to create
UnauthorizedException
public void remove(Gateway gateway) throws UnauthorizedException
GatewayManager
remove
in interface GatewayManager
UnauthorizedException
protected boolean permCheck()
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |