org.ovirt.engine.api.restapi.resource

Class AbstractBackendActionableResource<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>

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

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

Direct Known Subclasses:

AbstractBackendStorageDomainContentResource, BackendAttachedStorageDomainResource, BackendHostNicResource, BackendHostResource, BackendSnapshotResource, BackendTemplateResource, BackendVmResource

public abstract class AbstractBackendActionableResource<R extends BaseResource,Q>
extends AbstractBackendSubResource<R,Q>

Nested Class Summary

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

AbstractBackendSubResource.ParametersProvider<R,Q>

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

AbstractBackendResource.EntityIdResolver, AbstractBackendResource.QueryIdResolver

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

BaseBackendResource.BackendFailureException, BaseBackendResource.EntityNotFoundException, BaseBackendResource.WebFaultException

Field Summary

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

guid, id, STRICTLY_IMMUTABLE

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

ACCEPTED_STATUS, entityType, ID_SEPARATOR, mappingLocator, modelType, MONITOR_DELAY, subCollections

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

backend, httpHeaders, LOG, messageBundle, sessionHelper, uriInfo

Constructor Summary

Constructors

Constructor and Description
AbstractBackendActionableResource(String id, Class<R> modelType, Class<Q> entityType, String... subCollections)

Method Summary

Methods

Modifier and Type	Method and Description
protected javax.ws.rs.core.Response	actionAsync(VdcReturnValueBase actionResult, Action action)
protected javax.ws.rs.core.Response	actionFailure(Action action, javax.ws.rs.WebApplicationException wae)
protected javax.ws.rs.core.Response	actionStatus(CreationStatus status, Action action)
protected javax.ws.rs.core.Response	actionSuccess(Action action)
protected void	awaitGrace(Action action)
protected javax.ws.rs.core.Response	doAction(VdcActionType task, VdcActionParametersBase params, Action action) Perform an action, managing asynchrony and returning an appropriate response.
protected boolean	expectBlocking(Action action)
ActionResource	getActionSubresource(String action, String oid)
protected Guid	getHostId(Action action)
protected Guid	getHostId(Host host)
protected javax.ws.rs.core.Response	handleError(Exception e, Action action)

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

getEntity, getStrictlyImmutable, performGet, performGet, performUpdate, performUpdate, validateUpdate

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

addLinks, addLinks, addLinks, addLinks, addOrUpdateLink, addParents, asCollection, asGuidOr404, asString, awaitCompletion, delay, entityNotFound, getAsynchronousStatus, getMapper, getMappingLocator, getQueryParams, incomplete, inject, injectSearchLinks, linkSubCollections, linkSubResource, map, map, map, map, newModel, notFound, notFound, populate, removeIfExist, setMappingLocator, urlEncode

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

Constructor Detail

AbstractBackendActionableResource

public AbstractBackendActionableResource(String id,
                                 Class<R> modelType,
                                 Class<Q> entityType,
                                 String... subCollections)

Method Detail

doAction

protected javax.ws.rs.core.Response doAction(VdcActionType task,
                                 VdcActionParametersBase params,
                                 Action action)

Perform an action, managing asynchrony and returning an appropriate response.

Parameters:

uriInfo - wraps the URI for the current request

task - the backend task

params - the task parameters

action - action representation

Returns:

awaitGrace

protected void awaitGrace(Action action)

expectBlocking

protected boolean expectBlocking(Action action)

getActionSubresource

public ActionResource getActionSubresource(String action,
                                  String oid)

getHostId

protected Guid getHostId(Host host)

getHostId

protected Guid getHostId(Action action)

handleError

protected javax.ws.rs.core.Response handleError(Exception e,
                                    Action action)

actionFailure

protected javax.ws.rs.core.Response actionFailure(Action action,
                                      javax.ws.rs.WebApplicationException wae)

actionSuccess

protected javax.ws.rs.core.Response actionSuccess(Action action)

actionStatus

protected javax.ws.rs.core.Response actionStatus(CreationStatus status,
                                     Action action)

actionAsync

protected javax.ws.rs.core.Response actionAsync(VdcReturnValueBase actionResult,
                                    Action action)