org.wso2.carbon.dataservices.core.tools

Class DSTools

java.lang.Object

org.wso2.carbon.dataservices.core.tools.DSTools

public class DSTools
extends Object

This class is used in creating and invoking data services locally, without running it as a server.

Constructor Summary

Constructors

Constructor and Description
DSTools()

Method Summary

Modifier and Type	Method and Description
static void	abortBoxcar(DataService dataService) This method aborts the current boxcarring session
static org.apache.axiom.om.OMElement	accessResource(DataService dataService, String resourcePath, Map<String,ParamValue> params, String accessMethod) This method accesses a resource defined in the data service.
static void	beginBoxcar(DataService dataService) This method begins a boxcarring session.
static DataService	createDataService(org.apache.axiom.om.OMElement dbsElement, String dsLocation) This method creates a DataService object, given the data services descriptor information.
static org.apache.axiom.om.OMElement	endBoxcar(DataService dataService) This method ends and commits a boxcarring session.
static void	invokeOperation(DataService dataService, String operationName, List<Map<String,ParamValue>> batchParams) This method invokes the batch version of the operation defined in the given data service.
static org.apache.axiom.om.OMElement	invokeOperation(DataService dataService, String operationName, Map<String,ParamValue> params) This method invokes a single operation defined in the given data service.
static org.apache.axiom.om.OMElement	serializeDataService(DataService dataService) This method serializes the given DataService object to a data services configuration document (.dbs XML file format).
static void	setDataServicesUser(DataServiceUser user) This method sets the current active data services user.

Methods inherited from class java.lang.Object

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

Constructor Detail

DSTools

public DSTools()

Method Detail

createDataService

public static DataService createDataService(org.apache.axiom.om.OMElement dbsElement,
                                            String dsLocation)
                                     throws DataServiceFault

This method creates a DataService object, given the data services descriptor information.

Parameters:

dbsElement - The OMElement of the DBS file root element.

dsLocation - The location of the DBS file, this is purely used for informational purposes and can be null.

Returns:

The initialized DataService object.

Throws:

DataServiceFault - The exception is thrown if the DataService cannot be initialized, i.e. authentication problems, cannot create database connections etc.

serializeDataService

public static org.apache.axiom.om.OMElement serializeDataService(DataService dataService)

This method serializes the given DataService object to a data services configuration document (.dbs XML file format).

Parameters:

dataService - The DataService object to be serialized.

Returns:

return an OMElement representing the root element of a data services configuration document.

setDataServicesUser

public static void setDataServicesUser(DataServiceUser user)

This method sets the current active data services user.

Parameters:

user - This represents the data service objects which contains the username and user roles.

beginBoxcar

public static void beginBoxcar(DataService dataService)
                        throws DataServiceFault

This method begins a boxcarring session.

Parameters:

dataService - The DataService object which represents the data service

Throws:

DataServiceFault - thrown if an error condition occurs in executing the operation

endBoxcar

public static org.apache.axiom.om.OMElement endBoxcar(DataService dataService)
                                               throws DataServiceFault

This method ends and commits a boxcarring session.

Parameters:

dataService - The DataService object which represents the data service

Returns:

returns the XML payload if there is any from the boxcarring session

Throws:

DataServiceFault - thrown if an error condition occurs in executing the operation

abortBoxcar

public static void abortBoxcar(DataService dataService)
                        throws DataServiceFault

This method aborts the current boxcarring session

Parameters:

dataService - The DataService object which represents the data service

Throws:

DataServiceFault - thrown if an error condition occurs in executing the operation

invokeOperation

public static org.apache.axiom.om.OMElement invokeOperation(DataService dataService,
                                                            String operationName,
                                                            Map<String,ParamValue> params)
                                                     throws DataServiceFault

This method invokes a single operation defined in the given data service.

Parameters:

dataService - The DataService object which represents the data service.

operationName - The name of the operation.

params - The parameters destined for the operation.

Returns:

returns the XML result if it exists.

Throws:

DataServiceFault - thrown if an error condition occurs in executing the operation.

See Also:

invokeOperation(DataService, String, List)

invokeOperation

public static void invokeOperation(DataService dataService,
                                   String operationName,
                                   List<Map<String,ParamValue>> batchParams)
                            throws DataServiceFault

This method invokes the batch version of the operation defined in the given data service.

Parameters:

dataService - The DataService object which represents the data service.

operationName - The name of the operation.

params - The lists of parameters destined for the operation.

Throws:

DataServiceFault - thrown if an error condition occurs in executing the batch operation.

See Also:

invokeOperation(DataService, String, Map)

accessResource

public static org.apache.axiom.om.OMElement accessResource(DataService dataService,
                                                           String resourcePath,
                                                           Map<String,ParamValue> params,
                                                           String accessMethod)
                                                    throws DataServiceFault

This method accesses a resource defined in the data service.

Parameters:

dataService - The DataService object which represents the data service.

resourcePath - The resource path of the data service resource.

params - The parameters destined for the resource.

accessMethod - The HTTP access method defined in the data service resource.

Returns:

returns the XML result if it exists.

Throws:

DataServiceFault - thrown if an error condition occurs in accessing the resource.