org.cyclos.services.users

Interface ConnectedUserService

All Superinterfaces:

Service

All Known Subinterfaces:

ConnectedUserServiceLocal

All Known Implementing Classes:

ConnectedUserServiceSecurity

public interface ConnectedUserService
extends Service

Service interface for connected users

Method Summary

Modifier and Type	Method and Description
int	disconnect(UserLocatorVO userLocator) Disconnects the given user.
int	disconnectBySessionTokens(java.util.Set<java.lang.String> sessionTokens) Removes all sessions with the given tokens, returning the number of sessions actually removed
ConnectedUserSearchData	getSearchData() Returns data for searching connected users
Page<ConnectedUserVO>	search(ConnectedUserQuery query) Searches users connected to the application

Method Detail

disconnect

int disconnect(@NotNull
               UserLocatorVO userLocator)
        throws FrameworkException

Disconnects the given user. Returns the number of sessions actually removed

Throws:

FrameworkException

disconnectBySessionTokens

int disconnectBySessionTokens(@NotNull
                              java.util.Set<java.lang.String> sessionTokens)
                       throws FrameworkException

Removes all sessions with the given tokens, returning the number of sessions actually removed

Throws:

FrameworkException

getSearchData

ConnectedUserSearchData getSearchData()
                               throws FrameworkException

Returns data for searching connected users

Throws:

FrameworkException

search

Page<ConnectedUserVO> search(@NotNull
                             ConnectedUserQuery query)
                      throws FrameworkException

Searches users connected to the application

Throws:

FrameworkException