org.ovirt.engine.api.restapi.resource

Class AbstractBackendResource<R extends BaseResource,Q>

java.lang.Object

org.ovirt.engine.api.restapi.resource.BaseBackendResource

org.ovirt.engine.api.restapi.resource.BackendResource

org.ovirt.engine.api.restapi.resource.AbstractBackendResource<R,Q>

Direct Known Subclasses:

AbstractBackendCollectionResource, AbstractBackendSubResource, BackendEventResource, BackendPermitResource

public class AbstractBackendResource<R extends BaseResource,Q>
extends BackendResource

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractBackendResource.EntityIdResolver
protected class	AbstractBackendResource.QueryIdResolver

Nested classes/interfaces inherited from class org.ovirt.engine.api.restapi.resource.BaseBackendResource

BaseBackendResource.BackendFailureException, BaseBackendResource.EntityNotFoundException, BaseBackendResource.WebFaultException

Field Summary

Fields

Modifier and Type	Field and Description
protected static javax.ws.rs.core.Response.Status	ACCEPTED_STATUS
protected Class<Q>	entityType
protected static String	ID_SEPARATOR
protected MappingLocator	mappingLocator
protected Class<R>	modelType
protected static long	MONITOR_DELAY
protected String[]	subCollections

Fields inherited from class org.ovirt.engine.api.restapi.resource.BaseBackendResource

backend, httpHeaders, LOG, messageBundle, sessionHelper, uriInfo

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBackendResource(Class<R> modelType, Class<Q> entityType)
protected	AbstractBackendResource(Class<R> modelType, Class<Q> entityType, String... subCollections)

Method Summary

Methods

Modifier and Type	Method and Description
protected R	addLinks(R model, boolean doNotLinkSubCollections)
protected R	addLinks(R model, Class<? extends BaseResource> suggestedParent, boolean doNotLinkSubCollections)
protected R	addLinks(R model, Class<? extends BaseResource> suggestedParent, String... subCollectionMembersToExclude)
protected R	addLinks(R model, String... subCollectionMembersToExclude)
protected <B extends BaseResource> void	addOrUpdateLink(B model, String relation, String href)
protected R	addParents(R model) Add any parent resource references needed for constructing links.
protected List<Q>	asCollection(Object o)
protected Guid	asGuidOr404(String id) Convert a string to a Guid, or return a 404 response.
protected String	asString(List<Guid> list)
protected CreationStatus	awaitCompletion(VdcReturnValueBase result)
protected void	delay(long delay)
protected Q	entityNotFound()
protected CreationStatus	getAsynchronousStatus(VdcReturnValueBase result)
protected <F,T> Mapper<F,T>	getMapper(Class<F> from, Class<T> to)
MappingLocator	getMappingLocator()
protected VdcQueryParametersBase	getQueryParams(Class<? extends VdcQueryParametersBase> queryParamsClass, Guid id)
protected boolean	incomplete(CreationStatus status)
protected <S extends AbstractBackendResource<?,?>> S	inject(S resource)
protected R	injectSearchLinks(R resource, String[] rels)
protected R	linkSubCollections(R model, Class<? extends BaseResource> suggestedParent, String... subCollectionMembersToExclude)
protected R	linkSubResource(R model, String subResource, String oid)
protected R	map(Q entity)
protected R	map(Q entity, R template)
protected Q	map(R model)
protected Q	map(R model, Q template)
protected R	newModel(String id)
protected R	notFound()
protected <T> T	notFound(Class<T> clz)
protected R	populate(R model, Q entity)
protected <B extends BaseResource> void	removeIfExist(B model, String relation)
void	setMappingLocator(MappingLocator mappingLocator)
protected String	urlEncode(String url)

Methods inherited from class org.ovirt.engine.api.restapi.resource.BackendResource

doAction, doGetEntity, doNonBlockingAction, expectNonBlocking, getBackendCollection, getConfigurationValue, getEntity, getEntity, getEntity, performAction, performAction, performNonBlockingAction

Methods inherited from class org.ovirt.engine.api.restapi.resource.BaseBackendResource

asCollection, asGuid, asGuid, combine, fault, getBackend, getCurrent, getEffectiveLocale, getHttpHeaders, getMessageBundle, getSessionHelper, getUriInfo, handleError, handleError, instantiate, localize, localize, localize, sessionize, sessionize, setBackend, setHttpHeaders, setMessageBundle, setSessionHelper, setUriInfo, validateEnum, validateParameters, validateParameters

Methods inherited from class java.lang.Object

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

Field Detail

ID_SEPARATOR

protected static final String ID_SEPARATOR

See Also:

Constant Field Values

MONITOR_DELAY

protected static final long MONITOR_DELAY

See Also:

Constant Field Values

ACCEPTED_STATUS

protected static final javax.ws.rs.core.Response.Status ACCEPTED_STATUS

mappingLocator

protected MappingLocator mappingLocator

modelType

protected Class<R extends BaseResource> modelType

entityType

protected Class<Q> entityType

subCollections

protected String[] subCollections

Constructor Detail

AbstractBackendResource

protected AbstractBackendResource(Class<R> modelType,
                       Class<Q> entityType)

AbstractBackendResource

protected AbstractBackendResource(Class<R> modelType,
                       Class<Q> entityType,
                       String... subCollections)

Method Detail

setMappingLocator

public void setMappingLocator(MappingLocator mappingLocator)

getMappingLocator

public MappingLocator getMappingLocator()

inject

protected <S extends AbstractBackendResource<?,?>> S inject(S resource)

getMapper

protected <F,T> Mapper<F,T> getMapper(Class<F> from,
                          Class<T> to)

map

protected R map(Q entity)

map

protected R map(Q entity,
    R template)

map

protected Q map(R model)

map

protected Q map(R model,
    Q template)

awaitCompletion

protected CreationStatus awaitCompletion(VdcReturnValueBase result)

getAsynchronousStatus

protected CreationStatus getAsynchronousStatus(VdcReturnValueBase result)

incomplete

protected boolean incomplete(CreationStatus status)

delay

protected void delay(long delay)

populate

protected R populate(R model,
         Q entity)

addParents

protected R addParents(R model)

Add any parent resource references needed for constructing links. LinkHelper.addLinks() constructs the 'href' attribute from @model using its 'id' attribute and the 'id' attribute of any parent resources. This method provides the hook through which all sub-resource classes should add references to parent resources so that LinkHelper can do its job. e.g. in order to get a URL like 'clusters/{cid}/networks/{nid}' you would need to have: protected Network addParents(Network network) { network.setCluster(new Cluster()); network.getCluster().setId(clusterId); return network; }

Parameters:

the - resource representation

Returns:

the model with any parent references added

addLinks

protected R addLinks(R model,
         String... subCollectionMembersToExclude)

addLinks

protected R addLinks(R model,
         boolean doNotLinkSubCollections)

addLinks

protected R addLinks(R model,
         Class<? extends BaseResource> suggestedParent,
         String... subCollectionMembersToExclude)

addLinks

protected R addLinks(R model,
         Class<? extends BaseResource> suggestedParent,
         boolean doNotLinkSubCollections)

asCollection

protected List<Q> asCollection(Object o)

asString

protected String asString(List<Guid> list)

urlEncode

protected String urlEncode(String url)

newModel

protected R newModel(String id)

linkSubResource

protected R linkSubResource(R model,
                String subResource,
                String oid)

linkSubCollections

protected R linkSubCollections(R model,
                   Class<? extends BaseResource> suggestedParent,
                   String... subCollectionMembersToExclude)

injectSearchLinks

protected R injectSearchLinks(R resource,
                  String[] rels)

removeIfExist

protected <B extends BaseResource> void removeIfExist(B model,
                                          String relation)

addOrUpdateLink

protected <B extends BaseResource> void addOrUpdateLink(B model,
                                            String relation,
                                            String href)

getQueryParams

protected VdcQueryParametersBase getQueryParams(Class<? extends VdcQueryParametersBase> queryParamsClass,
                                    Guid id)

asGuidOr404

protected Guid asGuidOr404(String id)

Convert a string to a Guid, or return a 404 response. If an invalid UUID is supplied to a sub-resource locator, this method will cause us to return a 404 response via the sub-resource constructor.

Parameters:

id - the incoming UUID

Returns:

a Guid

Throws:

javax.ws.rs.WebApplicationException - a 404 response, if the UUID is invalid

notFound

protected R notFound()

entityNotFound

protected Q entityNotFound()

notFound

protected <T> T notFound(Class<T> clz)