Skip navigation links

oracle.adf.view.rich.remote
Enum RemoteApplicationResponse.Status

java.lang.Object
java.lang.Enum<RemoteApplicationResponse.Status>
oracle.adf.view.rich.remote.RemoteApplicationResponse.Status

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RemoteApplicationResponse.Status>

Enclosing class:

RemoteApplicationResponse

public static enum RemoteApplicationResponse.Status

extends java.lang.Enum<RemoteApplicationResponse.Status>

implements java.io.Serializable

The status of the execution result.

Enum Constant Summary

ERROR
This status will only happen during an execution request and indicates that there was an uncaught exception which was thrown sometime during execution of the FacesServlet.

FAILED_VALIDATION
This indicates that the TaskHandler.validateExecution(ExternalContext,Serializable[]) method for a handler failed and returned a result.

OK
The response was okay and the result will return an InputStream from the producer.

REDIRECT
This status will happen when the remote application issues a redirect.

SESSION_INVALID
This status will happen when the session on the remote server is invalid.

TASK_ERROR
There was an exception which was thrown by one of the handlers returned from a TaskHandler during remote execution.

VERSION_MISMATCH
This indicates that there is a version mismatch between consumer and producer.

Method Summary

static RemoteApplicationResponse.Status	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RemoteApplicationResponse.Status[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

VERSION_MISMATCH

public static final RemoteApplicationResponse.Status VERSION_MISMATCH

This indicates that there is a version mismatch between consumer and producer. The RemoteApplication framework relies on serialized objects and shared stylesheets. As a result, the consumer and the producer MUST be compatible. If the producer and the consumer are NOT compatible, this type of status is returned. Please note that "compatible" versions are not necessarily "identical" versions, although currently it is the case that both producer and consumer must be identical. For this status, the RemoteApplicationResponse.getResultType() will either return OBJECT or empty and the result will be either the producer's version string (if available) or an empty string if it is not. Additionally, there will be no RemoteApplicationInstance variable on this response.

FAILED_VALIDATION

public static final RemoteApplicationResponse.Status FAILED_VALIDATION

This indicates that the TaskHandler.validateExecution(ExternalContext,Serializable[]) method for a handler failed and returned a result. In this case, the value returned from the handler will be returned in RemoteApplicationResponse.getTaskResult(String) as well as wrapped in a FailedValidationResult on RemoteApplicationResponse.getResult().

TASK_ERROR

public static final RemoteApplicationResponse.Status TASK_ERROR

There was an exception which was thrown by one of the handlers returned from a TaskHandler during remote execution. In this case, the exception returned from the failed task will be returned in the RemoteApplicationResponse.getTaskResult(String) method. In addition the exception will be wrapped in a TaskResult and made available in RemoteApplicationResponse.getResult().

ERROR

public static final RemoteApplicationResponse.Status ERROR

This status will only happen during an execution request and indicates that there was an uncaught exception which was thrown sometime during execution of the FacesServlet. Not that this does not mean the problem lies in the FacesServlet, it could also have happened on one of the filters. In this case, the taskResults will be fully populated and the getResult will contain the ErrorResult.

SESSION_INVALID

public static final RemoteApplicationResponse.Status SESSION_INVALID

This status will happen when the session on the remote server is invalid. This will generally happen only if a previously established session expires. If this is the case then any of the RemoteApplicationInstances for this RemoteApplication will also be invalid. The result returned for this type will contain the RemoteApplication that we tried to make the request with which should contain the old session and session cookie value.

REDIRECT

public static final RemoteApplicationResponse.Status REDIRECT

This status will happen when the remote application issues a redirect. In JSF this is something that is fairly common and it requires special handling in a remote taskflow environment. As such, we do not handle this through Http. Instead we let the framework handle REAL Server initiated redirects and we focus on JSF redirects.

OK

public static final RemoteApplicationResponse.Status OK

The response was okay and the result will return an InputStream from the producer.

Method Detail

values

public static RemoteApplicationResponse.Status[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RemoteApplicationResponse.Status c : RemoteApplicationResponse.Status.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RemoteApplicationResponse.Status valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

Skip navigation links