|
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.CallRetry
public class CallRetry
Defines failure-retry condition for API call.
1) If no exceptions are registered, all call exceptions will be retried.
2) If the current exception is registered in the CallRetry object, the call
will be retried.
3) If the current exception is an ApiException (XML API) or SdkSoapException
(SOAP API) and the returned API error code is registered in the
TriggerApiErrorCodes property, the call will be retried.
4) If the current exception is an SdkHTTPException and the returned HTTP
response code is registered in the TriggerHTTPErrorCodes property, the call
will be retried.
Title:
Description:
Copyright: Copyright (c) 2004
Company: eBay Inc.
Constructor Summary | |
---|---|
CallRetry()
Constructor. |
Method Summary | |
---|---|
int |
getDelayTime()
Get delay time for between each retry-API-call. |
int |
getMaximumRetries()
Get maximum number of retries if the failure continues to happen. |
String[] |
getTriggerApiErrorCodes()
Get list of API error codes upon which the retry should be triggered. |
Class[] |
getTriggerExceptions()
Get the list of exception names upon any of them the call-retry will be triggered. |
int[] |
getTriggerHTTPErrorCodes()
|
void |
setDelayTime(int delayTime)
Set delay time between each retry-API-call. |
void |
setMaximumRetries(int maximumRetries)
Set maximum number of retries if the failure continues to happen. |
void |
setTriggerApiErrorCodes(String[] triggerApiErrorCodes)
If the trigger exception list (setTriggerExceptions()) contains ebay.sdk.ApiException, sets the list of API error codes upong which the retry should be triggered. |
void |
setTriggerExceptions(Class[] triggerExceptions)
Set the list of exception names upon any of them the call-retry will be triggered. |
void |
setTriggerHTTPErrorCodes(int[] triggerHTTPErrorCodes)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CallRetry()
Method Detail |
---|
public Class[] getTriggerExceptions()
public void setTriggerExceptions(Class[] triggerExceptions)
null means the call-retry will be triggered for any exception.
triggerExceptions
- String[]public String[] getTriggerApiErrorCodes()
public void setTriggerApiErrorCodes(String[] triggerApiErrorCodes)
null means the retry will be triggered for any API error.
triggerApiErrorCodes
- The API error code list.public int[] getTriggerHTTPErrorCodes()
public void setTriggerHTTPErrorCodes(int[] triggerHTTPErrorCodes)
public int getMaximumRetries()
public void setMaximumRetries(int maximumRetries)
maximumRetries
- The maximum number of retries to be set to.public int getDelayTime()
public void setDelayTime(int delayTime)
delayTime
- The delay time to be set to. In milliseconds.
|
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.