org.xwiki.livedata.rest

Interface LiveDataPropertiesResource

@Unstable
public interface LiveDataPropertiesResource

Provides the list of known properties from an existing LiveDataSource.

Since:

12.10

Version:

$Id: 190d7baa46bb7468668daf09e69b4aa1358ef9a8 $

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addProperty(String sourceId, String namespace, PropertyDescriptor propertyDescriptor) Adds a new property to the data set.
Properties	getProperties(String sourceId, String namespace) Provides the list of properties known by a specific LiveDataSource implementation.

Method Detail

getProperties

Properties getProperties(String sourceId,
                         String namespace)
                  throws Exception

Provides the list of properties known by a specific LiveDataSource implementation.

Parameters:

sourceId - indicates the LiveDataSource component implementation

namespace - the component manager name-space where to look for LiveDataSource 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 the LiveDataSource component implementation

namespace - the component manager name-space where to look for LiveDataSource implementations; if not specified then the context / current name-space is used

propertyDescriptor - describes the property to add

Returns:

the response

Throws:

Exception - if adding the property fails