jadex.platform.service.remote.commands

Class RemoteResultCommand

java.lang.Object

jadex.bridge.service.types.security.DefaultAuthorizable

jadex.platform.service.remote.commands.AbstractRemoteCommand

jadex.platform.service.remote.commands.RemoteResultCommand

All Implemented Interfaces:

jadex.bridge.service.types.security.IAuthorizable, IRemoteCommand

Direct Known Subclasses:

RemoteFutureSourceCommand, RemoteIntermediateResultCommand

public class RemoteResultCommand
extends AbstractRemoteCommand

Command that represents the result(s) of a remote command. Notifies the caller about the result.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	callid The callid.
protected java.lang.Exception	exception The exception.
protected boolean	isref The flag if result is declared as reference.
protected java.lang.String	methodname The method name.
protected java.lang.Object	result The result.
protected jadex.bridge.IComponentIdentifier	sender The sending component.

Fields inherited from class jadex.platform.service.remote.commands.AbstractRemoteCommand

nonfunc, receiver

Fields inherited from class jadex.bridge.service.types.security.DefaultAuthorizable

authdata, dcontent, dur, timestamp

Constructor Summary

Constructors

Constructor and Description
RemoteResultCommand() Create a new remote result command.
RemoteResultCommand(jadex.bridge.IComponentIdentifier sender, java.lang.Object result, java.lang.Exception exception, java.lang.String callid, boolean isref, java.lang.String methodname, java.util.Map<java.lang.String,java.lang.Object> nonfunc) Create a new remote result command.

Method Summary

Modifier and Type	Method and Description
jadex.commons.future.IIntermediateFuture	execute(jadex.bridge.IExternalAccess component, RemoteServiceManagementService rsms) Execute the command.
java.lang.String	getCallId() Get the callid.
java.lang.Exception	getException() Get the exception.
java.lang.String	getMethodName() Get the methodname.
java.lang.Object	getResult() Get the result.
java.lang.String	getSecurityLevel() Get the security level of the request.
jadex.bridge.IComponentIdentifier	getSender() Get the sender.
jadex.commons.future.IFuture<java.lang.Void>	preprocessCommand(jadex.bridge.IInternalAccess component, RemoteReferenceModule rrm, jadex.bridge.IComponentIdentifier target) Preprocess command and replace if they are remote references.
void	setCallId(java.lang.String callid) Set the callid.
void	setException(java.lang.Exception exception) Set the exception.
void	setMethodName(java.lang.String methodname) Set the methodname.
void	setResult(java.lang.Object result) Set the result.
void	setSender(jadex.bridge.IComponentIdentifier sender) Set the sender.
java.lang.String	toString() Get as string.

Methods inherited from class jadex.platform.service.remote.commands.AbstractRemoteCommand

getNonFunctionalProperties, getNonFunctionalProperty, getOrigin, getRealReceiver, getReceiver, postprocessCommand, setNonFunctionalProperties

Methods inherited from class jadex.bridge.service.types.security.DefaultAuthorizable

getAuthenticationData, getDigestContent, getTimestamp, getValidityDuration, setAuthenticationData, setDigestContent, setTimestamp, setValidityDuration

Methods inherited from class java.lang.Object

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

Methods inherited from interface jadex.bridge.service.types.security.IAuthorizable

getAuthenticationData, getDigestContent, getTimestamp, getValidityDuration, setAuthenticationData, setTimestamp

Field Detail

sender

protected jadex.bridge.IComponentIdentifier sender

The sending component.

result

protected java.lang.Object result

The result.

exception

protected java.lang.Exception exception

The exception.

callid

protected java.lang.String callid

The callid.

isref

protected boolean isref

The flag if result is declared as reference.

methodname

protected java.lang.String methodname

The method name. For debugging.

Constructor Detail

RemoteResultCommand

public RemoteResultCommand()

Create a new remote result command.

RemoteResultCommand

public RemoteResultCommand(jadex.bridge.IComponentIdentifier sender,
                           java.lang.Object result,
                           java.lang.Exception exception,
                           java.lang.String callid,
                           boolean isref,
                           java.lang.String methodname,
                           java.util.Map<java.lang.String,java.lang.Object> nonfunc)

Create a new remote result command.

Method Detail

preprocessCommand

public jadex.commons.future.IFuture<java.lang.Void> preprocessCommand(jadex.bridge.IInternalAccess component,
                                                                      RemoteReferenceModule rrm,
                                                                      jadex.bridge.IComponentIdentifier target)

Preprocess command and replace if they are remote references.

Overrides:

preprocessCommand in class AbstractRemoteCommand

execute

public jadex.commons.future.IIntermediateFuture execute(jadex.bridge.IExternalAccess component,
                                                        RemoteServiceManagementService rsms)

Execute the command.

Parameters:

lrms - The local remote management service.

Returns:

An optional result command that will be sent back to the command origin.

getSecurityLevel

public java.lang.String getSecurityLevel()

Get the security level of the request.

Specified by:

getSecurityLevel in interface jadex.bridge.service.types.security.IAuthorizable

Overrides:

getSecurityLevel in class jadex.bridge.service.types.security.DefaultAuthorizable

getResult

public java.lang.Object getResult()

Get the result.

Returns:

the result.

setResult

public void setResult(java.lang.Object result)

Set the result.

Parameters:

result - The result to set.

getException

public java.lang.Exception getException()

Get the exception.

Returns:

The exception.

setException

public void setException(java.lang.Exception exception)

Set the exception.

Parameters:

exception - The exception to set.

getCallId

public java.lang.String getCallId()

Get the callid.

Returns:

the callid.

setCallId

public void setCallId(java.lang.String callid)

Set the callid.

Parameters:

callid - The callid to set.

getMethodName

public java.lang.String getMethodName()

Get the methodname.

Returns:

the methodname.

setMethodName

public void setMethodName(java.lang.String methodname)

Set the methodname.

Parameters:

methodname - The methodname to set.

getSender

public jadex.bridge.IComponentIdentifier getSender()

Get the sender.

Overrides:

getSender in class AbstractRemoteCommand

Returns:

the sender.

setSender

public void setSender(jadex.bridge.IComponentIdentifier sender)

Set the sender.

Parameters:

sender - The sender to set.

toString

public java.lang.String toString()

Get as string.

Overrides:

toString in class java.lang.Object