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

Class NotificationServiceImpl

java.lang.Object

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

All Implemented Interfaces:

JAXRSService, NotificationService

@Service
public class NotificationServiceImpl
extends Object
implements NotificationService

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

Method Summary

Modifier and Type	Method and Description
void	actionJob(JobAction action) Executes an action on the notification job.
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(NotificationTO notificationTO) Creates a new notification.
protected javax.ws.rs.core.Response	createResponse(ProvisioningResult<?> provisioningResult) Builds response to successful create request, taking into account any Prefer header.
void	delete(String key) Deletes the notification matching the given key.
protected String	getActualKey(AnyDAO<?> dao, String pretendingKey)
JobTO	getJob() Returns details about notification job.
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<NotificationTO>	list() Returns a list of all notifications.
protected javax.ws.rs.core.Response	modificationResponse(Object entity) Builds response to successful modification request, taking into account any Prefer header.
NotificationTO	read(String key) Returns notification with matching key.
void	update(NotificationTO notificationTO) Updates the notification 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

NotificationServiceImpl

public NotificationServiceImpl()

Method Detail

create

public javax.ws.rs.core.Response create(NotificationTO notificationTO)

Description copied from interface: NotificationService

Creates a new notification.

Specified by:

create in interface NotificationService

Parameters:

notificationTO - Creates a new notification.

Returns:

Response object featuring Location header of created notification

read

public NotificationTO read(String key)

Description copied from interface: NotificationService

Returns notification with matching key.

Specified by:

read in interface NotificationService

Parameters:

key - key of notification to be read

Returns:

notification with matching key

list

public List<NotificationTO> list()

Description copied from interface: NotificationService

Returns a list of all notifications.

Specified by:

list in interface NotificationService

Returns:

list of all notifications.

update

public void update(NotificationTO notificationTO)

Description copied from interface: NotificationService

Updates the notification matching the given key.

Specified by:

update in interface NotificationService

Parameters:

notificationTO - notification to be stored

delete

public void delete(String key)

Description copied from interface: NotificationService

Deletes the notification matching the given key.

Specified by:

delete in interface NotificationService

Parameters:

key - key for notification to be deleted

getJob

public JobTO getJob()

Description copied from interface: NotificationService

Returns details about notification job.

Specified by:

getJob in interface NotificationService

Returns:

details about notification job

actionJob

public void actionJob(JobAction action)

Description copied from interface: NotificationService

Executes an action on the notification job.

Specified by:

actionJob in interface NotificationService

Parameters:

action - action to execute

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