oracle.adf.view.rich.model

Class RemoteRegionErrorListener

java.lang.Object

oracle.adf.view.rich.model.RemoteRegionErrorListener

public abstract class RemoteRegionErrorListener
extends Object

This class listens for an error condition on a Region component when an error occurs retrieving remote content. The listener can then provide additional information to be sent to the user.

In general the RemoteRegionErrorEvent is somewhat minimalistic in the types of events it returns. Although every Remote Region error will call this listener, only those events explicitly defined in Type will be explicitly defined. More event types may be added later. IF a listener needs distinguish between different RemoteRegionErrorEvent types, it's suggested that you implement your listener in such a fashion that it will not break if other event types are added in the future. For instance:

 switch(event.getType())
   case HTTP_ERROR:
     //do something
     break;
   case AUTHORIZATION_ERROR:
     //do something
     break;
   default:
     //all other cases
 

This way if another event type is added, your existing code still functions. Additionally, the String returned by this listener will be processed in the same way as a af:outputFormattedText component. As such, some minor formatting is allowed. Please refer to the documentation on af:outputFormattedText for more information.

The listener which is used for the application should be defined in the web.xml in the following fashion: <context-param> <context-name>oracle.adf.view.rich.REMOTE_REGION_ERROR_LISTENER</context-name> <context-value>myapp.MyRemoteRegionErrorListener</context-value> </context-param>

The system makes no guarentees as to the longevity of this listener. It may be instantiated every remote region failure or it may span several requests. It is suggested that implementations of this listener interface remain thread-safe and stateless. Any state information required should be stored externally.

Since:

12.1.4.0

Constructor Summary

Constructors

Constructor and Description
RemoteRegionErrorListener()

Method Summary

Modifier and Type	Method and Description
String	getAdditionalUserInformation(RemoteRegionErrorEvent event) Provides additional information to the Region component in the event of an Error while trying to retrieve remote content.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteRegionErrorListener

public RemoteRegionErrorListener()

Method Detail

getAdditionalUserInformation

public String getAdditionalUserInformation(RemoteRegionErrorEvent event)

Provides additional information to the Region component in the event of an Error while trying to retrieve remote content.

Parameters:

event - the event which triggered the call

Returns:

a String that you wish returned as part of the error response that gets sent to the browser or null if no information is required.