Package org.exoplatform.services.user

Class UserStateService

java.lang.Object

org.exoplatform.services.user.UserStateService

public class UserStateService
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMETD_CHANNEL
static final String	DEFAULT_STATUS
static final String	INVISIBLE
static final String	STATUS_OFFLINE
static final String	USER_STATE_CACHE_NAME

Constructor Summary

Constructors

Constructor	Description
UserStateService(org.exoplatform.ws.frameworks.cometd.ContinuationService continuationService, org.exoplatform.services.cache.CacheService cacheService, org.exoplatform.commons.api.settings.SettingService settingService)

Method Summary

Modifier and Type	Method	Description
void	clearCache()
int	getDelay()	Deprecated. Not needed anymore since we check connected users on WebSocket Channel
UserStateModel	getUserState(String userId)	Return user connection state
boolean	isOnline(String userId)	Checks whether a user is online or not
UserStateModel	lastLogin()
List<UserStateModel>	online()
UserStateModel	ping(String userId)	Deprecated. not needed anymore since the user online status is managed in realtime with WebSocket Channel
void	save(UserStateModel model)	Deprecated. use saveStatus(String, String) instead
void	saveStatus(String userId, String status)	Changes online status of the user: donotditurb, absent, available ...

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_STATUS

public static final String DEFAULT_STATUS

See Also:

• Constant Field Values

STATUS_OFFLINE

public static final String STATUS_OFFLINE

See Also:

• Constant Field Values

INVISIBLE

public static final String INVISIBLE

See Also:

• Constant Field Values

USER_STATE_CACHE_NAME

public static final String USER_STATE_CACHE_NAME

See Also:

• Constant Field Values

COMETD_CHANNEL

public static final String COMETD_CHANNEL

See Also:

• Constant Field Values

Constructor Details

UserStateService

public UserStateService(org.exoplatform.ws.frameworks.cometd.ContinuationService continuationService,
 org.exoplatform.services.cache.CacheService cacheService,
 org.exoplatform.commons.api.settings.SettingService settingService)

Method Details

online

public List<UserStateModel> online()

Returns:

List of UserStateModel of online users

isOnline

public boolean isOnline(String userId)

Checks whether a user is online or not

Parameters:

userId - user name

Returns:

true if user is still connected else false

getUserState

public UserStateModel getUserState(String userId)

Return user connection state

Parameters:

userId - user name

Returns:

UserStateModel

lastLogin

public UserStateModel lastLogin()

Returns:

Last logged in user

saveStatus

public void saveStatus(String userId,
 String status)

Changes online status of the user: donotditurb, absent, available ...

Parameters:

userId - user name

status - Status of the online user

getDelay

@Deprecated
public int getDelay()

Deprecated.

Not needed anymore since we check connected users on WebSocket Channel

Returns:

default delay to consider user as inactive

save

@Deprecated
public void save(UserStateModel model)

Deprecated.

use saveStatus(String, String) instead

Changes user online/offline status

Parameters:

model - UserStateModel

ping

@Deprecated
public UserStateModel ping(String userId)

Deprecated.

not needed anymore since the user online status is managed in realtime with WebSocket Channel

Changes user status to online and saves the last activity time

Parameters:

userId - user name

Returns:

saved UserStateModel

clearCache

public void clearCache()