EJBTHREE-2020: implement passivation
[jboss-ejb3:jboss-ejb3-context.git] / base / src / main / java / org / jboss / ejb3 / context / base / BaseSessionContext.java
1 /*
2  * JBoss, Home of Professional Open Source
3  * Copyright (c) 2010, JBoss Inc., and individual contributors as indicated
4  * by the @authors tag. See the copyright.txt in the distribution for a
5  * full listing of individual contributors.
6  *
7  * This is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU Lesser General Public License as
9  * published by the Free Software Foundation; either version 2.1 of
10  * the License, or (at your option) any later version.
11  *
12  * This software is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this software; if not, write to the Free
19  * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21  */
22 package org.jboss.ejb3.context.base;
23
24 import org.jboss.ejb3.context.CurrentInvocationContext;
25 import org.jboss.ejb3.context.spi.SessionBeanManager;
26 import org.jboss.ejb3.context.spi.SessionContext;
27 import org.jboss.ejb3.context.spi.SessionInvocationContext;
28
29 import javax.ejb.EJBLocalObject;
30 import javax.ejb.EJBObject;
31 import javax.xml.rpc.handler.MessageContext;
32 import java.io.ObjectStreamException;
33 import java.io.Serializable;
34
35 /**
36  * Implementation of the SessionContext interface.
37  *
38  * The class is Serializable to allow stateful beans to passivate.
39  * 
40  * @author <a href="cdewolf@redhat.com">Carlo de Wolf</a>
41  */
42 public class BaseSessionContext extends BaseEJBContext
43    implements Serializable, SessionContext
44 {
45    private static final long serialVersionUID = 1L;
46
47    /**
48     * A serializable handle to be able to push this context into an object stream.
49     */
50    private static class Handle implements Serializable
51    {
52       private static final long serialVersionUID = 1L;
53
54       private Object instance;
55
56       private Handle(Object instance)
57       {
58          this.instance = instance;
59       }
60
61       private Object readResolve() throws ObjectStreamException
62       {
63          SessionBeanManager manager = CurrentInvocationContext.get(SessionInvocationContext.class).getManager();
64          return new BaseSessionContext(manager, instance);
65       }
66    }
67
68    public BaseSessionContext(SessionBeanManager manager, Object instance)
69    {
70       super(manager, instance);
71    }
72
73    public <T> T getBusinessObject(Class<T> businessInterface) throws IllegalStateException
74    {
75       // to allow override per invocation
76       return getCurrentInvocationContext().getBusinessObject(businessInterface);
77    }
78
79    protected SessionInvocationContext getCurrentInvocationContext()
80    {
81       SessionInvocationContext current = CurrentInvocationContext.get(SessionInvocationContext.class);
82       assert current.getEJBContext() == this;
83       return current;
84    }
85
86    public EJBLocalObject getEJBLocalObject() throws IllegalStateException
87    {
88       // to allow override per invocation
89       return getCurrentInvocationContext().getEJBLocalObject();
90    }
91
92    public EJBObject getEJBObject() throws IllegalStateException
93    {
94       // to allow override per invocation
95       return getCurrentInvocationContext().getEJBObject();
96    }
97
98    public Class getInvokedBusinessInterface() throws IllegalStateException
99    {
100       return getCurrentInvocationContext().getInvokedBusinessInterface();
101    }
102
103    public SessionBeanManager getManager()
104    {
105       return (SessionBeanManager) super.getManager();
106    }
107    
108    public MessageContext getMessageContext() throws IllegalStateException
109    {
110       return getCurrentInvocationContext().getMessageContext();
111    }
112
113    private Object writeReplace() throws ObjectStreamException
114    {
115       // the manager is never Serializable, so we should only make sure the bean ends up in the stream.
116       // note that the bean itself doesn't have to be Serializable, but the assumption is that a capable stream
117       // is used.
118       return new Handle(getTarget());
119    }
120 }