FileTransferAgent (Esprit Network Suite)

java.lang.Object
- de.esprit.common.util.DumpableObject
- - de.esprit.common.util.TransferableObject
  - - de.esprit.netsuite.netdata.AbstractCrossPlatformObject<C,S>
    - - de.esprit.netsuite.netdata.agent.AbstractAgent<C,S>
      - de.esprit.netsuite.netdata.agent.AbstractLockableAgent<C,S>
        
        de.esprit.netsuite.netdata.agent.AbstractCommonAgent<C,S>
        
        de.esprit.netsuite.netdata.agent.internal.transfer.FileTransferAgent<C,S>

All Implemented Interfaces:

TaskEvent.Source, TaskIdHolder, Renderable, SimpleLogSupport, DeepCloneable, Dumpable, ClientObject<C>, Agent<C,S>, AsyncAgent<C,S>, PrintableAgent, PrintableInMessage, PrintableInResponse, TimeMeasurable, CrossPlatformObject<C,S>, ResourceLockHolder, ServerObject<S>, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

ExFileSetTransferAgent, ExFileTransferAgent, ExMixedFileTransferAgent
```
public class FileTransferAgent<C extends ClientContext,S extends ServerContext>
extends AbstractCommonAgent<C,S>
implements PrintableAgent, TaskEvent.Source
```
This agent performs a bidirectional file transfer for the FileTransferJobs which it contains. It builds a FileTransferJobList, checks the validity of the content on client and server and if both succeed, starts a FileTransferClientTask for performing the up/downloads via the transfer Channel.
A file transfer runs asynchronously by default but this can be controlled with setTransferAsync(boolean). You may also automatically acquire a ResourceLock with setTransferLocked(boolean). Note that if a locked transfer is being run synchronously the client would not be able to retrigger the lock. Therefore retriggering is disabled for this case and the lock will never time out on the server.

Author:

Rainer Buesch

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description
`FileTransferAgent(C clientCtx)`
`FileTransferAgent(C clientCtx, boolean isTransferAsync)`
`FileTransferAgent(C clientCtx, java.lang.String jobName)`
`FileTransferAgent(C clientCtx, java.lang.String jobName, boolean isTransferAsync)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addJob(FileTransferJob job)`
`void`	`addTaskListener(TaskEvent.Listener l)`
`void`	`awaitClientCommit()` Blocks the calling thread until the commit was received by the server
`void`	`clearClientParams()` Clears the parameters in the client cache that have been set by this agent.
`void`	`clearJobs()`
`protected AgentId`	`createAgentId(SessionId sessId)`
`void`	`doInitiallyOnClient()` Is executed just before the agent is being sent to the server.
`void`	`doOnClientSideCancellation()` Is called by the `TaskManager` when an `AgentId` is being cancelled.
`void`	`doOnResponseConfirmed()` Is called on an agent when it was received in a `NetResponse` AFTER the response has been confirmed to the server.
`void`	`doOnServerSideCancellation()` Is called by the `AgentExecutorTask` when a cancellation has been detected.
`boolean`	`equals(java.lang.Object obj)` Evaluates equality by comparing the AgentId object.
`void`	`executeForResponse()` Performs the initial check on the servers target directory.
`void`	`executeOnServer()` This is the agent's main execution method called on the server.
`TransferAgentId`	`getAgentId()` Returns a server side unique identifier.
`java.lang.Object`	`getArgument()` Returns the optional argument of this agent.
`<T> T`	`getClientParam(java.lang.String key)` Fetches an agent specific parameter from the client cache.
`java.util.Map`	`getClientParams()` Allows an async agent to store an Agent-specific parameter in a client cache.
`FileTransferClientTask`	`getClientTask()`
`java.lang.Exception`	`getError()` Returns the Exception that may have been raised during agent execution on the server.
`int`	`getJobCount()`
`JobId`	`getJobId()`
`FileTransferJobList`	`getJobList()`
`java.lang.String`	`getJobName()`
`java.lang.String`	`getName()` Returns a meaningful name for debugging purposes.
`SessionId`	`getOwnerSessionId()` Returns session id of the actual originator client (which cannot be a CoClient, but just a normal client)
`int`	`getPriority()` Returns the thread priority which is used to execute this agent
`long`	`getProcessingDuration()` Returns the time (in millis) it has taken to process the agent on server side.
`long`	`getReceivedTime()` Tells when the agent was received by the client
`protected java.lang.String`	`getResourceName()` Is used as the resource name for locking if locking us used
`protected ResourceType`	`getResourceType()`
`int`	`getResponseTimeout()` Returns the desired timeout (in seconds) that should apply to this agent, or 0 if no timeout should be used.
`long`	`getSentTime()` Tells when the agent was sent by the client
`SessionId`	`getSessionId()` Returns the SessionId of the owner of this agent
`java.lang.String`	`getTargetServer()` Returns the target server if one is set.
`TaskId`	`getTaskId()` Returns the unique identifier for this task.
`long`	`getTotalDuration()` Returns the time (in millis) it has taken from sending to finishing postprocessing of the agent.
`long`	`getTransferDuration()` Returns the time (in millis) it has taken from sending to receiving the agent.
`protected int`	`getZippedArgumentLength()`
`boolean`	`hasClientParam(java.lang.String key)` Checks whether an agent specific parameter exists in the client cache.
`boolean`	`hasError()` Tells whether the agent had an Exception during execution on server side.
`int`	`hashCode()`
`boolean`	`hasRun()` Tells whether this agent has been executed on the server.
`boolean`	`isPartialResultsEnabled()` Tells whether the agent supports partial results.
`boolean`	`isReceived()` Tells whether this agent yet has been received by the client.
`boolean`	`isReceivedInMessage()` Returns true if the agent has been received within a message.
`boolean`	`isReceivedInResponse()` Returns true if the agent has been received within a response.
`boolean`	`isRejectable()` Tells whether this agent can be rejected when the server is on heavy load.
`boolean`	`isTransferAsync()`
`boolean`	`isTransferLocked()`
`void`	`logDebug(java.lang.String message)`
`void`	`logDump(java.lang.String message)`
`void`	`logError(java.lang.String message)`
`void`	`logError(java.lang.String message, java.lang.Exception error)`
`void`	`logFatal(java.lang.String message, java.lang.Exception error)`
`void`	`logInfo(java.lang.String message)`
`void`	`logVerbose(java.lang.String message)`
`void`	`logWarning(java.lang.String message)`
`void`	`processCommitMessage()` Is called directly by the MessageReceiveThread before message postprocessing is done
`void`	`putClientParam(java.lang.String key, java.lang.Object value)` Putting a null value results in removing the key
`void`	`removeTaskListener(TaskEvent.Listener l)`
`boolean`	`sendForBooleanExecution()` Same as `Agent.sendForExecution()` but does not return the agent, rather it returns true if the agent has successfully being processed, false otherwise.
`FileTransferAgent`	`sendForExecution()` Sends the agent to the server for execution and returns the readily processed agent.
`<A extends Agent<C,S>> A`	`sendForSilentExecution()` Same as `Agent.sendForExecution()` just without throwing an Exception.
`void`	`setArgument(java.lang.Object arg)` Besides any internal variables the agent may optionally carry an arbitrary argument.
`void`	`setArgument(java.lang.Object arg, boolean doZip)` Same as setArgument(Object) but compresses the argument to a zipped byte array.
`void`	`setFailed(java.lang.Exception error)` Sets the internal Exception of the Agent.
`void`	`setFinished()` Is called by the server to mark this agent as being processed and stores the processing duration.
`void`	`setName(java.lang.String agentName)` Sets a meaningful name for debugging purposes.
`void`	`setOwnerSessionId(SessionId origSessId)` Sets the sessionId of the user who creates the agent
`void`	`setPartialResultsEnabled(boolean isEnabled)` Tells whether the agent supports partial results.
`void`	`setPriority(int priority)` Sets the thread priority which is used to execute this agent
`void`	`setReceivedInMessage(boolean isReceivedInMessage)` Is set when this agent has been received within a message
`void`	`setReceivedTime(long receivedTime)` Is called by the client when the agent is received
`void`	`setRejectable(boolean state)` If set to false, then the agent cannot be rejected by the server even if the server is on heavy load.
`void`	`setResponseTimeout(int seconds)` Sets the response timeout in seconds.
`void`	`setRollbackEnabled(boolean isRollbackEnabled)`
`void`	`setSentTime(long sentTime)` Is called by the client when the agent is sent
`void`	`setServerContext(S serverCtx)` Sets the server runtime environment
`void`	`setSessionId(SessionId sessId)` Allows for setting the SessionId of this agent
`void`	`setTargetServer(java.lang.String targetServer)` Sets the target server.
`void`	`setTransferAsync(boolean isAsync)` Tells whether the caller should block until the file transfer has finished.
`void`	`setTransferLocked(boolean isLocked)` Enforces fetching an exclusive lock on the server prior to starting the transfer.
`DumpString`	`toDumpString(DumpString s)` This method creates a multi line debug output to display the full content of the agent.
`ToString`	`toString(ToString s)` This method creates a single line debug output to display the most important properties of the agent

Methods inherited from class de.esprit.netsuite.netdata.agent.AbstractLockableAgent
acquireAsExclusiveLock, getLock, hasLock, isAutoReleaseLock, lockDataSource, lockDataSourcePool, lockExclusive, lockExclusive, lockExclusive, lockExclusive, lockShared, lockShared, lockShared, releaseLock, releaseLock, setAutoReleaseLock, setLock

Methods inherited from class de.esprit.netsuite.netdata.agent.AbstractAgent
checkCancelled, checkPermission, doFinallyOnClient, doFinallyOnServer, doInitiallyOnServer, doOnMessageError, doOnMessageReceived, doOnResponseError, doOnResponseReceived, getKillerSessionId, getMessageTimeout, getRenderColor, getRenderIcon, getRenderText, isAsync, isIgnoreMessageError, isNoReturn, isTimedOut, setAsync, setCancelledBy, setIgnoreMessageError, setMessageTimeout, setNoReturn, sleepChecked, wasCancelled

Methods inherited from class de.esprit.netsuite.netdata.AbstractCrossPlatformObject
checkOnClient, checkOnServer, getClientContext, getLogChannel, getServerContext, isLogDebug, isLogVerbose, isOnClient, isOnServer, setClientContext, setLogChannel

Methods inherited from class de.esprit.common.util.TransferableObject
clone, deepClone

Methods inherited from class de.esprit.common.util.DumpableObject
configureDumpHeadlineLength, configureDumpMaxElementsPrinted, copyDumpStringValues, copyToStringValues, createDumpHeader, toDumpString, toString

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.esprit.netsuite.server.lock.ResourceLockHolder
getSessionId

Methods inherited from interface de.esprit.netsuite.netdata.agent.Agent
clearClientParams, getArgument, getClientParam, getClientParams, getError, getName, getOwnerSessionId, getPriority, getResponseTimeout, getSessionId, getTargetServer, hasClientParam, hasError, hasRun, isPartialResultsEnabled, isReceived, isReceivedInMessage, isReceivedInResponse, isRejectable, putClientParam, sendForBooleanExecution, sendForSilentExecution, setArgument, setArgument, setFailed, setFinished, setPartialResultsEnabled, setPriority, setReceivedInMessage, setRejectable, setResponseTimeout, setSessionId, setTargetServer

Methods inherited from interface de.esprit.netsuite.netdata.CrossPlatformObject
isOnClient, isOnServer, setClientContext, setServerContext

Methods inherited from interface de.esprit.netsuite.client.ClientObject
getClientContext

Methods inherited from interface de.esprit.netsuite.server.ServerObject
getServerContext

Methods inherited from interface de.esprit.common.type.Dumpable
toDumpString, toString

Methods inherited from interface de.esprit.common.type.DeepCloneable
deepClone

Methods inherited from interface de.esprit.netsuite.netdata.agent.TimeMeasurable
getProcessingDuration, getReceivedTime, getSentTime, getTotalDuration, getTransferDuration, setReceivedTime, setSentTime

Methods inherited from interface de.esprit.common.log.SimpleLogSupport
getLogChannel, isLogDebug, isLogVerbose, logDebug, logDump, logError, logError, logFatal, logInfo, logVerbose, logWarning, setLogChannel

- Constructor Detail
  - FileTransferAgent
```
public FileTransferAgent(C clientCtx)
```
  - FileTransferAgent
```
public FileTransferAgent(C clientCtx,
                 java.lang.String jobName)
```
  - FileTransferAgent
```
public FileTransferAgent(C clientCtx,
                 boolean isTransferAsync)
```
  - FileTransferAgent
```
public FileTransferAgent(C clientCtx,
                 java.lang.String jobName,
                 boolean isTransferAsync)
```
- Method Detail
  - createAgentId
```
protected AgentId createAgentId(SessionId sessId)
```
  - getAgentId
```
public TransferAgentId getAgentId()
```
    Description copied from interface: Agent
    
    Returns a server side unique identifier. Note that a client remembers this identifier which is used to cancel an asynchronously running agent.
    
    Specified by:
    
    getAgentId in interface Agent<C extends ClientContext,S extends ServerContext>
  - doOnClientSideCancellation
```
public void doOnClientSideCancellation()
```
    Description copied from interface: AsyncAgent
    
    Is called by the TaskManager when an AgentId is being cancelled. Within this method the agent may perform any client-side reaction on cancellation. Note that this method is called BEFORE the cancel-request is sent to the server.
    
    Specified by:
    
    doOnClientSideCancellation in interface AsyncAgent<C extends ClientContext,S extends ServerContext>
    
    Overrides:
    
    doOnClientSideCancellation in class AbstractAgent<C extends ClientContext,S extends ServerContext>
  - doOnServerSideCancellation
```
public void doOnServerSideCancellation()
```
    Description copied from interface: AsyncAgent
    
    Is called by the AgentExecutorTask when a cancellation has been detected. Within this method the agent may perform any server-side reaction on cancellation.
    
    Specified by:
    
    doOnServerSideCancellation in interface AsyncAgent<C extends ClientContext,S extends ServerContext>
    
    Overrides:
    
    doOnServerSideCancellation in class AbstractAgent<C extends ClientContext,S extends ServerContext>
  - sendForExecution
```
public FileTransferAgent sendForExecution()
                                   throws java.lang.Exception
```
    Description copied from interface: Agent
    
    Sends the agent to the server for execution and returns the readily processed agent. If the received agent contains an error this error is thrown.
    
    Specified by:
    
    sendForExecution in interface Agent<C extends ClientContext,S extends ServerContext>
    
    Throws:
    
    java.lang.Exception - on failure
    See Also:
    Agent.sendForSilentExecution(), Agent.sendForBooleanExecution()
  - setName
```
public final void setName(java.lang.String agentName)
```
    Description copied from interface: Agent
    
    Sets a meaningful name for debugging purposes. This name is printed in the toString() method by default. The default name is the latter part of the class-name.
    
    Specified by:
    
    setName in interface Agent<C extends ClientContext,S extends ServerContext>
  - setOwnerSessionId
```
public final void setOwnerSessionId(SessionId origSessId)
```
    Description copied from interface: Agent
    
    Sets the sessionId of the user who creates the agent
    
    Specified by:
    
    setOwnerSessionId in interface Agent<C extends ClientContext,S extends ServerContext>
  - getJobList
```
public final FileTransferJobList getJobList()
```
  - setRollbackEnabled
```
public final void setRollbackEnabled(boolean isRollbackEnabled)
```
  - setTransferLocked
```
public final void setTransferLocked(boolean isLocked)
```
    Enforces fetching an exclusive lock on the server prior to starting the transfer. The lock is automatically released when the transfer has finished. No locking is done by default. The default resource name is the name of the transfer job.
    
    See Also:
    getResourceName()
  - isTransferLocked
```
public final boolean isTransferLocked()
```
  - setTransferAsync
```
public final void setTransferAsync(boolean isAsync)
```
    Tells whether the caller should block until the file transfer has finished. By default a file transfer runs asynchronously without blocking the caller.
  - isTransferAsync
```
public final boolean isTransferAsync()
```
  - getJobCount
```
public final int getJobCount()
```
  - clearJobs
```
public final void clearJobs()
```
  - addJob
```
public final void addJob(FileTransferJob job)
```
  - getJobId
```
public final JobId getJobId()
```
  - getJobName
```
public final java.lang.String getJobName()
```
  - getResourceName
```
protected final java.lang.String getResourceName()
```
    Is used as the resource name for locking if locking us used
    
    See Also:
    setTransferLocked(boolean)
  - getResourceType
```
protected final ResourceType getResourceType()
```
  - executeForResponse
```
public final void executeForResponse()
                              throws java.lang.Exception
```
    Performs the initial check on the servers target directory. MUST NOT be overridden by subclasses.
    
    Specified by:
    
    executeForResponse in interface AsyncAgent<C extends ClientContext,S extends ServerContext>
    
    Overrides:
    
    executeForResponse in class AbstractAgent<C extends ClientContext,S extends ServerContext>
    
    Throws:
    
    java.lang.Exception
  - executeOnServer
```
public final void executeOnServer()
                           throws java.lang.Exception
```
    Description copied from interface: Agent
    
    This is the agent's main execution method called on the server.
    
    Specified by:
    
    executeOnServer in interface Agent<C extends ClientContext,S extends ServerContext>
    
    Throws:
    
    java.lang.Exception
  - doInitiallyOnClient
```
public final void doInitiallyOnClient()
                               throws java.lang.Exception
```
    Description copied from interface: Agent
    
    Is executed just before the agent is being sent to the server.
    
    Specified by:
    
    doInitiallyOnClient in interface Agent<C extends ClientContext,S extends ServerContext>
    
    Overrides:
    
    doInitiallyOnClient in class AbstractAgent<C extends ClientContext,S extends ServerContext>
    
    Throws:
    
    java.lang.Exception
  - doOnResponseConfirmed
```
public final void doOnResponseConfirmed()
                                 throws java.lang.Exception
```
    Description copied from interface: Agent
    
    Is called on an agent when it was received in a NetResponse AFTER the response has been confirmed to the server.
    
    Specified by:
    
    doOnResponseConfirmed in interface Agent<C extends ClientContext,S extends ServerContext>
    
    Overrides:
    
    doOnResponseConfirmed in class AbstractAgent<C extends ClientContext,S extends ServerContext>
    
    Throws:
    
    java.lang.Exception
  - processCommitMessage
```
public final void processCommitMessage()
```
    Is called directly by the MessageReceiveThread before message postprocessing is done
  - awaitClientCommit
```
public final void awaitClientCommit()
                             throws java.lang.Exception
```
    Blocks the calling thread until the commit was received by the server
    
    Throws:
    
    java.lang.Exception
  - getClientTask
```
public final FileTransferClientTask getClientTask()
```
  - addTaskListener
```
public final void addTaskListener(TaskEvent.Listener l)
```
    Specified by:
    
    addTaskListener in interface TaskEvent.Source
  - removeTaskListener
```
public final void removeTaskListener(TaskEvent.Listener l)
```
    Specified by:
    
    removeTaskListener in interface TaskEvent.Source
  - toString
```
public ToString toString(ToString s)
```
    This method creates a single line debug output to display the most important properties of the agent
    
    Specified by:
    
    toString in interface Dumpable
    
    Overrides:
    
    toString in class AbstractLockableAgent<C extends ClientContext,S extends ServerContext>
  - toDumpString
```
public DumpString toDumpString(DumpString s)
```
    This method creates a multi line debug output to display the full content of the agent.
    
    Specified by:
    
    toDumpString in interface Dumpable
    
    Overrides:
    
    toDumpString in class AbstractLockableAgent<C extends ClientContext,S extends ServerContext>
  - getClientParams
```
public final java.util.Map getClientParams()
```
    Description copied from interface: Agent
    
    Allows an async agent to store an Agent-specific parameter in a client cache. An agent or a sequence of agents can access such parameters when they have been received via message. The client cache is automatically cleared when the agent is done - no matter whether it was cancelled or normally finished.
    
    Specified by:
    
    getClientParams in interface Agent<C extends ClientContext,S extends ServerContext>
  - putClientParam
```
public final void putClientParam(java.lang.String key,
                  java.lang.Object value)
```
    Putting a null value results in removing the key
    
    Specified by:
    
    putClientParam in interface Agent<C extends ClientContext,S extends ServerContext>
    
    See Also:
    Agent.getClientParams()
  - getClientParam
```
public final <T> T getClientParam(java.lang.String key)
```
    Description copied from interface: Agent
    
    Fetches an agent specific parameter from the client cache.
    
    Specified by:
    
    getClientParam in interface Agent<C extends ClientContext,S extends ServerContext>
    
    See Also:
    Agent.getClientParams()
  - hasClientParam
```
public final boolean hasClientParam(java.lang.String key)
```
    Description copied from interface: Agent
    
    Checks whether an agent specific parameter exists in the client cache.
    
    Specified by:
    
    hasClientParam in interface Agent<C extends ClientContext,S extends ServerContext>
  - clearClientParams
```
public final void clearClientParams()
```
    Description copied from interface: Agent
    
    Clears the parameters in the client cache that have been set by this agent.
    
    Specified by:
    
    clearClientParams in interface Agent<C extends ClientContext,S extends ServerContext>
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Evaluates equality by comparing the AgentId object.
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getTaskId
```
public final TaskId getTaskId()
```
    Description copied from interface: TaskIdHolder
    
    Returns the unique identifier for this task. This identifier is only valid for a single task execution. When the same task instance executes another time then it will have a new TaskId.
    
    Specified by:
    
    getTaskId in interface TaskIdHolder
  - getSessionId
```
public final SessionId getSessionId()
```
    Returns the SessionId of the owner of this agent
    
    Specified by:
    
    getSessionId in interface Agent<C extends ClientContext,S extends ServerContext>
    
    See Also:
    Agent.setSessionId(SessionId), Agent.getOwnerSessionId()
  - setSessionId
```
public final void setSessionId(SessionId sessId)
```
    Description copied from interface: Agent
    
    Allows for setting the SessionId of this agent
    
    Specified by:
    
    setSessionId in interface Agent<C extends ClientContext,S extends ServerContext>
    
    See Also:
    Agent.getSessionId()
  - setServerContext
```
public final void setServerContext(S serverCtx)
```
    Description copied from interface: CrossPlatformObject
    
    Sets the server runtime environment
    
    Specified by:
    
    setServerContext in interface CrossPlatformObject<C extends ClientContext,S extends ServerContext>
    
    Overrides:
    
    setServerContext in class AbstractCrossPlatformObject<C extends ClientContext,S extends ServerContext>
    
    See Also:
    ServerObject.getServerContext()
  - isPartialResultsEnabled
```
public final boolean isPartialResultsEnabled()
```
    Description copied from interface: Agent
    
    Tells whether the agent supports partial results. If set to true then agent postprocessing takes place even if the agent contains an error.
    
    Specified by:
    
    isPartialResultsEnabled in interface Agent<C extends ClientContext,S extends ServerContext>
    
    See Also:
    Agent.setPartialResultsEnabled(boolean)
  - setPartialResultsEnabled
```
public final void setPartialResultsEnabled(boolean isEnabled)
```
    Description copied from interface: Agent
    
    Tells whether the agent supports partial results. If set to true then agent postprocessing takes place even if the agent contains an error.
    
    Specified by:
    
    setPartialResultsEnabled in interface Agent<C extends ClientContext,S extends ServerContext>
    
    See Also:
    Agent.isPartialResultsEnabled()
  - setRejectable
```
public final void setRejectable(boolean state)
```
    Description copied from interface: Agent
    
    If set to false, then the agent cannot be rejected by the server even if the server is on heavy load. Is true by default. This feature should be used sparingly because it may lead to overloading the server. A normal rejectable agent is put into the AgentWorkerThreadPool which has a limited capacity. A non-rejectable agent is put into the AgentSleeperThreadPool which as unlimited capacity.
    
    Specified by:
    
    setRejectable in interface Agent<C extends ClientContext,S extends ServerContext>
  - isRejectable
```
public final boolean isRejectable()
```
    Description copied from interface: Agent
    
    Tells whether this agent can be rejected when the server is on heavy load.
    
    Specified by:
    
    isRejectable in interface Agent<C extends ClientContext,S extends ServerContext>
  - getOwnerSessionId
```
public final SessionId getOwnerSessionId()
```
    Returns session id of the actual originator client (which cannot be a CoClient, but just a normal client)
    
    Specified by:
    
    getOwnerSessionId in interface Agent<C extends ClientContext,S extends ServerContext>
  - getTargetServer
```
public final java.lang.String getTargetServer()
```
    Description copied from interface: Agent
    
    Returns the target server if one is set.
    
    Specified by:
    
    getTargetServer in interface Agent<C extends ClientContext,S extends ServerContext>
    
    See Also:
    Agent.setTargetServer(String)
  - setTargetServer
```
public final void setTargetServer(java.lang.String targetServer)
```
    Description copied from interface: Agent
    
    Sets the target server. The target server may be any server in a cascading server network. The agent is being routed to the target server for execution.
    Note that target server routing is not supported for async agents.
    
    Specified by:
    
    setTargetServer in interface Agent<C extends ClientContext,S extends ServerContext>
    
    See Also:
    Agent.getTargetServer()
  - getName
```
public final java.lang.String getName()
```
    Description copied from interface: Agent
    
    Returns a meaningful name for debugging purposes. This name is printed in the toString() method by default.
    
    Specified by:
    
    getName in interface Agent<C extends ClientContext,S extends ServerContext>
  - setResponseTimeout
```
public final void setResponseTimeout(int seconds)
```
    Sets the response timeout in seconds. A zero value indicates that the DEFAULT_REQUEST_TIMEOUT is being used. A negative value indicates that there is no timeout constraint.
    
    Specified by:
    
    setResponseTimeout in interface Agent<C extends ClientContext,S extends ServerContext>
    
    See Also:
    Agent.getResponseTimeout()
  - getResponseTimeout
```
public final int getResponseTimeout()
```
    Description copied from interface: Agent
    
    Returns the desired timeout (in seconds) that should apply to this agent, or 0 if no timeout should be used.
    
    Specified by:
    
    getResponseTimeout in interface Agent<C extends ClientContext,S extends ServerContext>
    
    See Also:
    Agent.setResponseTimeout(int)
  - hasRun
```
public final boolean hasRun()
```
    Description copied from interface: Agent
    
    Tells whether this agent has been executed on the server. After execution it contains either an error or a valid result if applicable.
    
    Specified by:
    
    hasRun in interface Agent<C extends ClientContext,S extends ServerContext>
    
    See Also:
    Agent.hasError()
  - hasError
```
public final boolean hasError()
```
    Description copied from interface: Agent
    
    Tells whether the agent had an Exception during execution on server side.
    
    Specified by:
    
    hasError in interface Agent<C extends ClientContext,S extends ServerContext>
    
    See Also:
    Agent.getError()
  - getError
```
public final java.lang.Exception getError()
```
    Description copied from interface: Agent
    
    Returns the Exception that may have been raised during agent execution on the server. You must check with Agent.hasError() whether an Exception exists in the agent.
    
    Specified by:
    
    getError in interface Agent<C extends ClientContext,S extends ServerContext>
    
    See Also:
    Agent.setFailed(Exception), Agent.hasError()
  - setFinished
```
public final void setFinished()
```
    Description copied from interface: Agent
    
    Is called by the server to mark this agent as being processed and stores the processing duration. After this method has been called the agent is returned to the client.
    
    Specified by:
    
    setFinished in interface Agent<C extends ClientContext,S extends ServerContext>
    
    See Also:
    CrossPlatformObject.setServerContext(ServerContext ctx)
  - setFailed
```
public final void setFailed(java.lang.Exception error)
```
    Description copied from interface: Agent
    
    Sets the internal Exception of the Agent. This Exception is set if agent processing failed on the server.
    
    Specified by:
    
    setFailed in interface Agent<C extends ClientContext,S extends ServerContext>
    
    See Also:
    Agent.getError(), Agent.hasError()
  - isReceivedInResponse
```
public final boolean isReceivedInResponse()
```
    Description copied from interface: Agent
    
    Returns true if the agent has been received within a response.
    
    Specified by:
    
    isReceivedInResponse in interface Agent<C extends ClientContext,S extends ServerContext>
  - isReceivedInMessage
```
public final boolean isReceivedInMessage()
```
    Description copied from interface: Agent
    
    Returns true if the agent has been received within a message. This is only possible for async agents.
    
    Specified by:
    
    isReceivedInMessage in interface Agent<C extends ClientContext,S extends ServerContext>
    
    See Also:
    Agent.setReceivedInMessage(boolean)
  - setReceivedInMessage
```
public final void setReceivedInMessage(boolean isReceivedInMessage)
```
    Description copied from interface: Agent
    
    Is set when this agent has been received within a message
    
    Specified by:
    
    setReceivedInMessage in interface Agent<C extends ClientContext,S extends ServerContext>
    
    See Also:
    Agent.isReceivedInMessage()
  - getPriority
```
public final int getPriority()
```
    Description copied from interface: Agent
    
    Returns the thread priority which is used to execute this agent
    
    Specified by:
    
    getPriority in interface Agent<C extends ClientContext,S extends ServerContext>
  - setPriority
```
public final void setPriority(int priority)
```
    Description copied from interface: Agent
    
    Sets the thread priority which is used to execute this agent
    
    Specified by:
    
    setPriority in interface Agent<C extends ClientContext,S extends ServerContext>
  - setSentTime
```
public final void setSentTime(long sentTime)
```
    Description copied from interface: TimeMeasurable
    
    Is called by the client when the agent is sent
    
    Specified by:
    
    setSentTime in interface TimeMeasurable
  - getSentTime
```
public final long getSentTime()
```
    Description copied from interface: TimeMeasurable
    
    Tells when the agent was sent by the client
    
    Specified by:
    
    getSentTime in interface TimeMeasurable
  - setReceivedTime
```
public final void setReceivedTime(long receivedTime)
```
    Description copied from interface: TimeMeasurable
    
    Is called by the client when the agent is received
    
    Specified by:
    
    setReceivedTime in interface TimeMeasurable
  - getReceivedTime
```
public final long getReceivedTime()
```
    Description copied from interface: TimeMeasurable
    
    Tells when the agent was received by the client
    
    Specified by:
    
    getReceivedTime in interface TimeMeasurable
  - isReceived
```
public final boolean isReceived()
```
    Description copied from interface: Agent
    
    Tells whether this agent yet has been received by the client.
    
    Specified by:
    
    isReceived in interface Agent<C extends ClientContext,S extends ServerContext>
  - getProcessingDuration
```
public final long getProcessingDuration()
```
    Description copied from interface: TimeMeasurable
    
    Returns the time (in millis) it has taken to process the agent on server side.
    
    Specified by:
    
    getProcessingDuration in interface TimeMeasurable
  - getTotalDuration
```
public final long getTotalDuration()
```
    Description copied from interface: TimeMeasurable
    
    Returns the time (in millis) it has taken from sending to finishing postprocessing of the agent.
    
    Specified by:
    
    getTotalDuration in interface TimeMeasurable
  - getTransferDuration
```
public final long getTransferDuration()
```
    Description copied from interface: TimeMeasurable
    
    Returns the time (in millis) it has taken from sending to receiving the agent.
    
    Specified by:
    
    getTransferDuration in interface TimeMeasurable
  - setArgument
```
public final void setArgument(java.lang.Object arg,
               boolean doZip)
```
    Description copied from interface: Agent
    
    Same as setArgument(Object) but compresses the argument to a zipped byte array.
    
    Specified by:
    
    setArgument in interface Agent<C extends ClientContext,S extends ServerContext>
  - setArgument
```
public final void setArgument(java.lang.Object arg)
```
    Description copied from interface: Agent
    
    Besides any internal variables the agent may optionally carry an arbitrary argument.
    
    Specified by:
    
    setArgument in interface Agent<C extends ClientContext,S extends ServerContext>
  - getArgument
```
public final java.lang.Object getArgument()
```
    Description copied from interface: Agent
    
    Returns the optional argument of this agent. Note that if the argument was zipped it is being unzipped automatically before it is returned.
    
    Specified by:
    
    getArgument in interface Agent<C extends ClientContext,S extends ServerContext>
  - getZippedArgumentLength
```
protected final int getZippedArgumentLength()
```
  - sendForSilentExecution
```
public final <A extends Agent<C,S>> A sendForSilentExecution()
```
    Description copied from interface: Agent
    
    Same as Agent.sendForExecution() just without throwing an Exception. The returned Agent should be manually checked if it contains an Exception.
    
    Specified by:
    
    sendForSilentExecution in interface Agent<C extends ClientContext,S extends ServerContext>
    
    See Also:
    Agent.sendForExecution(), Agent.sendForBooleanExecution()
  - sendForBooleanExecution
```
public final boolean sendForBooleanExecution()
```
    Description copied from interface: Agent
    
    Same as Agent.sendForExecution() but does not return the agent, rather it returns true if the agent has successfully being processed, false otherwise. In the case of agent processing failure the error Exception is stored in the original input agent and can be requested from there.
    
    Specified by:
    
    sendForBooleanExecution in interface Agent<C extends ClientContext,S extends ServerContext>
    
    Returns:
    true if the agent succeeded, false if the agent failed.
    See Also:
    Agent.sendForExecution(), Agent.sendForSilentExecution()
  - logFatal
```
public final void logFatal(java.lang.String message,
            java.lang.Exception error)
```
    Specified by:
    
    logFatal in interface SimpleLogSupport
    
    Overrides:
    
    logFatal in class AbstractCrossPlatformObject<C extends ClientContext,S extends ServerContext>
  - logError
```
public final void logError(java.lang.String message,
            java.lang.Exception error)
```
    Specified by:
    
    logError in interface SimpleLogSupport
    
    Overrides:
    
    logError in class AbstractCrossPlatformObject<C extends ClientContext,S extends ServerContext>
  - logError
```
public final void logError(java.lang.String message)
```
    Specified by:
    
    logError in interface SimpleLogSupport
    
    Overrides:
    
    logError in class AbstractCrossPlatformObject<C extends ClientContext,S extends ServerContext>
  - logWarning
```
public final void logWarning(java.lang.String message)
```
    Specified by:
    
    logWarning in interface SimpleLogSupport
    
    Overrides:
    
    logWarning in class AbstractCrossPlatformObject<C extends ClientContext,S extends ServerContext>
  - logInfo
```
public final void logInfo(java.lang.String message)
```
    Specified by:
    
    logInfo in interface SimpleLogSupport
    
    Overrides:
    
    logInfo in class AbstractCrossPlatformObject<C extends ClientContext,S extends ServerContext>
  - logVerbose
```
public final void logVerbose(java.lang.String message)
```
    Specified by:
    
    logVerbose in interface SimpleLogSupport
    
    Overrides:
    
    logVerbose in class AbstractCrossPlatformObject<C extends ClientContext,S extends ServerContext>
  - logDebug
```
public final void logDebug(java.lang.String message)
```
    Specified by:
    
    logDebug in interface SimpleLogSupport
    
    Overrides:
    
    logDebug in class AbstractCrossPlatformObject<C extends ClientContext,S extends ServerContext>
  - logDump
```
public final void logDump(java.lang.String message)
```
    Specified by:
    
    logDump in interface SimpleLogSupport
    
    Overrides:
    
    logDump in class AbstractCrossPlatformObject<C extends ClientContext,S extends ServerContext>

Class FileTransferAgent<C extends ClientContext,S extends ServerContext>

Constructor Summary

Method Summary

Methods inherited from class de.esprit.netsuite.netdata.agent.AbstractLockableAgent

Methods inherited from class de.esprit.netsuite.netdata.agent.AbstractAgent

Methods inherited from class de.esprit.netsuite.netdata.AbstractCrossPlatformObject

Methods inherited from class de.esprit.common.util.TransferableObject

Methods inherited from class de.esprit.common.util.DumpableObject

Methods inherited from class java.lang.Object

Methods inherited from interface de.esprit.netsuite.server.lock.ResourceLockHolder

Methods inherited from interface de.esprit.netsuite.netdata.agent.Agent

Methods inherited from interface de.esprit.netsuite.netdata.CrossPlatformObject

Methods inherited from interface de.esprit.netsuite.client.ClientObject

Methods inherited from interface de.esprit.netsuite.server.ServerObject

Methods inherited from interface de.esprit.common.type.Dumpable

Methods inherited from interface de.esprit.common.type.DeepCloneable

Methods inherited from interface de.esprit.netsuite.netdata.agent.TimeMeasurable

Methods inherited from interface de.esprit.common.log.SimpleLogSupport

Constructor Detail

FileTransferAgent

FileTransferAgent

FileTransferAgent

FileTransferAgent

Method Detail

createAgentId

getAgentId

doOnClientSideCancellation

doOnServerSideCancellation

sendForExecution

setName

setOwnerSessionId

getJobList

setRollbackEnabled

setTransferLocked

isTransferLocked

setTransferAsync

isTransferAsync

getJobCount

clearJobs

addJob

getJobId

getJobName

getResourceName

getResourceType

executeForResponse

executeOnServer

doInitiallyOnClient

doOnResponseConfirmed

processCommitMessage

awaitClientCommit

getClientTask

addTaskListener

removeTaskListener

toString

toDumpString

getClientParams

putClientParam

getClientParam

hasClientParam

clearClientParams

equals

hashCode

getTaskId

getSessionId

setSessionId

setServerContext

isPartialResultsEnabled

setPartialResultsEnabled

setRejectable

isRejectable

getOwnerSessionId

getTargetServer

setTargetServer

getName

setResponseTimeout

getResponseTimeout

hasRun

hasError

getError

setFinished