Package org.cyclos.impl.access

Class UserChannelServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.access.UserChannelServiceImpl

All Implemented Interfaces:

UserChannelServiceLocal, UserChannelService, Service

@Service
public class UserChannelServiceImpl
extends BaseServiceImpl
implements UserChannelServiceLocal

Implementation for UserChannelService

Field Summary

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, customFieldValueHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

Constructor Summary

Constructors

Constructor	Description
UserChannelServiceImpl()

Method Summary

Modifier and Type	Method	Description
boolean	enableChannel(User user, Channel channel)	Makes sure that the given channel is enabled for the given user.
List<Channel>	getAccessibleChannels(BasicUser user)	Returns a list with all accessible channels for the given user.
UserChannelsData	getChannelsData(UserLocatorVO locator)	Returns data for viewing / editing the channels access for the given user
boolean	isChannelAccessible(BasicUser user, Channel channel)	Returns whether the given user can access the given channel
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
void	saveChannels(UserLocatorVO locator, Set<ChannelVO> channelVOs)	Saves the channels access for the given user.

Methods inherited from class org.cyclos.impl.BaseServiceImpl

initializeNetworkMappings

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getBaseEntityManagerHandler, getConfiguration, getLoggedBasicUser, getLoggedUser, getProducts, getTranslatedName, getTranslatedValue, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, setAlreadyValidated, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object

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

Constructor Detail

UserChannelServiceImpl

public UserChannelServiceImpl()

Method Detail

enableChannel

public boolean enableChannel(User user,
                             Channel channel)
                      throws FrameworkException

Description copied from interface: UserChannelServiceLocal

Makes sure that the given channel is enabled for the given user. Returns false when the channel cannot be enabled (is disabled by the configuration)

Specified by:

enableChannel in interface UserChannelServiceLocal

Throws:

FrameworkException

getAccessibleChannels

public List<Channel> getAccessibleChannels(BasicUser user)
                                    throws FrameworkException

Description copied from interface: UserChannelServiceLocal

Returns a list with all accessible channels for the given user.

Specified by:

getAccessibleChannels in interface UserChannelServiceLocal

Throws:

FrameworkException

See Also:

UserChannelServiceLocal.isChannelAccessible(BasicUser, Channel)

getChannelsData

public UserChannelsData getChannelsData(UserLocatorVO locator)
                                 throws FrameworkException

Description copied from interface: UserChannelService

Returns data for viewing / editing the channels access for the given user

Specified by:

getChannelsData in interface UserChannelService

Throws:

FrameworkException

isChannelAccessible

public boolean isChannelAccessible(BasicUser user,
                                   Channel channel)
                            throws FrameworkException

Description copied from interface: UserChannelServiceLocal

Returns whether the given user can access the given channel

Specified by:

isChannelAccessible in interface UserChannelServiceLocal

Throws:

FrameworkException

saveChannels

public void saveChannels(UserLocatorVO locator,
                         Set<ChannelVO> channelVOs)
                  throws FrameworkException

Description copied from interface: UserChannelService

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

Specified by:

saveChannels in interface UserChannelService

Throws:

FrameworkException

registerNetworkMappings

protected void registerNetworkMappings(NetworkPathRegistry networkPathRegistry)

Description copied from class: BaseServiceImpl

Needs to be overridden by subclasses to register the path up to the network

Specified by:

registerNetworkMappings in class BaseServiceImpl