Package com.atlassian.crowd.plugin.rest.service.resource.admin

Class SessionsAdminResource

java.lang.Object

com.atlassian.crowd.plugin.rest.service.resource.admin.SessionsAdminResource

@Path("sessions")
@Consumes("application/json")
@Produces("application/json")
public class SessionsAdminResource
extends Object

Represents a resource for managing current application and user sessions.

Since:

3.4.0

Constructor Summary

Constructors

Constructor	Description
SessionsAdminResource(SessionsAdminController controller)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	expireSession(String randomHash)	Expires the session with given ID
RestPage<ApplicationSessionsSearchResultEntity>	getApplicationSessions(String searchKeyword, RestPageRequest pageRequest)	Lists the sessions of applications for specified parameters
RestPage<UserSessionsSearchResultEntity>	getUserSessions(String searchKeyword, Long directoryId, RestPageRequest pageRequest)	Lists the sessions of users for specified parameters

Methods inherited from class java.lang.Object

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

Constructor Details

SessionsAdminResource

@Inject
public SessionsAdminResource(SessionsAdminController controller)

Method Details

getApplicationSessions

@GET
@Path("application")
@ExperimentalApi
public RestPage<ApplicationSessionsSearchResultEntity> getApplicationSessions(@QueryParam("search")
 String searchKeyword,
 @BeanParam
 RestPageRequest pageRequest)

Lists the sessions of applications for specified parameters

Parameters:

searchKeyword - the search keyword for sessions filtering

pageRequest - details about paging

Returns:

a paged list of application sessions

getUserSessions

@GET
@Path("user")
@ExperimentalApi
public RestPage<UserSessionsSearchResultEntity> getUserSessions(@QueryParam("search")
 String searchKeyword,
 @QueryParam("directoryId")
 Long directoryId,
 @BeanParam
 RestPageRequest pageRequest)

Lists the sessions of users for specified parameters

Parameters:

searchKeyword - the search keyword for sessions filtering

directoryId - the id of directory for sessions filtering

pageRequest - details about paging

Returns:

a paged list of application sessions

expireSession

@DELETE
@Path("{randomHash}")
@ExperimentalApi
public javax.ws.rs.core.Response expireSession(@PathParam("randomHash")
 String randomHash)

Expires the session with given ID

Parameters:

randomHash - the randomHash of a session to expire

Returns:

a paged list of application sessions