Package com.testdroid.api

Class APIEntity

java.lang.Object

com.testdroid.api.APIEntity

Direct Known Subclasses:

APIAccessGroup, APIAccount, APIAccountConcurrencyStatusMap, APIAccountPreference, APIAccountService, APIAccountServicePayment, APIActivity, APIAdminDevice, APIAdminDeviceModel, APIAdminDeviceProblem, APIAdminDeviceProblemPair, APIAdminDeviceSession, APIAdminDeviceSessionStatistics, APIAdminDeviceType, APIAdminEmail, APIAdminFrameworkStatistics, APIAdminInteractiveDeviceSession, APIAdministrator, APIAdminOverview, APIAdminTestRun, APIAdminTrialStatistics, APIBasicDeviceTime, APIBillingPeriod, APIBillingPeriodUsage, APIBrokerHub, APIBrowser, APICloudInfo, APICluster, APICommand, APIConnection, APIDesktopBrowser, APIDesktopBrowserCapabilities, APIDesktopPlatform, APIDevice, APIDeviceAvailability, APIDeviceCleanupConfiguration, APIDeviceFilter, APIDeviceFilterGroup, APIDeviceGroup, APIDeviceModelCriterion, APIDeviceModelPool, APIDevicePicker, APIDeviceProperty, APIDeviceSession, APIDeviceSessionConfig, APIDeviceSessionDataAvailability, APIDeviceSessionStep, APIDeviceStatistic, APIDeviceStatus, APIDeviceUsage, APIEnum, APIFileConfig, APIFramework, APIHealthCheck, APILabelGroup, APILicense, APIList, APIMaintenance, APINotification, APIProject, APIProjectJobConfig, APIProperty, APIRole, APIS3Url, APIScreenshot, APIService, APISharedResource, APISignalingSession, APISimpleList, APISmartbearTunnel, APISoftwareVersion, APITestCaseRun, APITestCaseRunStep, APITestRun, APITestRunConfig, APITestRunDataAvailability, APITestRunParameter, APIUser, APIUserDeviceTime, APIUserDeviceTimeSummary, APIUserFile, APIUserFileProperty, APIUserFileTag, APIUserPreference, APIUserStatistics, APIVisualTestAccess, APIVisualTestImage

public abstract class APIEntity
extends Object

Author:

Łukasz Kajda <[email protected]>, Slawomir Pawluk <[email protected]>

Field Summary

Fields

Modifier and Type	Field	Description
protected APIClient	client
protected Long	id
static final com.fasterxml.jackson.databind.ObjectMapper	OBJECT_MAPPER
protected Long	parentId
protected String	selfURI
static final com.fasterxml.jackson.dataformat.xml.XmlMapper	XML_MAPPER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	APIEntity()
protected	APIEntity(Long id)

Method Summary

Modifier and Type	Method	Description
protected abstract <T extends APIEntity> void	clone(T from)
protected <T extends APIEntity> void	cloneBase(T from)
protected static String	createUri(String preUri, String postUri)
protected void	deleteResource(String uri)
protected InputStream	getFile(String uri)
Long	getId()	Returns ID of entity if such ID exists.
protected <T extends APIEntity> APIListResource<T>	getListResource(String uri, Context<T> context)
protected <T extends APIEntity> APIListResource<T>	getListResource(String uri, Class<T> type)
Long	getParentId()
protected <T extends APIEntity> APIResource<T>	getResource(String uri, Class<T> type)
String	getSelfURI()
protected <T extends APIEntity> T	postFile(String uri, File file, Map<String,String> fileExtraParams, String contentType, Class<T> type)
protected <T extends APIEntity> T	postResource(String uri, Object body, Class<T> type)
void	refresh()
void	setId(Long id)
void	setSelfURI(String selfURI)
String	toJson()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

OBJECT_MAPPER

public static final com.fasterxml.jackson.databind.ObjectMapper OBJECT_MAPPER

XML_MAPPER

public static final com.fasterxml.jackson.dataformat.xml.XmlMapper XML_MAPPER

client

protected APIClient client

id

protected Long id

selfURI

protected String selfURI

parentId

protected Long parentId

Constructor Details

APIEntity

protected APIEntity()

APIEntity

protected APIEntity(Long id)

Method Details

createUri

protected static String createUri(String preUri,
 String postUri)

getId

public Long getId()

Returns ID of entity if such ID exists. Usually it does not exist for lists. Please use hasId() method to check if ID exists.

setId

public void setId(Long id)

getSelfURI

public String getSelfURI()

setSelfURI

public void setSelfURI(String selfURI)

getParentId

public Long getParentId()

getResource

protected <T extends APIEntity> APIResource<T> getResource(String uri,
 Class<T> type)
                                                    throws APIException

Throws:

APIException

getListResource

protected <T extends APIEntity> APIListResource<T> getListResource(String uri,
 Class<T> type)
                                                            throws APIException

Throws:

APIException

getListResource

protected <T extends APIEntity> APIListResource<T> getListResource(String uri,
 Context<T> context)
                                                            throws APIException

Throws:

APIException

postResource

protected <T extends APIEntity> T postResource(String uri,
 Object body,
 Class<T> type)
                                        throws APIException

Throws:

APIException

postFile

protected <T extends APIEntity> T postFile(String uri,
 File file,
 Map<String,String> fileExtraParams,
 String contentType,
 Class<T> type)
                                    throws APIException

Throws:

APIException

deleteResource

protected void deleteResource(String uri)
                       throws APIException

Throws:

APIException

getFile

protected InputStream getFile(String uri)
                       throws APIException

Throws:

APIException

refresh

public void refresh()
             throws APIException

Throws:

APIException

toJson

public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

clone

protected abstract <T extends APIEntity> void clone(T from)

cloneBase

protected <T extends APIEntity> void cloneBase(T from)