Skip navigation links

oracle.adf.view.rich.remote
Class TaskHandler

java.lang.Object
oracle.adf.view.rich.remote.TaskHandler

Direct Known Subclasses:

InvalidateSessionTaskHandler, MapTaskHandler

public abstract class TaskHandler

extends java.lang.Object

This is the interface for a TaskHandler. TaskHandlers are a key component to the RemoteApplication subsystem and the whole RemoteTaskFlow system in general as they allow various pieces of adf to run custom logic on a remote producer. Tasks are added to the request via the RemoteApplicationRequest's addTask methods.

Since:

11.1.1.7.2

Constructor Summary

TaskHandler()

Method Summary

void	beginExecute(javax.faces.context.ExternalContext ec, java.io.Serializable[] params) Run at the begin of an execution so that the environment may be set up correctly.
java.io.Serializable	endExecute(javax.faces.context.ExternalContext ec, java.io.Serializable[] params) Run at the end of an execution so that a result may be returned and the environment can be cleaned up properly.
java.io.Serializable	invoke(javax.faces.context.ExternalContext ec, java.io.Serializable[] params) Run durring an invoke request.
java.io.Serializable	validateExecution(javax.faces.context.ExternalContext ec, java.io.Serializable[] params) Run before the beginExecute or the invoke methods in a request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TaskHandler

public TaskHandler()

Method Detail

validateExecution

public java.io.Serializable validateExecution(javax.faces.context.ExternalContext ec,
                                              java.io.Serializable[] params)

Run before the beginExecute or the invoke methods in a request. Generally this method will not be overridden, but it essentially allows for validation of the environment before execution continues. If a result other then "null" is returned, then the current request will return immedietly without executing the faces lifecycle or any other task handlers and a FAILED_VALIDATION response will be returned to the server with this return value as the result. <p/> If the returned object is an exception, it will be added to the logs. If it is any other type of object it will be

beginExecute

public void beginExecute(javax.faces.context.ExternalContext ec,
                         java.io.Serializable[] params)

Run at the begin of an execution so that the environment may be set up correctly. Handler's overriding this method "should not" execute the superclass logic as it will impact the default logic of the endExecute method.

Parameters:

params -

endExecute

public java.io.Serializable endExecute(javax.faces.context.ExternalContext ec,
                                       java.io.Serializable[] params)

Run at the end of an execution so that a result may be returned and the environment can be cleaned up properly.

Parameters:

params -

Returns:

invoke

public java.io.Serializable invoke(javax.faces.context.ExternalContext ec,
                                   java.io.Serializable[] params)

Run durring an invoke request.

Parameters:

ec -

params -

Returns:

Skip navigation links