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

Class UserSelfServiceImpl

java.lang.Object

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

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

All Implemented Interfaces:

JAXRSService, UserSelfService

@Service
public class UserSelfServiceImpl
extends AbstractService
implements UserSelfService

Field Summary

Fields

Modifier and Type	Field	Description
protected UserLogic	logic
protected SyncopeLogic	syncopeLogic

Fields inherited from class org.apache.syncope.core.rest.cxf.service.AbstractService

LOG, messageContext, OPTIONS_ALLOW, searchContext, 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_KEYWORD, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RECURSIVE, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER

Constructor Summary

Constructors

Constructor	Description
UserSelfServiceImpl(UserLogic logic, SyncopeLogic syncopeLogic)

Method Summary

Modifier and Type	Method	Description
void	compliance(ComplianceQuery query)	Checks compliance of the given username and / or password with applicable policies.
void	confirmPasswordReset(String token, String password)	Reset the password value for the user matching the provided token, if available and still valid.
javax.ws.rs.core.Response	create(UserCR createReq)	Self-registration for new user.
javax.ws.rs.core.Response	delete()	Self-deletes user.
javax.ws.rs.core.Response	mustChangePassword(PasswordPatch password)	Changes own password when change was forced by an administrator.
javax.ws.rs.core.Response	read()	Returns the user making the service call.
void	requestPasswordReset(String username, String securityAnswer)	Provides answer for the security question configured for user matching the given username, if any.
javax.ws.rs.core.Response	status(StatusR statusR)	Self-perform a status update.
javax.ws.rs.core.Response	update(UserUR updateReq)	Self-updates user.
javax.ws.rs.core.Response	update(UserTO user)	Self-updates user.

Methods inherited from class org.apache.syncope.core.rest.cxf.service.AbstractService

applyPreference, buildPagedResult, checkETag, createResponse, findActualKey, getOrderByClauses, getPreference, isNullPriorityAsync, modificationResponse

Methods inherited from class java.lang.Object

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

Field Detail

logic

protected final UserLogic logic

syncopeLogic

protected final SyncopeLogic syncopeLogic

Constructor Detail

UserSelfServiceImpl

public UserSelfServiceImpl(UserLogic logic,
                           SyncopeLogic syncopeLogic)

Method Detail

create

public javax.ws.rs.core.Response create(UserCR createReq)

Description copied from interface: UserSelfService

Self-registration for new user.

Specified by:

create in interface UserSelfService

Parameters:

createReq - user to be created

Returns:

Response object featuring Location header of self-registered user as well as the user itself enriched with propagation status information

read

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

Description copied from interface: UserSelfService

Returns the user making the service call.

Specified by:

read in interface UserSelfService

Returns:

calling user data, including own UUID, entitlements and delegations

update

public javax.ws.rs.core.Response update(UserUR updateReq)

Description copied from interface: UserSelfService

Self-updates user.

Specified by:

update in interface UserSelfService

Parameters:

updateReq - modification to be applied to self

Returns:

Response object featuring the updated user

update

public javax.ws.rs.core.Response update(UserTO user)

Description copied from interface: UserSelfService

Self-updates user.

Specified by:

update in interface UserSelfService

Parameters:

user - complete update

Returns:

Response object featuring the updated user

status

public javax.ws.rs.core.Response status(StatusR statusR)

Description copied from interface: UserSelfService

Self-perform a status update.

Specified by:

status in interface UserSelfService

Parameters:

statusR - status update details

Returns:

Response object featuring the updated user enriched with propagation status information

delete

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

Description copied from interface: UserSelfService

Self-deletes user.

Specified by:

delete in interface UserSelfService

Returns:

Response object featuring the deleted user

mustChangePassword

public javax.ws.rs.core.Response mustChangePassword(PasswordPatch password)

Description copied from interface: UserSelfService

Changes own password when change was forced by an administrator.

Specified by:

mustChangePassword in interface UserSelfService

Parameters:

password - the password value to update

Returns:

Response object featuring the updated user

compliance

public void compliance(ComplianceQuery query)

Description copied from interface: UserSelfService

Checks compliance of the given username and / or password with applicable policies.

Specified by:

compliance in interface UserSelfService

Parameters:

query - compliance query

requestPasswordReset

public void requestPasswordReset(String username,
                                 String securityAnswer)

Description copied from interface: UserSelfService

Provides answer for the security question configured for user matching the given username, if any. If provided answer matches the one stored for that user, a password reset token is internally generated, otherwise an error is returned.

Specified by:

requestPasswordReset in interface UserSelfService

Parameters:

username - username for which the security answer is provided

securityAnswer - actual answer text

confirmPasswordReset

public void confirmPasswordReset(String token,
                                 String password)

Description copied from interface: UserSelfService

Reset the password value for the user matching the provided token, if available and still valid. If the token actually matches one of users, and if it is still valid at the time of submission, the matching user's password value is set as provided. The new password value will need anyway to comply with all relevant password policies.

Specified by:

confirmPasswordReset in interface UserSelfService

Parameters:

token - password reset token

password - new password to be set