com.tibco.as.space.router

Class RouterActionResult

java.lang.Object

com.tibco.as.space.router.RouterActionResult

All Implemented Interfaces:

Result

public abstract class RouterActionResult
extends java.lang.Object
implements Result

Constructor Summary

Constructors

Constructor and Description
RouterActionResult()

Method Summary

Modifier and Type	Method and Description
static RouterActionResult	create()
static RouterActionResult	create(byte[] data)
static RouterActionResult	create(RouterWriteAction routerWriteAction, java.lang.String sourceSiteName)
static RouterActionResult	create(Tuple tuple)
abstract void	deserialize(byte[] bytes)
abstract long	getLogNum()
abstract java.lang.String	getRequestId()
abstract java.lang.String	getSourceSiteName()
abstract Tuple	getTuple()
abstract byte[]	serialize() Serialize the RouteActionResult
abstract RouterActionResult	setFailed() Indicate that Action failed
abstract RouterActionResult	setFailed(ASException exception) Set the exception of the failure
abstract RouterActionResult	setTuple(Tuple tuple)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tibco.as.space.Result

getError, getStatus, hasError

Constructor Detail

RouterActionResult

public RouterActionResult()

Method Detail

create

public static RouterActionResult create()

create

public static RouterActionResult create(byte[] data)
                                 throws ASException

Throws:

ASException

create

public static RouterActionResult create(RouterWriteAction routerWriteAction,
                                        java.lang.String sourceSiteName)
                                 throws ASException

Throws:

ASException

create

public static RouterActionResult create(Tuple tuple)

Parameters:

tuple - Tuple to pass with the action result

Returns:

ActionResult this action result is returned

getRequestId

public abstract java.lang.String getRequestId()

Returns:

String router action request ID

getLogNum

public abstract long getLogNum()

Returns:

long log number

getSourceSiteName

public abstract java.lang.String getSourceSiteName()

Returns:

String source site name

setFailed

public abstract RouterActionResult setFailed()

Indicate that Action failed

Returns:

ActionResult this action result is returned

setFailed

public abstract RouterActionResult setFailed(ASException exception)

Set the exception of the failure

Parameters:

exception - of the route failure

Returns:

ActionResult this action result is returned

setTuple

public abstract RouterActionResult setTuple(Tuple tuple)

Parameters:

tuple - Tuple to pass with the action result

Returns:

ActionResult this action result is returned

getTuple

public abstract Tuple getTuple()

Returns:

Tuple if setTuple was called.

serialize

public abstract byte[] serialize()
                          throws ASException

Serialize the RouteActionResult

Returns:

RouteActionResult

Throws:

ASException

deserialize

public abstract void deserialize(byte[] bytes)
                          throws ASException

Throws:

ASException