App (ACT Framework 1.9.1a API)

java.lang.Object
- act.util.LogSupport
- - act.util.LogSupportedDestroyableBase
  - - act.app.App

All Implemented Interfaces:

Destroyable
```
public class App
extends LogSupportedDestroyableBase
```
App represents an application that is deployed in a Act container

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class App.F

static interface App.HotReloadListener
- Nested classes/interfaces inherited from interface act.Destroyable
  Destroyable.Util

Nested Classes
Modifier and Type	Class and Description
`static class`	`App.F`
`static interface`	`App.HotReloadListener`

Field Summary
- Fields inherited from class act.util.LogSupport
  DASHED_LINE, DOUBLE_DASHED_LINE, HASH_SYMBOL_LINE, logger, STAR_LINE, TILD_LINE

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`App(File appBase, osgl.version.Version version, ProjectLayout layout)`
`protected`	`App(String name, osgl.version.Version version, File appBase, ProjectLayout layout)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Router`	`adminRouter()`
`List<File>`	`allLibDirs(boolean requireTestProfile)`
`List<File>`	`allResourceDirs(boolean requireTestProfile)`
`List<File>`	`allSourceDirs()`
`void`	`asyncRefresh()` In dev mode it could request app to refresh.
`File`	`base()` The base dir where an application sit within
`List<File>`	`baseDirs()`
`BinderManager`	`binderManager()`
`RequestHandler`	`blockIssueHandler()`
`act.app.AppBuilder`	`builder()`
`org.osgl.cache.CacheService`	`cache()`
`org.osgl.cache.CacheService`	`cache(String name)`
`CaptchaManager`	`captchaManager()`
`boolean`	`checkUpdates(boolean async)` Check if app needs updates.
`boolean`	`checkUpdatesNonBlock(boolean async)`
`<T> Class<T>`	`classForName(String className)` Load/get a class by name using the app’s `classLoader()`
`AppClassLoader`	`classLoader()`
`<T extends ClassMetaInfoBase<T>> ClassMetaInfoManager<T>`	`classMetaInfoManager(Class<T> metaInfoType)`
`CliDispatcher`	`cliDispatcher()`
`Router`	`cliOverHttpRouter()`
`CliServer`	`cliServer()`
`AppConfig<?>`	`config()`
`<K,V> ConcurrentMap<K,V>`	`createConcurrentMap()`
`<K,V> Map<K,V>`	`createMap()`
`<E> Set<E>`	`createSet()`
`AppCrypto`	`crypto()`
`String`	`cuid()` Return an ID in string that is unique across the cluster
`SysEventId`	`currentState()`
`DbServiceManager`	`dbServiceManager()`
`String`	`decrypt(String message)`
`void`	`detectChanges()`
`void`	`emit(SysEventId sysEvent)`
`String`	`encrypt(String message)`
`MasterEntityMetaInfoRepo`	`entityMetaInfoRepo()`
`boolean`	`equals(Object obj)`
`EventBus`	`eventBus()`
`boolean`	`eventEmitted(SysEventId sysEvent)`
`File`	`file(String path)`
`<T> T`	`getInstance(Class<T> clz)` Get/Create new instance of a class
`<T> T`	`getInstance(String className)` Get/Create new instance of a class specified by the className
`URL`	`getResource(String name)` Finds the resource with the given name.
`InputStream`	`getResourceAsStream(String name)` Returns an input stream for reading the specified resource.
`Router`	`getRouterFor(String className, String methodName)`
`void`	`handleBlockIssue(Throwable e)`
`boolean`	`hasBlockIssue()` Check if the app has block issue set
`int`	`hashCode()`
`boolean`	`hasMoreRouters()`
`File`	`home()` The home dir of an application, referenced only at runtime.
`HttpClientService`	`httpClientService()`
`<DI extends DependencyInjector> DI`	`injector()`
`<DI extends DependencyInjector> App`	`injector(DI dependencyInjector)` Deprecated.
`static App`	`instance()`
`AppInterceptorManager`	`interceptorManager()`
`boolean`	`isDev()`
`boolean`	`isLoading()`
`boolean`	`isMainThread()`
`boolean`	`isProd()`
`boolean`	`isRoutedActionMethod(String className, String methodName)`
`boolean`	`isSingleton(Class<?> cls)` Report if a class is registered into singleton registry
`boolean`	`isSingleton(Object o)`
`boolean`	`isStarted()`
`Set<String>`	`jarFileBlackList()`
`Set<String>`	`jarFileBlackList2()`
`JobManager`	`jobManager()`
`ProjectLayout`	`layout()`
`List<File>`	`libDirs()`
`MailerConfigManager`	`mailerConfigManager()`
`MetricMetaInfoRepo`	`metricMetaInfoRepo()`
`Act.Mode`	`mode()`
`String`	`name()` Returns the name of the app
`PrincipalProvider`	`principalProvider()`
`String`	`profile()`
`void`	`refresh()`
`void`	`refresh(boolean async)`
`void`	`register(ClassMetaInfoManager<?> classMetaInfoManager)`
`void`	`registerDaemon(Daemon daemon)`
`List<Daemon>`	`registeredDaemons()`
`void`	`registerHotReloadListener(App.HotReloadListener listener)`
`void`	`registerPrincipalProvider(PrincipalProvider principalProvider)`
`<T> void`	`registerSingleton(Class<? extends T> cls, T instance)`
`void`	`registerSingleton(Object instance)`
`void`	`registerSingletonClass(Class<?> aClass)`
`protected void`	`releaseResources()`
`StringValueResolverManager`	`resolverManager()`
`File`	`resource(String path)`
`List<File>`	`resourceDirs()`
`void`	`restart()`
`Router`	`router()`
`Router`	`router(NamedPort port)`
`Router`	`router(String name)`
`SampleDataProviderManager`	`sampleDataProviderManager()`
`Set<String>`	`scanList()`
`AppCodeScannerManager`	`scannerManager()`
`Set<Pattern>`	`scanPattern()`
`Set<String>`	`scanPrefixList()`
`Set<String>`	`scanSuffixList()`
`<T extends AppService<T>> T`	`service(Class<T> serviceClass)`
`SessionManager`	`sessionManager()`
`String`	`shortId()` Returns short id which is derived from passed in app name.
`void`	`shutdown()`
`void`	`shutdown(int exitCode)`
`void`	`shutdownEventBus()`
`String`	`sign(String message)`
`<T> T`	`singleton(Class<T> clz)`
`SingletonRegistry`	`singletonRegistry()`
`List<File>`	`sourceDirs()`
`Router`	`sysRouter()`
`static App`	`testInstance()`
`List<File>`	`testLibDirs()`
`File`	`testResource(String path)`
`List<File>`	`testResourceDirs()`
`List<File>`	`testSourceDirs()`
`File`	`tmpDir()`
`String`	`toString()`
`void`	`unregisterDaemon(Daemon daemon)`
`UploadFileStorageService`	`uploadFileStorageService()`
`osgl.version.Version`	`version()` Returns the app version
`boolean`	`wasStarted()` Check if the app has been started before.

Methods inherited from class act.util.LogSupportedDestroyableBase
addSubResource, destroy, isDestroyed, reload, scope

Methods inherited from class act.util.LogSupport
debug, debug, error, error, fatal, fatal, info, info, isDebugEnabled, isTraceEnabled, logger, printCenter, printCenterWithLead, printDashedLine, printDoubleDashedLine, printHashSimbolLine, println, printStarLine, printTildLine, trace, trace, warn, warn

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

Constructor Detail

App

protected App(File appBase,
              osgl.version.Version version,
              ProjectLayout layout)

App

protected App(String name,
              osgl.version.Version version,
              File appBase,
              ProjectLayout layout)

Method Detail

instance
```
public static App instance()
```

name
```
public String name()
```
Returns the name of the app

Returns:

the app name

version
```
public osgl.version.Version version()
```
Returns the app version

Returns:

the app version

shortId
```
public String shortId()
```
Returns short id which is derived from passed in app name.

Note App.shortId() is by no means to create a unique identifier of application.

Returns:

the short id of the app

profile
```
public String profile()
```

mode
```
public Act.Mode mode()
```

isDev
```
public boolean isDev()
```

isProd
```
public boolean isProd()
```

config
```
public AppConfig<?> config()
```

baseDirs
```
public List<File> baseDirs()
```

sourceDirs
```
public List<File> sourceDirs()
```

resourceDirs
```
public List<File> resourceDirs()
```

libDirs
```
public List<File> libDirs()
```

testSourceDirs
```
public List<File> testSourceDirs()
```

testResourceDirs
```
public List<File> testResourceDirs()
```

testLibDirs
```
public List<File> testLibDirs()
```

allSourceDirs
```
public List<File> allSourceDirs()
```

allResourceDirs

public List<File> allResourceDirs(boolean requireTestProfile)

allLibDirs

public List<File> allLibDirs(boolean requireTestProfile)

cliDispatcher
```
public CliDispatcher cliDispatcher()
```

cliServer
```
public CliServer cliServer()
```

captchaManager

public CaptchaManager captchaManager()

router
```
public Router router()
```

sysRouter
```
public Router sysRouter()
```

cliOverHttpRouter
```
public Router cliOverHttpRouter()
```

adminRouter
```
public Router adminRouter()
```

router
```
public Router router(String name)
```

router
```
public Router router(NamedPort port)
```

crypto
```
public AppCrypto crypto()
```

base
```
public File base()
```
The base dir where an application sit within

home
```
public File home()
```
The home dir of an application, referenced only at runtime.
Note when app is running in dev mode, appHome shall be appBase/target, while app is deployed to Act at other mode, appHome shall be the same as appBase

classLoader
```
public AppClassLoader classLoader()
```

layout
```
public ProjectLayout layout()
```

registerHotReloadListener

public void registerHotReloadListener(App.HotReloadListener listener)

checkUpdates
```
public boolean checkUpdates(boolean async)
```
Check if app needs updates.

Parameters:

async - refresh app async or sync

Returns:

true if there are updates and app require hot reload

checkUpdatesNonBlock

public boolean checkUpdatesNonBlock(boolean async)

detectChanges
```
public void detectChanges()
```

restart
```
public void restart()
```

handleBlockIssue

public void handleBlockIssue(Throwable e)

asyncRefresh
```
public void asyncRefresh()
```
In dev mode it could request app to refresh. However if the request is issued in a thread that will be interrupted e.g. the cli thread, it should call refresh in an new thread

isStarted
```
public boolean isStarted()
```

wasStarted
```
public boolean wasStarted()
```
Check if the app has been started before. This could be useful to fix some state issue that caused by hotreload in dev mode

isLoading
```
public boolean isLoading()
```

isMainThread
```
public boolean isMainThread()
```

shutdown
```
public void shutdown()
```

shutdown
```
public void shutdown(int exitCode)
```

releaseResources
```
protected void releaseResources()
```
Overrides:

releaseResources in class LogSupportedDestroyableBase

refresh
```
public void refresh(boolean async)
```

blockIssueHandler

public RequestHandler blockIssueHandler()

refresh
```
public void refresh()
```

hasBlockIssue
```
public boolean hasBlockIssue()
```
Check if the app has block issue set

Returns:

true if the app has block issue encountered during start up

builder
```
public act.app.AppBuilder builder()
```

classMetaInfoManager

public <T extends ClassMetaInfoBase<T>> ClassMetaInfoManager<T> classMetaInfoManager(Class<T> metaInfoType)

register

public void register(ClassMetaInfoManager<?> classMetaInfoManager)

isSingleton
```
public boolean isSingleton(Class<?> cls)
```
Report if a class is registered into singleton registry

Parameters:

cls - the class

Returns:

true if the class is registered into singleton registry

isSingleton
```
public boolean isSingleton(Object o)
```

tmpDir
```
public File tmpDir()
```

file
```
public File file(String path)
```

resource
```
public File resource(String path)
```

testResource

public File testResource(String path)

sampleDataProviderManager

public SampleDataProviderManager sampleDataProviderManager()

registerDaemon

public void registerDaemon(Daemon daemon)

unregisterDaemon

public void unregisterDaemon(Daemon daemon)

registeredDaemons

public List<Daemon> registeredDaemons()

registerSingleton

public <T> void registerSingleton(Class<? extends T> cls,
                                  T instance)

registerSingletonClass

public void registerSingletonClass(Class<?> aClass)

registerSingleton

public void registerSingleton(Object instance)

interceptorManager

public AppInterceptorManager interceptorManager()

sessionManager

public SessionManager sessionManager()

scannerManager

public AppCodeScannerManager scannerManager()

dbServiceManager

public DbServiceManager dbServiceManager()

resolverManager

public StringValueResolverManager resolverManager()

binderManager
```
public BinderManager binderManager()
```

cache

public org.osgl.cache.CacheService cache()

cache

public org.osgl.cache.CacheService cache(String name)

mailerConfigManager

public MailerConfigManager mailerConfigManager()

eventBus
```
public EventBus eventBus()
```

httpClientService

public HttpClientService httpClientService()

entityMetaInfoRepo

public MasterEntityMetaInfoRepo entityMetaInfoRepo()

jobManager
```
public JobManager jobManager()
```

metricMetaInfoRepo

public MetricMetaInfoRepo metricMetaInfoRepo()

injector

@Deprecated
public <DI extends DependencyInjector> App injector(DI dependencyInjector)

Deprecated.

injector

public <DI extends DependencyInjector> DI injector()

singletonRegistry

public SingletonRegistry singletonRegistry()

uploadFileStorageService

public UploadFileStorageService uploadFileStorageService()

principalProvider

public PrincipalProvider principalProvider()

registerPrincipalProvider

public void registerPrincipalProvider(PrincipalProvider principalProvider)

sign
```
public String sign(String message)
```

encrypt

public String encrypt(String message)

decrypt

public String decrypt(String message)

singleton

public <T> T singleton(Class<T> clz)

getInstance
```
public <T> T getInstance(String className)
```
Get/Create new instance of a class specified by the className

This method will call the build in DependencyInjector to load the instance. And this is dependency inject process, not a simple constructor call

Note the class will be loaded by the app’s classLoader()

Type Parameters:

T - the generic type of the class

Parameters:

className - the className of the instance to be returned

Returns:

the instance of the class

getInstance
```
public <T> T getInstance(Class<T> clz)
```
Get/Create new instance of a class

This method will call the build in DependencyInjector to load the instance. And this is dependency inject process, not a simple constructor call

Type Parameters:

T - the generic type of the class

Parameters:

clz - the class

Returns:

the instance of the class

getResource
```
public URL getResource(String name)
```
Finds the resource with the given name.

This call delegate to ClassLoader.getResource(String) on App classloader.

Parameters:

name - the resource name

Returns:

URL to the resource if found or null if not found.

getResourceAsStream
```
public InputStream getResourceAsStream(String name)
```
Returns an input stream for reading the specified resource.

This will call ClassLoader.getResourceAsStream(String) on classLoader().

Parameters:

name - the resource name

Returns:

the input stream to the resource or null if resource not found

createMap
```
public <K,V> Map<K,V> createMap()
```

createConcurrentMap

public <K,V> ConcurrentMap<K,V> createConcurrentMap()

createSet
```
public <E> Set<E> createSet()
```

classForName
```
public <T> Class<T> classForName(String className)
```
Load/get a class by name using the app’s classLoader()

Parameters:

className - the name of the class to be loaded

Returns:

the class as described above

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

cuid
```
public String cuid()
```
Return an ID in string that is unique across the cluster

Returns:

a cluster unique id

service

public <T extends AppService<T>> T service(Class<T> serviceClass)

emit

public void emit(SysEventId sysEvent)

jarFileBlackList
```
public Set<String> jarFileBlackList()
```

jarFileBlackList2

public Set<String> jarFileBlackList2()

scanList
```
public Set<String> scanList()
```

scanPrefixList
```
public Set<String> scanPrefixList()
```

scanSuffixList
```
public Set<String> scanSuffixList()
```

scanPattern
```
public Set<Pattern> scanPattern()
```

eventEmitted

public boolean eventEmitted(SysEventId sysEvent)

currentState
```
public SysEventId currentState()
```

isRoutedActionMethod

public boolean isRoutedActionMethod(String className,
                                    String methodName)

hasMoreRouters
```
public boolean hasMoreRouters()
```

getRouterFor

public Router getRouterFor(String className,
                           String methodName)

shutdownEventBus
```
public void shutdownEventBus()
```

testInstance
```
public static App testInstance()
```

Class App

Nested Class Summary

Nested classes/interfaces inherited from interface act.Destroyable

Field Summary

Fields inherited from class act.util.LogSupport

Constructor Summary

Method Summary

Methods inherited from class act.util.LogSupportedDestroyableBase

Methods inherited from class act.util.LogSupport

Methods inherited from class java.lang.Object

Constructor Detail

App

App

Method Detail

instance

name

version

shortId

profile

mode

isDev

isProd

config

baseDirs

sourceDirs

resourceDirs

libDirs

testSourceDirs

testResourceDirs

testLibDirs

allSourceDirs

allResourceDirs

allLibDirs

cliDispatcher

cliServer

captchaManager

router

sysRouter

cliOverHttpRouter

adminRouter

router

router

crypto

base

home

classLoader

layout

registerHotReloadListener

checkUpdates

checkUpdatesNonBlock

detectChanges

restart

handleBlockIssue

asyncRefresh

isStarted

wasStarted

isLoading

isMainThread

shutdown

shutdown

releaseResources

refresh

blockIssueHandler

refresh

hasBlockIssue

builder

classMetaInfoManager

register

isSingleton

isSingleton

tmpDir

file

resource

testResource

sampleDataProviderManager

registerDaemon

unregisterDaemon

registeredDaemons

registerSingleton

registerSingletonClass