org.ovirt.engine.api.restapi.resource

Class BackendGroupsResource

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.AbstractBackendCollectionResource<Group,ad_groups>

org.ovirt.engine.api.restapi.resource.BackendGroupsResource

All Implemented Interfaces:

GroupsResource

Direct Known Subclasses:

AbstractBackendGroupsResource

public class BackendGroupsResource
extends AbstractBackendCollectionResource<Group,ad_groups>
implements GroupsResource

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	BackendGroupsResource.GroupIdResolver

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

Modifier and Type	Field and Description
protected static String	AD_SEARCH_TEMPLATE

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

CASE_SENSITIVE_CONSTRAINT_PARAMETER, FROM_CONSTRAINT_PARAMETER, LOG

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, messageBundle, sessionHelper, uriInfo

Constructor Summary

Constructors

Constructor and Description
BackendGroupsResource()
BackendGroupsResource(String id, BackendDomainResource parent)

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	add(Group group)
protected Group	addParents(Group group) Add any parent resource references needed for constructing links.
protected ad_groups	getAdGroup(Group group)
protected List<DbUser>	getGroupsCollection(SearchType searchType, String constraint)
protected List<ad_groups>	getGroupsFromDomain()
GroupResource	getGroupSubResource(String id) Sub-resource locator method, returns individual GroupResource on which the remainder of the URI is dispatched.
protected String	getSearchPattern(String param)
Groups	list()
ad_groups	lookupGroupById(Guid id)
protected Group	mapAdGroup(ad_groups entity)
protected Groups	mapDbGroupsCollection(List<DbUser> entities)
protected Group	mapDbUser(DbUser entity)
protected Groups	mapDomainGroupsCollection(List<ad_groups> entities)
javax.ws.rs.core.Response	performRemove(String id)

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

asString, expectBlocking, getBackendCollection, getBackendCollection, getBackendCollection, getEntity, handleAsynchrony, performCreation, remove, resolveCreated

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

addLinks, addLinks, addLinks, addLinks, addOrUpdateLink, 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

Methods inherited from interface org.ovirt.engine.api.resource.GroupsResource

remove

Field Detail

AD_SEARCH_TEMPLATE

protected static final String AD_SEARCH_TEMPLATE

See Also:

Constant Field Values

Constructor Detail

BackendGroupsResource

public BackendGroupsResource()

BackendGroupsResource

public BackendGroupsResource(String id,
                     BackendDomainResource parent)

Method Detail

list

public Groups list()

Specified by:

list in interface GroupsResource

add

public javax.ws.rs.core.Response add(Group group)

Specified by:

add in interface GroupsResource

performRemove

public javax.ws.rs.core.Response performRemove(String id)

Specified by:

performRemove in class AbstractBackendCollectionResource<Group,ad_groups>

getGroupSubResource

public GroupResource getGroupSubResource(String id)

Description copied from interface: GroupsResource

Sub-resource locator method, returns individual GroupResource on which the remainder of the URI is dispatched.

Specified by:

getGroupSubResource in interface GroupsResource

Parameters:

id - the Group ID

Returns:

matching subresource if found

mapDomainGroupsCollection

protected Groups mapDomainGroupsCollection(List<ad_groups> entities)

mapDbGroupsCollection

protected Groups mapDbGroupsCollection(List<DbUser> entities)

mapAdGroup

protected Group mapAdGroup(ad_groups entity)

mapDbUser

protected Group mapDbUser(DbUser entity)

addParents

protected Group addParents(Group group)

Description copied from class: AbstractBackendResource

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; }

Overrides:

addParents in class AbstractBackendResource<Group,ad_groups>

Returns:

the model with any parent references added

getSearchPattern

protected String getSearchPattern(String param)

getAdGroup

protected ad_groups getAdGroup(Group group)

getGroupsFromDomain

protected List<ad_groups> getGroupsFromDomain()

lookupGroupById

public ad_groups lookupGroupById(Guid id)

getGroupsCollection

protected List<DbUser> getGroupsCollection(SearchType searchType,
                               String constraint)