Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

uk.org.ogsadai.client.toolkit.activity.delivery
Class DeliverToGFTP

java.lang.Object
  |
  +--uk.org.ogsadai.client.toolkit.activity.RequestComponent
        |
        +--uk.org.ogsadai.client.toolkit.activity.Activity
              |
              +--uk.org.ogsadai.client.toolkit.activity.delivery.DeliverToGFTP
public class DeliverToGFTP
extends Activity

This activity delivers data from some activity via GridFTP.

It has one input - the data to be delivered - and no output.

Server-side, OGSA-DAI will use the client's GSI credential during the transfer. If no credential is provided then the activity will fail.

Author:
The OGSA-DAI Project Team

Field Summary
private static java.lang.String COPYRIGHT_NOTICE
          Copyright statement
private  boolean mAppend
          Append data if file already exists?
private  java.lang.String mFile
          GridFTP file.
private  java.lang.String mHost
          GridFTP host.
private  int mPort
          GridFTP port.
 
Fields inherited from class uk.org.ogsadai.client.toolkit.activity.Activity
 
Fields inherited from class uk.org.ogsadai.client.toolkit.activity.RequestComponent
 
Constructor Summary
DeliverToGFTP()
          Constructs a request to deliver data via GridFTP.
DeliverToGFTP(java.lang.String host, int port, java.lang.String file)
          Constructs a request to deliver data via GridFTP.
 
Method Summary
protected  java.lang.String generateXML()
          Generates the XML representing the activity.
 void setAppend(boolean append)
          Sets whether or not the data should be appended to a file if the file already exists.
 void setFile(java.lang.String file)
          Set the GridFTP file.
 void setHost(java.lang.String host)
          Set the GridFTP host.
 void setInput(ActivityOutput input)
          Sets the input of this activity to be the output from another activity that will provide the data to be stored.
 void setPort(int port)
          Set the GridFTP port.
 
Methods inherited from class uk.org.ogsadai.client.toolkit.activity.Activity
addInput, addOutput, addOutputs, getDataResourceID, getInputParameters, getOutputParameters, getOutputs, replaceSpecialCharacters, setDataResourceID, setInput
 
Methods inherited from class uk.org.ogsadai.client.toolkit.activity.RequestComponent
getDataService, getName, getSession, setDataService, setSession
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT_NOTICE

private static final java.lang.String COPYRIGHT_NOTICE
Copyright statement

See Also:
Constant Field Values

mHost

private java.lang.String mHost
GridFTP host.

mPort

private int mPort
GridFTP port.

mFile

private java.lang.String mFile
GridFTP file.

mAppend

private boolean mAppend
Append data if file already exists?

Constructor Detail

DeliverToGFTP

public DeliverToGFTP()
Constructs a request to deliver data via GridFTP.

The activity must be configured using the set methods.

DeliverToGFTP

public DeliverToGFTP(java.lang.String host,
                     int port,
                     java.lang.String file)
Constructs a request to deliver data via GridFTP.

By default the file will be overwritten if it already exits. To append data to the file use the setAppend method.

The activity providing the input data must be set using setInput.

Parameters:
host - GridFTP host name.
port - GridFTP port number.
file - GridFTP file.
Throws:
java.lang.IllegalArgumentException - If host is null. If file is null.
Method Detail

setHost

public void setHost(java.lang.String host)
Set the GridFTP host.

Parameters:
host - GridFTP host name.
Throws:
java.lang.IllegalArgumentException - If host is null.

setPort

public void setPort(int port)
Set the GridFTP port.

Parameters:
port - GridFTP port number.

setFile

public void setFile(java.lang.String file)
Set the GridFTP file.

Parameters:
file - GridFTP file.
Throws:
java.lang.IllegalArgumentException - If file is null.

setAppend

public void setAppend(boolean append)
Sets whether or not the data should be appended to a file if the file already exists.

Parameters:
append - true if the data is to be appended to the file if it already exists. false if any existing file is to be overwritten.

setInput

public final void setInput(ActivityOutput input)
Sets the input of this activity to be the output from another activity that will provide the data to be stored.

Parameters:
input - Output from another activity.
Throws:
java.lang.IllegalArgumentException - If input is null.

generateXML

protected java.lang.String generateXML()
Description copied from class: RequestComponent
Generates the XML representing the activity. This XML can then be inserted into a perform document that is sent to a data service.

Specified by:
generateXML in class Activity
Returns:
the XML for the activity
See Also:
Activity.generateXML()
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD