net.sf.xbus.technical.as400
Class AS400ProgramSender

java.lang.Object
  net.sf.xbus.technical.as400.AS400FileBase
      net.sf.xbus.technical.as400.AS400ProgramSender

All Implemented Interfaces:

ObjectSender, Sender

public class AS400ProgramSender
extends AS400FileBase
implements Sender, ObjectSender

The AS400ProgramSender calls a program on an AS400 and gives back the result.

Field Summary

static java.lang.String	CALLTYPE_MULTI
static java.lang.String	CALLTYPE_SINGLE

Fields inherited from class net.sf.xbus.technical.as400.AS400FileBase

mConverter

Constructor Summary

AS400ProgramSender(XBUSSystem destination)
Constructs an AS400ProgramSender for a given XBUSSystem

Method Summary

java.lang.Object	execute(java.lang.String function, java.lang.Object callData) Performs the program call on the AS400.
static org.w3c.dom.Document	getTemplateAsDocument() Returns a W3C document containing an empty AS400ProgramMessage
static java.lang.String	getTemplateAsString() Returns a XML string containing an empty AS400ProgramMessage
java.lang.String	getType() A Sender can send data either as a String or as an Object to the neighboring system.

Methods inherited from class net.sf.xbus.technical.as400.AS400FileBase

callAS400Program, copyFile, deleteFile, deleteMember, getEncoding, getRenamedMember, releaseLock, renameFile, setLock

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CALLTYPE_SINGLE

public static final java.lang.String CALLTYPE_SINGLE

See Also:

Constant Field Values

CALLTYPE_MULTI

public static final java.lang.String CALLTYPE_MULTI

See Also:

Constant Field Values

Constructor Detail

AS400ProgramSender

public AS400ProgramSender(XBUSSystem destination)

Constructs an AS400ProgramSender for a given XBUSSystem

Parameters:

destination - XBUSSystem which consists two informations:
-The name of the system is used to identify the system
-Additionally an adress might be available.

Method Detail

execute

public java.lang.Object execute(java.lang.String function,
                                java.lang.Object callData)
                         throws XException

Performs the program call on the AS400. Steps to do this:

• prepare input parameter
• call program with input parameters
• retrieve result and fromat output parameters

  Specified by:

  execute in interface ObjectSender

  Parameters:

  function - the path of the called program

  callData - org.w3c.Document containing input parameter structure and values and output parameter structure

  Returns:

  org.w3c.Document containing the output data of the AS400 program in the specied structure

  Throws:

  XException

getType

public java.lang.String getType()

Description copied from interface: Sender

A Sender can send data either as a String or as an Object to the neighboring system.
When working with Strings the Sender must fulfill two preconditions:

• getType returns Constants.TYPE_TEXT
• The class implements the interface TextSender

When working with Objects the Sender must also fulfill two preconditions:

• getType returns Constants.TYPE_OBJECT
• The class implements the interface ObjectSender

Specified by:

getType in interface Sender

getTemplateAsString

public static java.lang.String getTemplateAsString()
                                            throws XException

Returns a XML string containing an empty AS400ProgramMessage

Throws:

XException

getTemplateAsDocument

public static org.w3c.dom.Document getTemplateAsDocument()
                                                  throws XException

Returns a W3C document containing an empty AS400ProgramMessage

Throws:

XException