ProvisionFilesUtil (SeqWare 1.1.2 API)

java.lang.Object
- net.sourceforge.seqware.common.util.filetools.ProvisionFilesUtil

```
public class ProvisionFilesUtil
extends Object
```
ProvisionFilesUtil class.

Version:

$Id: $Id

Author:

boconnor

Field Summary

Fields
Modifier and Type	Field and Description
`protected Key`	`dataDecryptionKey`
`protected Key`	`dataEncryptionKey`
`protected String`	`fileName`
`protected File`	`inputFile`
`protected long`	`inputSize`
`protected String`	`originalFileName`
`protected long`	`position`
`protected int`	`READ_ATTEMPTS`

Constructor Summary

Constructors
Constructor and Description

ProvisionFilesUtil()
Default ctor.

ProvisionFilesUtil(boolean verbose)
Set verbose mode ctor.

Constructors
Constructor and Description
`ProvisionFilesUtil()` Default ctor.
`ProvisionFilesUtil(boolean verbose)` Set verbose mode ctor.

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`calculateInputMetadata(String input, FileMetadata metadata)`
`File`	`copyToFile(BufferedInputStream reader, String output, boolean fullOutputPath, int bufLen, String input, Cipher decryptCipher, Cipher encryptCipher, FileMetadata metadata)` Copy reader into output using Cipher.
`File`	`copyToFile(BufferedInputStream reader, String output, int bufLen, String input)`
`boolean`	`createSymlink(String output, boolean fullOutputPath, String input)` Creates symlink of input to output.
`static String`	`createTargetDirectory(String folderStore, String email)` Creates abstract pathname.
`static String`	`createTargetPath(String folderStore, String email, String fileName)` Creates abstract pathname.
`Cipher`	`getDecryptCipher(String decryptKey)` Gets cipher by DecryptKey.
`Cipher`	`getEncryptCipher(String encryptKey)` Gets cipher by EncryptKey.
`String`	`getFileName()` Gets the file name.
`static long`	`getFileSize(String path)` getFileSize.
`BufferedInputStream`	`getHttpInputStream(String input, int bufLen, long startPosition)` getHttpInputStream.
`String`	`getOriginalFileName()` Getter for the field `originalFileName`.
`BufferedInputStream`	`getS3InputStream(String input, int bufLen, long startPosition)` getS3InputStream.
`BufferedInputStream`	`getS3InputStream(String input, int bufLen, long startPosition, String accessKey, String secretKey)` getS3InputStream.
`URL`	`getS3Url(String input)` getS3Url.
`URL`	`getS3Url(String input, String accessKey, String secretKey)` getS3Url.
`BufferedInputStream`	`getSourceReader(String input, int bufLen, long startPosition)` This attempts to resume if passed in startPosition > 0.
`boolean`	`isVerbose()` isVerbose.
`boolean`	`putToHttp()` Not supported yet.
`boolean`	`putToS3(BufferedInputStream reader, String output, boolean fullOutputPath)` Copy file using reader into output.
`boolean`	`putToS3(BufferedInputStream reader, String output, boolean fullOutputPath, int connectionTimeout, int maxConnections, int maxErrorRetry, int socketTimeout)`
`boolean`	`putToS3(InputStream reader, String output, boolean fullOutputPath, Cipher decryptCipher, Cipher encryptCipher)` Copy file using reader into output.
`boolean`	`putToS3(InputStream reader, String output, boolean fullOutputPath, int connectionTimeout, int maxConnections, int maxErrorRetry, int socketTimeout, Cipher decryptCipher, Cipher encryptCipher)`
`void`	`setDataDecryptionKeyString(String value)` Sets data decryption key.
`void`	`setDataEncryptionKeyString(String value)` Sets data encryption key.
`void`	`setOriginalFileName(String originalFileName)` Setter for the field `originalFileName`.
`void`	`setVerbose(boolean verbose)` Enable class verbose mode.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

READ_ATTEMPTS
```
protected final int READ_ATTEMPTS
```
See Also:
Constant Field Values

inputSize
```
protected long inputSize
```

position
```
protected long position
```

fileName
```
protected String fileName
```

originalFileName
```
protected String originalFileName
```

inputFile
```
protected File inputFile
```

dataEncryptionKey
```
protected Key dataEncryptionKey
```

dataDecryptionKey
```
protected Key dataDecryptionKey
```

Constructor Detail
- ProvisionFilesUtil
```
public ProvisionFilesUtil()
```
  Default ctor.
- ProvisionFilesUtil
```
public ProvisionFilesUtil(boolean verbose)
```
  Set verbose mode ctor.
  
  Parameters:
  verbose - a boolean.

Method Detail

getFileName
```
public String getFileName()
```
Gets the file name. Available after the getSourceReader has been invoked.

Returns:
String representation of the proceeded file name

createSymlink

public boolean createSymlink(String output,
                    boolean fullOutputPath,
                    String input)

Creates symlink of input to output.

Parameters:: output - a String object.; fullOutputPath -; input - a String object.
Returns:: a boolean.

getDecryptCipher
```
public Cipher getDecryptCipher(String decryptKey)
```
Gets cipher by DecryptKey.

Parameters:
decryptKey - a String object.

Returns:
Cipher object

getEncryptCipher
```
public Cipher getEncryptCipher(String encryptKey)
```
Gets cipher by EncryptKey.

Parameters:
encryptKey - a String object.

Returns:
Cipher object

copyToFile

public File copyToFile(BufferedInputStream reader,
              String output,
              int bufLen,
              String input)

copyToFile

public File copyToFile(BufferedInputStream reader,
              String output,
              boolean fullOutputPath,
              int bufLen,
              String input,
              Cipher decryptCipher,
              Cipher encryptCipher,
              FileMetadata metadata)

Copy reader into output using Cipher.

Parameters:: reader - a BufferedInputStream object.; output - a String object.; fullOutputPath -; bufLen - a int.; input - a String object.; metadata - store the file size and md5sum here after checking the destination; decryptCipher - a Cipher object.; encryptCipher - a Cipher object.
Returns:: written File object

putToHttp
```
public boolean putToHttp()
```
Not supported yet.

Returns:
a boolean.

putToS3
```
public boolean putToS3(BufferedInputStream reader,
              String output,
              boolean fullOutputPath)
```
Copy file using reader into output.

Parameters:
reader - a BufferedInputStream object.
output - a String object.
fullOutputPath -

Returns:
true if OK

putToS3

public boolean putToS3(BufferedInputStream reader,
              String output,
              boolean fullOutputPath,
              int connectionTimeout,
              int maxConnections,
              int maxErrorRetry,
              int socketTimeout)

Parameters:: reader -; output -; fullOutputPath -; connectionTimeout -; maxConnections -; maxErrorRetry -; socketTimeout -
Returns:

putToS3

public boolean putToS3(InputStream reader,
              String output,
              boolean fullOutputPath,
              Cipher decryptCipher,
              Cipher encryptCipher)

Copy file using reader into output.

Parameters:: reader - a InputStream object.; output - a String object.; fullOutputPath -; decryptCipher - a Cipher object.; encryptCipher - a Cipher object.
Returns:: true if OK

putToS3

public boolean putToS3(InputStream reader,
              String output,
              boolean fullOutputPath,
              int connectionTimeout,
              int maxConnections,
              int maxErrorRetry,
              int socketTimeout,
              Cipher decryptCipher,
              Cipher encryptCipher)

Parameters:: reader -; output -; fullOutputPath -; connectionTimeout -; maxConnections -; maxErrorRetry -; socketTimeout -; decryptCipher -; encryptCipher -
Returns:

getS3Url
```
public URL getS3Url(String input)
```
getS3Url.

Parameters:
input - a String object.

Returns:
a URL object.

getS3Url

public URL getS3Url(String input,
           String accessKey,
           String secretKey)

getS3Url.

Parameters:: input - a String object.; accessKey - a String object.; secretKey - a String object.
Returns:: a URL object.

getSourceReader

public BufferedInputStream getSourceReader(String input,
                                  int bufLen,
                                  long startPosition)

This attempts to resume if passed in startPosition > 0.

Parameters:: input - a String object.; bufLen - a int.; startPosition - a long.
Returns:: reader of input file

getHttpInputStream

public BufferedInputStream getHttpInputStream(String input,
                                     int bufLen,
                                     long startPosition)

getHttpInputStream.

Parameters:: input - a String object.; bufLen - a int.; startPosition - a long.
Returns:: a BufferedInputStream object.

getS3InputStream

public BufferedInputStream getS3InputStream(String input,
                                   int bufLen,
                                   long startPosition,
                                   String accessKey,
                                   String secretKey)

getS3InputStream.

Parameters:: input - a String object.; bufLen - a int.; startPosition - a long.; accessKey - a String object.; secretKey - a String object.
Returns:: a BufferedInputStream object.

getS3InputStream

public BufferedInputStream getS3InputStream(String input,
                                   int bufLen,
                                   long startPosition)

getS3InputStream.

Parameters:: input - a String object.; bufLen - a int.; startPosition - a long.
Returns:: a BufferedInputStream object.

setDataEncryptionKeyString
```
public void setDataEncryptionKeyString(String value)
```
Sets data encryption key.

Parameters:
value - BASE64-encoded key

setDataDecryptionKeyString
```
public void setDataDecryptionKeyString(String value)
```
Sets data decryption key.

Parameters:
value - BASE64-encoded key

isVerbose
```
public boolean isVerbose()
```
isVerbose.

Returns:
a boolean.

setVerbose
```
public void setVerbose(boolean verbose)
```
Enable class verbose mode.

Parameters:
verbose - a boolean.

createTargetPath

public static String createTargetPath(String folderStore,
                      String email,
                      String fileName)

Creates abstract pathname.

Parameters:: folderStore - a String object.; email - a String object.; fileName - a String object.
Returns:: a String object.

createTargetDirectory

public static String createTargetDirectory(String folderStore,
                           String email)

Creates abstract pathname.

Parameters:: folderStore - a String object.; email - a String object.
Returns:: a String object.

getFileSize
```
public static long getFileSize(String path)
                        throws Exception
```
getFileSize.

Parameters:
path - a String object.

Returns:
a long.

Throws:

Exception - if any.

getOriginalFileName
```
public String getOriginalFileName()
```
Getter for the field originalFileName.

Returns:
a String object.

setOriginalFileName
```
public void setOriginalFileName(String originalFileName)
```
Setter for the field originalFileName.

Parameters:
originalFileName - a String object.

calculateInputMetadata

public static void calculateInputMetadata(String input,
                          FileMetadata metadata)
                                   throws RuntimeException

Throws:: RuntimeException

Class ProvisionFilesUtil

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

READ_ATTEMPTS

inputSize

position

fileName

originalFileName

inputFile

dataEncryptionKey

dataDecryptionKey

Constructor Detail

ProvisionFilesUtil

ProvisionFilesUtil

Method Detail

getFileName

createSymlink

getDecryptCipher

getEncryptCipher

copyToFile

copyToFile

putToHttp

putToS3

putToS3

putToS3

putToS3

getS3Url

getS3Url

getSourceReader

getHttpInputStream

getS3InputStream

getS3InputStream

setDataEncryptionKeyString

setDataDecryptionKeyString

isVerbose

setVerbose

createTargetPath

createTargetDirectory

getFileSize

getOriginalFileName

setOriginalFileName

calculateInputMetadata