org.apache.syncope.core.rest.cxf.service

Class SyncopeServiceImpl

java.lang.Object

org.apache.syncope.core.rest.cxf.service.SyncopeServiceImpl

All Implemented Interfaces:

JAXRSService, SyncopeService

@Service
public class SyncopeServiceImpl
extends Object
implements SyncopeService

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	LOG
protected org.apache.cxf.jaxrs.ext.MessageContext	messageContext
protected static String	OPTIONS_ALLOW
protected SearchCondVisitor	searchCondVisitor
protected org.apache.cxf.jaxrs.ext.search.SearchContext	searchContext
protected javax.ws.rs.core.UriInfo	uriInfo

Fields inherited from interface org.apache.syncope.common.rest.api.service.JAXRSService

CRLF, DOUBLE_DASH, PARAM_ANYTYPE_KIND, PARAM_ANYTYPEKEY, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER

Constructor Summary

Constructors

Constructor and Description
SyncopeServiceImpl()

Method Summary

Modifier and Type	Method and Description
protected javax.ws.rs.core.Response.ResponseBuilder	applyPreference(ProvisioningResult<?> provisioningResult, javax.ws.rs.core.Response.ResponseBuilder builder)
javax.ws.rs.core.Response	batch() Gets batch results, in case asynchronous was requested.
javax.ws.rs.core.Response	batch(InputStream input) Requests for batch execution.
protected <T extends BaseBean> PagedResult<T>	buildPagedResult(List<T> list, int page, int size, int totalCount) Builds a paged result out of a list of items and additional information.
protected void	checkETag(String etag)
void	clearEntityCache() Evicts all entities from cache.
protected javax.ws.rs.core.Response	createResponse(ProvisioningResult<?> provisioningResult) Builds response to successful create request, taking into account any Prefer header.
protected String	getActualKey(AnyDAO<?> dao, String pretendingKey)
protected List<OrderByClause>	getOrderByClauses(String orderBy)
protected Preference	getPreference() Reads Prefer header from request and parses into a Preference instance.
protected SearchCond	getSearchCond(String fiql, String realm)
protected boolean	isNullPriorityAsync()
protected javax.ws.rs.core.Response	modificationResponse(Object entity) Builds response to successful modification request, taking into account any Prefer header.
NumbersInfo	numbers() Provides some numbers about the managed entities (users, groups, any objects...).
PlatformInfo	platform() Provides information summary about platform configuration (workflow adapters, provisioning managers, validators, actions, correlation rules, reportlets, ...).
TypeExtensionTO	readUserTypeExtension(String groupName) Extracts User type extension information, for the provided group.
PagedResult<GroupTO>	searchAssignableGroups(String realm, String term, int page, int size) Returns the list of Groups, according to provided paging instructions, assignable to Users and Any Objects of the provided Realm.
Map<String,Object>	statistics() Provides entity cache statistics information.
javax.ws.rs.core.Response	statistics(String operation) Operates on entity cache statistics.
SystemInfo	system() Provides information about the underlying system (Operating System, CPU / memory usage, ...).

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.slf4j.Logger LOG

OPTIONS_ALLOW

protected static final String OPTIONS_ALLOW

See Also:

Constant Field Values

uriInfo

@Context
protected javax.ws.rs.core.UriInfo uriInfo

messageContext

@Context
protected org.apache.cxf.jaxrs.ext.MessageContext messageContext

searchContext

@Context
protected org.apache.cxf.jaxrs.ext.search.SearchContext searchContext

searchCondVisitor

@Autowired
protected SearchCondVisitor searchCondVisitor

Constructor Detail

SyncopeServiceImpl

public SyncopeServiceImpl()

Method Detail

platform

public PlatformInfo platform()

Description copied from interface: SyncopeService

Provides information summary about platform configuration (workflow adapters, provisioning managers, validators, actions, correlation rules, reportlets, ...).

Specified by:

platform in interface SyncopeService

Returns:

information summary about platform configuration (workflow adapters, provisioning managers, validators, actions, correlation rules, reportlets, ...)

system

public SystemInfo system()

Description copied from interface: SyncopeService

Provides information about the underlying system (Operating System, CPU / memory usage, ...).

Specified by:

system in interface SyncopeService

Returns:

information about the underlying system (Operating System, CPU / memory usage, ...)

numbers

public NumbersInfo numbers()

Description copied from interface: SyncopeService

Provides some numbers about the managed entities (users, groups, any objects...).

Specified by:

numbers in interface SyncopeService

Returns:

some numbers about the managed entities (users, groups, any objects...)

statistics

public Map<String,Object> statistics()

Description copied from interface: SyncopeService

Provides entity cache statistics information.

Specified by:

statistics in interface SyncopeService

Returns:

cache statistics

statistics

public javax.ws.rs.core.Response statistics(String operation)

Description copied from interface: SyncopeService

Operates on entity cache statistics.

Specified by:

statistics in interface SyncopeService

Parameters:

operation - enable, disable or reset entity cache statistics

Returns:

clearEntityCache

public void clearEntityCache()

Description copied from interface: SyncopeService

Evicts all entities from cache.

Specified by:

clearEntityCache in interface SyncopeService

searchAssignableGroups

public PagedResult<GroupTO> searchAssignableGroups(String realm,
                                                   String term,
                                                   int page,
                                                   int size)

Description copied from interface: SyncopeService

Returns the list of Groups, according to provided paging instructions, assignable to Users and Any Objects of the provided Realm.

Specified by:

searchAssignableGroups in interface SyncopeService

Parameters:

realm - of the User and Any Objects assignable to the returned Groups

term - groups search term

page - search page

size - search page size

Returns:

list of Groups, according to provided paging instructions, assignable to Users and Any Objects of the provided Realm

readUserTypeExtension

public TypeExtensionTO readUserTypeExtension(String groupName)

Description copied from interface: SyncopeService

Extracts User type extension information, for the provided group.

Specified by:

readUserTypeExtension in interface SyncopeService

Parameters:

groupName - group name

Returns:

User type extension information, for the provided group

batch

public javax.ws.rs.core.Response batch(InputStream input)

Description copied from interface: SyncopeService

Requests for batch execution.

Specified by:

batch in interface SyncopeService

Parameters:

input - batch request

Returns:

batch results returned as Response entity, in case no 'Prefer: respond-async' was specified

batch

public javax.ws.rs.core.Response batch()

Description copied from interface: SyncopeService

Gets batch results, in case asynchronous was requested.

Specified by:

batch in interface SyncopeService

Returns:

batch results as Response entity

getActualKey

protected String getActualKey(AnyDAO<?> dao,
                              String pretendingKey)

isNullPriorityAsync

protected boolean isNullPriorityAsync()

getPreference

protected Preference getPreference()

Reads Prefer header from request and parses into a Preference instance.

Returns:

a Preference instance matching the passed Prefer header, or Preference.NONE if missing.

applyPreference

protected javax.ws.rs.core.Response.ResponseBuilder applyPreference(ProvisioningResult<?> provisioningResult,
                                                                    javax.ws.rs.core.Response.ResponseBuilder builder)

createResponse

protected javax.ws.rs.core.Response createResponse(ProvisioningResult<?> provisioningResult)

Builds response to successful create request, taking into account any Prefer header.

Parameters:

provisioningResult - the entity just created

Returns:

response to successful create request

modificationResponse

protected javax.ws.rs.core.Response modificationResponse(Object entity)

Builds response to successful modification request, taking into account any Prefer header.

Parameters:

entity - the entity just modified

Returns:

response to successful modification request

checkETag

protected void checkETag(String etag)

getSearchCond

protected SearchCond getSearchCond(String fiql,
                                   String realm)

getOrderByClauses

protected List<OrderByClause> getOrderByClauses(String orderBy)

buildPagedResult

protected <T extends BaseBean> PagedResult<T> buildPagedResult(List<T> list,
                                                               int page,
                                                               int size,
                                                               int totalCount)

Builds a paged result out of a list of items and additional information.

Type Parameters:

T - result type

Parameters:

list - bare list of items to be returned

page - current page

size - requested size

totalCount - total result size (not considering pagination)

Returns:

paged result