All Superinterfaces:

Service

All Known Subinterfaces:

ConnectedUserServiceLocal
```
public interface ConnectedUserService
extends Service
```
Service interface for connected users

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`int`	`disconnect(@NotNull UserLocatorVO userLocator)`	Disconnects the given user.
`int`	`disconnectBySessionTokens(@NotNull Set<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(@NotNull ConnectedUserQuery query)`	Searches users connected to the application

Method Detail

disconnect

int disconnect(@NotNull
               @NotNull UserLocatorVO userLocator)
        throws FrameworkException

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

Throws:: FrameworkException

disconnectBySessionTokens

int disconnectBySessionTokens(@NotNull
                              @NotNull Set<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
                             @NotNull ConnectedUserQuery query)
                      throws FrameworkException

Searches users connected to the application