com.testdroid.api.APIResource Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of testdroid-api Show documentation

The Testdroid API library for Java

There is a newer version: 3.34.0

package com.testdroid.api;

import java.io.InputStream;

/**
 * @author Łukasz Kajda 
 */
public class APIResource {

    protected APIClient client;

    protected Class type;

    protected String resourceURI;

    private T entity;

    public APIResource(APIClient client, String resourceURI, Class type) {
        this.client = client;
        this.resourceURI = resourceURI;
        this.type = type;
    }

    /**
     * Returns the entity owned by this resource.
     * It may be retrieved from server or from cache.
     *
     * @throws APIException on any API errors.
     */
    public T getEntity() throws APIException {
        refresh();
        return entity;
    }

    /**
     * Calls API and returns response stream as a result. No cache is used here.
     *
     * @return InputStream from API response
     * @throws APIException on any API errors.
     */
    public InputStream getStream() throws APIException {
        return client.get(resourceURI);
    }

    /**
     * Updates the entity owned by this resource in server side.
     *
     * @return updated entity
     * @throws APIException on any API errors.
     */
    public T update() throws APIException {
        entity = client.post(resourceURI, null, type);
        return entity;
    }

    /**
     * Deletes the entity owned by this resource in server side.
     *
     * @throws APIException on any API errors.
     */
    public void delete() throws APIException {
        client.delete(resourceURI);
        this.entity = null;
    }

    /**
     * Forces retrieving entity from the server side.
     *
     * @throws APIException on any API errors.
     */
    public void refresh() throws APIException {
        entity = client.get(resourceURI, type);
    }
}