com.highqsoft.xsd

Class Filetransfer

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.Filetransfer

All Implemented Interfaces:

ExecutableIF, ImplementationIF

public class Filetransfer
extends AbstractImplementation
implements ExecutableIF

This class transfers files to a remote CORBAFileServer. It can be used as an implementation inside a MoMa XML configuration file.
The following table lists all the argument of this implementation. Keywords are case insensitive.

Argument Keyword	Datatype	Default	Description
TargetRef	String	none	The name of reference to the target ASAM ODS session.
UseSocket	boolean	true	This value is used to decide whether to use sockets to transport the data files.
SocketPort	Integer	6900	If the transport is configured to use sockets, this property specifies the port number that should be used.
Dir	String	none	The directory that is the root for that operation. The zip entries will be added relative to that point. If this argument is not available, the argument Filename must be specified.
Filename	String	none	The filename to be transfered. This parameter is meaningful only if the argument Dir is not available.
prefix	String	none	An optional server side subdirectory.
CORBAFileServer.*	String	none	All arguments will be passed to the StreamFactory instance. So the CORBAFileServer settings can be specified here.
deleteaftertransfer	Boolean	false	Set this value to true to delete file after transfer on the client.

Since:

$Date: 2017/04/06 13:30:30 $

Version:

$Revision: 1.15 $

Author:

Andreas Hofmann

See Also:

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	deleteAfterTransfer
protected java.lang.String	dir
protected java.lang.String	filename
protected static java.lang.String	LOGGER_NAME
protected int	socketPort
protected boolean	useSocket

Fields inherited from class com.highqsoft.xsd.AbstractImplementation

arguments, ctx, descriptor, NEW_LINE

Constructor Summary

Constructors

Constructor and Description
Filetransfer()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Execute the termination.
java.io.FileFilter	getFileFilter() Get the file filter to check files for transfer.
java.io.File[]	getFiles() Get all the file to be a part of the zip file.
protected void	getFiles(java.util.Vector<java.io.File> vec, java.io.File dir, java.io.FileFilter filter) Get all the file to be a part of the zip file.
protected AoSession	getSession() Get the session.
protected java.lang.String	getSubDir(java.io.File file) Get the sub folder name for the given file.
void	init() Initialize the termination.
void	saveLocations(java.io.File[] localFiles, java.lang.String[] locations) Save the locations.
void	setArguments(java.util.Properties args) Set argument property map.
void	terminate() Terminate the termination.

Methods inherited from class com.highqsoft.xsd.AbstractImplementation

addAttributesToNameValueUnitArray, addAttributeToNameValueUnitArray, addStringValueToNameValueUnitArray, checkDirectoy, checkDirectoy, checkDirectoy, checkFile, checkFile, checkFile, checkIntValue, checkStringValue, compressNvuArray, createMessageFromPropertyFile, createMessageFromPropertyFile, createMessageFromPropertyFile, createTsUnionFromObject, deleteRowWithAttributes, getArguments, getContext, getDescriptor, getListFromProperty, getMandatoryProperty, getMandatoryProperty, getMandatoryPropertyAsInt, getMandatoryPropertyAsList, getMandatoryPropertyWithRuleException, getNvuArrayFromMap, getNvuArrayFromMap, getNvuObjectWithName, getNvuObjectWithName, getNvuObjectWithName, getOdsCacheFromProperty, getOptioanlPropertyAsInt, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsList, makeUpperCaseKeyword, removeAttributeFromNameValueUnitArray, removeAttributeFromNameValueUnitArray, setContext, setDescriptor

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.xsd.ImplementationIF

getContext, getDescriptor, setContext, setDescriptor

Field Detail

LOGGER_NAME

protected static final java.lang.String LOGGER_NAME

useSocket

protected boolean useSocket

socketPort

protected int socketPort

dir

protected java.lang.String dir

filename

protected java.lang.String filename

deleteAfterTransfer

protected boolean deleteAfterTransfer

Constructor Detail

Filetransfer

public Filetransfer()

Method Detail

setArguments

public void setArguments(java.util.Properties args)
                  throws InvalidArgumentException

Set argument property map.

Specified by:

setArguments in interface ImplementationIF

Overrides:

setArguments in class AbstractImplementation

Parameters:

arguments - the property map

Throws:

InvalidArgumentException - if the arguments are not valid.

execute

public void execute()
             throws ExecutableException

Execute the termination.

Specified by:

execute in interface ExecutableIF

Throws:

ExecutableException - if execution fails.

saveLocations

public void saveLocations(java.io.File[] localFiles,
                 java.lang.String[] locations)
                   throws ExecutableException

Save the locations. The default implementation does nothing here.

Parameters:

localFiles - The array containing the local file descriptors.

locations - The array containing the values returns by the server.

Throws:

ExecutableException - if something is wrong.

getFiles

public java.io.File[] getFiles()

Get all the file to be a part of the zip file.

Returns:

an array containing all the file for the archive.

getFiles

protected void getFiles(java.util.Vector<java.io.File> vec,
            java.io.File dir,
            java.io.FileFilter filter)

Get all the file to be a part of the zip file.

getFileFilter

public java.io.FileFilter getFileFilter()

Get the file filter to check files for transfer. The default implementation accepts all files.

Returns:

the file filter that check files.

getSubDir

protected java.lang.String getSubDir(java.io.File file)

Get the sub folder name for the given file. This implementation returns the PREFIX argument or an empty string.

Parameters:

file - the trigger file.

Returns:

the relative folder name.

terminate

public void terminate()
               throws TerminationException

Terminate the termination.

Specified by:

terminate in interface ExecutableIF

Throws:

TerminationException - if termination fails.

init

public void init()
          throws InitializationFailedException

Initialize the termination.

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - if the initialization fails.

getSession

protected AoSession getSession()

Get the session.

Returns:

the session.