com.ebay.sdk.call.ValidateChallengeInputCall Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ebaysdkcore Show documentation

This SDK enables you to use Java to make API calls in the eBay Trading API, which is an XML API. This maven build is provided by tonicsoft for convenience and is an exact copy of version 981 of the project distributed by eBay via the official eBay SDK website.

The newest version!

/*
Copyright (c) 2013 eBay, Inc.
This program is licensed under the terms of the eBay Common Development and
Distribution License (CDDL) Version 1.0 (the "License") and any subsequent  version 
thereof released by eBay.  The then-current version of the License can be found 
at http://www.opensource.org/licenses/cddl1.php and in the eBaySDKLicense file that 
is under the root directory at /LICENSE.txt.
*/

package com.ebay.sdk.call;

import java.lang.Boolean;
import java.lang.String;

import com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
 * 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 botblock challenge.
 * 
 Input property: KeepTokenValid - Whether the challenge token should remain valid for up to two minutes.
 * 
 Output property: ReturnedValidToken - Indicates whether the token is valid.
 * 
 * @author Ron Murphy
 * @version 1.0
 */

public class ValidateChallengeInputCall extends com.ebay.sdk.ApiCall
{
  
  private String challengeToken = null;
  private String userInput = null;
  private Boolean keepTokenValid = null;
  private Boolean returnedValidToken=null;


  /**
   * Constructor.
   */
  public ValidateChallengeInputCall() {
  }

  /**
   * Constructor.
   * @param apiContext The ApiContext object to be used to make the call.
   */
  public ValidateChallengeInputCall(ApiContext apiContext) {
    super(apiContext);
    

  }

  /**
   * Validates the user response to a GetChallengeToken
   * botblock challenge.
   * 
   * 

   * @throws ApiException
   * @throws SdkException
   * @throws Exception
   * @return The Boolean object.
   */
  public Boolean validateChallengeInput()
      throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
  {
    ValidateChallengeInputRequestType req;
    req = new ValidateChallengeInputRequestType();
    if (this.challengeToken != null)
      req.setChallengeToken(this.challengeToken);
    if (this.userInput != null)
      req.setUserInput(this.userInput);
    if (this.keepTokenValid != null)
      req.setKeepTokenValid(this.keepTokenValid);

    ValidateChallengeInputResponseType resp = (ValidateChallengeInputResponseType) execute(req);

    this.returnedValidToken = resp.isValidToken();
    return this.getReturnedValidToken();
  }

  /**
   * Gets the ValidateChallengeInputRequestType.challengeToken.
   * @return String
   */
  public String getChallengeToken()
  {
    return this.challengeToken;
  }

  /**
   * Sets the ValidateChallengeInputRequestType.challengeToken.
   * @param challengeToken String
   */
  public void setChallengeToken(String challengeToken)
  {
    this.challengeToken = challengeToken;
  }

  /**
   * Gets the ValidateChallengeInputRequestType.keepTokenValid.
   * @return Boolean
   */
  public Boolean getKeepTokenValid()
  {
    return this.keepTokenValid;
  }

  /**
   * Sets the ValidateChallengeInputRequestType.keepTokenValid.
   * @param keepTokenValid Boolean
   */
  public void setKeepTokenValid(Boolean keepTokenValid)
  {
    this.keepTokenValid = keepTokenValid;
  }

  /**
   * Gets the ValidateChallengeInputRequestType.userInput.
   * @return String
   */
  public String getUserInput()
  {
    return this.userInput;
  }

  /**
   * Sets the ValidateChallengeInputRequestType.userInput.
   * @param userInput String
   */
  public void setUserInput(String userInput)
  {
    this.userInput = userInput;
  }

  /**
   * Valid after executing the API.
   * Gets the returned ValidateChallengeInputResponseType.returnedValidToken.
   * 
   * @return Boolean
   */
  public Boolean getReturnedValidToken()
  {
    return this.returnedValidToken;
  }

}