Changes since
the last release

com.ebay.sdk.call
Class GetSessionIDCall

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

public class GetSessionIDCall
extends ApiCall

Wrapper class of the GetSessionID 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: RuName - The eBay Registered URL must be specified in this field. An eBay Registered URL is created and associated with a developer's Sandbox or Production key set by logging into the user's developer account on developer.ebay.com and going to the User Tokens page. The RuName value passed in this field must match the one specified for the specific Sandbox or Production key set being used to make the GetSessionID call. For more information on adding and registering your RuName, see the Setting Up an Application to Receive Tokens tutorial.
Output property: ReturnedSessionID - A 40-character identifier supplied by eBay to an application. Used to confirm the identities of the user and the application in a URL redirect during the process in which the user agrees to let the application wield a user token that grants the application the right to access eBay data on behalf of the user. Subsequently also used as input for the FetchToken API call. The SessionID value is valid for five minutes after it is retrieved.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetSessionIDCall()
          Constructor.
GetSessionIDCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 java.lang.String getReturnedSessionID()
          Valid after executing the API.
 java.lang.String getRuName()
          Gets the GetSessionIDRequestType.ruName.
 java.lang.String getSessionID()
          Retrieves a session ID that identifies a user and your application when you make a FetchToken request.
 void setRuName(java.lang.String ruName)
          Sets the GetSessionIDRequestType.ruName.
 
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

GetSessionIDCall

public GetSessionIDCall()
Constructor.


GetSessionIDCall

public GetSessionIDCall(ApiContext apiContext)
Constructor.

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

getSessionID

public java.lang.String getSessionID()
                              throws ApiException,
                                     SdkException,
                                     java.lang.Exception
Retrieves a session ID that identifies a user and your application when you make a FetchToken request.

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

getRuName

public java.lang.String getRuName()
Gets the GetSessionIDRequestType.ruName.

Returns:
String

setRuName

public void setRuName(java.lang.String ruName)
Sets the GetSessionIDRequestType.ruName.

Parameters:
ruName - String

getReturnedSessionID

public java.lang.String getReturnedSessionID()
Valid after executing the API. Gets the returned GetSessionIDResponseType.returnedSessionID.

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.