|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ebay.sdk.ApiContext
public class ApiContext
Defines the API context with which an API call will be made. The APi context contains a variety of information, such as the credentials of the application and the user, the application's RuName, and the API server's URL.
If you have an auth token to use as credentials, you need only call
ApiCredential#seteBayToken(String)
to apply it. Otherwise you must
call both ApiCredential.setApiAccount(ApiAccount)
to set the application
credentials and ApiCredential#seteBayAccount(eBayAccount)
to set the
user credentials.
Title:
Description:
Copyright: Copyright (c) 2004 - 2007
Company: eBay Inc.
Constructor Summary | |
---|---|
ApiContext()
Constructor. |
Method Summary | |
---|---|
ApiCredential |
getApiCredential()
Get the ApiCredential object associated with this context. |
ApiLogging |
getApiLogging()
Get the ApiLogging object associated with this context. |
java.lang.String |
getApiServerUrl()
Get URL of the eBay API server to which the API call will be sent. |
CallRetry |
getCallRetry()
Get the CallRetry object. |
java.lang.String |
getEpsServerUrl()
Returns the epsServerUrl. |
java.lang.String |
getErrorLanguage()
Get the language in which to return error messages. |
java.lang.String |
getRequestXml()
|
java.lang.String |
getResponseXml()
|
java.lang.String |
getRouting()
Returns the routing. |
java.lang.String |
getRuName()
|
java.lang.String |
getSignInUrl()
Gets the URL of the User Consent Flow (the procedure in which the user gives consent for an application to perform API calls on his or her behalf). |
SiteCodeType |
getSite()
Gets the site for API calls under the context. |
int |
getTimeout()
Get timeout for the HTTP connection. |
int |
getTotalCalls()
Get total number of API calls that have been made with the ApiContext object. |
java.lang.String |
getWSDLVersion()
Gets the version of WSDL version to be used. |
int |
incrementTotalCalls()
Increase number of total calls by one. |
void |
setApiCredential(ApiCredential apiCredential)
Set the ApiCredential object associated with this context. |
void |
setApiLogging(ApiLogging apiLogging)
Set the ApiLogging object associated with this context. |
void |
setApiServerUrl(java.lang.String url)
Set URL of the eBay API server to which the API call will be sent. |
void |
setCallRetry(CallRetry callRetry)
Set the CallRetry object to be used to control the retry behaviour of calls. |
void |
setEpsServerUrl(java.lang.String epsServerUrl)
Sets the epsServerUrl. |
void |
setErrorLanguage(java.lang.String errorLanguage)
Set the language in which to return error messages. |
void |
setRequestXml(java.lang.String requestXml)
|
void |
setResponseXml(java.lang.String responseXml)
|
void |
setRouting(java.lang.String routing)
Sets the gateway routing. |
void |
setRuName(java.lang.String ruName)
|
void |
setSignInUrl(java.lang.String url)
Sets the URL of the User Consent Flow (the procedure in which the user gives consent for an application to perform API calls on his or her behalf). |
void |
setSite(SiteCodeType site)
Sets the common eBay site that for all the APIs calls made with the ApiContext object. |
void |
setTimeout(int timeout)
Set timeout for the HTTP connection. |
void |
setTotalCalls(int totalCalls)
Set total number of API calls made with the ApiContext object. |
void |
setWSDLVersion(java.lang.String wsdlVersion)
Sets the version of WSDL version to be used. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ApiContext()
Method Detail |
---|
public int getTimeout()
public void setTimeout(int timeout)
timeout
- the timeout value in milliseconds.public java.lang.String getApiServerUrl()
public void setApiServerUrl(java.lang.String url)
url
- The URL string to set.public java.lang.String getSignInUrl()
see the description of setSignInUrl(String)
.
public void setSignInUrl(java.lang.String url)
For more information about the User Consent Flow, see the Trading API Reference's section Getting a Token via FetchToken. (Note that this section does use the term "User Consent Flow"; it refers to "the URL that takes the user to the eBay sign-in page for new token creation.")
url
- The User Consent Flow's URL. The parameters should not be included.public ApiCredential getApiCredential()
public void setApiCredential(ApiCredential apiCredential)
apiCredential
- The ApiCredential object associated with this context.public java.lang.String getErrorLanguage()
public void setErrorLanguage(java.lang.String errorLanguage)
errorLanguage
- the error language string.public ApiLogging getApiLogging()
public void setApiLogging(ApiLogging apiLogging)
apiLogging
- ApiLoggingpublic CallRetry getCallRetry()
public void setCallRetry(CallRetry callRetry)
callRetry
- the CallRetry object to use.public int getTotalCalls()
public void setTotalCalls(int totalCalls)
totalCalls
- Total number of calls to be set to.public int incrementTotalCalls()
public java.lang.String getEpsServerUrl()
public void setRouting(java.lang.String routing)
routing
- The routing to setpublic java.lang.String getRouting()
public void setEpsServerUrl(java.lang.String epsServerUrl)
epsServerUrl
- The epsServerUrl to setpublic SiteCodeType getSite()
public void setSite(SiteCodeType site)
site
- SiteCodeTypepublic java.lang.String getWSDLVersion()
public void setWSDLVersion(java.lang.String wsdlVersion)
wsdlVersion
- Stringpublic java.lang.String getRequestXml()
public void setRequestXml(java.lang.String requestXml)
public java.lang.String getResponseXml()
public void setResponseXml(java.lang.String responseXml)
public java.lang.String getRuName()
public void setRuName(java.lang.String ruName)
|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.