Package: com.appistry.fabric
Interface IFabricRequest
Extends
FabricRequest extends Map<String, Object>
Methods
getApplicationName
String getApplicationName()
This method returns the application name.
| Return Value |
| String |
application name |
getProcessFlowName
String getProcessFlowName()
This method returns the process flow name.
| Return Value |
| String |
process flow name |
setId
This method sets the unique identifier for this request.
| Parameters |
| String |
unique request identifier |
getId
This method retrieves the unique identifier of this request.
| Return Value |
| String |
unique request identifier |
setUsername
void setUsername(String username)
This method sets the user name for this request.
| Parameters |
| String |
user name |
getUsername
This method returns the user name for this request.
| Return Value |
| String |
user name |
setPassword
void setPassword(String password)
This method sets the user's password for this request.
| Parameters |
| String |
user password |
getPassword
This method returns the user's password for this request.
| Return Value |
| String |
user password |
setSetupTimeout
void setSetupTimeout(int milliseconds)
This method sets the maximum amount of time, in milliseconds, the client and the fabric attempt to locate workers for request processing.
| Parameters |
| int |
amount of time, in milliseconds, the client and the fabric attempts to locate workers for request processing before timing out; Appistry recommends a setup timeout value greater than or equal to 3000 milliseconds; the default is Infinite milliseconds, Infinite indicates infinite |
getSetupTimeout
This method returns the maximum amount of time, in milliseconds, the client and the fabric attempt to locate workers for request processing.
| Return Value |
| int |
request setup timeout value |
setProcessingTimeout
void setProcessingTimeout(int seconds)
This property specifies the maximum amount of time, in seconds, the application fabric waits to receive the response to a request.
| Parameters |
| int |
the amount of time, in seconds, to wait before timing out; the default is Infinite seconds, Infinite indicates infinite |
getProcessingTimeout
int getProcessingTimeout()
This method returns the amount of time, in seconds, the application fabric waits to receive the response to a request.
| Return Value |
| int |
request processing timeout value |
setRecoverTimeout
void setRecoverTimeout(int milliseconds)
This method sets the maximum amount of time, in seconds, a client and the fabric attempt to retrieve the results of the specified process lost within the fabric.
| Parameters |
| int |
amount of time, in seconds, to listen before timing out; the default is 60 seconds |
getRecoverTimeout
This method returns the amount of time, in seconds, a client and the fabric attempt to retrieve the results of the specified process lost within the fabric.
| Return Value |
| int |
listening timeout value |
setSetupRetries
void setSetupRetries(int retries)
This method sets the number of times the fabric attempts to retry locating workers for request processing.
| Parameters |
| int |
number of times the fabric attempts to retry locating workers for request processing; the default is 3 |
getSetupRetries
This method returns the number of times the fabric attempts to retry locating workers for request processing.
| Return Value |
| int |
setup retry value |
setAutoRecover
void setAutoRecover(boolean recover)
This method indicates whether or not the fabric automatically attempts to recover the specified process lost within the fabric. If the value is TRUE, the fabric attempts to recover until the RecoverTimeout occurs. The default is TRUE.
| Parameters |
| boolean |
indicates if the fabric automatically attempts to recover the specified process lost within the fabric; the default is TRUE |
getAutoRecover
This method returns whether auto recover is turned on.
| Return Value |
| boolean |
auto recover value |
getResult
This method returns the result value of the process flow. This is the value returned from the fabric application as set by the last task in the process flow definition file.
| Return Value |
| String |
process flow result |
getLastException
Throwable getLastException()
When a Java or .NET fabric task throws an unhandled exception, a TaskException is propagated to the client API. The TaskException contains only the textual call stack for the remote exception. If one wants to retrieve the actual, serialized exception, they can use getLastException() to do so as long as the client API and the fabric task are based on the same language (i.e. Java client API and Java fabric task).
If the Java client calls a .NET fabric task which throws an unhandled exception then getLastException() would return NULL to the Java client.
| Return Value |
| Throwable |
last unhandled exception thrown by fabric task of same language-base as client API, NULL otherwise. |
