Changes since
the last release

com.ebay.sdk.call
Class ValidateChallengeInputCall

java.lang.Object
  extended by com.ebay.sdk.ApiCall
      extended by com.ebay.sdk.call.ValidateChallengeInputCall

public class ValidateChallengeInputCall
extends ApiCall

Wrapper class of the ValidateChallengeInput call of eBay SOAP API.

Title: SOAP API wrapper library.

Description: Contains wrapper classes for eBay SOAP APIs.

Copyright: Copyright (c) 2009

Company: eBay Inc.


Input property: ChallengeToken - Botblock token that was returned by GetChallengeToken.
Input property: UserInput - User response to a bot block challenge.
Input property: KeepTokenValid - This boolean field is included and set to 'true' if the challenge token should remain valid for up to two minutes.
Output property: ReturnedValidToken - Indicates whether the token is valid.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
ValidateChallengeInputCall()
          Constructor.
ValidateChallengeInputCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 java.lang.String getChallengeToken()
          Gets the ValidateChallengeInputRequestType.challengeToken.
 java.lang.Boolean getKeepTokenValid()
          Gets the ValidateChallengeInputRequestType.keepTokenValid.
 java.lang.Boolean getReturnedValidToken()
          Valid after executing the API.
 java.lang.String getUserInput()
          Gets the ValidateChallengeInputRequestType.userInput.
 void setChallengeToken(java.lang.String challengeToken)
          Sets the ValidateChallengeInputRequestType.challengeToken.
 void setKeepTokenValid(java.lang.Boolean keepTokenValid)
          Sets the ValidateChallengeInputRequestType.keepTokenValid.
 void setUserInput(java.lang.String userInput)
          Sets the ValidateChallengeInputRequestType.userInput.
 java.lang.Boolean validateChallengeInput()
          Validates the user response to a GetChallengeToken botblock challenge.
 
Methods inherited from class com.ebay.sdk.ApiCall
addDetailLevel, addSendRequestListener, execute, executeByApiName, getApiContext, getApiException, getBotBlock, getCallRetry, getDetailLevel, getEnableCompression, getEndUserIP, getErrorHandling, getInvocationID, getMessageID, getOutputSelector, getRequestXml, getResponseObject, getResponseXml, getSite, getWarningLevel, hasError, hasWarning, isEnableoAuthTokenHTTPHeader, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, setEnableoAuthTokenHTTPHeader, setEndUserIP, setErrorHandling, setInvocationID, setMessageID, setOutputSelector, setSite, setWarningLevel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ValidateChallengeInputCall

public ValidateChallengeInputCall()
Constructor.


ValidateChallengeInputCall

public ValidateChallengeInputCall(ApiContext apiContext)
Constructor.

Parameters:
apiContext - The ApiContext object to be used to make the call.
Method Detail

validateChallengeInput

public java.lang.Boolean validateChallengeInput()
                                         throws ApiException,
                                                SdkException,
                                                java.lang.Exception
Validates the user response to a GetChallengeToken botblock challenge.

Returns:
The Boolean object.
Throws:
ApiException
SdkException
java.lang.Exception

getChallengeToken

public java.lang.String getChallengeToken()
Gets the ValidateChallengeInputRequestType.challengeToken.

Returns:
String

setChallengeToken

public void setChallengeToken(java.lang.String challengeToken)
Sets the ValidateChallengeInputRequestType.challengeToken.

Parameters:
challengeToken - String

getKeepTokenValid

public java.lang.Boolean getKeepTokenValid()
Gets the ValidateChallengeInputRequestType.keepTokenValid.

Returns:
Boolean

setKeepTokenValid

public void setKeepTokenValid(java.lang.Boolean keepTokenValid)
Sets the ValidateChallengeInputRequestType.keepTokenValid.

Parameters:
keepTokenValid - Boolean

getUserInput

public java.lang.String getUserInput()
Gets the ValidateChallengeInputRequestType.userInput.

Returns:
String

setUserInput

public void setUserInput(java.lang.String userInput)
Sets the ValidateChallengeInputRequestType.userInput.

Parameters:
userInput - String

getReturnedValidToken

public java.lang.Boolean getReturnedValidToken()
Valid after executing the API. Gets the returned ValidateChallengeInputResponseType.returnedValidToken.

Returns:
Boolean

Changes since
the last release

The information contained in this document is proprietary and confidential. Use of this information and the eBay API requires a Non-Disclosure Agreement (NDA) between the user and eBay Inc. For information regarding a qualifying NDA, contact Developer Relations: developer-relations@ebay.com
© 2004-2009 eBay Inc. All rights reserved.