Changes since
the last release

com.ebay.sdk.call
Class FetchTokenCall

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

public class FetchTokenCall
extends ApiCall

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.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
FetchTokenCall()
          Constructor.
FetchTokenCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 String fetchToken()
          Retrieves an authentication token for a user.
 Calendar getHardExpirationTime()
          Valid after executing the API.
 String getReturnedRESTToken()
          Valid after executing the API.
 String getReturnedToken()
          Valid after executing the API.
 String getSecretID()
          Gets the FetchTokenRequestType.secretID.
 String getSessionID()
          Gets the FetchTokenRequestType.sessionID.
 void setSecretID(String secretID)
          Sets the FetchTokenRequestType.secretID.
 void setSessionID(String sessionID)
          Sets the FetchTokenRequestType.sessionID.
 
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, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, 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

FetchTokenCall

public FetchTokenCall()
Constructor.


FetchTokenCall

public FetchTokenCall(ApiContext apiContext)
Constructor.

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

fetchToken

public String fetchToken()
                  throws ApiException,
                         SdkException,
                         Exception
Retrieves an authentication token for a user.

Returns:
The String object.
Throws:
ApiException
SdkException
Exception

getSecretID

public String getSecretID()
Gets the FetchTokenRequestType.secretID.

Returns:
String

setSecretID

public void setSecretID(String secretID)
Sets the FetchTokenRequestType.secretID.

Parameters:
secretID - String

getSessionID

public String getSessionID()
Gets the FetchTokenRequestType.sessionID.

Returns:
String

setSessionID

public void setSessionID(String sessionID)
Sets the FetchTokenRequestType.sessionID.

Parameters:
sessionID - String

getHardExpirationTime

public Calendar getHardExpirationTime()
Valid after executing the API. Gets the returned FetchTokenResponseType.hardExpirationTime.

Returns:
Calendar

getReturnedRESTToken

public String getReturnedRESTToken()
Valid after executing the API. Gets the returned FetchTokenResponseType.returnedRESTToken.

Returns:
String

getReturnedToken

public String getReturnedToken()
Valid after executing the API. Gets the returned FetchTokenResponseType.returnedToken.

Returns:
String

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.