com.ebay.sdk.call.GetSessionIDCall Maven / Gradle / Ivy
/*
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 com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
* 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.
*
* @author Ron Murphy
* @version 1.0
*/
public class GetSessionIDCall extends com.ebay.sdk.ApiCall
{
private String ruName = null;
private String returnedSessionID=null;
/**
* Constructor.
*/
public GetSessionIDCall() {
}
/**
* Constructor.
* @param apiContext The ApiContext object to be used to make the call.
*/
public GetSessionIDCall(ApiContext apiContext) {
super(apiContext);
}
/**
* Retrieves a session ID that identifies a user and your application when you make a FetchToken request.
*
*
* @throws ApiException
* @throws SdkException
* @throws Exception
* @return The String object.
*/
public String getSessionID()
throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
{
GetSessionIDRequestType req;
req = new GetSessionIDRequestType();
if (this.ruName != null)
req.setRuName(this.ruName);
GetSessionIDResponseType resp = (GetSessionIDResponseType) execute(req);
this.returnedSessionID = resp.getSessionID();
return this.getReturnedSessionID();
}
/**
* Gets the GetSessionIDRequestType.ruName.
* @return String
*/
public String getRuName()
{
return this.ruName;
}
/**
* Sets the GetSessionIDRequestType.ruName.
* @param ruName String
*/
public void setRuName(String ruName)
{
this.ruName = ruName;
}
/**
* Valid after executing the API.
* Gets the returned GetSessionIDResponseType.returnedSessionID.
*
* @return String
*/
public String getReturnedSessionID()
{
return this.returnedSessionID;
}
}