OpenEjbTestContext

java.lang.Object
- org.apache.openejb.junit.context.OpenEjbTestContext

All Implemented Interfaces:

TestContext
```
public class OpenEjbTestContext
extends java.lang.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 java.util.Properties`	`contextConfig` Properties object used to initialize InitialContext
`protected static java.lang.String`	`DEFAULT_CONFIG_FILE_RESOURCE`
`protected static java.lang.String`	`LOGIN_CONFIG_RESOURCE`
`protected static java.lang.String`	`REALM_PROPERTY_KEY`

Constructor Summary

Constructors
Constructor and Description
`OpenEjbTestContext(java.lang.Class clazz)` Constructs a context for a class
`OpenEjbTestContext(java.lang.Class clazz, java.lang.String securityRole)` Constructs a context for a class
`OpenEjbTestContext(java.lang.reflect.Method method)` Constructs a context for a method
`OpenEjbTestContext(java.lang.reflect.Method method, java.lang.String securityRole)` Constructs a context for a method

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`protected void`	`configureSecurity(java.util.Properties env)` Loads the security configuration into the given Properties object
`void`	`configureTest(java.lang.Object testObj)` Configures a test instance for this context
`protected java.util.Properties`	`getContextConfig()` Constructs the configuration needed to create the InitialContext.
`protected javax.naming.InitialContext`	`getInitialContext()` Returns this context's InitialContext, creating it if necessary.
`protected java.lang.Object`	`getInjectionValue(java.lang.reflect.Field field)` Analyzes the field and returns any values which should be injected on it
`protected java.lang.Object`	`getOtherTestResource(TestResource resourceConfig)` Override to perform custom resource types injection.
`protected java.lang.Class<?>`	`getTestClass()`
`protected java.lang.reflect.Method`	`getTestMethod()`
`protected boolean`	`loadConfig(java.util.Properties env, ContextConfig contextConfig)` Interprets and loads InitialContext properties from the ContextConfig annotation
`protected boolean`	`loadConfigFile(java.util.Properties env, ContextConfig contextConfig)` Loads the configuration file specified in the `ContextConfig` annotation into the specified Properties instance
`protected boolean`	`loadConfigProperties(java.util.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, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - REALM_PROPERTY_KEY
```
protected static final java.lang.String REALM_PROPERTY_KEY
```
    See Also:
    
    Constant Field Values
  - LOGIN_CONFIG_RESOURCE
```
protected static final java.lang.String LOGIN_CONFIG_RESOURCE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CONFIG_FILE_RESOURCE
```
protected static final java.lang.String DEFAULT_CONFIG_FILE_RESOURCE
```
    See Also:
    
    Constant Field Values
  - contextConfig
```
protected java.util.Properties contextConfig
```
    Properties object used to initialize InitialContext
- Constructor Detail
  - OpenEjbTestContext
```
public OpenEjbTestContext(java.lang.Class clazz)
```
    Constructs a context for a class
    
    Parameters:
    
    clazz -
  - OpenEjbTestContext
```
public OpenEjbTestContext(java.lang.reflect.Method method)
```
    Constructs a context for a method
    
    Parameters:
    
    method -
  - OpenEjbTestContext
```
public OpenEjbTestContext(java.lang.Class clazz,
                          java.lang.String securityRole)
```
    Constructs a context for a class
    
    Parameters:
    
    clazz -
    
    securityRole -
  - OpenEjbTestContext
```
public OpenEjbTestContext(java.lang.reflect.Method method,
                          java.lang.String securityRole)
```
    Constructs a context for a method
    
    Parameters:
    
    method -
    
    securityRole -
- Method Detail
  - configureTest
```
public void configureTest(java.lang.Object testObj)
```
    Description copied from interface: TestContext
    
    Configures a test instance for this context
    
    Specified by:
    
    configureTest in interface TestContext
  - close
```
public void close()
```
    Specified by:
    
    close in interface TestContext
  - getInitialContext
```
protected javax.naming.InitialContext getInitialContext()
                                                 throws javax.naming.NamingException
```
    Returns this context's InitialContext, creating it if necessary.
    
    Returns:
    
    InitialContext for this TestContext
    
    Throws:
    
    javax.naming.NamingException
  - getContextConfig
```
protected java.util.Properties getContextConfig()
                                         throws java.io.IOException
```
    Constructs the configuration needed to create the InitialContext. This will be determined from the class/method supplied to the constructor.
    
    Returns:
    
    Throws:
    
    java.io.IOException
  - loadConfig
```
protected boolean loadConfig(java.util.Properties env,
                             ContextConfig contextConfig)
                      throws java.io.IOException
```
    Interprets and loads InitialContext properties from the ContextConfig annotation
    
    Parameters:
    
    env -
    
    contextConfig -
    
    Returns:
    
    true if any properties were loaded
    
    Throws:
    
    java.io.IOException
  - loadConfigProperties
```
protected boolean loadConfigProperties(java.util.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(java.util.Properties env,
                                 ContextConfig contextConfig)
                          throws java.io.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:
    
    java.io.IOException
  - configureSecurity
```
protected void configureSecurity(java.util.Properties env)
```
    Loads the security configuration into the given Properties object
    
    Parameters:
    
    env -
  - getInjectionValue
```
protected java.lang.Object getInjectionValue(java.lang.reflect.Field field)
                                      throws java.lang.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:
    
    java.lang.Exception
  - getOtherTestResource
```
protected java.lang.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 java.lang.Class<?> getTestClass()
```
    Returns:
    
    the test class
  - getTestMethod
```
protected java.lang.reflect.Method getTestMethod()
```
    Returns:
    
    the test method for which this context was created

Class OpenEjbTestContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

REALM_PROPERTY_KEY

LOGIN_CONFIG_RESOURCE

DEFAULT_CONFIG_FILE_RESOURCE

contextConfig

Constructor Detail

OpenEjbTestContext

OpenEjbTestContext

OpenEjbTestContext

OpenEjbTestContext

Method Detail

configureTest

close

getInitialContext

getContextConfig

loadConfig

loadConfigProperties

loadConfigFile

configureSecurity

getInjectionValue

getOtherTestResource

getTestClass

getTestMethod