Generated by
JDiff

org.cyclos.services.access Documentation Differences

This file contains all the changes in documentation in the package org.cyclos.services.access as colored differences. Deletions are shown like this, and additions are shown like this.
If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.
Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a <code> tag will cause all subsequent paragraphs to be displayed differently.

Class AccessClientService, ActivateAccessClientDTO activate(String, String)

Activates an access client for the current user, using the given activation code. It is possible to pass in a prefix (optional) to have it appended before the activation code itself. Returns a dto containing the principal type and a token which is then used to identify the remote application. The prefix is not returned. So, if for example, "123" is passed as prefix, and "ABCDEF", the token needed to be used on web service requests will be "123ABCDEF", but only "ABCDEF" is returned. If the prefix is null, no prefix is used.

Class AgreementLogService, void accept(Set<AgreementVO>)

Registers that the logged user has accepted the agreements with the given ids.agreements

Class InitializationService, BaseMobileUserInitializationData getMobileUserInitializationData(MobileUserDTO)

Returns all data needed to initialize the mobile app according to the current channel. If it's access client thenthen returns the data for the mobile app in POS mode. Otherwise return data for the mobile app in normal mode. @param dto contains the versions stored in the mobile application.

Class LoginService, UserLoginDetailedResult loginUser(UserLoginDTO)

Creates a session for an user, indicating a remote address (from the client connection) and a channel. Must be called by administrators with permissions to login other users, and is used when there is a system whichwhich relays logins to Cyclos.

Class PasswordService, List<String> requestNewOTP(OTPSendMedium)

Generates a new OTP (removing any previous password, if any) and sends it by the specified medium using thethe confirmation password type configured in the current channel for the logged user. @param medium the medium used to send the OTP. @throws SmsSendingException only if medium is OTPSendMedium.BY_SMS and the OTP could not be sent to anyany enabled for sms phone. @return the email or the normalized phones number the OTP was sent.

Class ServiceFacade, RequestData resolveRequestData(String, String, String)

Returns the route data about a given request URI. The return will contain the matched network id and internal name internal name (if not on global mode), the resolved configuration id (if null, should be handled as a not found onon client) and and the final URI (after removing the network root path and guest configuration key)

Class UserChannelService, void saveChannels(UserLocatorVO, Set<ChannelVO>)

Saves the channels access for the given user. Only the given channels will be accessible, however, some channelschannels are enforcedly enabled or disabled on configurations. In those cases, those channels will be enabled / disable despite the ones set viavia this method.