weave.servlets

Class AdminService

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

weave.servlets.WeaveServlet

weave.servlets.AdminService

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, IWeaveEntityManagementService

public class AdminService
extends WeaveServlet
implements IWeaveEntityManagementService

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class weave.servlets.WeaveServlet

WeaveServlet.ServletRequestInfo

Field Summary

Fields inherited from class weave.servlets.WeaveServlet

debugThreshold, JSONRPC_VERSION, METHOD, PARAMS, STREAM_PARAMETER_INDEX

Constructor Summary

Constructors

Constructor and Description
AdminService()

Method Summary

Methods

Modifier and Type	Method and Description
int[]	addChild(int parentId, int childId, int insertAtIndex) Adds a parent-child relationship to the server-side entity hierarchy table.
boolean	authenticate(java.lang.String username, java.lang.String password)
boolean	checkDatabaseConfigExists()
void	checkKeyColumnsForCSVImport(java.lang.String csvFile, java.lang.String[] keyColumns) Check if selected key column from CSV data has unique values
java.lang.Boolean	checkKeyColumnsForDBFImport(java.lang.String[] fileNames, java.lang.String[] keyColumnNames)
void	checkKeyColumnsForSQLImport(java.lang.String schemaName, java.lang.String tableName, java.lang.String[] keyColumns)
void	destroy()
int[]	findEntityIds(java.util.Map<java.lang.String,java.lang.String> publicMetadata, java.lang.String[] wildcardFields) Gets an Array of entity IDs with matching public metadata.
java.lang.String[]	findPublicFieldValues(java.lang.String fieldName, java.lang.String valueSearch) Finds matching values for a public metadata field.
ConnectionConfig.ConnectionInfo	getConnectionInfo(java.lang.String userToGet)
java.lang.String[]	getConnectionNames()
java.lang.String[]	getCSVColumnNames(java.lang.String csvFile) Read a list of csv files and return common header columns.
ConnectionConfig.DatabaseConfigInfo	getDatabaseConfigInfo()
java.lang.String[]	getDBFColumnNames(java.lang.String[] dbfFileNames)
DataConfig.DataEntityWithRelationships[]	getEntities(int[] ids) Gets an Array of Entity objects.
DataConfig.EntityHierarchyInfo[]	getHierarchyInfo(java.util.Map<java.lang.String,java.lang.String> publicMetadata) Gets EntityHierarchyInfo objects containing basic information on entities matching public metadata.
java.lang.String[]	getKeyTypes()
java.lang.String[]	getSQLColumnNames(java.lang.String schemaName, java.lang.String tableName)
java.lang.String[]	getSQLSchemaNames() The following functions get information about the database associated with a given connection name.
java.lang.String[]	getSQLTableNames(java.lang.String schemaName)
WeaveFileInfo[]	getUploadedCSVFiles()
WeaveFileInfo[]	getUploadedSHPFiles()
java.lang.String	getVersion()
WeaveFileInfo	getWeaveFileInfo(java.lang.String fileName)
java.lang.String[]	getWeaveFileNames(java.lang.Boolean showAllFiles) Return a list of Client Config files from docroot
int	importCSV(java.lang.String csvFile, java.lang.String csvKeyColumn, java.lang.String csvSecondaryKeyColumn, java.lang.String sqlSchema, java.lang.String sqlTable, boolean sqlOverwrite, java.lang.String configDataTableName, java.lang.String configKeyType, java.lang.String[] nullValues, java.lang.String[] filterColumnNames, boolean configAppend)
void	importDBF(java.lang.String[] fileNameWithoutExtension, java.lang.String sqlSchema, java.lang.String sqlTableName, boolean sqlOverwrite, java.lang.String[] nullValues)
int	importSHP(java.lang.String[] fileNameWithoutExtension, java.lang.String[] keyColumns, java.lang.String sqlSchema, java.lang.String sqlTablePrefix, boolean sqlOverwrite, java.lang.String configTitle, java.lang.String configKeyType, java.lang.String projectionSRS, java.lang.String[] nullValues, boolean importDBFData, boolean append) The following functions involve getting shapes into the database and into the config file.
int	importSQL(java.lang.String schemaName, java.lang.String tableName, java.lang.String keyColumnName, java.lang.String secondaryKeyColumnName, java.lang.String configDataTableName, java.lang.String keyType, java.lang.String[] filterColumnNames, boolean append)
void	init(javax.servlet.ServletConfig config)
void	initializeAdminService() This function should be the first thing called by the Admin Console to initialize the servlet.
void	keepAlive()
int	newEntity(DataConfig.DataEntityMetadata meta, int parentId, int insertAtIndex) Creates a new entity.
void	removeChild(int parentId, int childId) Removes a parent-child relationship from the server-side entity hierarchy table.
java.lang.String	removeConnectionInfo(java.lang.String userToRemove)
int[]	removeEntities(int[] entityIds) Removes entities and their children recursively.
java.lang.String	removeWeaveFile(java.lang.String fileName) Delete a Client Config file from docroot
java.lang.String	saveConnectionInfo(java.lang.String newUser, java.lang.String newPass, java.lang.String folderName, boolean grantSuperuser, java.lang.String connectString, boolean configOverwrite)
java.lang.String	saveWeaveFile(java.io.InputStream fileContent, java.lang.String fileName, boolean overwriteFile)
java.lang.String	setDatabaseConfigInfo(java.lang.String connectionName, java.lang.String password, java.lang.String schema, java.lang.String[] idFields)
DataConfig.DataEntity[]	testAllQueries(int table_id) Returns the results of testing attribute column sql queries.
void	updateEntity(int entityId, DataConfig.DataEntityMetadata diff) Updates the metadata for an existing entity.
void	uploadFile(java.lang.String fileName, java.io.InputStream content, boolean append) This function accepts an uploaded file.

Methods inherited from class weave.servlets.WeaveServlet

cast, deserializeAmf3, doGet, doPost, getCapabilities, getServletRequestInfo, initAllMethods, initMethod, methodToString, serializeCompressedAmf3

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminService

public AdminService()

Method Detail

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class WeaveServlet

Throws:

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet

initializeAdminService

public void initializeAdminService()
                            throws java.rmi.RemoteException

This function should be the first thing called by the Admin Console to initialize the servlet. If SQL config data migration is required, it will be done and periodic status updates will be written to the servlet output stream.

Throws:

java.rmi.RemoteException - Thrown when the DataConfig could not be initialized.

getVersion

public java.lang.String getVersion()

checkDatabaseConfigExists

public boolean checkDatabaseConfigExists()
                                  throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

authenticate

public boolean authenticate(java.lang.String username,
                   java.lang.String password)
                     throws java.rmi.RemoteException

Parameters:

user -

password -

Returns:

true if the user has superuser privileges.

Throws:

java.rmi.RemoteException - If authentication fails.

keepAlive

public void keepAlive()
               throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getWeaveFileNames

public java.lang.String[] getWeaveFileNames(java.lang.Boolean showAllFiles)
                                     throws java.rmi.RemoteException

Return a list of Client Config files from docroot

Returns:

A list of (xml) client config files existing in the docroot folder.

Throws:

java.rmi.RemoteException

saveWeaveFile

public java.lang.String saveWeaveFile(java.io.InputStream fileContent,
                             java.lang.String fileName,
                             boolean overwriteFile)
                               throws java.rmi.RemoteException

Parameters:

fileContent -

fileName -

overwriteFile -

Returns:

A description of the success or failure of this function.

Throws:

java.rmi.RemoteException

removeWeaveFile

public java.lang.String removeWeaveFile(java.lang.String fileName)
                                 throws java.rmi.RemoteException,
                                        java.lang.IllegalArgumentException

Delete a Client Config file from docroot

Returns:

A String message indicating if file was deleted.

Throws:

java.rmi.RemoteException

java.lang.IllegalArgumentException

getWeaveFileInfo

public WeaveFileInfo getWeaveFileInfo(java.lang.String fileName)
                               throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getConnectionNames

public java.lang.String[] getConnectionNames()
                                      throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getConnectionInfo

public ConnectionConfig.ConnectionInfo getConnectionInfo(java.lang.String userToGet)
                                                  throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

saveConnectionInfo

public java.lang.String saveConnectionInfo(java.lang.String newUser,
                                  java.lang.String newPass,
                                  java.lang.String folderName,
                                  boolean grantSuperuser,
                                  java.lang.String connectString,
                                  boolean configOverwrite)
                                    throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

removeConnectionInfo

public java.lang.String removeConnectionInfo(java.lang.String userToRemove)
                                      throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getDatabaseConfigInfo

public ConnectionConfig.DatabaseConfigInfo getDatabaseConfigInfo()
                                                          throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

setDatabaseConfigInfo

public java.lang.String setDatabaseConfigInfo(java.lang.String connectionName,
                                     java.lang.String password,
                                     java.lang.String schema,
                                     java.lang.String[] idFields)
                                       throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

addChild

public int[] addChild(int parentId,
             int childId,
             int insertAtIndex)
               throws java.rmi.RemoteException

Description copied from interface: IWeaveEntityManagementService

Adds a parent-child relationship to the server-side entity hierarchy table.

Specified by:

addChild in interface IWeaveEntityManagementService

Parameters:

parentId - The ID of the parent entity.

childId - The ID of the child entity.

insertAtIndex - Specifies insertion index for sort order.

Returns:

An Array of IDs whose relationships have changed as a result of adding the parent-child relationship.

Throws:

java.rmi.RemoteException

removeChild

public void removeChild(int parentId,
               int childId)
                 throws java.rmi.RemoteException

Description copied from interface: IWeaveEntityManagementService

Removes a parent-child relationship from the server-side entity hierarchy table.

Specified by:

removeChild in interface IWeaveEntityManagementService

Parameters:

parentId - The ID of the parent entity.

childId - The ID of the child entity.

Throws:

java.rmi.RemoteException

newEntity

public int newEntity(DataConfig.DataEntityMetadata meta,
            int parentId,
            int insertAtIndex)
              throws java.rmi.RemoteException

Description copied from interface: IWeaveEntityManagementService

Creates a new entity.

Specified by:

newEntity in interface IWeaveEntityManagementService

Parameters:

meta - Metadata for the new entity.

parentId - The parent entity ID, or -1 for no parent.

insertAtIndex - Specifies insertion index for sort order.

Returns:

An entity ID.

Throws:

java.rmi.RemoteException

removeEntities

public int[] removeEntities(int[] entityIds)
                     throws java.rmi.RemoteException

Description copied from interface: IWeaveEntityManagementService

Removes entities and their children recursively.

Specified by:

removeEntities in interface IWeaveEntityManagementService

Parameters:

entityIds - A list of entity IDs to remove.

Returns:

An Array of entity IDs that were removed.

Throws:

java.rmi.RemoteException

updateEntity

public void updateEntity(int entityId,
                DataConfig.DataEntityMetadata diff)
                  throws java.rmi.RemoteException

Description copied from interface: IWeaveEntityManagementService

Updates the metadata for an existing entity.

Specified by:

updateEntity in interface IWeaveEntityManagementService

Parameters:

entityId - An entity ID.

diff - Specifies the changes to make to the metadata.

Throws:

java.rmi.RemoteException

getHierarchyInfo

public DataConfig.EntityHierarchyInfo[] getHierarchyInfo(java.util.Map<java.lang.String,java.lang.String> publicMetadata)
                                                  throws java.rmi.RemoteException

Description copied from interface: IWeaveEntityManagementService

Gets EntityHierarchyInfo objects containing basic information on entities matching public metadata.

Specified by:

getHierarchyInfo in interface IWeaveEntityManagementService

Parameters:

publicMetadata - EntityMetadata containing values to match.

Returns:

An Array of EntityHierarchyInfo objects, sorted by title.

Throws:

java.rmi.RemoteException

getEntities

public DataConfig.DataEntityWithRelationships[] getEntities(int[] ids)
                                                     throws java.rmi.RemoteException

Description copied from interface: IWeaveEntityManagementService

Gets an Array of Entity objects.

Specified by:

getEntities in interface IWeaveEntityManagementService

Parameters:

ids - A list of entity IDs.

Returns:

An Array of Entity objects.

Throws:

java.rmi.RemoteException

findEntityIds

public int[] findEntityIds(java.util.Map<java.lang.String,java.lang.String> publicMetadata,
                  java.lang.String[] wildcardFields)
                    throws java.rmi.RemoteException

Description copied from interface: IWeaveEntityManagementService

Gets an Array of entity IDs with matching public metadata.

Specified by:

findEntityIds in interface IWeaveEntityManagementService

Parameters:

publicMetadata - Public metadata to search for.

wildcardFields - A list of field names in publicMetadata that should be treated as search strings with wildcards '?' and '*' for single-character and multi-character matching, respectively.

Returns:

An Array of IDs matching the search criteria.

Throws:

java.rmi.RemoteException

findPublicFieldValues

public java.lang.String[] findPublicFieldValues(java.lang.String fieldName,
                                       java.lang.String valueSearch)
                                         throws java.rmi.RemoteException

Description copied from interface: IWeaveEntityManagementService

Finds matching values for a public metadata field.

Specified by:

findPublicFieldValues in interface IWeaveEntityManagementService

Parameters:

fieldName - The name of the public metadata field to search.

valueSearch - A search string.

Returns:

An Array of matching values for the specified public metadata field.

Throws:

java.rmi.RemoteException

getSQLSchemaNames

public java.lang.String[] getSQLSchemaNames()
                                     throws java.rmi.RemoteException

The following functions get information about the database associated with a given connection name.

Throws:

java.rmi.RemoteException

getSQLTableNames

public java.lang.String[] getSQLTableNames(java.lang.String schemaName)
                                    throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getSQLColumnNames

public java.lang.String[] getSQLColumnNames(java.lang.String schemaName,
                                   java.lang.String tableName)
                                     throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

uploadFile

public void uploadFile(java.lang.String fileName,
              java.io.InputStream content,
              boolean append)
                throws java.rmi.RemoteException

This function accepts an uploaded file.

Parameters:

fileName - The name of the file.

content - The file content.

append - Set to true to append to an existing file.

Throws:

java.rmi.RemoteException

getUploadedCSVFiles

public WeaveFileInfo[] getUploadedCSVFiles()
                                    throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getUploadedSHPFiles

public WeaveFileInfo[] getUploadedSHPFiles()
                                    throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getCSVColumnNames

public java.lang.String[] getCSVColumnNames(java.lang.String csvFile)
                                     throws java.rmi.RemoteException

Read a list of csv files and return common header columns.

Parameters:

csvFile - A CSV file name

Returns:

A list of common header files or null if none exist encoded using

Throws:

java.rmi.RemoteException

getDBFColumnNames

public java.lang.String[] getDBFColumnNames(java.lang.String[] dbfFileNames)
                                     throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

checkKeyColumnsForSQLImport

public void checkKeyColumnsForSQLImport(java.lang.String schemaName,
                               java.lang.String tableName,
                               java.lang.String[] keyColumns)
                                 throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

checkKeyColumnsForCSVImport

public void checkKeyColumnsForCSVImport(java.lang.String csvFile,
                               java.lang.String[] keyColumns)
                                 throws java.rmi.RemoteException

Check if selected key column from CSV data has unique values

Parameters:

csvFile - The CSV file to check

keyColumns - The column names to check for unique values

Throws:

java.rmi.RemoteException - if the values in the key columns cannot be used to uniquely identify records.

checkKeyColumnsForDBFImport

public java.lang.Boolean checkKeyColumnsForDBFImport(java.lang.String[] fileNames,
                                            java.lang.String[] keyColumnNames)
                                              throws java.io.IOException

Throws:

java.io.IOException

importCSV

public int importCSV(java.lang.String csvFile,
            java.lang.String csvKeyColumn,
            java.lang.String csvSecondaryKeyColumn,
            java.lang.String sqlSchema,
            java.lang.String sqlTable,
            boolean sqlOverwrite,
            java.lang.String configDataTableName,
            java.lang.String configKeyType,
            java.lang.String[] nullValues,
            java.lang.String[] filterColumnNames,
            boolean configAppend)
              throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

importSQL

public int importSQL(java.lang.String schemaName,
            java.lang.String tableName,
            java.lang.String keyColumnName,
            java.lang.String secondaryKeyColumnName,
            java.lang.String configDataTableName,
            java.lang.String keyType,
            java.lang.String[] filterColumnNames,
            boolean append)
              throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

importSHP

public int importSHP(java.lang.String[] fileNameWithoutExtension,
            java.lang.String[] keyColumns,
            java.lang.String sqlSchema,
            java.lang.String sqlTablePrefix,
            boolean sqlOverwrite,
            java.lang.String configTitle,
            java.lang.String configKeyType,
            java.lang.String projectionSRS,
            java.lang.String[] nullValues,
            boolean importDBFData,
            boolean append)
              throws java.rmi.RemoteException

The following functions involve getting shapes into the database and into the config file.

Throws:

java.rmi.RemoteException

importDBF

public void importDBF(java.lang.String[] fileNameWithoutExtension,
             java.lang.String sqlSchema,
             java.lang.String sqlTableName,
             boolean sqlOverwrite,
             java.lang.String[] nullValues)
               throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

testAllQueries

public DataConfig.DataEntity[] testAllQueries(int table_id)
                                       throws java.rmi.RemoteException

Returns the results of testing attribute column sql queries.

Throws:

java.rmi.RemoteException

getKeyTypes

public java.lang.String[] getKeyTypes()
                               throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException