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

Class ConfigurationServiceImpl

java.lang.Object

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

All Implemented Interfaces:

ConfigurationService, JAXRSService

@Service
public class ConfigurationServiceImpl
extends Object
implements ConfigurationService

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
ConfigurationServiceImpl()

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)
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)
protected javax.ws.rs.core.Response	createResponse(ProvisioningResult<?> provisioningResult) Builds response to successful create request, taking into account any Prefer header.
void	delete(String schema) Deletes the configuration parameter with matching schema.
javax.ws.rs.core.Response	export() Exports internal storage content as downloadable XML file.
AttrTO	get(String schema) Returns configuration parameter with matching schema.
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()
List<AttrTO>	list() Returns all configuration parameters.
protected javax.ws.rs.core.Response	modificationResponse(Object entity) Builds response to successful modification request, taking into account any Prefer header.
void	set(AttrTO value) Creates / updates the configuration parameter with the given schema.

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

ConfigurationServiceImpl

public ConfigurationServiceImpl()

Method Detail

export

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

Description copied from interface: ConfigurationService

Exports internal storage content as downloadable XML file.

Specified by:

export in interface ConfigurationService

Returns:

internal storage content as downloadable XML file

delete

public void delete(String schema)

Description copied from interface: ConfigurationService

Deletes the configuration parameter with matching schema.

Specified by:

delete in interface ConfigurationService

Parameters:

schema - configuration parameter schema

list

public List<AttrTO> list()

Description copied from interface: ConfigurationService

Returns all configuration parameters.

Specified by:

list in interface ConfigurationService

Returns:

all configuration parameters

get

public AttrTO get(String schema)

Description copied from interface: ConfigurationService

Returns configuration parameter with matching schema.

Specified by:

get in interface ConfigurationService

Parameters:

schema - identifier of configuration to be read

Returns:

configuration parameter with matching schema

set

public void set(AttrTO value)

Description copied from interface: ConfigurationService

Creates / updates the configuration parameter with the given schema.

Specified by:

set in interface ConfigurationService

Parameters:

value - parameter value

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