net.sourceforge.taverna.io
Interface StreamTransmitter

All Known Implementing Classes:
AbstractStreamTransmitter, GetStreamTransmitter, PostStreamTransmitter

public interface StreamTransmitter

This interface describes the methods needed by a Stream Transmitter. This type of class can transmit values to an endpoint (such as a servlet or JSP page) and process the results via a StreamProcessor. Last edited by $Author: sowen70 $

Version:
$Revision: 1.2 $
Author:
Mark

Method Summary
 void setAuthentication(java.lang.String userName, java.lang.String password)
          This method sets the userName and password used to transmit data to the service.
 void setContext(java.lang.String context)
          This method sets the context for the url.
 void setHost(java.lang.String host)
          This method sets the host for the url.
 void setMimeHeader(java.lang.String name, java.lang.String value)
          This method sets the mime-header.
 void setPort(int port)
          This method sets the port for the url.
 void setServiceName(java.lang.String serviceName)
          This method is used to set the service URL.
 void setURL(java.lang.String url)
          This method sets the URL.
 java.util.Map transmit(java.util.Map map, StreamProcessor streamProcessor)
          This method takes a reflectable object and transmits it to a service
 

Method Detail

transmit

java.util.Map transmit(java.util.Map map,
                       StreamProcessor streamProcessor)
                       throws TransmitterException
This method takes a reflectable object and transmits it to a service

Parameters:
map - A map object (either HashTable or HashMap) containing the parameter names(keys) and parameter values to be transmitted.
Throws:
TransmitterException

setServiceName

void setServiceName(java.lang.String serviceName)
This method is used to set the service URL.

Parameters:
serviceName - The name of the service for the url.

setHost

void setHost(java.lang.String host)
This method sets the host for the url.

Parameters:
host -

setPort

void setPort(int port)
This method sets the port for the url.

Parameters:
port - The port used by the service.

setContext

void setContext(java.lang.String context)
This method sets the context for the url.

Parameters:
context - The following portion of the url: http://host:port/context

setAuthentication

void setAuthentication(java.lang.String userName,
                       java.lang.String password)
This method sets the userName and password used to transmit data to the service.

Parameters:
userName - The username used for authentication.
password - The password used for authentication.

setMimeHeader

void setMimeHeader(java.lang.String name,
                   java.lang.String value)
This method sets the mime-header.

Parameters:
name - Name of the header parameter.
value - The value of the header parameter.

setURL

void setURL(java.lang.String url)
            throws java.net.MalformedURLException
This method sets the URL.

Parameters:
url -
Throws:
java.net.MalformedURLException