com.serotonin.mango

Class Common

java.lang.Object

com.serotonin.mango.Common

public class Common
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Common.ContextKeys
static interface	Common.GroveServlets
static interface	Common.TimePeriods

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	ANON_VIEW_KEY
static ContextWrapper	ctx
private static java.lang.String	CUSTOM_VIEW_KEY
private static java.lang.String	environmentProfileName
private static java.lang.Object	i18nLock
private static java.lang.String	lazyFiledataPath
static com.serotonin.monitor.MonitoredValues	MONITORED_VALUES
static int	NEW_ID
private static java.lang.String	SESSION_USER
private static java.util.ResourceBundle	systemBundle
private static java.lang.String	systemLanguage
static ExportCodes	TIME_PERIOD_CODES
static com.serotonin.timer.RealTimeTimer	timer
static java.lang.String	UTF8
static java.nio.charset.Charset	UTF8_CS

Constructor Summary

Constructors

Constructor and Description
Common()

Method Summary

Modifier and Type	Method and Description
static void	addAnonymousView(javax.servlet.http.HttpServletRequest request, View view)
static void	changeEnvironmentProfile(java.lang.String provilePath)
static java.lang.String	encrypt(java.lang.String plaintext)
private static void	ensureI18n()
private static java.util.Locale	findLocale(java.lang.String language)
static java.lang.String	generateXid(java.lang.String prefix)
static View	getAnonymousView(javax.servlet.http.HttpServletRequest request, int id)
static View	getAnonymousView(int id)
private static java.util.List<View>	getAnonymousViews(javax.servlet.http.HttpServletRequest request)
static java.lang.String	getBackgroundProcessDescription()
static java.util.ResourceBundle	getBundle()
static java.util.List<CommPortProxy>	getCommPorts()
static com.serotonin.timer.CronTimerTrigger	getCronTrigger(int periodType, int delaySeconds)
static CustomView	getCustomView()
static CustomView	getCustomView(javax.servlet.http.HttpServletRequest request)
static java.lang.String	getDocPath()
static com.serotonin.util.PropertiesUtils	getEnvironmentProfile()
static java.lang.String	getFiledataPath()
static java.lang.String	getGroveUrl(java.lang.String servlet)
static org.apache.commons.httpclient.HttpClient	getHttpClient()
static org.apache.commons.httpclient.HttpClient	getHttpClient(int timeout)
static java.util.List<com.serotonin.db.KeyValuePair>	getLanguages()
static java.lang.String	getMessage(java.lang.String key)
static java.lang.String	getMessage(java.lang.String key, java.lang.Object... args)
static long	getMillis(int periodType, int periods) Returns the length of time in milliseconds that the
static org.joda.time.Period	getPeriod(int periodType, int periods)
static com.serotonin.web.i18n.LocalizableMessage	getPeriodDescription(int periodType, int periods)
static User	getUser()
static User	getUser(javax.servlet.http.HttpServletRequest request)
static java.lang.String	getVersion()
static void	setCustomView(javax.servlet.http.HttpServletRequest request, CustomView view)
static void	setSystemLanguage(java.lang.String language)
static void	setUser(javax.servlet.http.HttpServletRequest request, User user)

Methods inherited from class java.lang.Object

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

Field Detail

SESSION_USER

private static final java.lang.String SESSION_USER

See Also:

Constant Field Values

ANON_VIEW_KEY

private static final java.lang.String ANON_VIEW_KEY

See Also:

Constant Field Values

CUSTOM_VIEW_KEY

private static final java.lang.String CUSTOM_VIEW_KEY

See Also:

Constant Field Values

UTF8

public static final java.lang.String UTF8

See Also:

Constant Field Values

UTF8_CS

public static final java.nio.charset.Charset UTF8_CS

NEW_ID

public static final int NEW_ID

See Also:

Constant Field Values

ctx

public static ContextWrapper ctx

timer

public static final com.serotonin.timer.RealTimeTimer timer

MONITORED_VALUES

public static final com.serotonin.monitor.MonitoredValues MONITORED_VALUES

environmentProfileName

private static java.lang.String environmentProfileName

TIME_PERIOD_CODES

public static ExportCodes TIME_PERIOD_CODES

lazyFiledataPath

private static java.lang.String lazyFiledataPath

i18nLock

private static java.lang.Object i18nLock

systemLanguage

private static java.lang.String systemLanguage

systemBundle

private static java.util.ResourceBundle systemBundle

Constructor Detail

Common

public Common()

Method Detail

getVersion

public static final java.lang.String getVersion()

getMillis

public static long getMillis(int periodType,
                             int periods)

Returns the length of time in milliseconds that the

Parameters:

timePeriod -

numberOfPeriods -

Returns:

getPeriod

public static org.joda.time.Period getPeriod(int periodType,
                                             int periods)

getPeriodDescription

public static com.serotonin.web.i18n.LocalizableMessage getPeriodDescription(int periodType,
                                                                             int periods)

getUser

public static User getUser()

getUser

public static User getUser(javax.servlet.http.HttpServletRequest request)

setUser

public static void setUser(javax.servlet.http.HttpServletRequest request,
                           User user)

getBackgroundProcessDescription

public static java.lang.String getBackgroundProcessDescription()

getAnonymousView

public static View getAnonymousView(int id)

getAnonymousView

public static View getAnonymousView(javax.servlet.http.HttpServletRequest request,
                                    int id)

addAnonymousView

public static void addAnonymousView(javax.servlet.http.HttpServletRequest request,
                                    View view)

getAnonymousViews

private static java.util.List<View> getAnonymousViews(javax.servlet.http.HttpServletRequest request)

getCustomView

public static CustomView getCustomView()

getCustomView

public static CustomView getCustomView(javax.servlet.http.HttpServletRequest request)

setCustomView

public static void setCustomView(javax.servlet.http.HttpServletRequest request,
                                 CustomView view)

getEnvironmentProfile

public static com.serotonin.util.PropertiesUtils getEnvironmentProfile()

changeEnvironmentProfile

public static void changeEnvironmentProfile(java.lang.String provilePath)

getGroveUrl

public static java.lang.String getGroveUrl(java.lang.String servlet)

getDocPath

public static java.lang.String getDocPath()

getFiledataPath

public static java.lang.String getFiledataPath()

getCronTrigger

public static com.serotonin.timer.CronTimerTrigger getCronTrigger(int periodType,
                                                                  int delaySeconds)

getCommPorts

public static java.util.List<CommPortProxy> getCommPorts()
                                                  throws CommPortConfigException

Throws:

CommPortConfigException

encrypt

public static java.lang.String encrypt(java.lang.String plaintext)

getHttpClient

public static org.apache.commons.httpclient.HttpClient getHttpClient()

getHttpClient

public static org.apache.commons.httpclient.HttpClient getHttpClient(int timeout)

getMessage

public static java.lang.String getMessage(java.lang.String key)

getBundle

public static java.util.ResourceBundle getBundle()

ensureI18n

private static void ensureI18n()

getMessage

public static java.lang.String getMessage(java.lang.String key,
                                          java.lang.Object... args)

setSystemLanguage

public static void setSystemLanguage(java.lang.String language)

findLocale

private static java.util.Locale findLocale(java.lang.String language)

getLanguages

public static java.util.List<com.serotonin.db.KeyValuePair> getLanguages()

generateXid

public static java.lang.String generateXid(java.lang.String prefix)