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

Show more of this group Show more artifacts with this name
Show all versions of ebaysdkcore Show documentation
Repack of the eBay SDK version 939 for repository use
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 eBay SDK ../docs directory.
*/

package com.ebay.sdk.call;

import java.lang.String;
import java.util.Calendar;

import com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
 * Wrapper class of the FetchToken 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: SecretID - A value associated with the token retrieval request. SecretID is
 * defined by the application, and is passed in the redirect URL to the
 * eBay sign-in page. eBay recommends using a UUID for the secret ID
 * value. You must also set Username (part of the RequesterCredentials)
 * for the particular user of interest. SecretID and Username are not
 * required if SessionID is present.
 * 
 Input property: SessionID - A value associated with the token retrieval request. eBay generates the
 * session ID when the application makes a GetSessionID request. SessionID
 * is passed in the redirect URL to the eBay sign-in page. The advantage
 * of using SessionID is that it does not require UserID as part of the
 * FetchToken request. SessionID is not required if SecretID is present.
 * 
 Output property: ReturnedToken - The authentication token for the user.
 * 
 Output property: HardExpirationTime - Date and time at which the token returned in eBayAuthToken expires
 * and can no longer be used to authenticate the user for that application.
 * 
 Output property: ReturnedRESTToken - The REST authentication token for the user.
 * 
 * @author Ron Murphy
 * @version 1.0
 */

public class FetchTokenCall extends com.ebay.sdk.ApiCall
{
  
  private String secretID = null;
  private String sessionID = null;
  private String returnedToken=null;
  private Calendar hardExpirationTime=null;
  private String returnedRESTToken=null;


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

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

  }

  /**
   * Retrieves an authentication token for a user. Also for Half.com.
   * 
   * 

   * @throws ApiException one or more errors reported by an API call.
   * @throws SdkException The super class of all SDK exception types.
   * @throws Exception
   * @return The String object.
   */
  public String fetchToken()
      throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
  {
    FetchTokenRequestType req;
    req = new FetchTokenRequestType();
    if (this.secretID != null)
      req.setSecretID(this.secretID);
    if (this.sessionID != null)
      req.setSessionID(this.sessionID);

    FetchTokenResponseType resp = (FetchTokenResponseType) execute(req);

    this.returnedToken = resp.getEBayAuthToken();
    this.hardExpirationTime = resp.getHardExpirationTime();
    this.returnedRESTToken = resp.getRESTToken();
    return this.getReturnedToken();
  }

  /**
   * Gets the FetchTokenRequestType.secretID.
   * @return String
   */
  public String getSecretID()
  {
    return this.secretID;
  }

  /**
   * Sets the FetchTokenRequestType.secretID.
   * @param secretID String
   */
  public void setSecretID(String secretID)
  {
    this.secretID = secretID;
  }

  /**
   * Gets the FetchTokenRequestType.sessionID.
   * @return String
   */
  public String getSessionID()
  {
    return this.sessionID;
  }

  /**
   * Sets the FetchTokenRequestType.sessionID.
   * @param sessionID String
   */
  public void setSessionID(String sessionID)
  {
    this.sessionID = sessionID;
  }

  /**
   * Valid after executing the API.
   * Gets the returned FetchTokenResponseType.hardExpirationTime.
   * 
   * @return Calendar
   */
  public Calendar getHardExpirationTime()
  {
    return this.hardExpirationTime;
  }

  /**
   * Valid after executing the API.
   * Gets the returned FetchTokenResponseType.returnedRESTToken.
   * 
   * @return String
   */
  public String getReturnedRESTToken()
  {
    return this.returnedRESTToken;
  }

  /**
   * Valid after executing the API.
   * Gets the returned FetchTokenResponseType.returnedToken.
   * 
   * @return String
   */
  public String getReturnedToken()
  {
    return this.returnedToken;
  }

}