/*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.mobicents.servlet.sip.startup;
import java.io.File;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Stack;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.concurrent.ScheduledThreadPoolExecutor;
import javax.naming.NamingException;
import javax.servlet.Servlet;
import javax.servlet.ServletContext;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.ServletException;
import javax.servlet.sip.SipServlet;
import javax.servlet.sip.SipServletContextEvent;
import javax.servlet.sip.SipServletListener;
import javax.servlet.sip.SipServletRequest;
import javax.servlet.sip.TimerService;
import org.apache.AnnotationProcessor;
import org.apache.catalina.Container;
import org.apache.catalina.Engine;
import org.apache.catalina.Globals;
import org.apache.catalina.Host;
import org.apache.catalina.LifecycleException;
import org.apache.catalina.Manager;
import org.apache.catalina.Service;
import org.apache.catalina.Wrapper;
import org.apache.catalina.core.StandardContext;
import org.apache.catalina.deploy.LoginConfig;
import org.apache.log4j.Logger;
import org.jboss.web.tomcat.service.session.ClusteredSipManager;
import org.jboss.web.tomcat.service.session.ConvergedSessionReplicationContext;
import org.jboss.web.tomcat.service.session.distributedcache.spi.BatchingManager;
import org.jboss.web.tomcat.service.session.distributedcache.spi.DistributedCacheConvergedSipManager;
import org.mobicents.servlet.sip.annotation.ConcurrencyControlMode;
import org.mobicents.servlet.sip.core.SipApplicationDispatcher;
import org.mobicents.servlet.sip.core.session.DistributableSipManager;
import org.mobicents.servlet.sip.core.session.MobicentsSipApplicationSession;
import org.mobicents.servlet.sip.core.session.MobicentsSipSession;
import org.mobicents.servlet.sip.core.session.SipListenersHolder;
import org.mobicents.servlet.sip.core.session.SipManager;
import org.mobicents.servlet.sip.core.session.SipSessionsUtilImpl;
import org.mobicents.servlet.sip.core.session.SipStandardManager;
import org.mobicents.servlet.sip.core.timers.TimerServiceImpl;
import org.mobicents.servlet.sip.message.SipFactoryFacade;
import org.mobicents.servlet.sip.message.SipFactoryImpl;
import org.mobicents.servlet.sip.message.SipServletRequestImpl;
import org.mobicents.servlet.sip.message.SipServletResponseImpl;
import org.mobicents.servlet.sip.ruby.SipRubyController;
import org.mobicents.servlet.sip.startup.loading.SipLoginConfig;
import org.mobicents.servlet.sip.startup.loading.SipSecurityConstraint;
import org.mobicents.servlet.sip.startup.loading.SipServletImpl;
import org.mobicents.servlet.sip.startup.loading.SipServletMapping;
/**
* Sip implementation of the <b>Context</b> interface extending the standard
* tomcat context to allow deployment of converged applications (sip & web apps)
* as well as standalone sip servlets applications.
*
* @author Jean Deruelle
*
*/
public class SipStandardContext extends StandardContext implements SipContext {
private static final long serialVersionUID = 1L;
// the logger
private static transient Logger logger = Logger.getLogger(SipStandardContext.class);
private transient SipRubyController rubyController;
/**
* The descriptive information string for this implementation.
*/
private static final String info =
"org.mobicents.servlet.sip.startup.SipStandardContext/1.0";
// as mentionned per JSR 289 Section 6.1.2.1 default lifetime for an
// application session is 3 minutes
private static int DEFAULT_LIFETIME = 3;
protected String applicationName;
protected String smallIcon;
protected String largeIcon;
protected String description;
protected int proxyTimeout;
protected int sipApplicationSessionTimeout;
protected transient SipListenersHolder listeners;
protected String mainServlet;
protected transient SipFactoryFacade sipFactoryFacade;
protected transient SipSessionsUtilImpl sipSessionsUtil;
protected transient SipLoginConfig sipLoginConfig;
protected boolean hasDistributableManager;
protected String namingContextName;
protected transient Method sipApplicationKeyMethod;
protected transient ConcurrencyControlMode concurrencyControlMode;
/**
* The set of sip application listener class names configured for this
* application, in the order they were encountered in the sip.xml file.
*/
protected List<String> sipApplicationListeners = new CopyOnWriteArrayList<String>();
/**
* The set of sip servlet mapping configured for this
* application.
*/
protected List<SipServletMapping> sipServletMappings = new ArrayList<SipServletMapping>();
protected transient SipApplicationDispatcher sipApplicationDispatcher = null;
protected Map<String, Container> childrenMap;
protected Map<String, Container> childrenMapByClassName;
protected transient ScheduledThreadPoolExecutor executor = null;
/**
*
*/
public SipStandardContext() {
super();
sipApplicationSessionTimeout = DEFAULT_LIFETIME;
pipeline.setBasic(new SipStandardContextValve());
listeners = new SipListenersHolder(this);
childrenMap = new HashMap<String, Container>();
childrenMapByClassName = new HashMap<String, Container>();
int idleTime = getSipApplicationSessionTimeout();
if(idleTime <= 0) {
idleTime = 1;
}
executor = new ScheduledThreadPoolExecutor(4);
}
@Override
public void init() throws Exception {
if(logger.isInfoEnabled()) {
logger.info("Initializing the sip context");
}
// if (this.getParent() != null) {
// // Add the main configuration listener for sip applications
// LifecycleListener sipConfigurationListener = new SipContextConfig();
// this.addLifecycleListener(sipConfigurationListener);
// setDelegate(true);
// }
// call the super method to correctly initialize the context and fire
// up the
// init event on the new registered SipContextConfig, so that the
// standardcontextconfig
// is correctly initialized too
super.init();
prepareServletContext();
if(logger.isInfoEnabled()) {
logger.info("sip context Initialized");
}
}
protected void prepareServletContext() throws LifecycleException {
if(sipApplicationDispatcher == null) {
setApplicationDispatcher();
}
if(sipFactoryFacade == null) {
sipFactoryFacade = new SipFactoryFacade((SipFactoryImpl)sipApplicationDispatcher.getSipFactory(), this);
}
if(sipSessionsUtil == null) {
sipSessionsUtil = new SipSessionsUtilImpl(this);
}
//needed when restarting applications through the tomcat manager
this.getServletContext().setAttribute(javax.servlet.sip.SipServlet.SIP_FACTORY,
sipFactoryFacade);
this.getServletContext().setAttribute(javax.servlet.sip.SipServlet.TIMER_SERVICE,
TimerServiceImpl.getInstance());
this.getServletContext().setAttribute(javax.servlet.sip.SipServlet.SUPPORTED,
Arrays.asList(SipApplicationDispatcher.EXTENSIONS_SUPPORTED));
this.getServletContext().setAttribute("javax.servlet.sip.100rel", Boolean.TRUE);
this.getServletContext().setAttribute(javax.servlet.sip.SipServlet.SUPPORTED_RFCs,
Arrays.asList(SipApplicationDispatcher.RFC_SUPPORTED));
this.getServletContext().setAttribute(javax.servlet.sip.SipServlet.SIP_SESSIONS_UTIL,
sipSessionsUtil);
this.getServletContext().setAttribute(javax.servlet.sip.SipServlet.OUTBOUND_INTERFACES,
sipApplicationDispatcher.getOutboundInterfaces());
this.getServletContext().setAttribute(SipContext.LOAD_BALANCER,
((SipFactoryImpl)sipApplicationDispatcher.getSipFactory()).getLoadBalancerToUse());
}
/**
* @throws Exception
*/
protected void setApplicationDispatcher() throws LifecycleException {
Container container = getParent().getParent();
if(container instanceof Engine) {
Service service = ((Engine)container).getService();
if(service instanceof SipService) {
sipApplicationDispatcher =
((SipService)service).getSipApplicationDispatcher();
}
}
if(sipApplicationDispatcher == null) {
throw new LifecycleException("cannot find any application dispatcher for this context " + name);
}
}
@Override
public synchronized void start() throws LifecycleException {
if(logger.isInfoEnabled()) {
logger.info("Starting the sip context");
}
if( initialized ) {
prepareServletContext();
}
// Add missing components as necessary
if (getResources() == null) { // (1) Required by Loader
if (logger.isDebugEnabled())
logger.debug("Configuring default Resources");
try {
if ((getDocBase() != null) && (getDocBase().endsWith(".sar")) && (!(new File(getBasePath())).isDirectory()))
setResources(new SARDirContext());
} catch (IllegalArgumentException e) {
logger.error("Error initializing resources: " + e.getMessage());
// ok = false;
}
}
// Configure default manager if none was specified
if (manager == null) {
if ((getCluster() != null) && getDistributable()) {
try {
manager = getCluster().createManager(getName());
} catch (Exception ex) {
logger.error("standardContext.clusterFail", ex);
// ok = false;
}
} else {
setManager(new SipStandardManager());
}
}
//JSR 289 Section 2.1.1 Step 1.Deploy the application.
//This will make start the sip context config, which will in turn parse the sip descriptor deployment
//and call load on startup which is equivalent to
//JSR 289 Section 2.1.1 Step 2.Invoke servlet.init(), the initialization method on the Servlet. Invoke the init() on all the load-on-startup Servlets in the applicatio
super.start();
if(getAvailable()) {
//set the session manager on the specific sipstandardmanager to handle converged http sessions
if(getManager() instanceof SipManager) {
((SipManager)getManager()).setSipFactoryImpl(
((SipFactoryImpl)sipApplicationDispatcher.getSipFactory()));
((SipManager)manager).setContainer(this);
}
// JSR 289 16.2 Servlet Selection
// When using this mechanism (the main-servlet) for servlet selection,
// if there is only one servlet in the application then this
// declaration is optional and the lone servlet becomes the main servlet
if((mainServlet == null || mainServlet.length() < 1) && childrenMap.size() == 1) {
mainServlet = childrenMap.keySet().iterator().next();
}
//JSR 289 Section 2.1.1 Step 3.Invoke SipApplicationRouter.applicationDeployed() for this application.
//called implicitly within sipApplicationDispatcher.addSipApplication
sipApplicationDispatcher.addSipApplication(applicationName, this);
if(manager instanceof DistributableSipManager) {
hasDistributableManager = true;
if(logger.isInfoEnabled()) {
logger.info("this context contains a manager that allows applications to work in a distributed environment");
}
}
if(logger.isInfoEnabled()) {
logger.info("sip application session timeout for this context is " + sipApplicationSessionTimeout + " minutes");
}
if(logger.isInfoEnabled()) {
logger.info("sip context started");
}
} else {
if(logger.isInfoEnabled()) {
logger.info("sip context didn't started due to errors");
}
}
}
@Override
public ServletContext getServletContext() {
if (context == null) {
context = new ConvergedApplicationContext(getBasePath(), this);
if (getAltDDName() != null)
context.setAttribute(Globals.ALT_DD_ATTR,getAltDDName());
}
return ((ConvergedApplicationContext)context).getFacade();
}
@Override
public boolean listenerStart() {
boolean ok = super.listenerStart();
//the web listeners couldn't be started so we don't even try to load the sip ones
if(!ok) {
return ok;
}
if (logger.isDebugEnabled())
logger.debug("Configuring sip listeners");
// Instantiate the required listeners
ClassLoader loader = getLoader().getClassLoader();
ok = listeners.loadListeners(findSipApplicationListeners(), loader);
if(!ok) {
return ok;
}
List<ServletContextListener> servletContextListeners = listeners.getServletContextListeners();
if (servletContextListeners != null) {
ServletContextEvent event =
new ServletContextEvent(getServletContext());
for (ServletContextListener servletContextListener : servletContextListeners) {
if (servletContextListener == null)
continue;
try {
fireContainerEvent("beforeContextInitialized", servletContextListener);
servletContextListener.contextInitialized(event);
fireContainerEvent("afterContextInitialized", servletContextListener);
} catch (Throwable t) {
fireContainerEvent("afterContextInitialized", servletContextListener);
getLogger().error
(sm.getString("standardContext.listenerStart",
servletContextListener.getClass().getName()), t);
ok = false;
}
// TODO Annotation processing
}
}
return ok;
}
@Override
public boolean listenerStop() {
boolean ok = super.listenerStop();
if (logger.isDebugEnabled())
logger.debug("Sending application stop events");
List<ServletContextListener> servletContextListeners = listeners.getServletContextListeners();
if (servletContextListeners != null) {
ServletContextEvent event =
new ServletContextEvent(getServletContext());
for (ServletContextListener servletContextListener : servletContextListeners) {
if (servletContextListener == null)
continue;
try {
fireContainerEvent("beforeContextDestroyed", servletContextListener);
servletContextListener.contextDestroyed(event);
fireContainerEvent("afterContextDestroyed", servletContextListener);
} catch (Throwable t) {
fireContainerEvent("afterContextDestroyed", servletContextListener);
getLogger().error
(sm.getString("standardContext.listenerStop",
servletContextListener.getClass().getName()), t);
ok = false;
}
// TODO Annotation processing
}
}
// TODO Annotation processing check super class on tomcat 6
listeners.clean();
return ok;
}
/**
* Get base path. Copy pasted from StandardContext Tomcat class
*/
public String getBasePath() {
String docBase = null;
Container container = this;
while (container != null) {
if (container instanceof Host)
break;
container = container.getParent();
}
File file = new File(getDocBase());
if (!file.isAbsolute()) {
if (container == null) {
docBase = (new File(engineBase(), getDocBase())).getPath();
} else {
// Use the "appBase" property of this container
String appBase = ((Host) container).getAppBase();
file = new File(appBase);
if (!file.isAbsolute())
file = new File(engineBase(), appBase);
docBase = (new File(file, getDocBase())).getPath();
}
} else {
docBase = file.getPath();
}
return docBase;
}
@Override
public synchronized void stop() throws LifecycleException {
if(logger.isInfoEnabled()) {
logger.info("Stopping the sip context");
}
if(manager instanceof SipManager) {
((SipManager)manager).dumpSipSessions();
((SipManager)manager).dumpSipApplicationSessions();
logger.warn("number of active sip sessions : " + ((SipManager)manager).getActiveSipSessions());
logger.warn("number of active sip application sessions : " + ((SipManager)manager).getActiveSipApplicationSessions());
}
listeners.deallocateServletsActingAsListeners();
super.stop();
// this should happen after so that applications can still do some processing
// in destroy methods to notify that context is getting destroyed and app removed
if(sipApplicationDispatcher != null) {
if(applicationName != null) {
sipApplicationDispatcher.removeSipApplication(applicationName);
} else {
logger.error("the application name is null for the following context : " + name);
}
}
logger.info("sip context stopped");
}
@Override
public void loadOnStartup(Container[] containers) {
super.loadOnStartup(containers);
}
@Override
public Wrapper createWrapper() {
return super.createWrapper();
}
public void addChild(SipServletImpl sipServletImpl) {
SipServletImpl existingSipServlet = (SipServletImpl )children.get(sipServletImpl.getName());
if(existingSipServlet != null) {
logger.warn(sipServletImpl.getName() + " servlet already present, removing the previous one. " +
"This might be due to the fact that the definition of the servlet " +
"is present both in annotations and in sip.xml");
//we remove the previous one (annoations) because it may not have init parameters that has been defined in sip.xml
//See TCK Test ContextTest.testContext1
childrenMap.remove(sipServletImpl.getName());
childrenMapByClassName.remove(sipServletImpl.getServletClass());
super.removeChild(existingSipServlet);
}
childrenMap.put(sipServletImpl.getName(), sipServletImpl);
childrenMapByClassName.put(sipServletImpl.getServletClass(), sipServletImpl);
super.addChild(sipServletImpl);
}
public void removeChild(SipServletImpl sipServletImpl) {
super.removeChild(sipServletImpl);
childrenMap.remove(sipServletImpl.getName());
childrenMapByClassName.remove(sipServletImpl.getServletClass());
}
/**
* {@inheritDoc}
*/
public Map<String, Container> getChildrenMap() {
return childrenMap;
}
/**
* {@inheritDoc}
*/
public Container findChildrenByName(String name) {
return childrenMap.get(name);
}
/**
* {@inheritDoc}
*/
public Container findChildrenByClassName(String className) {
return childrenMapByClassName.get(className);
}
/* (non-Javadoc)
* @see org.mobicents.servlet.sip.startup.SipContext#getApplicationName()
*/
public String getApplicationName() {
return applicationName;
}
/* (non-Javadoc)
* @see org.mobicents.servlet.sip.startup.SipContext#setApplicationName(java.lang.String)
*/
public void setApplicationName(String applicationName) {
this.applicationName = applicationName;
}
/* (non-Javadoc)
* @see org.mobicents.servlet.sip.startup.SipContext#getDescription()
*/
public String getDescription() {
return description;
}
/* (non-Javadoc)
* @see org.mobicents.servlet.sip.startup.SipContext#setDescription(java.lang.String)
*/
public void setDescription(String description) {
this.description = description;
}
/* (non-Javadoc)
* @see org.mobicents.servlet.sip.startup.SipContext#getLargeIcon()
*/
public String getLargeIcon() {
return largeIcon;
}
/* (non-Javadoc)
* @see org.mobicents.servlet.sip.startup.SipContext#setLargeIcon(java.lang.String)
*/
public void setLargeIcon(String largeIcon) {
this.largeIcon = largeIcon;
}
/* (non-Javadoc)
* @see org.mobicents.servlet.sip.startup.SipContext#getListeners()
*/
public SipListenersHolder getListeners() {
return listeners;
}
/* (non-Javadoc)
* @see org.mobicents.servlet.sip.startup.SipContext#setListeners(org.mobicents.servlet.sip.core.session.SipListenersHolder)
*/
public void setListeners(SipListenersHolder listeners) {
this.listeners = listeners;
}
/* (non-Javadoc)
* @see org.mobicents.servlet.sip.startup.SipContext#getMainServlet()
*/
public String getMainServlet() {
return mainServlet;
}
/* (non-Javadoc)
* @see org.mobicents.servlet.sip.startup.SipContext#setMainServlet(java.lang.String)
*/
public void setMainServlet(String mainServlet) {
this.mainServlet = mainServlet;
}
/* (non-Javadoc)
* @see org.mobicents.servlet.sip.startup.SipContext#getProxyTimeout()
*/
public int getProxyTimeout() {
return proxyTimeout;
}
/* (non-Javadoc)
* @see org.mobicents.servlet.sip.startup.SipContext#setProxyTimeout(int)
*/
public void setProxyTimeout(int proxyTimeout) {
this.proxyTimeout = proxyTimeout;
}
public void addConstraint(SipSecurityConstraint securityConstraint) {
super.addConstraint(securityConstraint);
}
public void removeConstraint(SipSecurityConstraint securityConstraint) {
super.removeConstraint(securityConstraint);
}
/* (non-Javadoc)
* @see org.mobicents.servlet.sip.startup.SipContext#getSmallIcon()
*/
public String getSmallIcon() {
return smallIcon;
}
/* (non-Javadoc)
* @see org.mobicents.servlet.sip.startup.SipContext#setSmallIcon(java.lang.String)
*/
public void setSmallIcon(String smallIcon) {
this.smallIcon = smallIcon;
}
@Override
public void setLoginConfig(LoginConfig config) {
super.setLoginConfig(config);
}
@Override
public LoginConfig getLoginConfig() {
return super.getLoginConfig();
}
public void setSipLoginConfig(SipLoginConfig config) {
this.sipLoginConfig = config;
}
public SipLoginConfig getSipLoginConfig() {
return this.sipLoginConfig;
}
/**
* Add a new Listener class name to the set of Listeners
* configured for this application.
*
* @param listener Java class name of a listener class
*/
public void addSipApplicationListener(String listener) {
sipApplicationListeners.add(listener);
fireContainerEvent("addSipApplicationListener", listener);
// FIXME - add instance if already started?
}
/**
* Remove the specified application listener class from the set of
* listeners for this application.
*
* @param listener Java class name of the listener to be removed
*/
public void removeSipApplicationListener(String listener) {
sipApplicationListeners.remove(listener);
// Inform interested listeners
fireContainerEvent("removeSipApplicationListener", listener);
// FIXME - behavior if already started?
}
/**
* Return the set of sip application listener class names configured
* for this application.
*/
public String[] findSipApplicationListeners() {
return sipApplicationListeners.toArray(new String[sipApplicationListeners.size()]);
}
/**
* @return the sipApplicationDispatcher
*/
public SipApplicationDispatcher getSipApplicationDispatcher() {
return sipApplicationDispatcher;
}
/**
* @return the sipFactoryFacade
*/
public SipFactoryFacade getSipFactoryFacade() {
return sipFactoryFacade;
}
/**
* @return the sipSessionsUtil
*/
public SipSessionsUtilImpl getSipSessionsUtil() {
return sipSessionsUtil;
}
/**
* @return the timerService
*/
public TimerService getTimerService() {
return TimerServiceImpl.getInstance();
}
/**
* Get naming context full name.
*/
private String getNamingContextName() {
if (namingContextName == null) {
Container parent = getParent();
if (parent == null) {
namingContextName = getName();
} else {
Stack<String> stk = new Stack<String>();
StringBuffer buff = new StringBuffer();
while (parent != null) {
stk.push(parent.getName());
parent = parent.getParent();
}
while (!stk.empty()) {
buff.append("/" + stk.pop());
}
buff.append(getName());
namingContextName = buff.toString();
}
}
return namingContextName;
}
@Override
public synchronized void setManager(Manager manager) {
if(manager instanceof SipManager && sipApplicationDispatcher != null) {
((SipManager)manager).setSipFactoryImpl(
((SipFactoryImpl)sipApplicationDispatcher.getSipFactory()));
((SipManager)manager).setContainer(this);
}
if(manager instanceof DistributableSipManager) {
hasDistributableManager = true;
if(logger.isInfoEnabled()) {
logger.info("this context contains a manager that allows applications to work in a distributed environment");
}
}
super.setManager(manager);
}
@Override
public Manager getManager() {
return super.getManager();
}
/**
* @return the sipApplicationSessionTimeout in minutes
*/
public int getSipApplicationSessionTimeout() {
return sipApplicationSessionTimeout;
}
/**
* @param sipApplicationSessionTimeout the sipApplicationSessionTimeout to set in minutes
*/
public void setSipApplicationSessionTimeout(int sipApplicationSessionTimeout) {
this.sipApplicationSessionTimeout = sipApplicationSessionTimeout;
}
public Method getSipApplicationKeyMethod() {
return sipApplicationKeyMethod;
}
public void setSipApplicationKeyMethod(Method sipApplicationKeyMethod) {
this.sipApplicationKeyMethod = sipApplicationKeyMethod;
}
public String getJbossBasePath() {
return getBasePath();
}
/**
* {@inheritDoc}
*/
public void addSipServletMapping(SipServletMapping sipServletMapping) {
sipServletMappings.add(sipServletMapping);
}
/**
* {@inheritDoc}
*/
public List<SipServletMapping> findSipServletMappings() {
return sipServletMappings;
}
/**
* {@inheritDoc}
*/
public SipServletMapping findSipServletMappings(SipServletRequest sipServletRequest) {
if(logger.isDebugEnabled()) {
logger.debug("Checking sip Servlet Mapping for following request : " + sipServletRequest);
}
for (SipServletMapping sipServletMapping : sipServletMappings) {
if(sipServletMapping.getMatchingRule().matches(sipServletRequest)) {
return sipServletMapping;
} else {
logger.debug("Following mapping rule didn't match : servletName => " +
sipServletMapping.getServletName() + " | expression = "+
sipServletMapping.getMatchingRule().getExpression());
}
}
return null;
}
/**
* {@inheritDoc}
*/
public void removeSipServletMapping(SipServletMapping sipServletMapping) {
sipServletMappings.remove(sipServletMapping);
}
/**
* {@inheritDoc}
*/
public SipManager getSipManager() {
return (SipManager)manager;
}
@Override
public String getInfo() {
return info;
}
public AnnotationProcessor getAnnotationProcessor() {
// TODO Auto-generated method stub
return new DummyAnnotationProcessor();
}
// ----------------------------------------------- DummyAnnotationProcessor Inner Class
protected class DummyAnnotationProcessor implements AnnotationProcessor {
public void postConstruct(Object instance)
throws IllegalAccessException, InvocationTargetException {
// Do nothing
}
public void preDestroy(Object instance) throws IllegalAccessException,
InvocationTargetException {
getInstanceManager().destroyInstance(instance);
}
public void processAnnotations(Object instance)
throws IllegalAccessException, InvocationTargetException,
NamingException {
getInstanceManager().newInstance(instance);
}
}
public void enterSipApp(SipServletRequestImpl request, SipServletResponseImpl response, SipManager manager, boolean startCacheActivity, boolean bindSessions) {
switch (concurrencyControlMode) {
case SipSession:
MobicentsSipSession sipSession = null;
if(request != null) {
sipSession = ((MobicentsSipSession)request.getSipSession());
} else if (response != null ) {
sipSession = ((MobicentsSipSession)response.getSipSession());
}
if(sipSession != null) {
sipSession.getSemaphore().acquireUninterruptibly();
}
break;
case SipApplicationSession:
MobicentsSipApplicationSession sipApplicationSession = null;
if(request != null) {
sipApplicationSession = ((MobicentsSipApplicationSession)request.getApplicationSession(false));
} else if (response != null ) {
sipApplicationSession = ((MobicentsSipApplicationSession)response.getApplicationSession(false));
}
if(sipApplicationSession != null) {
sipApplicationSession.getSemaphore().acquireUninterruptibly();
}
break;
case None:
break;
}
if(getDistributable() && hasDistributableManager) {
startBatchTransaction();
if(bindSessions) {
ConvergedSessionReplicationContext.enterSipappAndBindSessions(request, response, manager, startCacheActivity);
} else {
ConvergedSessionReplicationContext.enterSipapp(request, response, startCacheActivity);
}
}
}
public void exitSipApp(SipServletRequestImpl request, SipServletResponseImpl response) {
switch (concurrencyControlMode) {
case SipSession:
MobicentsSipSession sipSession = null;
if(request != null) {
sipSession = ((MobicentsSipSession)request.getSipSession());
} else if (response != null ) {
sipSession = ((MobicentsSipSession)response.getSipSession());
}
if(sipSession != null && sipSession.getSemaphore() != null) {
sipSession.getSemaphore().release();
}
break;
case SipApplicationSession:
MobicentsSipApplicationSession sipApplicationSession = null;
if(request != null) {
sipApplicationSession = ((MobicentsSipApplicationSession)request.getApplicationSession(false));
} else if (response != null ) {
sipApplicationSession = ((MobicentsSipApplicationSession)response.getApplicationSession(false));
}
if(sipApplicationSession != null && sipApplicationSession.getSemaphore() != null) {
sipApplicationSession.getSemaphore().release();
}
break;
case None:
break;
}
if (getDistributable() && hasDistributableManager) {
if(logger.isInfoEnabled()) {
logger.info("We are now after the servlet invocation, We replicate no matter what");
}
try {
ConvergedSessionReplicationContext ctx = ConvergedSessionReplicationContext
.exitSipapp();
if(logger.isInfoEnabled()) {
logger.info("Snapshot Manager " + ctx.getSoleSnapshotSipManager());
}
if (ctx.getSoleSnapshotSipManager() != null) {
ctx.getSoleSnapshotSipManager().snapshot(
ctx.getSoleSipSession());
ctx.getSoleSnapshotSipManager().snapshot(
ctx.getSoleSipApplicationSession());
}
} finally {
endBatchTransaction();
}
}
}
private boolean startBatchTransaction() {
DistributedCacheConvergedSipManager distributedConvergedManager = ((ClusteredSipManager) manager)
.getDistributedCacheConvergedSipManager();
BatchingManager tm = distributedConvergedManager.getBatchingManager();
boolean started = false;
try {
if (tm != null && tm.isBatchInProgress() == false) {
tm.startBatch();
started = true;
}
} catch (RuntimeException re) {
throw re;
} catch (Exception e) {
throw new IllegalStateException(
"Failed to initiate batch replication transaction", e);
}
return started;
}
private void endBatchTransaction() {
DistributedCacheConvergedSipManager distributedConvergedManager = ((ClusteredSipManager) manager)
.getDistributedCacheConvergedSipManager();
BatchingManager tm = distributedConvergedManager.getBatchingManager();
try {
if (tm != null && tm.isBatchInProgress() == true) {
tm.endBatch();
}
} catch (Exception e) {
throw new IllegalStateException(
"Failed to stop batch replication transaction", e);
}
}
public boolean notifySipServletsListeners() {
boolean ok = true;
List<SipServletListener> sipServletListeners = listeners.getSipServletsListeners();
if(logger.isDebugEnabled()) {
logger.debug(sipServletListeners.size() + " SipServletListener to notify of servlet initialization");
}
Container[] children = findChildren();
if(logger.isDebugEnabled()) {
logger.debug(children.length + " container to notify of servlet initialization");
}
enterSipApp(null, null, null, true, false);
try {
for (Container container : children) {
if(logger.isDebugEnabled()) {
logger.debug("container " + container.getName() + ", class : " + container.getClass().getName());
}
if(container instanceof Wrapper) {
Wrapper wrapper = (Wrapper) container;
Servlet sipServlet = null;
try {
sipServlet = wrapper.allocate();
if(sipServlet instanceof SipServlet) {
SipServletContextEvent sipServletContextEvent =
new SipServletContextEvent(getServletContext(), (SipServlet)sipServlet);
for (SipServletListener sipServletListener : sipServletListeners) {
sipServletListener.servletInitialized(sipServletContextEvent);
}
}
} catch (ServletException e) {
logger.error("Cannot allocate the servlet "+ wrapper.getServletClass() +" for notifying the listener " +
"that it has been initialized", e);
ok = false;
} catch (Throwable e) {
logger.error("An error occured when initializing the servlet " + wrapper.getServletClass(), e);
ok = false;
}
try {
if(sipServlet != null) {
wrapper.deallocate(sipServlet);
}
} catch (ServletException e) {
logger.error("Deallocate exception for servlet" + wrapper.getName(), e);
ok = false;
} catch (Throwable e) {
logger.error("Deallocate exception for servlet" + wrapper.getName(), e);
ok = false;
}
}
}
} finally {
exitSipApp(null, null);
}
return ok;
}
public ConcurrencyControlMode getConcurrencyControlMode() {
return concurrencyControlMode;
}
public void setConcurrencyControlMode(ConcurrencyControlMode mode) {
this.concurrencyControlMode = mode;
}
public SipRubyController getSipRubyController() {
return rubyController;
}
public void setSipRubyController(SipRubyController sipRubyController) {
this.rubyController = sipRubyController;
}
public ScheduledThreadPoolExecutor getThreadPoolExecutor() {
return executor;
}
}