Package org.xwiki.livedata.rest
Interface LiveDataPropertiesResource
public interface LiveDataPropertiesResource
Provides the list of known properties from an existing
LiveDataSource
.- Since:
- 12.10
- Version:
- $Id: c4c56c5afed6afaa426bc6ff8ecd22a21218e1af $
-
Method Summary
Modifier and TypeMethodDescriptionjavax.ws.rs.core.Response
addProperty
(String sourceId, String namespace, PropertyDescriptor propertyDescriptor) Adds a new property to the data set.getProperties
(String sourceId, String namespace) Provides the list of properties known by a specificLiveDataSource
implementation.
-
Method Details
-
getProperties
Provides the list of properties known by a specificLiveDataSource
implementation.- Parameters:
sourceId
- indicates theLiveDataSource
component implementationnamespace
- the component manager name-space where to look forLiveDataSource
implementations; if not specified then the context / current name-space is used- Returns:
- the list of properties known / supported by specified
LiveDataSource
component implementation - Throws:
Exception
- if retrieving the list of properties fails
-
addProperty
javax.ws.rs.core.Response addProperty(String sourceId, String namespace, PropertyDescriptor propertyDescriptor) throws Exception Adds a new property to the data set.- Parameters:
sourceId
- indicates theLiveDataSource
component implementationnamespace
- the component manager name-space where to look forLiveDataSource
implementations; if not specified then the context / current name-space is usedpropertyDescriptor
- describes the property to add- Returns:
- the response
- Throws:
Exception
- if adding the property fails
-