com.oracle.communications.brm.cc.batchpayments

Class BatchPaymentsUtil

java.lang.Object

com.oracle.communications.brm.cc.batchpayments.BatchPaymentsUtil

public class BatchPaymentsUtil
extends Object

This utility is used for batch payments related operations.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BATCH_PAYMENT_FILES_PATH
static String	BATCH_PAYMENT_TEMPLATES_PATH

Constructor Summary

Constructors

Constructor and Description
BatchPaymentsUtil()

Method Summary

Modifier and Type	Method and Description
static PaymentBatchFileHeader	convertJSONToPaymentBatchFileHeader(File file) Reads given JSON file and converts to PaymentBatchFileHeader.
static boolean	deleteFile(String filePath) Deletes file from the given filePath.
static String	getBatchPaymentsDirectoryName() Retrieves batch payment directory name from configurations xml if its not populated with Installer path, Else it returns the batch payment files path populated with Installer.
static String	getBatchPaymentsFilesPath(HttpServletRequest servletRequest) Retrieves batch payment files path from context-param BATCH_PAYMENT_FILES_PATH in web.xml
static String	getBatchPaymentsTemplatesPath(HttpServletRequest servletRequest) Retrieves batch payment template files path from context-param BATCH_PAYMENT_TEMPLATES_PATH in web.xml.
static String	getDelimiter(Map<String,String> templateDelimiterData) Retrieve delimiter of a template file.
static String	getErrorDirectoryPath() Get Error Batch Payments Directory Path.
static int	getFilesCountFromDirectory(String directoryPath) Get the count of files for a given directory path.
static List<File>	getFilesList(String directoryPath, String globbingPattern) Get all files of a directory based on the given globbingPattern, For example: globbingPattern "*.pmt" gets only .pmt files, "*.{json}" gets only .json files "*.{pmt,json} gets both .pmt and .json files
static String	getProcessedDirectoryPath() Get Processed Batch Payments Directory Path.
static String	getProcessingDirectoryPath() Get Processing Batch Payments Directory Path.
static String	getUnProcessedDirectoryPath() Get UnProcessed Batch Payments Directory Path.
static boolean	isFileExists(String filePath) Check if the file is already exists in a given path.
static boolean	isValidBatchPaymentFile(String fileName) Validates batch payment file extension, Only .pmt, .txt and .text files are supported for batch payments.
static <T> T[]	join(T[]... arrays) Joins multiple arrays and returns the concatenated array.
static void	moveFile(String sourceDirPath, String targetDirPath, String fileName, boolean replaceExistingFile) Checks if target directory exists or not; If not exits; Creates a target directory and moves the given file from source directory to target, If target directory already exists; then directly moves the given file from source directory to target.
static void	populateInstallerFilePaths(HttpServletRequest servletRequest) Populates batch payments related files paths that are given through BillingCare Installation wizard; The file paths will get retrieved from context parameters BATCH_PAYMENT_FILES_PATH and BATCH_PAYMENT_TEMPLATES_PATH; The context-param values will get populated via Plan.xml that gets updated on deployment path of BillingCare.war through BillingCare OUI installer.
static BasicFileAttributes	readFileAttributes(String filePath) Reads basic file attributes.
static void	savePaymentBatchFileHeaderAsJSONFile(String targetDirPath, PaymentBatchFileHeader paymentBatchFileHeader) Writes batch payment file header to a JSON file and saves the file to the given directory path.
static boolean	uploadFile(InputStream inputStream, String fileName, boolean replaceExistingFile) Uploads a file to the given targetPath.

Methods inherited from class java.lang.Object

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

Field Detail

BATCH_PAYMENT_FILES_PATH

public static String BATCH_PAYMENT_FILES_PATH

BATCH_PAYMENT_TEMPLATES_PATH

public static String BATCH_PAYMENT_TEMPLATES_PATH

Constructor Detail

BatchPaymentsUtil

public BatchPaymentsUtil()

Method Detail

uploadFile

public static boolean uploadFile(InputStream inputStream,
                                 String fileName,
                                 boolean replaceExistingFile)

Uploads a file to the given targetPath.

Parameters:

inputStream -

fileName -

replaceExistingFile -

Returns:

Throws:

ApplicationException

isValidBatchPaymentFile

public static boolean isValidBatchPaymentFile(String fileName)

Validates batch payment file extension, Only .pmt, .txt and .text files are supported for batch payments.

Parameters:

fileName -

Returns:

true; if it is valid file extension, otherwise false.

moveFile

public static void moveFile(String sourceDirPath,
                            String targetDirPath,
                            String fileName,
                            boolean replaceExistingFile)
                     throws ApplicationException

Checks if target directory exists or not; If not exits; Creates a target directory and moves the given file from source directory to target, If target directory already exists; then directly moves the given file from source directory to target.

Parameters:

sourceDirPath -

targetDirPath -

fileName -

replaceExistingFile -

Throws:

ApplicationException

isFileExists

public static boolean isFileExists(String filePath)

Check if the file is already exists in a given path.

Parameters:

filePath -

Returns:

true if file exists

getBatchPaymentsDirectoryName

public static String getBatchPaymentsDirectoryName()

Retrieves batch payment directory name from configurations xml if its not populated with Installer path, Else it returns the batch payment files path populated with Installer.

Returns:

parent directory name for batch payments.

getUnProcessedDirectoryPath

public static String getUnProcessedDirectoryPath()

Get UnProcessed Batch Payments Directory Path.

Returns:

'unprocessed' directory path.

getProcessingDirectoryPath

public static String getProcessingDirectoryPath()

Get Processing Batch Payments Directory Path.

Returns:

'processing' directory path.

getProcessedDirectoryPath

public static String getProcessedDirectoryPath()

Get Processed Batch Payments Directory Path.

Returns:

'processed' directory path.

getErrorDirectoryPath

public static String getErrorDirectoryPath()

Get Error Batch Payments Directory Path.

Returns:

'error' directory path.

readFileAttributes

public static BasicFileAttributes readFileAttributes(String filePath)
                                              throws IOException

Reads basic file attributes.

Parameters:

filePath -

Returns:

Throws:

IOException

getDelimiter

public static String getDelimiter(Map<String,String> templateDelimiterData)

Retrieve delimiter of a template file.

Parameters:

templateDelimiterData -

Returns:

join

public static <T> T[] join(T[]... arrays)

Joins multiple arrays and returns the concatenated array. The arrays being joined should all be of one type only.

Type Parameters:

T - Java Type

Parameters:

arrays - Arrays that need to be concatenated

Returns:

Joined Array

savePaymentBatchFileHeaderAsJSONFile

public static void savePaymentBatchFileHeaderAsJSONFile(String targetDirPath,
                                                        PaymentBatchFileHeader paymentBatchFileHeader)
                                                 throws ApplicationException

Writes batch payment file header to a JSON file and saves the file to the given directory path.

Parameters:

targetDirPath -

paymentBatchFileHeader -

Throws:

ApplicationException

convertJSONToPaymentBatchFileHeader

public static PaymentBatchFileHeader convertJSONToPaymentBatchFileHeader(File file)
                                                                  throws IOException

Reads given JSON file and converts to PaymentBatchFileHeader.

Parameters:

file -

Returns:

paymentBatchFileHeader

Throws:

IOException

getFilesList

public static List<File> getFilesList(String directoryPath,
                                      String globbingPattern)

Get all files of a directory based on the given globbingPattern, For example: globbingPattern "*.pmt" gets only .pmt files, "*.{json}" gets only .json files "*.{pmt,json} gets both .pmt and .json files

Parameters:

directoryPath -

globbingPattern -

Returns:

list of files

deleteFile

public static boolean deleteFile(String filePath)

Deletes file from the given filePath.

Parameters:

filePath -

Returns:

getFilesCountFromDirectory

public static int getFilesCountFromDirectory(String directoryPath)
                                      throws IOException

Get the count of files for a given directory path.

Parameters:

directoryPath -

Returns:

the count of files in a directory

Throws:

IOException

populateInstallerFilePaths

public static void populateInstallerFilePaths(HttpServletRequest servletRequest)

Populates batch payments related files paths that are given through BillingCare Installation wizard; The file paths will get retrieved from context parameters BATCH_PAYMENT_FILES_PATH and BATCH_PAYMENT_TEMPLATES_PATH; The context-param values will get populated via Plan.xml that gets updated on deployment path of BillingCare.war through BillingCare OUI installer.

Parameters:

servletRequest -

getBatchPaymentsFilesPath

public static String getBatchPaymentsFilesPath(HttpServletRequest servletRequest)

Retrieves batch payment files path from context-param BATCH_PAYMENT_FILES_PATH in web.xml

Parameters:

servletRequest - is a servletRequest

Returns:

batch payment files path

getBatchPaymentsTemplatesPath

public static String getBatchPaymentsTemplatesPath(HttpServletRequest servletRequest)

Retrieves batch payment template files path from context-param BATCH_PAYMENT_TEMPLATES_PATH in web.xml.

Parameters:

servletRequest - is a servletRequest

Returns:

batch payment template files path