org.apache.openejb.junit.context

Class OpenEjbTestContext

java.lang.Object

org.apache.openejb.junit.context.OpenEjbTestContext

All Implemented Interfaces:

TestContext

public class OpenEjbTestContext
extends Object
implements TestContext

To implement your own context, you need to create an implementation of TestContext which would configure the test when instructed. You can then use whatever method of configuration you choose.

Field Summary

Fields

Modifier and Type	Field and Description
protected Properties	contextConfig Properties object used to initialize InitialContext
protected static String	DEFAULT_CONFIG_FILE_RESOURCE
protected static String	LOGIN_CONFIG_RESOURCE
protected static String	REALM_PROPERTY_KEY

Constructor Summary

Constructors

Constructor and Description
OpenEjbTestContext(Class clazz) Constructs a context for a class
OpenEjbTestContext(Class clazz, String securityRole) Constructs a context for a class
OpenEjbTestContext(Method method) Constructs a context for a method
OpenEjbTestContext(Method method, String securityRole) Constructs a context for a method

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
protected void	configureSecurity(Properties env) Loads the security configuration into the given Properties object
void	configureTest(Object testObj) Configures a test instance for this context
protected void	finalize()
protected Properties	getContextConfig() Constructs the configuration needed to create the InitialContext.
protected InitialContext	getInitialContext() Returns this context's InitialContext, creating it if necessary.
protected Object	getInjectionValue(Field field) Analyzes the field and returns any values which should be injected on it
protected Object	getOtherTestResource(TestResource resourceConfig) Override to perform custom resource types injection.
protected Class<?>	getTestClass()
protected Method	getTestMethod()
protected boolean	loadConfig(Properties env, ContextConfig contextConfig) Interprets and loads InitialContext properties from the ContextConfig annotation
protected boolean	loadConfigFile(Properties env, ContextConfig contextConfig) Loads the configuration file specified in the ContextConfig annotation into the specified Properties instance
protected boolean	loadConfigProperties(Properties env, ContextConfig contextConfig) Loads the direct properties from the annotation configuration into the given Properties object

Methods inherited from class java.lang.Object

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

Field Detail

REALM_PROPERTY_KEY

protected static final String REALM_PROPERTY_KEY

See Also:

Constant Field Values

LOGIN_CONFIG_RESOURCE

protected static final String LOGIN_CONFIG_RESOURCE

See Also:

Constant Field Values

DEFAULT_CONFIG_FILE_RESOURCE

protected static final String DEFAULT_CONFIG_FILE_RESOURCE

See Also:

Constant Field Values

contextConfig

protected Properties contextConfig

Properties object used to initialize InitialContext

Constructor Detail

OpenEjbTestContext

public OpenEjbTestContext(Class clazz)

Constructs a context for a class

Parameters:

testClazz -

OpenEjbTestContext

public OpenEjbTestContext(Method method)

Constructs a context for a method

Parameters:

testClazz -

method -

OpenEjbTestContext

public OpenEjbTestContext(Class clazz,
                  String securityRole)

Constructs a context for a class

Parameters:

testClazz -

OpenEjbTestContext

public OpenEjbTestContext(Method method,
                  String securityRole)

Constructs a context for a method

Parameters:

testClazz -

method -

Method Detail

configureTest

public void configureTest(Object testObj)

Description copied from interface: TestContext

Configures a test instance for this context

Specified by:

configureTest in interface TestContext

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

close

public void close()

Specified by:

close in interface TestContext

getInitialContext

protected InitialContext getInitialContext()
                                    throws NamingException

Returns this context's InitialContext, creating it if necessary.

Returns:

InitialContext for this TestContext

Throws:

NamingException

getContextConfig

protected Properties getContextConfig()
                               throws IOException

Constructs the configuration needed to create the InitialContext. This will be determined from the class/method supplied to the constructor.

Returns:

Throws:

IOException

loadConfig

protected boolean loadConfig(Properties env,
                 ContextConfig contextConfig)
                      throws IOException

Interprets and loads InitialContext properties from the ContextConfig annotation

Parameters:

env -

contextConfig -

Returns:

true if any properties were loaded

Throws:

IOException

loadConfigProperties

protected boolean loadConfigProperties(Properties env,
                           ContextConfig contextConfig)

Loads the direct properties from the annotation configuration into the given Properties object

Parameters:

env -

contextConfig -

Returns:

true if any properties were loaded

loadConfigFile

protected boolean loadConfigFile(Properties env,
                     ContextConfig contextConfig)
                          throws IOException

Loads the configuration file specified in the ContextConfig annotation into the specified Properties instance

Parameters:

env -

contextConfig -

Returns:

true if any properties were loaded

Throws:

IOException

configureSecurity

protected void configureSecurity(Properties env)

Loads the security configuration into the given Properties object

Parameters:

env -

getInjectionValue

protected Object getInjectionValue(Field field)
                            throws Exception

Analyzes the field and returns any values which should be injected on it

Parameters:

field -

Returns:

reference to value to inject, or null if nothing should be injected

Throws:

Exception

getOtherTestResource

protected Object getOtherTestResource(TestResource resourceConfig)

Override to perform custom resource types injection. This method will be called when whatever value was specified in the TestResource annotation wasn't understood by the performInjections(java.lang.Object) method. This method will be called, supplying the annotation, and you can then interpret and create the value to be injected. By default this method just returns null.

You can use this to inject values into annotated fields which contain custom values in their names.

Parameters:

resourceConfig -

Returns:

instance to inject into annotated field.

getTestClass

protected Class<?> getTestClass()

Returns:

the test class

getTestMethod

protected Method getTestMethod()

Returns:

the test method for which this context was created