net.proteusframework.core.spring

Class ApplicationContextUtils

java.lang.Object

net.proteusframework.core.spring.ApplicationContextUtils

public class ApplicationContextUtils
extends Object

Utilities for getting an application context.

Author:

Pat B. Double (double@i2rd.com)

Method Summary

Modifier and Type	Method and Description
ApplicationContext	getContext() Get the application context.
ApplicationContext	getContext(String locationHint) Get the application context.
static ApplicationContextUtils	getInstance() Get an instance.
boolean	isContextAvailable() Check if the context has been loaded.
boolean	isStarting() Check if the context is starting.
void	setContext(ApplicationContext context) Set the application context.
void	setStarting(boolean value) Mark the context as starting.
void	stop() Stop the ApplicationContext.

Methods inherited from class java.lang.Object

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

Method Detail

getContext

@Nullable
public ApplicationContext getContext()

Get the application context. If no context has been set an XML context will be loaded from the location specified in the Java system property "spring.context.location". If this property is not set the default location of "/applicationContext.xml" will be used.

Returns:

ApplicationContext or null if starting.

getContext

@Nullable
public ApplicationContext getContext(String locationHint)

Get the application context. In general it is best not to use this method but use getContext(). The location can be set through a Java system property. This method should normally be used for unit tests.

Parameters:

locationHint - a hint to the location of the context. Usually a classpath, file, or Java class implementing Configuration.

Returns:

ApplicationContext or null if unable to create one.

getInstance

public static ApplicationContextUtils getInstance()

Get an instance.

Returns:

ApplicationContextUtils.

isContextAvailable

public boolean isContextAvailable()

Check if the context has been loaded.

Returns:

true if the context has been loaded.

isStarting

public boolean isStarting()

Check if the context is starting.

Returns:

true if starting; otherwise false.

setContext

public void setContext(ApplicationContext context)

Set the application context. This will be set automatically by I2RDApplicationEventMulticaster

Parameters:

context - the context.

setStarting

public void setStarting(boolean value)

Mark the context as starting. Internal Use.

Parameters:

value - the value.

stop

public void stop()

Stop the ApplicationContext.