edu.illinois.ncsa.isda.softwareserver.polyglot

Class PolyglotRESTUtilities

java.lang.Object

edu.illinois.ncsa.isda.softwareserver.polyglot.PolyglotRESTUtilities

public class PolyglotRESTUtilities
extends Object

Polyglot REST interface utility functions.

Author:

Kenton McHenry

Constructor Summary

Constructors

Constructor and Description
PolyglotRESTUtilities()

Method Summary

Methods

Modifier and Type	Method and Description
static String	getForm(Polyglot polyglot, boolean POST_UPLOADS, String selected_output) Get a web form interface for this restful service.
static String	toString(Collection<String> strings) Convert a Collection of strings to a line separated list of strings.
static String	truncateFileName(int prefixId, String filepath) Truncate filename from the leftmost filename to a reasonable length, so caller can put length of prefix (maximum FILENAME_PREFIX_RESERVED_LENGTH) before the truncated filename and DOT_LOG_EXTENSION_LENGTH length as a new extension.
static String	truncateFileName(String filepath) Truncate filename to a reasonable length.
static String	truncateURLFileName(String filepath) truncate URL filename to a reasonable length.
static void	updateMongo(com.mongodb.DB db, Polyglot polyglot) Push logged information to mongo.
static void	updateMongo(com.mongodb.DB db, PolyglotAuxiliary.RequestInformation request) Push request information to mongo.

Methods inherited from class java.lang.Object

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

Constructor Detail

PolyglotRESTUtilities

public PolyglotRESTUtilities()

Method Detail

truncateFileName

public static String truncateFileName(String filepath)

Truncate filename to a reasonable length. This function will find the prefix positive integer delimited by '_' if there is such integer in the prefix of filename, then it will be treated as prefixId and added back as prefix of truncated filename. Warning, positive prefixId will take space of FILENAME_RESERVED_LENGTH. However, for current filename naming, FILENAME_RESERVED_LENGTH is wide enough to hold (jobdId_ or sessionID_) + prefixId.

Parameters:

filepath - full path of file

Returns:

full path of file with truncated filename (containing valid Url encoding)

truncateURLFileName

public static String truncateURLFileName(String filepath)

truncate URL filename to a reasonable length. It will truncate the part of filename without prefixid, and add back prefixid as prefix of truncated filename.

Parameters:

filepath - full path of file

Returns:

full path of file with truncated filename (containing valid Url encoding)

truncateFileName

public static String truncateFileName(int prefixId,
                      String filepath)

Truncate filename from the leftmost filename to a reasonable length, so caller can put length of prefix (maximum FILENAME_PREFIX_RESERVED_LENGTH) before the truncated filename and DOT_LOG_EXTENSION_LENGTH length as a new extension. Note: caller explicitly gives valid sessionid or jobid as the prefix of truncated filename. Warning: it will cut off multiple extensions if the length of multiple extensions > 191, which is not possible.

Parameters:

prefixId - if sessionid or jobid >= 1, then add such id as prefix of truncated filename, otherwise not.

filepath - full path of file

Returns:

full path of file with truncated filename (containing valid Url encoding)

getForm

public static String getForm(Polyglot polyglot,
             boolean POST_UPLOADS,
             String selected_output)

Get a web form interface for this restful service.

Parameters:

polylgot - the polyglot steward

POST_UPLOADS - true if this form should use POST rather than GET for uploading files

selected_output - the default output format

Returns:

the form

updateMongo

public static void updateMongo(com.mongodb.DB db,
               Polyglot polyglot)

Push logged information to mongo.

Parameters:

db - a mongo database

polyglot - the polyglot steward

updateMongo

public static void updateMongo(com.mongodb.DB db,
               PolyglotAuxiliary.RequestInformation request)

Push request information to mongo.

Parameters:

db - a mongo database

toString

public static String toString(Collection<String> strings)

Convert a Collection of strings to a line separated list of strings.

Parameters:

strings - a Collection of strings

Returns:

the resulting string representation