act

Class Act

java.lang.Object

act.Act

@Versioned
public final class Act
extends Object

The Act runtime and facade

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Act.F
static class	Act.Mode

Field Summary

Fields

Modifier and Type	Field and Description
static org.osgl.logging.Logger	LOGGER
static String	PROP_APP_JAR_FILE Used to set/get system property to communicate the app jar file if app is loaded from jar
static osgl.version.Version	VERSION

Constructor Summary

Constructors

Constructor and Description
Act()

Method Summary

Modifier and Type	Method and Description
static App	app() Return the App instance
static Class<?>	appClassForName(String className) Call App.classForName(String) method on the current app instance
static AppConfig	appConfig() Return the App’s config
static AppManager	applicationManager()
static AppServicePluginManager	appServicePluginManager()
static osgl.version.Version	appVersion() Returns the app version
static org.osgl.cache.CacheService	cache() Returns the application’s cache service
static ClassInfoRepository	classInfoRepository()
static ActConfig	conf()
static AppCrypto	crypto() Returns the current application's crypto service
static String	cuid() Generate custer unique ID via App.cuid()
static DbManager	dbManager()
static void	delete(String url, RequestHandlerBase handler)
static void	delete(String url, SimpleRequestHandler handler)
static void	emit(SysEventId sysEvent) Trigger an App event
static BytecodeEnhancerManager	enhancerManager()
static EventBus	eventBus() Returns the app’s eventBus
static void	get(String url, RequestHandlerBase handler)
static void	get(String url, SimpleRequestHandler handler)
static <T> T	getInstance(Class<? extends T> clz) Return an instance with give class
static <T> T	getInstance(String className) Return an instance with give class name
static void	getNonblock(String url, SimpleRequestHandler handler)
static URL	getResource(String name) Find a resource by given name.
static InputStream	getResourceAsStream(String name) Returns an input stream for reading the specified resource.
static void	hook(App app)
static int	httpPort()
protected static void	initApplicationManager()
static <DI extends DependencyInjector> DI	injector() Returns the app’s DependencyInjector
static boolean	isDev()
static boolean	isProd()
static JobManager	jobManager() Returns the app’s JobManager
static MetricPlugin	metricPlugin()
static Act.Mode	mode()
static Network	network()
static String	nodeGroup()
static List<Class<?>>	pluginClasses()
static GenericPluginManager	pluginManager()
static void	post(String url, RequestHandlerBase handler)
static void	post(String url, SimpleRequestHandler handler)
static String	profile() Return the current profile name
static void	put(String url, RequestHandlerBase handler)
static void	put(String url, SimpleRequestHandler handler)
static <T extends Plugin> T	registeredPlugin(Class<T> type)
static <T extends ActEvent> void	registerEventListener(Class<T> eventClass, ActEventListener<T> listener)
static void	registerPlugin(Plugin plugin)
static void	registerTypeConverters()
static RequestRefreshClassLoader	requestRefreshClassLoader()
static RequestServerRestart	requestRestart()
static AppCodeScannerPluginManager	scannerPluginManager()
static void	shutdown(App app)
static <T> T	singleton(Class<T> singletonClass) Deprecated.
static void	start() Start Act application
static void	start(Class<?> anyAppClass) Start Act application with scan package specified by a class
static void	start(String appName) Start Act application with specified app name
static void	start(String appName, Class<?> anyAppClass) Start Act application with specified name and scan package specified by a class
static void	start(String appName, Class<?> anyAppClass, osgl.version.Version appVersion) Start Act application with specified app name, app version and scan page via an app class
static void	start(String appName, String scanPackage) Start Act application with specified app name and scan package.
static void	start(String appName, String scanPackage, osgl.version.Version appVersion) Start Act application with specified app name, app version and scan package
static void	startup(AppDescriptor descriptor)
static void	trigger(ActEvent<?> event)
static void	trigger(SysEventId sysEventId) Alias of emit(SysEventId)
static ViewManager	viewManager()

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final osgl.version.Version VERSION

LOGGER

public static final org.osgl.logging.Logger LOGGER

PROP_APP_JAR_FILE

public static final String PROP_APP_JAR_FILE

Used to set/get system property to communicate the app jar file if app is loaded from jar

See Also:

Constant Field Values

Constructor Detail

Act

public Act()

Method Detail

mode

public static Act.Mode mode()

isProd

public static boolean isProd()

isDev

public static boolean isDev()

profile

public static String profile()

Return the current profile name

nodeGroup

public static String nodeGroup()

conf

public static ActConfig conf()

classInfoRepository

public static ClassInfoRepository classInfoRepository()

pluginClasses

public static List<Class<?>> pluginClasses()

appServicePluginManager

public static AppServicePluginManager appServicePluginManager()

dbManager

public static DbManager dbManager()

enhancerManager

public static BytecodeEnhancerManager enhancerManager()

pluginManager

public static GenericPluginManager pluginManager()

metricPlugin

public static MetricPlugin metricPlugin()

scannerPluginManager

public static AppCodeScannerPluginManager scannerPluginManager()

applicationManager

public static AppManager applicationManager()

viewManager

public static ViewManager viewManager()

network

public static Network network()

registerPlugin

public static void registerPlugin(Plugin plugin)

registeredPlugin

public static <T extends Plugin> T registeredPlugin(Class<T> type)

startup

public static void startup(AppDescriptor descriptor)

shutdown

public static void shutdown(App app)

requestRestart

public static RequestServerRestart requestRestart()

requestRefreshClassLoader

public static RequestRefreshClassLoader requestRefreshClassLoader()

hook

public static void hook(App app)

trigger

public static void trigger(ActEvent<?> event)

registerEventListener

public static <T extends ActEvent> void registerEventListener(Class<T> eventClass,
                                                              ActEventListener<T> listener)

cuid

public static String cuid()

Generate custer unique ID via App.cuid()

Returns:

a cluster unique ID generated

crypto

public static AppCrypto crypto()

Returns the current application's crypto service

Returns:

an AppCrypto instance

app

public static App app()

Return the App instance

Returns:

the App instance

appVersion

public static osgl.version.Version appVersion()

Returns the app version

Returns:

the app version

appConfig

public static AppConfig appConfig()

Return the App’s config

Returns:

the app config

singleton

@Deprecated
public static <T> T singleton(Class<T> singletonClass)

Deprecated.

Utility method to retrieve singleton instance via App.singleton(Class) method.

This method is deprecated. Please use getInstance(Class) instead

Type Parameters:

T -

Parameters:

singletonClass -

Returns:

the singleton instance

cache

public static org.osgl.cache.CacheService cache()

Returns the application’s cache service

Returns:

the cache service

emit

public static void emit(SysEventId sysEvent)

Trigger an App event

Parameters:

sysEvent - the app event

trigger

public static void trigger(SysEventId sysEventId)

Alias of emit(SysEventId)

Parameters:

sysEventId - the app event

eventBus

public static EventBus eventBus()

Returns the app’s eventBus

Returns:

the eventBus

jobManager

public static JobManager jobManager()

Returns the app’s JobManager

Returns:

the app’s jobManager

injector

public static <DI extends DependencyInjector> DI injector()

Returns the app’s DependencyInjector

Type Parameters:

DI - the generic type of injector

Returns:

the app’s injector

appClassForName

public static Class<?> appClassForName(String className)

Call App.classForName(String) method on the current app instance

Parameters:

className - the class name

Returns:

the class corresponding to the name specified

getInstance

public static <T> T getInstance(String className)

Return an instance with give class name

Type Parameters:

T - the generic type of the class

Parameters:

className - the class name

Returns:

the instance of the class

getInstance

public static <T> T getInstance(Class<? extends T> clz)

Return an instance with give class

Type Parameters:

T - the generic type of the class

Parameters:

clz - the class

Returns:

the instance of the class

getResource

public static URL getResource(String name)

Find a resource by given name.

This call delegate to App.getResource(String) on app().

Parameters:

name - the resource name

Returns:

the URL if found, or null if resource not found

getResourceAsStream

public static InputStream getResourceAsStream(String name)

Returns an input stream for reading the specified resource.

This will call App.getResourceAsStream(String) on app().

Parameters:

name - The resource name

Returns:

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

get

public static void get(String url,
                       SimpleRequestHandler handler)

getNonblock

public static void getNonblock(String url,
                               SimpleRequestHandler handler)

post

public static void post(String url,
                        SimpleRequestHandler handler)

put

public static void put(String url,
                       SimpleRequestHandler handler)

delete

public static void delete(String url,
                          SimpleRequestHandler handler)

get

public static void get(String url,
                       RequestHandlerBase handler)

post

public static void post(String url,
                        RequestHandlerBase handler)

put

public static void put(String url,
                       RequestHandlerBase handler)

delete

public static void delete(String url,
                          RequestHandlerBase handler)

start

public static void start()
                  throws Exception

Start Act application

Throws:

Exception - any exception raised during app start

start

public static void start(String appName)
                  throws Exception

Start Act application with specified app name

Parameters:

appName - the app name, optional

Throws:

Exception - any exception thrown out

start

public static void start(String appName,
                         String scanPackage)
                  throws Exception

Start Act application with specified app name and scan package.

If there are multiple packages, they should be joined in a single string by comma ,. And the first package name will be used to explore the .version file in the class path

Parameters:

appName - the app name, optional

scanPackage - the scan package

Throws:

Exception - any exception raised during act start up

start

public static void start(String appName,
                         Class<?> anyAppClass)
                  throws Exception

Start Act application with specified name and scan package specified by a class

Parameters:

appName - the app name

anyAppClass - specifies the scan package

Throws:

Exception - any exception raised during act start up

start

public static void start(Class<?> anyAppClass)
                  throws Exception

Start Act application with scan package specified by a class

Parameters:

anyAppClass - specifies the scan package

Throws:

Exception - any exception raised during act start up

start

public static void start(String appName,
                         Class<?> anyAppClass,
                         osgl.version.Version appVersion)
                  throws Exception

Start Act application with specified app name, app version and scan page via an app class

Parameters:

appName - the app name

anyAppClass - specifies the scan package

appVersion - the app version tag

Throws:

Exception - any exception raised during act start up

start

public static void start(String appName,
                         String scanPackage,
                         osgl.version.Version appVersion)
                  throws Exception

Start Act application with specified app name, app version and scan package

Parameters:

appName - the app name

scanPackage - the scan package, the package could be separated by Constants.LIST_SEPARATOR

appVersion - the app version tag

Throws:

Exception - any exception raised during act start up

registerTypeConverters

public static void registerTypeConverters()

initApplicationManager

protected static void initApplicationManager()

httpPort

public static int httpPort()