flux.file
Class FileActionException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          flux.EngineException
              flux.file.FileActionException

All Implemented Interfaces:

java.io.Serializable

public class FileActionException
extends EngineException

Indicates that an error has occurred in a file action and contains file listings for successful and unsuccessful file operations that occurred before the file action failed.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

See Also:

Serialized Form

Constructor Summary

FileActionException(java.lang.String message, java.util.Map<java.lang.String,java.lang.String> successfulUrlStrings, java.util.Map<java.lang.String,java.lang.String> unsuccessfulUrlStrings)
Raises a file action exception.

FileActionException(java.lang.String message, java.lang.Throwable cause, java.util.Map<java.lang.String,java.lang.String> successfulUrlStrings, java.util.Map<java.lang.String,java.lang.String> unsuccessfulUrlStrings)
Raises a file action exception.

FileActionException(java.lang.Throwable cause, java.util.Map<java.lang.String,java.lang.String> successfulUrlStrings, java.util.Map<java.lang.String,java.lang.String> unsuccessfulUrlStrings)
Raises a file action exception.

Method Summary

java.util.Map<java.lang.String,java.lang.String>	getSuccessfulFilenames() Returns source to destination mapping of filenames for which the file action was carried out successfully.
java.util.Map<java.net.URL,java.net.URL>	getSuccessfulUrlObjects() Returns 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>	getSuccessfulUrlStrings() URLs of files for which the file action was carried out successfully.
java.util.Map<java.lang.String,java.lang.String>	getUnsuccessfulFilenames() Returns source to destination mapping of filenames for which the file action was not carried out successfully.
java.util.Map<java.net.URL,java.net.URL>	getUnsuccessfulUrlObjects() Returns URLs of files and directories for which the file action was not carried out successfully.
java.util.Map<java.lang.String,java.lang.String>	getUnsuccessfulUrlStrings() URLs of files and directories for which the file action was not carried out successfully.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FileActionException

public FileActionException(java.lang.String message,
                           java.util.Map<java.lang.String,java.lang.String> successfulUrlStrings,
                           java.util.Map<java.lang.String,java.lang.String> unsuccessfulUrlStrings)

Raises a file action exception.

Parameters:

message - The reason why the file action exception is being raised.

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

unsuccessfulUrlStrings - URLs of files and directories for which the file action was not carried out successfully.

FileActionException

public FileActionException(java.lang.Throwable cause,
                           java.util.Map<java.lang.String,java.lang.String> successfulUrlStrings,
                           java.util.Map<java.lang.String,java.lang.String> unsuccessfulUrlStrings)

Raises a file action exception.

Parameters:

cause - The cause of the file action exception being raised.

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

unsuccessfulUrlStrings - URLs of files and directories for which the file action was not carried out successfully.

FileActionException

public FileActionException(java.lang.String message,
                           java.lang.Throwable cause,
                           java.util.Map<java.lang.String,java.lang.String> successfulUrlStrings,
                           java.util.Map<java.lang.String,java.lang.String> unsuccessfulUrlStrings)

Raises a file action exception.

Parameters:

message - The reason why the file action exception is being raised.

cause - The cause of the file action exception being raised.

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

unsuccessfulUrlStrings - URLs of files and directories for which the file action was not carried out successfully.

Method Detail

getSuccessfulFilenames

public java.util.Map<java.lang.String,java.lang.String> getSuccessfulFilenames()

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

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

This field contains system-dependant absolute paths only for the file protocol (file://), but the "file://" string is not contained in any of the entries in this map. Only system-dependent file paths are contained in this map.

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

Returns:

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

getSuccessfulUrlObjects

public java.util.Map<java.net.URL,java.net.URL> getSuccessfulUrlObjects()

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

This field contains the same information as the "successful_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 "successful_url_strings" field.

Returns:

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

getSuccessfulUrlStrings

public java.util.Map<java.lang.String,java.lang.String> getSuccessfulUrlStrings()

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

This method returns the same information as the "successful_url_objects" field, except file names are stored as strings, not URL objects.

Returns:

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

getUnsuccessfulFilenames

public java.util.Map<java.lang.String,java.lang.String> getUnsuccessfulFilenames()

Returns source to destination mapping of filenames for which the file action was not carried out successfully.

The keys of the map are the source filenames the file action failed on and the values of the map are the destination filenames.

This field contains system-dependant absolute paths only for the file protocol (file://), but the "file://" string is not contained in any of the entries in this map. Only system-dependent file paths are contained in this map.

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

Returns:

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

getUnsuccessfulUrlObjects

public java.util.Map<java.net.URL,java.net.URL> getUnsuccessfulUrlObjects()

Returns URLs of files and directories for which the file action was not carried out successfully.

This method returns the same information as the "unsuccessful_url_strings" field, except file names are stored as URL objects, not strings.

Returns:

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

getUnsuccessfulUrlStrings

public java.util.Map<java.lang.String,java.lang.String> getUnsuccessfulUrlStrings()

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

This method returns the same information as the "unsuccessful_url_objects" field, except file names are stored as strings, not URL objects.

Returns:

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