com.adobe.versioncue.nativecomm

Interface IRequest

public interface IRequest

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IRequest.IListener Listener interface to get progress information during request execution

Method Summary

Modifier and Type	Method and Description
java.lang.String	call()
IResult	execute() Performs a synchronous message transaction with the underlying native process.
IRequest.IListener	listener()
IRequest	listener(IRequest.IListener listener) Sets the progress listener of this request
NCMap	params()
IRequest	params(NCMap params)
INativeService	processPool() Deprecated. use service() instead
IRequest	put(java.lang.String name, boolean value) Add a request parameter
IRequest	put(java.lang.String name, java.nio.ByteBuffer value) Add a request parameter
IRequest	put(java.lang.String name, double value) Add a request parameter
IRequest	put(java.lang.String name, INCExternalizable value) Add a request parameter
IRequest	put(java.lang.String name, int value) Add a request parameter
IRequest	put(java.lang.String name, long value) Add a request parameter
IRequest	put(java.lang.String name, NCType value) Add a request parameter
IRequest	put(java.lang.String name, java.lang.String value) Add a request parameter
int	retries()
IRequest	retries(int retries) Sets the maximum number of retries for this request.
INativeService	service()
int	timeout()
IRequest	timeout(int timeout) Sets the timeout of this request in milliseconds

Method Detail

processPool

@Deprecated
INativeService processPool()

Deprecated. use service() instead

Returns:

INativeService to execute on

service

INativeService service()

Returns:

INativeService to execute on

call

java.lang.String call()

Returns:

NativeService call name

params

NCMap params()

Returns:

NativeService parameters dictionary

params

IRequest params(NCMap params)

Parameters:

params - NativeService parameters dictionary

Returns:

the IRequest

timeout

int timeout()

Returns:

timeout of this request in milliseconds; 0 == no timeout

timeout

IRequest timeout(int timeout)

Sets the timeout of this request in milliseconds

Parameters:

timeout - timeout of this request in milliseconds; 0 == no timeout

Returns:

the IRequest

retries

int retries()

Returns:

maximum number of retries for this request; 0 == do not retry

retries

IRequest retries(int retries)

Sets the maximum number of retries for this request.

Parameters:

retries - maximum number of retries for this request; 0 == do not retry

Returns:

the IRequest

listener

IRequest.IListener listener()

Returns:

the progress listener of this request

listener

IRequest listener(IRequest.IListener listener)

Sets the progress listener of this request

Parameters:

listener - progress listener of this request

Returns:

the IRequest

execute

IResult execute()
         throws NativeCommException

Performs a synchronous message transaction with the underlying native process. The request is send to the next idle native process.

The method then blocks until a response is received or the request times out.

The response is returned to the caller.

Returns:

native process repsonse

Throws:

NativeCommException - on failure

put

IRequest put(java.lang.String name,
             NCType value)

Add a request parameter

Parameters:

name - parameter name

value - parameter value

Returns:

the IRequest

put

IRequest put(java.lang.String name,
             INCExternalizable value)

Add a request parameter

Parameters:

name - parameter name

value - parameter value

Returns:

the IRequest

put

IRequest put(java.lang.String name,
             java.lang.String value)

Add a request parameter

Parameters:

name - parameter name

value - parameter value

Returns:

the IRequest

put

IRequest put(java.lang.String name,
             boolean value)

Add a request parameter

Parameters:

name - parameter name

value - parameter value

Returns:

the IRequest

put

IRequest put(java.lang.String name,
             int value)

Add a request parameter

Parameters:

name - parameter name

value - parameter value

Returns:

the IRequest

put

IRequest put(java.lang.String name,
             long value)

Add a request parameter

Parameters:

name - parameter name

value - parameter value

Returns:

the IRequest

put

IRequest put(java.lang.String name,
             double value)

Add a request parameter

Parameters:

name - parameter name

value - parameter value

Returns:

the IRequest

put

IRequest put(java.lang.String name,
             java.nio.ByteBuffer value)

Add a request parameter

Parameters:

name - parameter name

value - parameter value

Returns:

the IRequest