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

Class PolicyServiceImpl

java.lang.Object

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

All Implemented Interfaces:

JAXRSService, PolicyService

@Service
public class PolicyServiceImpl
extends Object
implements PolicyService

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

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)
javax.ws.rs.core.Response	create(PolicyType type, PolicyTO policyTO) Create a new policy.
protected javax.ws.rs.core.Response	createResponse(ProvisioningResult<?> provisioningResult) Builds response to successful create request, taking into account any Prefer header.
void	delete(PolicyType type, String key) Delete policy matching the given key.
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()
<T extends PolicyTO> List<T>	list(PolicyType type) Returns a list of policies of the matching type.
protected javax.ws.rs.core.Response	modificationResponse(Object entity) Builds response to successful modification request, taking into account any Prefer header.
<T extends PolicyTO> T	read(PolicyType type, String key) Returns the policy matching the given key.
void	update(PolicyType type, PolicyTO policyTO) Updates policy matching the given key.

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

PolicyServiceImpl

public PolicyServiceImpl()

Method Detail

create

public javax.ws.rs.core.Response create(PolicyType type,
                                        PolicyTO policyTO)

Description copied from interface: PolicyService

Create a new policy.

Specified by:

create in interface PolicyService

Parameters:

type - policy type

policyTO - Policy to be created (needs to match type)

Returns:

Response object featuring Location header of created policy

delete

public void delete(PolicyType type,
                   String key)

Description copied from interface: PolicyService

Delete policy matching the given key.

Specified by:

delete in interface PolicyService

Parameters:

type - policy type

key - key of policy to be deleted

list

public <T extends PolicyTO> List<T> list(PolicyType type)

Description copied from interface: PolicyService

Returns a list of policies of the matching type.

Specified by:

list in interface PolicyService

Type Parameters:

T - response type (extending PolicyTO)

Parameters:

type - Type selector for requested policies

Returns:

list of policies with matching type

read

public <T extends PolicyTO> T read(PolicyType type,
                                   String key)

Description copied from interface: PolicyService

Returns the policy matching the given key.

Specified by:

read in interface PolicyService

Type Parameters:

T - response type (extending PolicyTO)

Parameters:

type - policy type

key - key of requested policy

Returns:

policy with matching id

update

public void update(PolicyType type,
                   PolicyTO policyTO)

Description copied from interface: PolicyService

Updates policy matching the given key.

Specified by:

update in interface PolicyService

Parameters:

type - policy type

policyTO - Policy to replace existing policy

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