Package com.kaltura.client.utils.request

Class MultiRequestBuilder

java.lang.Object

com.kaltura.client.utils.request.RequestBuilderData<SelfType>

com.kaltura.client.utils.request.BaseRequestBuilder<List<Object>,MultiRequestBuilder>

com.kaltura.client.utils.request.MultiRequestBuilder

All Implemented Interfaces:

RequestElement<List<Object>>

public class MultiRequestBuilder
extends BaseRequestBuilder<List<Object>,MultiRequestBuilder>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MultiRequestBuilder.Tokenizer

Field Summary

Fields

Modifier and Type	Field	Description
static String	MULTIREQUEST_ACTION	the service name in the request url: "...service/multirequest"

Fields inherited from class com.kaltura.client.utils.request.BaseRequestBuilder

connectionConfig, files, headers, onCompletion, type, url

Fields inherited from class com.kaltura.client.utils.request.RequestBuilderData

params

Constructor Summary

Constructors

Constructor	Description
MultiRequestBuilder()
MultiRequestBuilder(RequestBuilder<?,?,?>... requests)	constructs instance and fill it with requests

Method Summary

Modifier and Type	Method	Description
MultiRequestBuilder	add(MultiRequestBuilder multiRequestBuilder)	Adds the requests from kalturaMultiRequestBuilder parameter to the end of the current requests list
MultiRequestBuilder	add(RequestBuilder<?,?,?> request)
MultiRequestBuilder	add(RequestBuilder<?,?,?>... requests)	adds 1 or more single request to be activated as part of the multrequest
String	getAction()
String	getTag()
String	getUrlTail()
MultiRequestBuilder	link(int sourceRequestIdx, int destRequestIdx, String sourceKey, String destKey)	Binds request param value to another request's response value.
MultiRequestBuilder	link(RequestBuilder<?,?,?> sourceRequest, RequestBuilder<?,?,?> destRequest, String sourceKey, String destKey)	Binds request param value to another request's response value.
void	onComplete(Response<List<Object>> response)
protected Object	parse(String response)
MultiRequestBuilder	setCompletion(OnCompletion<Response<List<Object>>> onCompletion)

Methods inherited from class com.kaltura.client.utils.request.BaseRequestBuilder

build, build, config, generateErrorResponse, getBody, getContentType, getFiles, getHeaders, getMethod, getParams, getType, getUrl, parseResponse, prepareHeaders, prepareParams, prepareUrl, setFile, setHeaders, setHeaders, setParams

Methods inherited from class com.kaltura.client.utils.request.RequestBuilderData

setApiVersion, setClientTag, setKs, setLanguage, setPartnerId, setResponseProfile, setSessionId

Methods inherited from class java.lang.Object

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

Field Detail

MULTIREQUEST_ACTION

public static final String MULTIREQUEST_ACTION

the service name in the request url: "...service/multirequest"

See Also:

Constant Field Values

Constructor Detail

MultiRequestBuilder

public MultiRequestBuilder()

MultiRequestBuilder

public MultiRequestBuilder(RequestBuilder<?,?,?>... requests)

constructs instance and fill it with requests

Parameters:

requests - requests list

Method Detail

setCompletion

public MultiRequestBuilder setCompletion(OnCompletion<Response<List<Object>>> onCompletion)

add

public MultiRequestBuilder add(RequestBuilder<?,?,?>... requests)

adds 1 or more single request to be activated as part of the multrequest

Parameters:

requests - requests list

Returns:

MultiRequestBuilder

add

public MultiRequestBuilder add(RequestBuilder<?,?,?> request)

add

public MultiRequestBuilder add(MultiRequestBuilder multiRequestBuilder)

Adds the requests from kalturaMultiRequestBuilder parameter to the end of the current requests list

Parameters:

multiRequestBuilder - another multirequests to copy requests from

Returns:

MultiRequestBuilder

onComplete

public void onComplete(Response<List<Object>> response)

Specified by:

onComplete in interface RequestElement<List<Object>>

Overrides:

onComplete in class BaseRequestBuilder<List<Object>,MultiRequestBuilder>

parse

protected Object parse(String response)
                throws APIException

Overrides:

parse in class BaseRequestBuilder<List<Object>,MultiRequestBuilder>

Throws:

APIException

getUrlTail

public String getUrlTail()

Specified by:

getUrlTail in class BaseRequestBuilder<List<Object>,MultiRequestBuilder>

Returns:

- The url postfix for Multirequest

getAction

public String getAction()

link

public MultiRequestBuilder link(int sourceRequestIdx,
                                int destRequestIdx,
                                String sourceKey,
                                String destKey)

Binds request param value to another request's response value.

Parameters:

sourceRequestIdx - the index of the request from which response value should be taken from

destRequestIdx - the index of the destination request in the multirequest list

sourceKey - the properties path in the response to the needed value (exp. user.loginSession.ks)

destKey - the property that will get the result from the source request

Returns:

MultiRequestBuilder

link

public MultiRequestBuilder link(RequestBuilder<?,?,?> sourceRequest,
                                RequestBuilder<?,?,?> destRequest,
                                String sourceKey,
                                String destKey)

Binds request param value to another request's response value. In request body the value of the destKey parameter will have a formatted string indicating the source request index in the list and the path in the response to bind as value

Parameters:

sourceRequest - the request from which response value will be taken

destRequest - the request to bind to it's parameter.

sourceKey - propeties path in the source request response.

destKey - the param property to set its value as linked.

Returns:

MultiRequestBuilder

getTag

public String getTag()

Specified by:

getTag in interface RequestElement<List<Object>>

Specified by:

getTag in class BaseRequestBuilder<List<Object>,MultiRequestBuilder>