org.markysoft.vani.core

Class VaniContext

java.lang.Object

org.markysoft.vani.core.VaniContext

public class VaniContext
extends Object

This class is the central utility for the framework. It provides various methods to interact with spring framework and is responsible for initialising JavaScript interfaces.

Author:

Thomas

Constructor Summary

Constructors

Constructor and Description
VaniContext()

Method Summary

Modifier and Type	Method and Description
<T> T	createBean(Class<T> beanClass) method to instantiate specified class and resolve all annotated dependencies.
org.openqa.selenium.WebDriver	createDefaultDriver() method to generate and register FirefoxDriver.
org.springframework.context.ApplicationContext	getAppContext()
org.springframework.core.env.Environment	getEnvironment()
org.reflections.Reflections	getReflections()
<T> TypeHandler<T,?>	getTypeHandlerFor(Class<T> targetType) This method will look for a registered TypeHandler, which is able to handle provided type.
protected void	initJsTypeHandler() This method will look for all classes annotated with JsTypeHandler and instantiates and registers found classes to VaniContext.
boolean	isProfileEnabled(org.springframework.context.annotation.Profile profileAnnotation) method to check whether at least one profile of provided profile annotation is active.
protected void	registerJavaScripts() This method will scan classpath for all classes annotated with JavaScript.The corresponding source of each found interface will be loaded and the dependencies (specified by JavaScriptDependency and plugins will also be assigned.
void	registerTypeHandler(TypeHandler typeHandler) This method will register provided TypeHandler to VaniContext.
String	resolveExpression(String expr) method tries to resolve given SpEl-expression.
void	setAppContext(org.springframework.context.ApplicationContext appContext)
void	setConfigurableBeanFactory(org.springframework.beans.factory.config.ConfigurableListableBeanFactory configurableBeanFactory)
void	setEnvironment(org.springframework.core.env.Environment environment)
void	setJsLoader(JavaScriptLoader jsLoader)
void	setJsProxyFactory(JavaScriptProxyFactory jsProxyFactory)
void	setReflections(org.reflections.Reflections reflections)
void	shutdownWebDrivers()

Methods inherited from class java.lang.Object

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

Constructor Detail

VaniContext

public VaniContext()

Method Detail

getReflections

public org.reflections.Reflections getReflections()

setReflections

public void setReflections(org.reflections.Reflections reflections)

getEnvironment

public org.springframework.core.env.Environment getEnvironment()

setEnvironment

public void setEnvironment(org.springframework.core.env.Environment environment)

getAppContext

public org.springframework.context.ApplicationContext getAppContext()

setAppContext

public void setAppContext(org.springframework.context.ApplicationContext appContext)

setConfigurableBeanFactory

public void setConfigurableBeanFactory(org.springframework.beans.factory.config.ConfigurableListableBeanFactory configurableBeanFactory)

isProfileEnabled

public boolean isProfileEnabled(org.springframework.context.annotation.Profile profileAnnotation)

method to check whether at least one profile of provided profile annotation is active.

Parameters:

profileAnnotation -

Returns:

returns true if at least one profile is active, else false. If profileAnnotation is NULL false will be returned.

resolveExpression

public String resolveExpression(String expr)

method tries to resolve given SpEl-expression.

Parameters:

expr - expression with SpEl-expressions

Returns:

returns resolved value or the given one.

createDefaultDriver

public org.openqa.selenium.WebDriver createDefaultDriver()

method to generate and register FirefoxDriver.

Returns:

returns default web driver instance (FirefoxDriver)

registerJavaScripts

@PostConstruct
protected void registerJavaScripts()

This method will scan classpath for all classes annotated with JavaScript.The corresponding source of each found interface will be loaded and the dependencies (specified by JavaScriptDependency and plugins will also be assigned.

For each js-interface, a proxy will be created and registered as singelton spring bean. The registered bean name is equal to uncapitalized class name.

After that, all available TypeHandler annotated with JsTypeHandler are registered.

initJsTypeHandler

protected void initJsTypeHandler()

This method will look for all classes annotated with JsTypeHandler and instantiates and registers found classes to VaniContext.

The dependencies of the handler instance will also be resolved by spring during instantiation.

createBean

public <T> T createBean(Class<T> beanClass)

method to instantiate specified class and resolve all annotated dependencies. The created instance will NOT be registered.

Parameters:

beanClass -

Returns:

registerTypeHandler

public void registerTypeHandler(TypeHandler typeHandler)

This method will register provided TypeHandler to VaniContext.

If there is already a registered handler for the target type of given handler, it will be replaced with specified one.

Parameters:

typeHandler - TypeHandler for registration (if you provide NULL, value will be skipped)

getTypeHandlerFor

public <T> TypeHandler<T,?> getTypeHandlerFor(Class<T> targetType)

This method will look for a registered TypeHandler, which is able to handle provided type.

Parameters:

targetType - type, which should be handled

Returns:

returns registered TypeHandler for provided type or NULL if no appropriate handler is registered.

shutdownWebDrivers

@PreDestroy
public void shutdownWebDrivers()

setJsLoader

@Autowired
public void setJsLoader(JavaScriptLoader jsLoader)

setJsProxyFactory

@Autowired
public void setJsProxyFactory(JavaScriptProxyFactory jsProxyFactory)