Latkes (Latke Core 3.0.6 API)

java.lang.Object
- org.b3log.latke.Latkes

```
public final class Latkes
extends Object
```
Latke framework configuration utility facade.

Version:

2.11.0.10, Nov 5, 2019

Author:

Liang Ding

See Also:

init(), shutdown(), getServePath(), getStaticServePath()

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Latkes.RuntimeCache` Latke runtime cache specified in the configuration file local.properties.
`static class`	`Latkes.RuntimeDatabase` Latke runtime JDBC database specified in the configuration file local.properties.
`static class`	`Latkes.RuntimeMode` Latke runtime mode.

Field Summary

Fields
Modifier and Type	Field and Description
`static ExecutorService`	`EXECUTOR_SERVICE` Executor service.
`static long`	`startupTimeMillis` Application startup time millisecond.
`static String`	`VERSION` Version.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static long`	`currentPID()` Gets the current process's id.
`static String`	`getContextPath()` Gets context path.
`static File`	`getFile(String path)` Gets a file with the specified path.
`static String`	`getLatkeProperty(String key)` Gets a property specified by the given key from file "latke.properties".
`static Locale`	`getLocale()` Gets the locale.
`static String`	`getLocalProperty(String key)` Gets a property specified by the given key from file "local.properties".
`static String`	`getOperatingSystemName()` Gets operating system name.
`static String`	`getPublicIP()` Gets public IP.
`static Latkes.RuntimeCache`	`getRuntimeCache()` Gets the runtime cache.
`static Latkes.RuntimeDatabase`	`getRuntimeDatabase()` Gets the runtime database.
`static Latkes.RuntimeMode`	`getRuntimeMode()` Gets the runtime mode.
`static String`	`getScanPath()` Gets IoC scan path.
`static String`	`getServePath()` Gets serve path.
`static String`	`getServer()` Gets server.
`static String`	`getServerHost()` Gets server host.
`static String`	`getServerPort()` Gets server port.
`static String`	`getServerScheme()` Gets server scheme.
`static String`	`getSkinName(String skinDirName)` Gets the skin name for the specified skin directory name.
`static String`	`getStaticPath()` Gets static path.
`static String`	`getStaticResourceVersion()` Gets static resource (JS, CSS files) version.
`static String`	`getStaticServePath()` Gets static serve path.
`static String`	`getStaticServer()` Gets static server.
`static String`	`getStaticServerHost()` Gets static server host.
`static String`	`getStaticServerPort()` Gets static server port.
`static String`	`getStaticServerScheme()` Gets static server scheme.
`static void`	`init()` Initializes Latke framework.
`static void`	`initPublicIP()` Init public IP.
`static boolean`	`isDocker()` Checks if process is running via docker.
`static boolean`	`isEnabledSession()` Is enabled HTTP session.
`static List<String>`	`listFiles(String path)` Lists file names under the specified path
`static void`	`setContextPath(String contextPath)` Sets context path with the specified context path.
`static void`	`setEnabledSession(boolean enabled)` Whether enables HTTP session.
`static void`	`setLakteProps(Properties props)` Sets latke.props with the specified props.
`static void`	`setLatkeProperty(String key, String value)` Sets latke.props with the specified key and value.
`static void`	`setLocale(Locale locale)` Sets the locale with the specified locale.
`static void`	`setLocalProperty(String key, String value)` Sets local.props with the specified key and value.
`static void`	`setLocalProps(Properties props)` Sets local.props with the specified props.
`static void`	`setRuntimeMode(Latkes.RuntimeMode runtimeMode)` Sets the runtime mode with the specified mode.
`static void`	`setScanPath(String scanPath)` Sets IoC scan path with the specified scan path.
`static void`	`setStaticPath(String staticPath)` Sets static path with the specified static path.
`static void`	`setStaticResourceVersion(String staticResourceVersion)` Sets static resource version with the specified static resource version.
`static void`	`shutdown()` Shutdowns Latke.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EXECUTOR_SERVICE
```
public static final ExecutorService EXECUTOR_SERVICE
```
    Executor service.
  - VERSION
```
public static final String VERSION
```
    Version.
    
    See Also:
    
    Constant Field Values
  - startupTimeMillis
```
public static long startupTimeMillis
```
    Application startup time millisecond.
- Method Detail
  - setEnabledSession
```
public static void setEnabledSession(boolean enabled)
```
    Whether enables HTTP session. Default is enabled.
    
    Parameters:
    
    enabled - true if enable it
  - isEnabledSession
```
public static boolean isEnabledSession()
```
    Is enabled HTTP session.
    
    Returns:
    
    if enabled it, returns false otherwise
  - isDocker
```
public static boolean isDocker()
```
    Checks if process is running via docker.
    
    Returns:
    
    true it is, returns false otherwise
  - currentPID
```
public static long currentPID()
```
    Gets the current process's id.
    
    Returns:
    
    the current process's id
  - getOperatingSystemName
```
public static String getOperatingSystemName()
```
    Gets operating system name.
    
    Returns:
    
    os name
  - setLocalProps
```
public static void setLocalProps(Properties props)
```
    Sets local.props with the specified props. This method is useful when you want to override behaviours of the default properties.
    
    Parameters:
    
    props - the specified props
  - setLocalProperty
```
public static void setLocalProperty(String key,
                                    String value)
```
    Sets local.props with the specified key and value.
    
    Parameters:
    
    key - the specified key
    
    value - the specified value
  - setLakteProps
```
public static void setLakteProps(Properties props)
```
    Sets latke.props with the specified props. This method is useful when you want to override behaviours of the default properties.
    
    Parameters:
    
    props - the specified props
  - setLatkeProperty
```
public static void setLatkeProperty(String key,
                                    String value)
```
    Sets latke.props with the specified key and value.
    
    Parameters:
    
    key - the specified key
    
    value - the specified value
  - getStaticResourceVersion
```
public static String getStaticResourceVersion()
```
    Gets static resource (JS, CSS files) version.
    Returns the value of "staticResourceVersion" property in local.properties. Returns the application startup millisecond if not found the "staticResourceVersion" property in local.properties.
    
    Returns:
    
    static resource version
  - setStaticResourceVersion
```
public static void setStaticResourceVersion(String staticResourceVersion)
```
    Sets static resource version with the specified static resource version.
    
    Parameters:
    
    staticResourceVersion - the specified static resource version
  - getServerScheme
```
public static String getServerScheme()
```
    Gets server scheme.
    
    Returns:
    
    server scheme
  - getServerHost
```
public static String getServerHost()
```
    Gets server host.
    
    Returns:
    
    server host
  - getPublicIP
```
public static String getPublicIP()
```
    Gets public IP.
    
    Returns:
    
    public IP
  - initPublicIP
```
public static void initPublicIP()
```
    Init public IP.
  - getServerPort
```
public static String getServerPort()
```
    Gets server port.
    
    Returns:
    
    server port
  - getServer
```
public static String getServer()
```
    Gets server.
    
    Returns:
    
    server, ${serverScheme}://${serverHost}:${serverPort}
  - getServePath
```
public static String getServePath()
```
    Gets serve path.
    
    Returns:
    
    serve path, ${server}${contextPath}
  - getStaticServerScheme
```
public static String getStaticServerScheme()
```
    Gets static server scheme.
    
    Returns:
    
    static server scheme
  - getStaticServerHost
```
public static String getStaticServerHost()
```
    Gets static server host.
    
    Returns:
    
    static server host
  - getStaticServerPort
```
public static String getStaticServerPort()
```
    Gets static server port.
    
    Returns:
    
    static server port
  - getStaticServer
```
public static String getStaticServer()
```
    Gets static server.
    
    Returns:
    
    static server, ${staticServerScheme}://${staticServerHost}:${staticServerPort}
  - getStaticServePath
```
public static String getStaticServePath()
```
    Gets static serve path.
    
    Returns:
    
    static serve path, ${staticServer}${staticPath}
  - getContextPath
```
public static String getContextPath()
```
    Gets context path.
    
    Returns:
    
    context path
  - setContextPath
```
public static void setContextPath(String contextPath)
```
    Sets context path with the specified context path.
    
    Parameters:
    
    contextPath - the specified context path
  - getStaticPath
```
public static String getStaticPath()
```
    Gets static path.
    
    Returns:
    
    static path
  - setStaticPath
```
public static void setStaticPath(String staticPath)
```
    Sets static path with the specified static path.
    
    Parameters:
    
    staticPath - the specified static path
  - getScanPath
```
public static String getScanPath()
```
    Gets IoC scan path.
    
    Returns:
    
    scan path
  - setScanPath
```
public static void setScanPath(String scanPath)
```
    Sets IoC scan path with the specified scan path.
    
    Parameters:
    
    scanPath - the specified scan path
  - init
```
public static void init()
```
    Initializes Latke framework.
  - getRuntimeMode
```
public static Latkes.RuntimeMode getRuntimeMode()
```
    Gets the runtime mode.
    
    Returns:
    
    runtime mode
  - setRuntimeMode
```
public static void setRuntimeMode(Latkes.RuntimeMode runtimeMode)
```
    Sets the runtime mode with the specified mode.
    
    Parameters:
    
    runtimeMode - the specified mode
  - getRuntimeCache
```
public static Latkes.RuntimeCache getRuntimeCache()
```
    Gets the runtime cache.
    
    Returns:
    
    runtime cache
  - getRuntimeDatabase
```
public static Latkes.RuntimeDatabase getRuntimeDatabase()
```
    Gets the runtime database.
    
    Returns:
    
    runtime database
  - getLocale
```
public static Locale getLocale()
```
    Gets the locale.
    
    Returns:
    
    the locale
  - setLocale
```
public static void setLocale(Locale locale)
```
    Sets the locale with the specified locale.
    
    Parameters:
    
    locale - the specified locale
  - getLocalProperty
```
public static String getLocalProperty(String key)
```
    Gets a property specified by the given key from file "local.properties".
    
    Parameters:
    
    key - the given key
    
    Returns:
    
    the value, returns null if not found
  - getLatkeProperty
```
public static String getLatkeProperty(String key)
```
    Gets a property specified by the given key from file "latke.properties".
    
    Parameters:
    
    key - the given key
    
    Returns:
    
    the value, returns null if not found
  - shutdown
```
public static void shutdown()
```
    Shutdowns Latke.
  - getSkinName
```
public static String getSkinName(String skinDirName)
```
    Gets the skin name for the specified skin directory name. The skin name was configured in skin.properties file(name as the key) under skin directory specified by the given skin directory name.
    
    Parameters:
    
    skinDirName - the given skin directory name
    
    Returns:
    
    skin name, returns null if not found or error occurs
  - getFile
```
public static File getFile(String path)
```
    Gets a file with the specified path.
    
    Parameters:
    
    path - the specified path
    
    Returns:
    
    file
  - listFiles
```
public static List<String> listFiles(String path)
```
    Lists file names under the specified path
    
    Parameters:
    
    path - the specified path
    
    Returns:
    
    file names

Class Latkes

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EXECUTOR_SERVICE

VERSION

startupTimeMillis

Method Detail

setEnabledSession

isEnabledSession

isDocker

currentPID

getOperatingSystemName

setLocalProps

setLocalProperty

setLakteProps

setLatkeProperty

getStaticResourceVersion

setStaticResourceVersion

getServerScheme

getServerHost

getPublicIP

initPublicIP

getServerPort

getServer

getServePath

getStaticServerScheme

getStaticServerHost

getStaticServerPort

getStaticServer

getStaticServePath

getContextPath

setContextPath

getStaticPath

setStaticPath

getScanPath

setScanPath

init

getRuntimeMode

setRuntimeMode

getRuntimeCache

getRuntimeDatabase

getLocale

setLocale

getLocalProperty

getLatkeProperty

shutdown

getSkinName

getFile

listFiles