com.worklight.wlclient.api.challengehandler

Class GatewayChallengeHandler

java.lang.Object

com.worklight.wlclient.api.challengehandler.BaseChallengeHandler<WLResponse>

com.worklight.wlclient.api.challengehandler.GatewayChallengeHandler

All Implemented Interfaces:

WLResponseListener

public abstract class GatewayChallengeHandler
extends BaseChallengeHandler<WLResponse>
implements WLResponseListener

You use this abstract base class to create a custom challenge handler to handle responses from a third party gateway. You must extend this class to implement your own challenge handler logic.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_TIMEOUT_IN_MILLISECONDS

Constructor Summary

Constructors

Constructor and Description
GatewayChallengeHandler(java.lang.String gatewayName) Constructs an GatewayChallengeHandler with a specific 'gatewayName'.

Method Summary

Modifier and Type	Method and Description
abstract boolean	canHandleResponse(WLResponse response) This method must be overridden by extending the GatewayChallengeHandler class.

Methods inherited from class com.worklight.wlclient.api.challengehandler.BaseChallengeHandler

cancel, clearChallengeRequests, clearWaitingList, getHandlerName, handleChallenge, releaseWaitingList, startHandleChallenge

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.worklight.wlclient.api.WLResponseListener

onFailure, onSuccess

Field Detail

DEFAULT_TIMEOUT_IN_MILLISECONDS

public static int DEFAULT_TIMEOUT_IN_MILLISECONDS

Constructor Detail

GatewayChallengeHandler

public GatewayChallengeHandler(java.lang.String gatewayName)

Constructs an GatewayChallengeHandler with a specific 'gatewayName'.

Method Detail

canHandleResponse

public abstract boolean canHandleResponse(WLResponse response)

This method must be overridden by extending the GatewayChallengeHandler class. In most cases, you call this method to test whether there is a gateway challenge to be handled in the response. If the method returns true, the IBM MobileFirst Platform calls the BaseChallengeHandler.handleChallenge(Object) method.

Parameters:

response - The response to be tested.