com.edgeti.VisibilityServer.Ingestor

Class IngestManager

java.lang.Object

com.edgeti.VisibilityServer.Ingestor.IngestManager

public class IngestManager
extends java.lang.Object

The Class IngestManager. Requires two lines from the Visibility3\WEB-INF\classes\visibility.properties: fileuploader.uploadDirectory database.database

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTO_INGEST_TABLE_NAME The Constant AUTO_INGEST_TABLE_NAME.
static java.lang.String	CLASSIFICATION_TABLE_NAME The Constant CLASSIFICATION_TABLE_NAME.
static java.lang.String	DATA_TABLE_NAME The Constant DATA_TABLE_NAME.
private java.lang.String	database The database.
protected org.apache.log4j.Logger	logger The logger.
private static java.lang.String	PROP_FILE Name of the properties file which must exist on the classpath.
static java.lang.String	ROLE_COLUMNS_TABLE_NAME The Constant ROLE_COLUMNS_TABLE_NAME.
static java.lang.String	ROLES_DATA_TABLE_NAME The Constant ROLES_DATA_TABLE_NAME.
static java.lang.String	ROLES_TABLE_NAME The Constant ROLES_TABLE_NAME.
private java.lang.String	uploadDir The upload dir.

Constructor Summary

Constructors

Constructor and Description
IngestManager() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	createTables() Create tables for user and tables tracking....
java.lang.String	deleteAutoIngest(FlexAutoIngestRowObject autoIngest) Delete auto ingest in the database
java.lang.String	deleteFile(java.lang.String filename) Delete a file in the upload directory
java.lang.String	deleteIngestedData(java.lang.String tableName, UserInfoObject user) Delete table from database
java.lang.String	deleteTable(java.lang.String tableName) Delete table from database
java.util.List<FlexAutoIngestRowObject>	getAutoIngests() Return list of cron jobs from the database
java.lang.String	getClassification(java.lang.String tableName) Gets the classification String from the 'table'.
java.util.ArrayList<java.lang.String>	getRoles(java.lang.String tableName) Returns list of roles specified
java.util.ArrayList<java.lang.String>	getTableColumns(java.lang.String tableName) Returns list of columns in the table
java.util.ArrayList<RoleInfoObject>	getTableRoleInfos(java.lang.String tableId) Returns list of role info objestcs for the table
java.util.List<java.lang.String>	getTableRoles(java.lang.String tableId) Returns list of roles for the table
java.lang.String	ingest(java.lang.String tableName, java.lang.String filename, boolean merge, java.lang.String classification, java.util.ArrayList<java.lang.String> roleColumns, UserInfoObject user, int published, java.util.ArrayList<RoleInfoObject> roles) Ingest file to the database
IngestResult	ingestExcel(java.lang.String tableName, java.lang.String filename, boolean merge) Ingest Excel spreadsheet
IngestResult	ingestFile(java.lang.String tableName, java.lang.String filename, boolean merge) Ingest file.
IngestResult	ingestXML(java.lang.String tableName, java.lang.String filename, boolean merge) Ingest xml file.
private boolean	isUserAdmin(UserInfoObject user) Check to see if user is admin
java.util.ArrayList<java.lang.String>	listColumnHeaders(java.lang.String filename) Returns list of column headers for file specified
java.util.ArrayList<java.lang.String>	listFiles() Return List of files at upload Directory
java.util.List<TablesInfoObject>	listTables() Returns list of tables in the database
static void	main(java.lang.String[] args) The main method.
private java.lang.String	parseDate(java.util.Date date) Parses the date using "yyyy-MM-dd HH:mm:ss.S"
java.lang.String	runAutoIngest(FlexAutoIngestRowObject autoIngest) Run auto ingest and update time
java.lang.String	saveAutoIngest(FlexAutoIngestRowObject autoIngest) Save auto ingest in the database check table_info againt table name and id, return error if user id != owner id create new table_info record if no existing table name found delete existing classification and roles, update with new
boolean	updateClassificationInfo(java.lang.String tableName, java.lang.String classification) Update table info, find table by name and update ownerId and published
boolean	updateIngestInfo(java.lang.String tableName, java.lang.String classification, java.util.ArrayList<java.lang.String> roleColumns, UserInfoObject user, int published, java.lang.String filename, java.util.ArrayList<RoleInfoObject> roles) Update table_data, table_roles, table_classification
boolean	updateRoleColumnsInfo(java.lang.String tableName, java.util.ArrayList<java.lang.String> roleColumns) Update role columns info, loop through the role columns list insert if data not exists, update if the data exists
boolean	updateRolesInfo(java.lang.String tableName, java.util.ArrayList<RoleInfoObject> roles) Update table roles info, loop through the roles list insert if data not exists, update if the data exists
boolean	updateTableInfo(java.lang.String tableName, int ownerId, long published, java.lang.String filename) Update table info, find table by name and update ownerId and published
java.lang.String	validate(FlexAutoIngestRowObject ingestFile) Make sure the file actually exists in the specified location
java.lang.String	validateUrl(java.lang.String url) Validate that the url is readable

Methods inherited from class java.lang.Object

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

Field Detail

PROP_FILE

private static final java.lang.String PROP_FILE

Name of the properties file which must exist on the classpath.

See Also:

Constant Field Values

AUTO_INGEST_TABLE_NAME

public static final java.lang.String AUTO_INGEST_TABLE_NAME

The Constant AUTO_INGEST_TABLE_NAME.

See Also:

Constant Field Values

DATA_TABLE_NAME

public static final java.lang.String DATA_TABLE_NAME

The Constant DATA_TABLE_NAME.

See Also:

Constant Field Values

ROLE_COLUMNS_TABLE_NAME

public static final java.lang.String ROLE_COLUMNS_TABLE_NAME

The Constant ROLE_COLUMNS_TABLE_NAME.

See Also:

Constant Field Values

CLASSIFICATION_TABLE_NAME

public static final java.lang.String CLASSIFICATION_TABLE_NAME

The Constant CLASSIFICATION_TABLE_NAME.

See Also:

Constant Field Values

ROLES_DATA_TABLE_NAME

public static final java.lang.String ROLES_DATA_TABLE_NAME

The Constant ROLES_DATA_TABLE_NAME.

See Also:

Constant Field Values

ROLES_TABLE_NAME

public static final java.lang.String ROLES_TABLE_NAME

The Constant ROLES_TABLE_NAME.

See Also:

Constant Field Values

uploadDir

private java.lang.String uploadDir

The upload dir.

database

private java.lang.String database

The database.

logger

protected org.apache.log4j.Logger logger

The logger.

Constructor Detail

IngestManager

public IngestManager()

Constructor. Instantiates a new IngestManager from the properties files or defaults if the properties file can't be opened.

Method Detail

createTables

public boolean createTables()

Create tables for user and tables tracking.... should be called from the constructor

Returns:

true, if successful

ingest

public java.lang.String ingest(java.lang.String tableName,
                      java.lang.String filename,
                      boolean merge,
                      java.lang.String classification,
                      java.util.ArrayList<java.lang.String> roleColumns,
                      UserInfoObject user,
                      int published,
                      java.util.ArrayList<RoleInfoObject> roles)

Ingest file to the database

Parameters:

tableName - the table name

filename - the filename

merge - the merge

classification - the classification

roleColumns - the role columns

user - the user

published - the published

roles - the roles

Returns:

the string

updateIngestInfo

public boolean updateIngestInfo(java.lang.String tableName,
                       java.lang.String classification,
                       java.util.ArrayList<java.lang.String> roleColumns,
                       UserInfoObject user,
                       int published,
                       java.lang.String filename,
                       java.util.ArrayList<RoleInfoObject> roles)

Update table_data, table_roles, table_classification

Parameters:

tableName - the table name

classification - the classification

roleColumns - array of headers for row columns

user - the user

published - the published flag

filename - the filename

roles - the roles

Returns:

true, if successful ingest

updateTableInfo

public boolean updateTableInfo(java.lang.String tableName,
                      int ownerId,
                      long published,
                      java.lang.String filename)

Update table info, find table by name and update ownerId and published

Parameters:

tableName - the table name

ownerId - the owner id from the users table

published - the published flag

filename - the filename

Returns:

true, if successful table update

updateClassificationInfo

public boolean updateClassificationInfo(java.lang.String tableName,
                               java.lang.String classification)

Update table info, find table by name and update ownerId and published

Parameters:

tableName - the table name

classification - the classification

Returns:

true, if successful

updateRoleColumnsInfo

public boolean updateRoleColumnsInfo(java.lang.String tableName,
                            java.util.ArrayList<java.lang.String> roleColumns)

Update role columns info, loop through the role columns list insert if data not exists, update if the data exists

Parameters:

tableName - the table name

roleColumns - the array of role columns

Returns:

true, if successful

updateRolesInfo

public boolean updateRolesInfo(java.lang.String tableName,
                      java.util.ArrayList<RoleInfoObject> roles)

Update table roles info, loop through the roles list insert if data not exists, update if the data exists

Parameters:

tableName - the table name

roles - the roles

Returns:

true, if successful

ingestFile

public IngestResult ingestFile(java.lang.String tableName,
                      java.lang.String filename,
                      boolean merge)

Ingest file.

Parameters:

tableName - the table name

filename - the filename

merge - the merge flag. true = merge, false = replace

Returns:

the IngestResult containing the status information

ingestXML

public IngestResult ingestXML(java.lang.String tableName,
                     java.lang.String filename,
                     boolean merge)

Ingest xml file.

Parameters:

tableName - the table name

filename - the filename

merge - the merge flag. true = merge, false = replace

Returns:

the IngestResult containing the status information

ingestExcel

public IngestResult ingestExcel(java.lang.String tableName,
                       java.lang.String filename,
                       boolean merge)

Ingest Excel spreadsheet

Parameters:

tableName - the table name

filename - the filename

merge - the merge flag. true = merge, false = replace

Returns:

the IngestResult containing the status information

deleteTable

public java.lang.String deleteTable(java.lang.String tableName)

Delete table from database

Parameters:

tableName - the table name

Returns:

status string ("Delete table: tableName" or "Error deleting table: tableName)

isUserAdmin

private boolean isUserAdmin(UserInfoObject user)

Check to see if user is admin

Parameters:

user - the user

Returns:

true, if is user admin

deleteIngestedData

public java.lang.String deleteIngestedData(java.lang.String tableName,
                                  UserInfoObject user)

Delete table from database

Parameters:

tableName - the table name

user - the user

Returns:

the string

listFiles

public java.util.ArrayList<java.lang.String> listFiles()

Return List of files at upload Directory

Returns:

ArrayList

deleteFile

public java.lang.String deleteFile(java.lang.String filename)

Delete a file in the upload directory

Parameters:

filename - the filename key for the directory

Returns:

the status String

listTables

public java.util.List<TablesInfoObject> listTables()

Returns list of tables in the database

Returns:

List

listColumnHeaders

public java.util.ArrayList<java.lang.String> listColumnHeaders(java.lang.String filename)

Returns list of column headers for file specified

Parameters:

filename - the filename

Returns:

the array list

getAutoIngests

public java.util.List<FlexAutoIngestRowObject> getAutoIngests()

Return list of cron jobs from the database

Returns:

the auto ingests

saveAutoIngest

public java.lang.String saveAutoIngest(FlexAutoIngestRowObject autoIngest)

Save auto ingest in the database check table_info againt table name and id, return error if user id != owner id create new table_info record if no existing table name found delete existing classification and roles, update with new

Parameters:

autoIngest - the auto ingest

Returns:

the string

deleteAutoIngest

public java.lang.String deleteAutoIngest(FlexAutoIngestRowObject autoIngest)

Delete auto ingest in the database

Parameters:

autoIngest - the auto ingest

Returns:

the string

runAutoIngest

public java.lang.String runAutoIngest(FlexAutoIngestRowObject autoIngest)

Run auto ingest and update time

Parameters:

autoIngest - the auto ingest FlexAutoIngestRowObject

Returns:

the status String

parseDate

private java.lang.String parseDate(java.util.Date date)

Parses the date using "yyyy-MM-dd HH:mm:ss.S"

Parameters:

date - the Date to format

Returns:

the formatted string

getTableColumns

public java.util.ArrayList<java.lang.String> getTableColumns(java.lang.String tableName)

Returns list of columns in the table

Parameters:

tableName - the table name

Returns:

the table columns

getTableRoles

public java.util.List<java.lang.String> getTableRoles(java.lang.String tableId)

Returns list of roles for the table

Parameters:

tableId - the table id

Returns:

the table roles

getTableRoleInfos

public java.util.ArrayList<RoleInfoObject> getTableRoleInfos(java.lang.String tableId)

Returns list of role info objestcs for the table

Parameters:

tableId - the table id

Returns:

the table role infos

getRoles

public java.util.ArrayList<java.lang.String> getRoles(java.lang.String tableName)

Returns list of roles specified

Parameters:

tableName - the table name

Returns:

the roles

getClassification

public java.lang.String getClassification(java.lang.String tableName)

Gets the classification String from the 'table'.

Parameters:

tableName - the table name

Returns:

the classification

validate

public java.lang.String validate(FlexAutoIngestRowObject ingestFile)

Make sure the file actually exists in the specified location

Parameters:

ingestFile - the FlexAutoIngestRowObject containing the location and file name

Returns:

the status String

validateUrl

public java.lang.String validateUrl(java.lang.String url)

Validate that the url is readable

Parameters:

url - the url

Returns:

the status String ("Validation Successful" or "Validation Failed")

main

public static void main(java.lang.String[] args)

The main method. For debugging only

Parameters:

args - the arguments