Package org.webappos.webcaller
Interface IWebCaller
-
public interface IWebCaller
Used by the server-side bridge and server-side web calls actions to make web calls.- Author:
- Sergejs Kozlovics
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
IWebCaller.CallingConventions
Specifies the calling convention for web calls.static class
IWebCaller.WebCallDeclaration
A class for storing one parsed web call declaration from some .webcalls file.static class
IWebCaller.WebCallSeed
A class for storing all necessary information required to make a web call.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
enqueue(IWebCaller.WebCallSeed seed)
Enqueues a web call.IWebCaller.WebCallDeclaration
getWebCallDeclaration(java.lang.String actionName)
Obtain a parsed web call declaration loaded from some .webcalls file.java.util.Map<java.lang.String,IWebCaller.WebCallDeclaration>
getWebCalls(java.lang.String fullAppName)
Obtain all legitimate web calls that can be used within the given webAppOS app.boolean
invokeNow(IWebCaller.WebCallSeed seed)
Tries to invoke the given web call in the current web processor, bypassing the bridge.boolean
webCallExists(java.lang.String actionName)
Checks whether the given web call action exists.
-
-
-
Method Detail
-
enqueue
void enqueue(IWebCaller.WebCallSeed seed)
Enqueues a web call.- Parameters:
seed
- the information required to make a web call
-
invokeNow
boolean invokeNow(IWebCaller.WebCallSeed seed)
Tries to invoke the given web call in the current web processor, bypassing the bridge.- Parameters:
seed
- the information required to make a web call- Returns:
- whether the operation succeeded (i.e., the adapter found and the call was made)
-
webCallExists
boolean webCallExists(java.lang.String actionName)
Checks whether the given web call action exists.- Parameters:
actionName
- web call action name to check- Returns:
- true, if the action was found, or false otherwise (also in case of an error)
-
getWebCallDeclaration
IWebCaller.WebCallDeclaration getWebCallDeclaration(java.lang.String actionName)
Obtain a parsed web call declaration loaded from some .webcalls file.- Parameters:
actionName
- web call action name to consider- Returns:
- a parsed web call declaration
-
getWebCalls
java.util.Map<java.lang.String,IWebCaller.WebCallDeclaration> getWebCalls(java.lang.String fullAppName)
Obtain all legitimate web calls that can be used within the given webAppOS app. Useful for the client side to know what it can call.- Parameters:
fullAppName
- the full app name (with the .app suffix)- Returns:
- a map: web call action name -> parsed web call declaration
-
-