org.wso2.carbon.data.provider

Class DataProviderAPI

java.lang.Object

org.wso2.carbon.data.provider.DataProviderAPI

All Implemented Interfaces:

org.wso2.msf4j.Microservice

@Path(value="/portal/apis/data-provider")
public class DataProviderAPI
extends Object
implements org.wso2.msf4j.Microservice

Data provider api service component.

Constructor Summary

Constructors

Constructor and Description
DataProviderAPI()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	dataProviderConfig(String providerName)
javax.ws.rs.core.Response	dataProviderList()
protected void	setCarbonTransport(DataProvider dataProvider)
protected void	start(org.osgi.framework.BundleContext bundleContext) This is the activation method of ServiceComponent.
protected void	stop() This is the deactivation method of ServiceComponent.
protected void	unsetCarbonTransport(DataProvider dataProvider)
javax.ws.rs.core.Response	validateProviderConfig(com.google.gson.JsonElement dataProviderConfig, String providerName)

Methods inherited from class java.lang.Object

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

Constructor Detail

DataProviderAPI

public DataProviderAPI()

Method Detail

start

protected void start(org.osgi.framework.BundleContext bundleContext)
              throws Exception

This is the activation method of ServiceComponent. This will be called when its references are satisfied.

Parameters:

bundleContext - the bundle context instance of this bundle.

Throws:

Exception - this will be thrown if an issue occurs while executing the activate method

stop

protected void stop()
             throws Exception

This is the deactivation method of ServiceComponent. This will be called when this component is being stopped or references are satisfied during runtime.

Throws:

Exception - this will be thrown if an issue occurs while executing the de-activate method

dataProviderList

@GET
 @Path(value="/list")
 @Produces(value="application/json")
public javax.ws.rs.core.Response dataProviderList()

dataProviderConfig

@GET
 @Path(value="/{providerName}/config")
 @Produces(value="application/json")
public javax.ws.rs.core.Response dataProviderConfig(@PathParam(value="providerName")
                                                                                                                                     String providerName)

validateProviderConfig

@POST
 @Path(value="/{providerName}/validate")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response validateProviderConfig(com.google.gson.JsonElement dataProviderConfig,
                                                                                                                                                                                 @PathParam(value="providerName")
                                                                                                                                                                                 String providerName)

setCarbonTransport

protected void setCarbonTransport(DataProvider dataProvider)

unsetCarbonTransport

protected void unsetCarbonTransport(DataProvider dataProvider)