|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AgentInterface
Method Summary | |
---|---|
String |
getDescription()
Retrieve a description of the agents functionality |
String |
getId()
Retrieve the agents id |
List<Object> |
getMethods(Boolean asJSON)
Retrieve a list with all the available methods. |
String |
getType()
Retrieve the agents type (its simple class name) |
List<String> |
getUrls()
Retrieve an array with the agents urls (can be one or multiple), and depends on the configured transport services. |
String |
getVersion()
Retrieve the agents version number |
String |
onSubscribe(String event,
String callbackUrl,
String callbackMethod)
Subscribe to an event. |
void |
onUnsubscribe(String subscriptionId,
String event,
String callbackUrl,
String callbackMethod)
Let an other agent unsubscribe from one of this agents events - If subscriptionId is provided, the subscription with this id will be deleted - If the parameter callbackUrl and optionally event and/or callbackMethod, all subscriptions with matching parameters will be deleted. |
Method Detail |
---|
String getId()
String getType()
String getVersion()
String getDescription()
List<String> getUrls()
List<Object> getMethods(Boolean asJSON)
asJSON
- If true, result is in a JSON format easily parsable by
a machine. If false (default), the returned list
contains human readable strings.
String onSubscribe(String event, String callbackUrl, String callbackMethod)
event
- callbackUrl
- callbackMethod
-
void onUnsubscribe(String subscriptionId, String event, String callbackUrl, String callbackMethod)
subscriptionId
- event
- callbackUrl
- callbackMethod
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |