RemoteFilePutReq (unet-framework 7.0.0 API)

org.arl.unet.remote.RemoteFilePutReq

Request to transfer a file to a remote node.

Field Summary

Fields
Modifiers	Name	Description
`protected java.lang.String`	`credentials`
`protected byte[]`	`data`
`protected java.lang.String`	`filename`
`protected java.lang.String`	`localFilename`
`protected Priority`	`priority`
`protected boolean`	`progress`
`protected boolean`	`resume`
`protected int`	`to`

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`credentials`
`byte[]`	`data`
`java.lang.String`	`filename`
`java.lang.String`	`localFilename`
`Priority`	`priority`
`int`	`to`

Constructor Summary

Constructors
Constructor and description
`RemoteFilePutReq ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.String`	`getCredentials()` Gets the user credentials for authentication.
	`byte[]`	`getData()` Gets the data to be transferred.
	`java.lang.String`	`getFilename()` Gets the name of the remote file.
	`java.lang.String`	`getLocalFilename()` Gets the name of the local file.
	`Priority`	`getPriority()` Gets the priority of the request.
	`boolean`	`getProgress()` Gets whether progress notifications are to be sent.
	`boolean`	`getResume()` Gets if previously interrupted file transfer may be resumed.
	`int`	`getTo()` Gets the destination node address.
	`void`	`setCredentials(java.lang.String credentials)` Sets the user credentials for authentication.
	`void`	`setData(byte[] data)` Sets the data to be transferred.
	`void`	`setFilename(java.lang.String filename)` Sets the name of the remote file.
	`void`	`setLocalFilename(java.lang.String filename)` Sets the name of the local file.
	`void`	`setPriority(Priority priority)` Sets the priority of the request.
	`void`	`setProgress(boolean b)` Sets whether progress notifications should be sent.
	`void`	`setResume(boolean resume)` Sets if previously interrupted file transfer may be resumed.
	`void`	`setTo(int destination)` Sets the destination.
	`java.lang.String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class org.arl.fjage.Message`	org.arl.fjage.Message#toString(), org.arl.fjage.Message#setPerformative(org.arl.fjage.Performative), org.arl.fjage.Message#getPerformative(), org.arl.fjage.Message#setRecipient(org.arl.fjage.AgentID), org.arl.fjage.Message#getRecipient(), org.arl.fjage.Message#setSender(org.arl.fjage.AgentID), org.arl.fjage.Message#getSender(), org.arl.fjage.Message#setMessageID(java.lang.String), org.arl.fjage.Message#getMessageID(), org.arl.fjage.Message#setInReplyTo(java.lang.String), org.arl.fjage.Message#getInReplyTo(), org.arl.fjage.Message#setSentAt(long), org.arl.fjage.Message#getSentAt(), org.arl.fjage.Message#getJsonCache(), org.arl.fjage.Message#setJsonCache(java.lang.String), org.arl.fjage.Message#wait(long, int), org.arl.fjage.Message#wait(long), org.arl.fjage.Message#wait(), org.arl.fjage.Message#equals(java.lang.Object), org.arl.fjage.Message#hashCode(), org.arl.fjage.Message#getClass(), org.arl.fjage.Message#notify(), org.arl.fjage.Message#notifyAll()

- Field Detail
  - protected java.lang.String credentials
  - protected byte[] data
  - protected java.lang.String filename
  - protected java.lang.String localFilename
  - protected Priority priority
  - protected boolean progress
  - protected boolean resume
  - protected int to
- Property Detail
  - java.lang.String credentials
  - byte[] data
  - java.lang.String filename
  - java.lang.String localFilename
  - Priority priority
  - int to
- Constructor Detail
  - public RemoteFilePutReq()
- Method Detail
  - public java.lang.String getCredentials()
    
    Gets the user credentials for authentication.
    Returns:
    credentials
  - public byte[] getData()
    
    Gets the data to be transferred.
    Returns:
    data to be transferred
  - public java.lang.String getFilename()
    
    Gets the name of the remote file.
    Returns:
    name of the remote file
  - public java.lang.String getLocalFilename()
    
    Gets the name of the local file. If the local filename is null, it is assumed to be the same as the remote filename.
    Returns:
    name of the local file
  - public Priority getPriority()
    
    Gets the priority of the request.
    Returns:
    priority
  - public boolean getProgress()
    
    Gets whether progress notifications are to be sent.
    Returns:
    true if progress notifications enabled
  - public boolean getResume()
    
    Gets if previously interrupted file transfer may be resumed.
    Returns:
    true if resume allowed, false to start afresh
  - public int getTo()
    
    Gets the destination node address.
    Returns:
    destination node address
  - public void setCredentials(java.lang.String credentials)
    
    Sets the user credentials for authentication.
    Parameters:
    credentials - credentials
  - public void setData(byte[] data)
    
    Sets the data to be transferred. If data is null, a file with the same name as the remote file is read from the local file system.
    Parameters:
    data - data to be transferred
  - public void setFilename(java.lang.String filename)
    
    Sets the name of the remote file.
    Parameters:
    filename - name of the remote file
  - public void setLocalFilename(java.lang.String filename)
    
    Sets the name of the local file. If the local filename is null, it is assumed to be the same as the remote filename.
    Parameters:
    filename - name of the local file
  - public void setPriority(Priority priority)
    
    Sets the priority of the request. Priority is advisory, and an agent may choose to ignore it, if it does not support prioritization.
    Parameters:
    priority - priority assigned to the request.
  - public void setProgress(boolean b)
    
    Sets whether progress notifications should be sent.
    Parameters:
    b - true to send progress notifications
  - public void setResume(boolean resume)
    
    Sets if previously interrupted file transfer may be resumed.
    Parameters:
    resume - true if resume allowed, false to start afresh
  - public void setTo(int destination)
    
    Sets the destination.
    Parameters:
    destination - address
  - @java.lang.Override public java.lang.String toString()

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Java] Class RemoteFilePutReq

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected java.lang.String credentials

protected byte[] data

protected java.lang.String filename

protected java.lang.String localFilename

protected Priority priority

protected boolean progress

protected boolean resume

protected int to

Property Detail

java.lang.String credentials

byte[] data

java.lang.String filename

java.lang.String localFilename

Priority priority

int to

Constructor Detail

public RemoteFilePutReq()

Method Detail

public java.lang.String getCredentials()

public byte[] getData()

public java.lang.String getFilename()

public java.lang.String getLocalFilename()

public Priority getPriority()

public boolean getProgress()

public boolean getResume()

public int getTo()

public void setCredentials(java.lang.String credentials)

public void setData(byte[] data)

public void setFilename(java.lang.String filename)

public void setLocalFilename(java.lang.String filename)

public void setPriority(Priority priority)

public void setProgress(boolean b)

public void setResume(boolean resume)

public void setTo(int destination)

@java.lang.Override public java.lang.String toString()