org.exoplatform.platform.common.rest

Class DashboardInformationRESTService

java.lang.Object

org.exoplatform.platform.common.rest.DashboardInformationRESTService

All Implemented Interfaces:

org.exoplatform.services.rest.resource.ResourceContainer

public class DashboardInformationRESTService
extends Object
implements org.exoplatform.services.rest.resource.ResourceContainer

WS REST which permit to access to all user's dashboards

And for each dashboard, you can access to all gadgets installed

• /dashboards to access to all dashboards
• dashboards/{userName}/{dashboardName} to access to all gadgets from a dashboard

Author:

Clement

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DashboardInformationRESTService.JsonDashboardInfo DTO Object used to create JSON response
static class	DashboardInformationRESTService.JsonGadgetInfo DTO Object used to create JSON response

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	STANDALONE_ROOT_PATH
protected static String	WS_ROOT_PATH

Constructor Summary

Constructors

Constructor and Description
DashboardInformationRESTService(org.exoplatform.portal.config.DataStorage dataStorageService, org.exoplatform.application.gadget.GadgetRegistryService gadgetRegistryService, org.exoplatform.portal.mop.description.DescriptionService descriptionService, org.exoplatform.portal.mop.navigation.NavigationService navigationService)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getDashboards(javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	getGadgetInformation(String userName, String dashboardName, javax.ws.rs.core.UriInfo uriInfo)

Methods inherited from class java.lang.Object

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

Field Detail

WS_ROOT_PATH

protected static final String WS_ROOT_PATH

See Also:

Constant Field Values

STANDALONE_ROOT_PATH

protected static final String STANDALONE_ROOT_PATH

See Also:

Constant Field Values

Constructor Detail

DashboardInformationRESTService

public DashboardInformationRESTService(org.exoplatform.portal.config.DataStorage dataStorageService,
                                       org.exoplatform.application.gadget.GadgetRegistryService gadgetRegistryService,
                                       org.exoplatform.portal.mop.description.DescriptionService descriptionService,
                                       org.exoplatform.portal.mop.navigation.NavigationService navigationService)

Method Detail

getDashboards

@RolesAllowed(value="users")
public javax.ws.rs.core.Response getDashboards(@Context
                                                                            javax.ws.rs.core.UriInfo uriInfo)

getGadgetInformation

@RolesAllowed(value="users")
public javax.ws.rs.core.Response getGadgetInformation(String userName,
                                                                                   String dashboardName,
                                                                                   @Context
                                                                                   javax.ws.rs.core.UriInfo uriInfo)