org.wso2.carbon.dataservices.core.dispatch

Class DataServiceRequest

java.lang.Object

org.wso2.carbon.dataservices.core.dispatch.DataServiceRequest

Direct Known Subclasses:

BatchDataServiceRequest, BoxcarringDataServiceRequest, RequestBoxRequest, SingleDataServiceRequest

public abstract class DataServiceRequest
extends Object

Represents a data services request.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DataServiceRequest(DataService dataService, String requestName)

Method Summary

Modifier and Type	Method and Description
static DataServiceRequest	createDataServiceRequest(org.apache.axis2.context.MessageContext msgContext)
org.apache.axiom.om.OMElement	dispatch() Dispatches the current request.
DataService	getDataService()
String	getRequestName()
String	getUser()
String[]	getUserRoles()
static boolean	isBoxcarringRequest(String requestName) Checks if the given request is a boxcarring request.
boolean	isDisableStreaming()
abstract org.apache.axiom.om.OMElement	processRequest() This method must implement the request specific request processing logic.
void	setUser(String requestUser)
void	setUserRoles(String[] userRoles)

Methods inherited from class java.lang.Object

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

Constructor Detail

DataServiceRequest

protected DataServiceRequest(DataService dataService,
                             String requestName)
                      throws DataServiceFault

Throws:

DataServiceFault

Method Detail

createDataServiceRequest

public static DataServiceRequest createDataServiceRequest(org.apache.axis2.context.MessageContext msgContext)
                                                   throws DataServiceFault

Throws:

DataServiceFault

getDataService

public DataService getDataService()

getRequestName

public String getRequestName()

isDisableStreaming

public boolean isDisableStreaming()

isBoxcarringRequest

public static boolean isBoxcarringRequest(String requestName)

Checks if the given request is a boxcarring request.

Parameters:

requestName - The request name

Returns:

True if this is a boxcarring request.

setUser

public void setUser(String requestUser)

getUser

public String getUser()

setUserRoles

public void setUserRoles(String[] userRoles)

getUserRoles

public String[] getUserRoles()

dispatch

public org.apache.axiom.om.OMElement dispatch()
                                       throws DataServiceFault

Dispatches the current request. This method does common dispatching logic and call the request type specific DataServiceRequestprocessRequest() method.

Returns:

The result of the request invocation

Throws:

DataServiceFault

processRequest

public abstract org.apache.axiom.om.OMElement processRequest()
                                                      throws DataServiceFault

This method must implement the request specific request processing logic.

Returns:

The result of the request invocation

Throws:

DataServiceFault