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, APIAdminError, APIAdminFrameworkStatistics, APIAdminInteractiveDeviceSession, APIAdminOverview, APIAdminTestRun, APIBasicDeviceTime, APIBillingPeriod, APIBillingPeriodUsage, APIBrokerHub, APIBrowser, APICloudInfo, APICluster, APICommand, APIConnection, APIDesktopBrowser, APIDesktopBrowserCapabilities, APIDesktopPlatform, APIDevice, APIDeviceCleanupConfiguration, APIDeviceFilter, APIDeviceFilterGroup, APIDeviceGroup, APIDeviceModelCriterion, APIDeviceModelPool, APIDeviceModelPoolStatistics, APIDevicePicker, APIDeviceProperty, APIDeviceSession, APIDeviceSessionConfig, APIDeviceSessionDataAvailability, APIDeviceSessionStep, APIDeviceStatistic, APIDeviceStatus, APIDeviceUsage, APIEnum, APIFileConfig, APIFramework, APIHealthCheck, APILabelGroup, APILicense, APIList, APIMaintenance, APINotification, APINotificationPlan, APIProject, APIProjectJobConfig, APIProperty, APIRole, APIS3Url, APIScreenshot, APIService, APISharedResource, APISimpleList, APISmartbearTunnel, APISoftwareVersion, APITag, APITestCaseRun, APITestCaseRunStep, APITestRun, APITestRunConfig, APITestRunDataAvailability, APITestRunParameter, APIUser, APIUserDeviceTime, APIUserDeviceTimeSummary, APIUserFile, APIUserFileProperty, APIUserFileTag, APIUserPreference, APIUserStatistics, APIVisualTestAccess, APIVisualTestImage

public abstract class APIEntity
extends java.lang.Object

Author:

Łukasz Kajda , Slawomir Pawluk

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
APIEntity()
APIEntity(java.lang.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 java.lang.String	createUri(java.lang.String preUri, java.lang.String postUri)
protected void	deleteResource(java.lang.String uri)
protected java.io.InputStream	getFile(java.lang.String uri)
java.lang.Long	getId()	Returns ID of entity if such ID exists.
protected <T extends APIEntity> APIListResource<T>	getListResource(java.lang.String uri, Context<T> context)
protected <T extends APIEntity> APIListResource<T>	getListResource(java.lang.String uri, java.lang.Class<T> type)
java.lang.Long	getParentId()
protected <T extends APIEntity> APIResource<T>	getResource(java.lang.String uri, java.lang.Class<T> type)
java.lang.String	getSelfURI()
protected <T extends APIEntity> T	postFile(java.lang.String uri, java.io.File file, java.util.Map<java.lang.String,java.lang.String> fileExtraParams, java.lang.String contentType, java.lang.Class<T> type)
protected <T extends APIEntity> T	postResource(java.lang.String uri, java.lang.Object body, java.lang.Class<T> type)
void	refresh()
void	setId(java.lang.Long id)
void	setSelfURI(java.lang.String selfURI)
java.lang.String	toJson()

Methods inherited from class java.lang.Object

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

Field Detail

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 java.lang.Long id

selfURI

protected java.lang.String selfURI

parentId

protected java.lang.Long parentId

Constructor Detail

APIEntity

public APIEntity()

APIEntity

public APIEntity(java.lang.Long id)

Method Detail

createUri

protected static java.lang.String createUri(java.lang.String preUri,
                                            java.lang.String postUri)

getId

public java.lang.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(java.lang.Long id)

getSelfURI

public java.lang.String getSelfURI()

setSelfURI

public void setSelfURI(java.lang.String selfURI)

getParentId

public java.lang.Long getParentId()

getResource

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

Throws:

APIException

getListResource

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

Throws:

APIException

getListResource

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

Throws:

APIException

postResource

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

Throws:

APIException

postFile

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

Throws:

APIException

deleteResource

protected void deleteResource(java.lang.String uri)
                       throws APIException

Throws:

APIException

getFile

protected java.io.InputStream getFile(java.lang.String uri)
                               throws APIException

Throws:

APIException

refresh

public void refresh()
             throws APIException

Throws:

APIException

toJson

public java.lang.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)