org.wso2.carbon.dataservices.core.admin

Class DataServiceAdmin

java.lang.Object

org.wso2.carbon.core.AbstractAdmin

org.wso2.carbon.dataservices.core.admin.DataServiceAdmin

Direct Known Subclasses:

DataServiceFileUploader

public class DataServiceAdmin
extends org.wso2.carbon.core.AbstractAdmin

Data Services admin service class, for the basic functions.

Field Summary

Fields inherited from class org.wso2.carbon.core.AbstractAdmin

axisConfig, configurationContext

Constructor Summary

Constructors

Constructor and Description
DataServiceAdmin()

Method Summary

Modifier and Type	Method and Description
String[]	getAllRoles(String authProviderConfig) Service method to get all the user roles for use in role based filtering when creating data services.
String[]	getAvailableDS() Return data services
String[]	getCarbonDataSourceNames()
String[]	getCarbonDataSourceNamesForTypes(String[] types)
String	getCarbonDataSourceType(String dsName)
String	getDataServiceContentAsString(String serviceId) Returns data service content as a String.
protected String	getDataServiceFileExtension()
String[]	getdbSchemaList(String datasourceId)
String	getDSService(String dataSourceId, String dbName, String[] schemas, String[] tableNames, boolean singleService, String serviceName, String serviceNamespace) Return the generated service name
String[]	getDSServiceList(String dataSourceId, String dbName, String[] schemas, String[] tableNames, boolean singleService, String serviceNamespace) Return the generated services name list
String[]	getInputMappingNames(String sql)
String[]	getOutputColumnNames(String sql)
PaginatedTableInfo	getPaginatedSchemaInfo(int pageNumber, String datasourceId)
PaginatedTableInfo	getPaginatedTableInfo(int pageNumber, String datasourceId, String dbName, String[] schemas)
String[]	getTableList(String datasourceId, String dbName, String[] schemas)
boolean	isDSNameAvailable(String dataService) This method check whether data service name is already available.
void	saveDataService(String serviceName, String serviceHierarchy, String serviceContents) Saves the data service in service repository.
String	testGSpreadConnection(String clientId, String clientSecret, String refreshToken, String visibility, String documentURL) This will test the connection(retrieve CallFeed) of a Google spreadsheet document.
String	testJDBCConnection(String driverClass, String jdbcURL, String username, String password, String passwordAlias) This will test a connection to a given database.
String	validateJSONMapping(String jsonMapping)

Methods inherited from class org.wso2.carbon.core.AbstractAdmin

getAxisConfig, getConfigContext, getConfigSystemRegistry, getConfigUserRegistry, getGovernanceRegistry, getGovernanceSystemRegistry, getGovernanceUserRegistry, getHttpSession, getLocalRepo, getRegistry, getTenantDomain, getUsername, getUserRealm, setConfigurationContext, setPermissionUpdateTimestamp

Methods inherited from class java.lang.Object

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

Constructor Detail

DataServiceAdmin

public DataServiceAdmin()

Method Detail

getDataServiceContentAsString

public String getDataServiceContentAsString(String serviceId)
                                     throws org.apache.axis2.AxisFault

Returns data service content as a String.

Parameters:

serviceId - The data service name

Returns:

The data service configuration data

Throws:

org.apache.axis2.AxisFault

getDataServiceFileExtension

protected String getDataServiceFileExtension()

saveDataService

public void saveDataService(String serviceName,
                            String serviceHierarchy,
                            String serviceContents)
                     throws org.apache.axis2.AxisFault

Saves the data service in service repository.

Parameters:

serviceName - The name of the data service to be saved

serviceHierarchy - The hierarchical path of the service

serviceContents - The content of the service

Throws:

org.apache.axis2.AxisFault

testJDBCConnection

public String testJDBCConnection(String driverClass,
                                 String jdbcURL,
                                 String username,
                                 String password,
                                 String passwordAlias)

This will test a connection to a given database. If connection can be made this method will return the status as String, if not, faliour String will be return.

Parameters:

driverClass - Driver class

jdbcURL - JDBC URL

username - User name

password - Pass word

Returns:

String; state

testGSpreadConnection

public String testGSpreadConnection(String clientId,
                                    String clientSecret,
                                    String refreshToken,
                                    String visibility,
                                    String documentURL)

This will test the connection(retrieve CallFeed) of a Google spreadsheet document. If connection can be made this method will return the status as String, if not, failure String will be return.

Parameters:

clientId - from developer console

clientSecret - from developer console

refreshToken - generated refresh token

visibility - Whether its private or public

documentURL - Google spreadsheet URL

Returns:

string State

getAvailableDS

public String[] getAvailableDS()
                        throws org.apache.axis2.AxisFault

Return data services

Returns:

names of the data services

Throws:

org.apache.axis2.AxisFault - AxisFault

isDSNameAvailable

public boolean isDSNameAvailable(String dataService)
                          throws org.apache.axis2.AxisFault

This method check whether data service name is already available.

Parameters:

dataService - Data Service Name

Returns:

boolean value

Throws:

org.apache.axis2.AxisFault

getCarbonDataSourceNames

public String[] getCarbonDataSourceNames()

getCarbonDataSourceNamesForTypes

public String[] getCarbonDataSourceNamesForTypes(String[] types)

getCarbonDataSourceType

public String getCarbonDataSourceType(String dsName)

getOutputColumnNames

public String[] getOutputColumnNames(String sql)
                              throws Exception

Throws:

Exception

getInputMappingNames

public String[] getInputMappingNames(String sql)
                              throws Exception

Throws:

Exception

getdbSchemaList

public String[] getdbSchemaList(String datasourceId)
                         throws Exception

Throws:

Exception

getPaginatedSchemaInfo

public PaginatedTableInfo getPaginatedSchemaInfo(int pageNumber,
                                                 String datasourceId)
                                          throws Exception

Throws:

Exception

getTableList

public String[] getTableList(String datasourceId,
                             String dbName,
                             String[] schemas)
                      throws org.apache.axis2.AxisFault

Throws:

org.apache.axis2.AxisFault

getPaginatedTableInfo

public PaginatedTableInfo getPaginatedTableInfo(int pageNumber,
                                                String datasourceId,
                                                String dbName,
                                                String[] schemas)
                                         throws Exception

Throws:

Exception

getDSServiceList

public String[] getDSServiceList(String dataSourceId,
                                 String dbName,
                                 String[] schemas,
                                 String[] tableNames,
                                 boolean singleService,
                                 String serviceNamespace)
                          throws Exception

Return the generated services name list

Throws:

Exception

getDSService

public String getDSService(String dataSourceId,
                           String dbName,
                           String[] schemas,
                           String[] tableNames,
                           boolean singleService,
                           String serviceName,
                           String serviceNamespace)
                    throws Exception

Return the generated service name

Throws:

Exception

validateJSONMapping

public String validateJSONMapping(String jsonMapping)

getAllRoles

public String[] getAllRoles(String authProviderConfig)
                     throws org.apache.axis2.AxisFault

Service method to get all the user roles for use in role based filtering when creating data services.

Parameters:

authProviderConfig - xml config of the authentication provider

Returns:

String array of roles

Throws:

org.apache.axis2.AxisFault