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

java.lang.Object
  |
  +--uk.org.ogsadai.client.toolkit.activity.RequestComponent
        |
        +--uk.org.ogsadai.client.toolkit.activity.Activity
              |
              +--uk.org.ogsadai.client.toolkit.activity.delivery.DeliverFromGFTP

public class DeliverFromGFTP

extends Activity

This activity reads data via GridFTP for delivery to another activity.

It has no input and one output - the data read.

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 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

DeliverFromGFTP()
Constructs a request to deliver data from GridFTP to another activity.

DeliverFromGFTP(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.
ActivityOutput	getOutput() Gets the activity's only output - the data read.
void	setFile(java.lang.String file) Set the GridFTP file.
void	setHost(java.lang.String host) Set the GridFTP host.
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.

Constructor Detail

DeliverFromGFTP

public DeliverFromGFTP()

Constructs a request to deliver data from GridFTP to another activity.

The activity must be configured using the set methods.

DeliverFromGFTP

public DeliverFromGFTP(java.lang.String host,
                       int port,
                       java.lang.String file)

Constructs a request to deliver data via GridFTP.

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.

getOutput

public ActivityOutput getOutput()

Gets the activity's only output - the data read.

Returns:

the activity output.

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()