EarlyFailureInterceptor (z/OS Connect OAS3 SPI)

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Superinterfaces:

Interceptor
```
public interface EarlyFailureInterceptor
extends Interceptor
```
Defines an extension of the Interceptor interface, and provides the ability for an interceptor to to be invoked for requests that fail before the invocation of Interceptor.preInvoke(java.util.Map<java.lang.Object, java.lang.Object>, com.ibm.zosconnect.spi.HttpZosConnectRequest, com.ibm.zosconnect.spi.Data).
When more than one interceptor is configured, the order of execution is determined by a sequence number. See Interceptor.getSequence().

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String copyright_notice
- Fields inherited from interface com.ibm.zosconnect.spi.Interceptor
  CFG_AD_SEQUENCE_ALIAS, DEFAULT_SEQUENCE_NUMBER

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`earlyFailure(HttpZosConnectRequest httpZosConnectRequest, Data data)` Runs implementor specific logic when the processing of a request fails in initial z/OS Connect EE processing.

Methods inherited from interface com.ibm.zosconnect.spi.Interceptor
getName, getSequence, postInvoke, preInvoke

- Field Detail
  - copyright_notice
```
static final java.lang.String copyright_notice
```
    See Also:
    
    Constant Field Values
- Method Detail
  - earlyFailure
```
void earlyFailure(HttpZosConnectRequest httpZosConnectRequest,
                  Data data)
```
    Runs implementor specific logic when the processing of a request fails in initial z/OS Connect EE processing. This early processing detects errors such as bad URLs, bad JSON and authentication failures. This method is not invoked once the Interceptor.preInvoke(java.util.Map<java.lang.Object, java.lang.Object>, com.ibm.zosconnect.spi.HttpZosConnectRequest, com.ibm.zosconnect.spi.Data) method has been called for a request and if this method is invoked for a request, then no further interceptor methods are called for that request.
    At a minimum, the following data is available when this method is called:
    - Data from all HttpZosConnectRequest methods
    - Data.REQUEST_ID
    - Data.TIME_ZOS_CONNECT_ENTRY
    - Data.TIME_ZOS_CONNECT_EXIT
    - Data.USER_NAME
    - Data.USER_NAME_MAPPED
    - Data.HTTP_RESPONSE_CODE
    - Data.getInputPayload()
    - Data.getRequestType()
    The request type will typically be Data.RequestType.UNKNOWN for requests failing early.
    Parameters:
    
    httpZosConnectRequest - A z/OS Connect EE representation of a HTTP servlet request.
    
    data - Common request specific data.