org.apache.webbeans.web.failover

Class DefaultOwbFailOverService

java.lang.Object

org.apache.webbeans.web.failover.DefaultOwbFailOverService

All Implemented Interfaces:

FailOverService

public class DefaultOwbFailOverService
extends Object
implements FailOverService

Default implementation of the FailOverService.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_CONVERSATION_CONTEXT_MAP
static String	ATTRIBUTE_SESSION_CONTEXT
static String	CONFIG_IS_SUPPORT_FAILOVER
static String	CONFIG_IS_SUPPORT_PASSIVATE
static String	CONFIG_RESOURCES_SERIALIZATION_HANDLER

Fields inherited from interface org.apache.webbeans.spi.FailOverService

NOT_HANDLED

Constructor Summary

Constructors

Constructor and Description
DefaultOwbFailOverService()

Method Summary

Modifier and Type	Method and Description
protected void	addActivationListenerToSession(javax.servlet.http.HttpSession session) Adds the FailOverSessionActivationListener to the current HttpSession.
protected void	addFailOverBagToSession(FailOverBag bag, javax.servlet.http.HttpSession session) Store the FailOverBag as attribute to the current HttpSession.
void	enableFailOverSupport(boolean supportFailOver) Enable failover support.
void	enablePassivationSupport(boolean supportPassivation) Enable passivation support.
String	getJvmId() Used for tracking the origin of serialized bean instances.
ObjectInputStream	getObjectInputStream(InputStream in) Deprecated. as we do not use Javassist anymore this is not needed anymore!
ObjectOutputStream	getObjectOutputStream(OutputStream out) Deprecated. as we do not use Javassist anymore this is not needed anymore!
Object	handleResource(javax.enterprise.inject.spi.Bean<?> bean, Object resourceObject, ObjectInput in, ObjectOutput out) Except the EJB remote stub, it is hard to handle other types of resources.
boolean	isPassivation()
boolean	isSupportFailOver()
boolean	isSupportPassivation()
protected void	restoreBeansFromFailOverBag(FailOverBag bag, javax.servlet.http.HttpSession session) Restores the session and conversation contexts from the given FailOverBag.
void	sessionDidActivate(javax.servlet.http.HttpSession session) Informs the service that the session did activate and that beans should be restored.
void	sessionIsIdle(javax.servlet.http.HttpSession session) Inform the service that a session is idle and that beans should be stored for fail over.
void	sessionIsInUse(javax.servlet.http.HttpSession session) Inform the service that the session will be active.
void	sessionWillPassivate(javax.servlet.http.HttpSession session) Invoked when the session will passivate and that beans should be stored for passivation.
protected void	storeBeansInFailOverBag(FailOverBag bag, javax.servlet.http.HttpSession session) Stores the session and conversation contexts in the FailOverBag.

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_IS_SUPPORT_FAILOVER

public static final String CONFIG_IS_SUPPORT_FAILOVER

See Also:

Constant Field Values

CONFIG_IS_SUPPORT_PASSIVATE

public static final String CONFIG_IS_SUPPORT_PASSIVATE

See Also:

Constant Field Values

CONFIG_RESOURCES_SERIALIZATION_HANDLER

public static final String CONFIG_RESOURCES_SERIALIZATION_HANDLER

See Also:

Constant Field Values

ATTRIBUTE_SESSION_CONTEXT

public static final String ATTRIBUTE_SESSION_CONTEXT

See Also:

Constant Field Values

ATTRIBUTE_CONVERSATION_CONTEXT_MAP

public static final String ATTRIBUTE_CONVERSATION_CONTEXT_MAP

See Also:

Constant Field Values

Constructor Detail

DefaultOwbFailOverService

public DefaultOwbFailOverService()

Method Detail

sessionIsIdle

public void sessionIsIdle(javax.servlet.http.HttpSession session)

Description copied from interface: FailOverService

Inform the service that a session is idle and that beans should be stored for fail over. Invoked when we finish a request.

Specified by:

sessionIsIdle in interface FailOverService

Parameters:

session - The HttpSession.

sessionIsInUse

public void sessionIsInUse(javax.servlet.http.HttpSession session)

Description copied from interface: FailOverService

Inform the service that the session will be active. Invoked when a request is received.

Specified by:

sessionIsInUse in interface FailOverService

Parameters:

session - The HttpSession.

sessionDidActivate

public void sessionDidActivate(javax.servlet.http.HttpSession session)

Description copied from interface: FailOverService

Informs the service that the session did activate and that beans should be restored.

Specified by:

sessionDidActivate in interface FailOverService

Parameters:

session - The HttpSession.

sessionWillPassivate

public void sessionWillPassivate(javax.servlet.http.HttpSession session)

Description copied from interface: FailOverService

Invoked when the session will passivate and that beans should be stored for passivation.

Specified by:

sessionWillPassivate in interface FailOverService

Parameters:

session - The HttpSession.

addActivationListenerToSession

protected void addActivationListenerToSession(javax.servlet.http.HttpSession session)

Adds the FailOverSessionActivationListener to the current HttpSession. It must not be manually registered when we store it as session attribute.

Parameters:

session - The current HttpSession.

addFailOverBagToSession

protected void addFailOverBagToSession(FailOverBag bag,
                                       javax.servlet.http.HttpSession session)

Store the FailOverBag as attribute to the current HttpSession. So when the session is fail over to other JVM or local disk, the attribute could also be serialized.

Parameters:

bag - The FailOverBag.

session - The current HttpSession.

storeBeansInFailOverBag

protected void storeBeansInFailOverBag(FailOverBag bag,
                                       javax.servlet.http.HttpSession session)

Stores the session and conversation contexts in the FailOverBag.

Parameters:

bag - The FailOverBag.

session - The current HttpSession.

restoreBeansFromFailOverBag

protected void restoreBeansFromFailOverBag(FailOverBag bag,
                                           javax.servlet.http.HttpSession session)

Restores the session and conversation contexts from the given FailOverBag.

Parameters:

bag - The FailOverBag.

session - The current HttpSession.

handleResource

public Object handleResource(javax.enterprise.inject.spi.Bean<?> bean,
                             Object resourceObject,
                             ObjectInput in,
                             ObjectOutput out)

Except the EJB remote stub, it is hard to handle other types of resources. Here we delegate serialization/deserialization to the application provided SerializationHandler.

Specified by:

handleResource in interface FailOverService

Parameters:

bean - The resource bean.

resourceObject - The resource bean instance

in - The input object stream

out - The output object stream

Returns:

FailOverService.NOT_HANDLED if not handled by handler.

getObjectInputStream

public ObjectInputStream getObjectInputStream(InputStream in)
                                       throws IOException

Deprecated. as we do not use Javassist anymore this is not needed anymore!

Get object input stream. Note, the stream should support deserialize javassist objects.

Specified by:

getObjectInputStream in interface FailOverService

Returns:

custom object input stream.

Throws:

IOException

getObjectOutputStream

public ObjectOutputStream getObjectOutputStream(OutputStream out)
                                         throws IOException

Deprecated. as we do not use Javassist anymore this is not needed anymore!

Get object output stream. Note, the stream should support deserialize javassist objects.

Specified by:

getObjectOutputStream in interface FailOverService

Returns:

custom object output stream.

Throws:

IOException

getJvmId

public String getJvmId()

Description copied from interface: FailOverService

Used for tracking the origin of serialized bean instances.

Specified by:

getJvmId in interface FailOverService

Returns:

an UUID which is unique for each installation. This might change on restarts.

isSupportFailOver

public boolean isSupportFailOver()

Specified by:

isSupportFailOver in interface FailOverService

Returns:

Whether or not the system supports failover

enableFailOverSupport

public void enableFailOverSupport(boolean supportFailOver)

Description copied from interface: FailOverService

Enable failover support.

Specified by:

enableFailOverSupport in interface FailOverService

Parameters:

supportFailOver - true to enable failover support

isSupportPassivation

public boolean isSupportPassivation()

Specified by:

isSupportPassivation in interface FailOverService

Returns:

Whether or not the system support passivation

enablePassivationSupport

public void enablePassivationSupport(boolean supportPassivation)

Description copied from interface: FailOverService

Enable passivation support.

Specified by:

enablePassivationSupport in interface FailOverService

Parameters:

supportPassivation - true to enable passivation support

isPassivation

public boolean isPassivation()