com.slickqa.client.impl

Class ApiPart<T>

java.lang.Object

com.slickqa.client.impl.ApiPart<T>

All Implemented Interfaces:

QueryAndCreateApi<T>, RetrieveUpdateDeleteApi<T>, ParentApiPart

Direct Known Subclasses:

FilesApiPart, ProjectApiPart, ReleaseApiPart, ResultApiPart

public class ApiPart<T>
extends Object
implements RetrieveUpdateDeleteApi<T>, QueryAndCreateApi<T>, ParentApiPart

Generic Query and CRUD Api Part. Created by jcorbett on 4/7/14.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.fasterxml.jackson.databind.JavaType	listType
protected com.fasterxml.jackson.databind.ObjectMapper	mapper
protected ParentApiPart	parent
protected com.fasterxml.jackson.databind.JavaType	type

Constructor Summary

Constructors

Constructor and Description
ApiPart(Class<T> type, ParentApiPart parent)
ApiPart(Class<T> type, ParentApiPart parent, com.fasterxml.jackson.databind.ObjectMapper mapper)

Method Summary

Methods

Modifier and Type	Method and Description
T	create(T item) Create a new item.
void	delete() Delete the specified object.
T	findOrCreate(T item) Find the specified item, or create it.
T	get() Retrieve a specific object.
List<T>	getList() Retreive a list of the specified object.
ParentApiPart	getParent()
SlickClient	getSlickClient()
javax.ws.rs.client.WebTarget	getWebTarget()
protected javax.ws.rs.client.WebTarget	getWebTargetForRequest()
protected <V> V	makeRequest(String method, com.fasterxml.jackson.databind.JavaType type, V body)
T	update(T item) Update an object.

Methods inherited from class java.lang.Object

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

Field Detail

parent

protected ParentApiPart parent

mapper

protected com.fasterxml.jackson.databind.ObjectMapper mapper

type

protected com.fasterxml.jackson.databind.JavaType type

listType

protected com.fasterxml.jackson.databind.JavaType listType

Constructor Detail

ApiPart

public ApiPart(Class<T> type,
       ParentApiPart parent,
       com.fasterxml.jackson.databind.ObjectMapper mapper)

ApiPart

public ApiPart(Class<T> type,
       ParentApiPart parent)

Method Detail

getWebTargetForRequest

protected javax.ws.rs.client.WebTarget getWebTargetForRequest()
                                                       throws SlickError

Throws:

SlickError

makeRequest

protected <V> V makeRequest(String method,
                com.fasterxml.jackson.databind.JavaType type,
                V body)
                 throws SlickError

Throws:

SlickError

getWebTarget

public javax.ws.rs.client.WebTarget getWebTarget()
                                          throws SlickError

Specified by:

getWebTarget in interface ParentApiPart

Throws:

SlickError

getParent

public ParentApiPart getParent()

Specified by:

getParent in interface ParentApiPart

getSlickClient

public SlickClient getSlickClient()

Specified by:

getSlickClient in interface ParentApiPart

get

public T get()
      throws SlickError

Description copied from interface: RetrieveUpdateDeleteApi

Retrieve a specific object.

Specified by:

get in interface RetrieveUpdateDeleteApi<T>

Returns:

The object returned from slick.

Throws:

SlickError - on errors reported from the slick server.

update

public T update(T item)
         throws SlickError

Description copied from interface: RetrieveUpdateDeleteApi

Update an object.

Specified by:

update in interface RetrieveUpdateDeleteApi<T>

Returns:

The updated object as returned by slick.

Throws:

SlickError - if the slick server returns an error.

delete

public void delete()
            throws SlickError

Description copied from interface: RetrieveUpdateDeleteApi

Delete the specified object.

Specified by:

delete in interface RetrieveUpdateDeleteApi<T>

Throws:

SlickError - if the slick server returns an error

getList

public List<T> getList()
                throws SlickError

Description copied from interface: QueryAndCreateApi

Retreive a list of the specified object.

Specified by:

getList in interface QueryAndCreateApi<T>

Returns:

The list of objects returned from slick.

Throws:

SlickError - if an invalid usage occurs or if the server returns an error.

create

public T create(T item)
         throws SlickError

Description copied from interface: QueryAndCreateApi

Create a new item.

Specified by:

create in interface QueryAndCreateApi<T>

Parameters:

item - The details of what to create

Returns:

The created item (with the id filled in by the server)

Throws:

SlickError - if an invalid usage occurs or if the server returns an error.

findOrCreate

public T findOrCreate(T item)
               throws SlickError

Description copied from interface: QueryAndCreateApi

Find the specified item, or create it. You need to specify enough data about the item for creation.

Specified by:

findOrCreate in interface QueryAndCreateApi<T>

Parameters:

item - The details of what to create (if needed)

Returns:

The found or created item (with the id filled in by the server)

Throws:

SlickError - if an invalid usage occurs or if the server returns an error.