com.SIMRacingApps

Class Server

java.lang.Object

com.SIMRacingApps.Server

public class Server
extends java.lang.Object

This class defines the static main() method used to start the internal server.

Since:

1.0

Author:

Jeffrey Gilliam

Copyright:

Copyright (C) 2015 - 2024 Jeffrey Gilliam

License:

Apache License 2.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	m_hostname

Constructor Summary

Constructors

Constructor and Description
Server()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getArg(java.lang.String arg) Returns the value of the specified argument as a string.
static boolean	getArg(java.lang.String arg, boolean defaultValue) Returns the value of the specified argument as a boolean.
static double	getArg(java.lang.String arg, double defaultValue) Returns the value of the specified argument as a double.
static int	getArg(java.lang.String arg, int defaultValue) Returns the value of the specified argument as a integer.
static java.lang.String	getArg(java.lang.String arg, java.lang.String defaultValue) Returns the value of the specified argument as a string.
static java.lang.String	getLog()
static int	getPort()
static boolean	isLogLevelFine()
static boolean	isLogLevelFiner()
static boolean	isLogLevelFinest() Use these methods to test if the specified level will actually log anything.
static boolean	isLogLevelInfo()
static boolean	isLogLevelSevere()
static boolean	isLogLevelWarning()
static void	logArgs() This method sends all the arguments to the log.
static java.util.logging.Logger	logger()
static void	logStackTrace(java.lang.Exception exception)
static void	logStackTrace(java.util.logging.Level level, java.lang.Exception exception)
static void	logStackTrace(java.util.logging.Level level, java.lang.String message, java.lang.Exception exception) This method should be used to log the entire stack trace to the log file.
static void	logStackTrace(java.util.logging.Level level, java.lang.String message, java.lang.StackTraceElement[] trace)
static void	logStackTrace(java.util.logging.Level level, java.lang.String message, java.lang.Throwable throwable) This method should be used to log the entire stack trace to the log file.
static void	main(java.lang.String[] args)
static void	parseArgs(java.lang.String[] args) This routine will parse for all args an put them in a map to be recalled from anywhere via any of the getArg()s methods.
static void	setLog(java.lang.String logname)

Methods inherited from class java.lang.Object

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

Field Detail

m_hostname

public static java.lang.String m_hostname

Constructor Detail

Server

public Server()

Method Detail

getLog

public static java.lang.String getLog()

setLog

public static void setLog(java.lang.String logname)

logger

public static java.util.logging.Logger logger()

logStackTrace

public static void logStackTrace(java.util.logging.Level level,
                                 java.lang.String message,
                                 java.lang.StackTraceElement[] trace)

Parameters:

level - The Level to log. Defaults to SEVERE.

message - A message you provide to be logged with the trace.

trace - An array to the stack trace.

logStackTrace

public static void logStackTrace(java.util.logging.Level level,
                                 java.lang.String message,
                                 java.lang.Exception exception)

This method should be used to log the entire stack trace to the log file.

Parameters:

level - (optional) The Level to log. Defaults to SEVERE.

message - (optional) A message you provide to be logged with the trace.

exception - The exception to get the trace from.

logStackTrace

public static void logStackTrace(java.util.logging.Level level,
                                 java.lang.String message,
                                 java.lang.Throwable throwable)

This method should be used to log the entire stack trace to the log file.

Parameters:

level - (optional) The Level to log. Defaults to SEVERE.

message - (optional) A message you provide to be logged with the trace.

throwable - The throwable obtained from an exception.

logStackTrace

public static void logStackTrace(java.util.logging.Level level,
                                 java.lang.Exception exception)

logStackTrace

public static void logStackTrace(java.lang.Exception exception)

isLogLevelFinest

public static boolean isLogLevelFinest()

Use these methods to test if the specified level will actually log anything. I do this in time critical sections to prevent forming the string to be logged, if it's not going to be logged anyway.

Returns:

true if level will be logged.

isLogLevelFiner

public static boolean isLogLevelFiner()

isLogLevelFine

public static boolean isLogLevelFine()

isLogLevelInfo

public static boolean isLogLevelInfo()

isLogLevelWarning

public static boolean isLogLevelWarning()

isLogLevelSevere

public static boolean isLogLevelSevere()

getPort

public static int getPort()

getArg

public static java.lang.String getArg(java.lang.String arg)

Returns the value of the specified argument as a string. The string will be empty if arg not found. It is not case sensitive, all args are stored in lower case.

Parameters:

arg - The argument name

Returns:

The value of the argument

getArg

public static java.lang.String getArg(java.lang.String arg,
                                      java.lang.String defaultValue)

Returns the value of the specified argument as a string. The defaultValue be returned if arg not found or blank. It is not case sensitive, all args are stored in lower case. All values are trimmed of leading and trailing spaces.

Parameters:

arg - The argument name

defaultValue - The value to use if argument not found

Returns:

The value of the argument

getArg

public static boolean getArg(java.lang.String arg,
                             boolean defaultValue)

Returns the value of the specified argument as a boolean. The defaultValue will be returned if arg not found or blank. It is not case sensitive, all args are stored in lower case.

Parameters:

arg - The argument name

defaultValue - The value to use if argument not found

Returns:

The value of the argument

getArg

public static int getArg(java.lang.String arg,
                         int defaultValue)

Returns the value of the specified argument as a integer. The defaultValue will be returned if arg not found or blank. It is not case sensitive, all args are stored in lower case.

Parameters:

arg - The argument name

defaultValue - The value to use if argument not found

Returns:

The value of the argument

getArg

public static double getArg(java.lang.String arg,
                            double defaultValue)

Returns the value of the specified argument as a double. The defaultValue will be returned if arg not found or blank. It is not case sensitive, all args are stored in lower case.

Parameters:

arg - The argument name

defaultValue - The value to use if argument not found

Returns:

The value of the argument

logArgs

public static void logArgs()

This method sends all the arguments to the log.

parseArgs

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

This routine will parse for all args an put them in a map to be recalled from anywhere via any of the getArg()s methods. The args can also be specified in a settings.txt file found in the userPath. Command line args override args in the settings file. It should be called by any application implementing it's own Main function.

The following arguments are used immediately to enable some features:

-level {logLevel}, where logLevel is SEVERE,WARNING,INFO,FINE,FINER,FINEST. Defaults to INFO.

-log {filename}, creates a log file using the -level option in the -userpath directory.

-settings {settingsFilename} The name of the settings file to use. Defaults to settings.txt.

-userpath {userPath}, A path where where users can add their own widgets and apps. It can be a list of directories separated by a semi-colon, just like the PATH environment variable. All paths must be absolute paths, Defaults to "%USERPROFILE%\Documents\SIMRacingApps".

-sendkeysdelay {milliseconds}, changes the delay sendkeys uses. Default is 32ms

-ip {IpAddress}, When users are connected to more than one network, this option forces the server to bind to the specified address instead of the first one.

Parameters:

args - command line arguments

main

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