flux.file

Class FileActionResult

java.lang.Object

flux.file.FileActionResult

All Implemented Interfaces:

PersistentVariableListener, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

AgentFileActionResult

public class FileActionResult
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable, PersistentVariableListener

Contains listings, in various formats, of files that underwent successful file actions.

Author:

Copyright 2000-2025 Flux Corporation. All rights reserved.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<java.lang.String>	contents Contents of files for which the file action was carried out successfully.
int	failed_count The number of files that failed in the file action operation.
java.util.Map<java.lang.String,java.lang.String>	filenames Source to destination mapping of filenames for which the file action was carried out successfully.
int	successful_count The number of files that succeeded in the file action operation.
java.util.Map<java.net.URL,java.net.URL>	url_objects Source to destination mapping of URL objects for which the file action was carried out successfully.
java.util.Map<java.lang.String,java.lang.String>	url_strings URLs of files for which the file action was carried out successfully.

Constructor Summary

Constructors

Constructor and Description
FileActionResult()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Clones this file action result.
void	createdVariable() Called immediately after a persistent variable has been created and populated with data from the database.
void	persistingVariable() Called immediately before a persistent variable is stored to the database.

Methods inherited from class java.lang.Object

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

Field Detail

filenames

public transient java.util.Map<java.lang.String,java.lang.String> filenames

Source to destination mapping of filenames for which the file action was carried out successfully.

The keys of the map are the source filenames involved in the file action and the values of the map are the destination filenames.

The filenames in this field do not contain path information. They are simply basenames. Any directory information is omitted.

For example, if the full filename for a file involved in a successful file action is "/outputs/atlanta/settlements.zip", then the string contained in this field is simply "settlements.zip".

url_objects

public transient java.util.Map<java.net.URL,java.net.URL> url_objects

Source to destination mapping of URL objects for which the file action was carried out successfully.

This field contains the same information as the "url_strings" field, except file names are stored as URL objects, not strings.

The keys of the map are the source URL objects the file action was performed on and the values of the map are the destination URLs.

For all non-file protocols, this map contains the same information as the "url_strings" field.

url_strings

public java.util.Map<java.lang.String,java.lang.String> url_strings

URLs of files for which the file action was carried out successfully.

This field contains the same information as the "url_objects" field, except file names are stored as strings, not URL objects.

contents

public java.util.List<java.lang.String> contents

Contents of files for which the file action was carried out successfully.

successful_count

public int successful_count

The number of files that succeeded in the file action operation.

failed_count

public int failed_count

The number of files that failed in the file action operation.

Constructor Detail

FileActionResult

public FileActionResult()

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clones this file action result.

Overrides:

clone in class java.lang.Object

Returns:

A clone of this File Action Result.

Throws:

java.lang.CloneNotSupportedException - If an error occurs.

createdVariable

public void createdVariable()
                     throws java.lang.Exception

Description copied from interface: PersistentVariableListener

Called immediately after a persistent variable has been created and populated with data from the database. Allows additional initialization work to be performed.

Specified by:

createdVariable in interface PersistentVariableListener

Throws:

java.lang.Exception - If the additional initialization work failed and the engine needs to be notified.

persistingVariable

public void persistingVariable()

Description copied from interface: PersistentVariableListener

Called immediately before a persistent variable is stored to the database. Allows final storage preparation work to be performed.

Specified by:

persistingVariable in interface PersistentVariableListener