org.frameworkset.spi.support

Class ApplicationObjectSupport

java.lang.Object

org.frameworkset.spi.support.ApplicationObjectSupport

Direct Known Subclasses:

AbstractEditorInf

public class ApplicationObjectSupport
extends java.lang.Object

Title: ApplicationObjectSupport.java

Description:

bboss workgroup

Copyright (c) 2007

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	logger Logger that is available to subclasses

Constructor Summary

Constructors

Constructor and Description
ApplicationObjectSupport()

Method Summary

Modifier and Type	Method and Description
BaseApplicationContext	getApplicationContext() Return the ApplicationContext that this object is associated with.
protected MessageSourceAccessor	getMessageSourceAccessor() Return a MessageSourceAccessor for the application context used by this object, for easy message access.
protected void	initApplicationContext() Subclasses can override this for custom initialization behavior.
protected void	initApplicationContext(BaseApplicationContext context) Subclasses can override this for custom initialization behavior.
protected boolean	isContextRequired() Determine whether this application object needs to run in an ApplicationContext.
protected java.lang.Class	requiredContextClass() Determine the context class that any context passed to setApplicationContext must be an instance of.
void	setApplicationContext(BaseApplicationContext context)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

Logger that is available to subclasses

Constructor Detail

ApplicationObjectSupport

public ApplicationObjectSupport()

Method Detail

setApplicationContext

public final void setApplicationContext(BaseApplicationContext context)
                                 throws com.frameworkset.spi.assemble.BeanInstanceException

Throws:

com.frameworkset.spi.assemble.BeanInstanceException

isContextRequired

protected boolean isContextRequired()

Determine whether this application object needs to run in an ApplicationContext.

Default is "false". Can be overridden to enforce running in a context (i.e. to throw IllegalStateException on accessors if outside a context).

See Also:

getApplicationContext(), getMessageSourceAccessor()

requiredContextClass

protected java.lang.Class requiredContextClass()

Determine the context class that any context passed to setApplicationContext must be an instance of. Can be overridden in subclasses.

See Also:

setApplicationContext(org.frameworkset.spi.BaseApplicationContext)

initApplicationContext

protected void initApplicationContext(BaseApplicationContext context)
                               throws java.lang.RuntimeException

Subclasses can override this for custom initialization behavior. Gets called by setApplicationContext after setting the context instance.

Note: Does not get called on reinitialization of the context but rather just on first initialization of this object's context reference.

The default implementation calls the overloaded initApplicationContext() method without ApplicationContext reference.

Parameters:

context - the containing ApplicationContext

Throws:

ApplicationContextException - in case of initialization errors

java.lang.Exception - if thrown by ApplicationContext methods

java.lang.RuntimeException

See Also:

setApplicationContext(org.frameworkset.spi.BaseApplicationContext)

initApplicationContext

protected void initApplicationContext()
                               throws java.lang.RuntimeException

Subclasses can override this for custom initialization behavior.

The default implementation is empty. Called by #initApplicationContext(org.frameworkset.spi.ApplicationContext).

Throws:

ApplicationContextException - in case of initialization errors

java.lang.Exception - if thrown by ApplicationContext methods

java.lang.RuntimeException

See Also:

setApplicationContext(org.frameworkset.spi.BaseApplicationContext)

getApplicationContext

public final BaseApplicationContext getApplicationContext()
                                                   throws java.lang.IllegalStateException

Return the ApplicationContext that this object is associated with.

Throws:

java.lang.IllegalStateException - if not running in an ApplicationContext

getMessageSourceAccessor

protected final MessageSourceAccessor getMessageSourceAccessor()
                                                        throws java.lang.IllegalStateException

Return a MessageSourceAccessor for the application context used by this object, for easy message access.

Throws:

java.lang.IllegalStateException - if not running in an ApplicationContext