io.soluble.pjb.servlet.RemoteHttpServletContextFactory Maven / Gradle / Ivy
Show all versions of php-java-bridge Show documentation
/*-*- mode: Java; tab-width:8 -*-*/
package io.soluble.pjb.servlet;
/*
* Copyright (C) 2003-2007 Jost Boekemeier
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*/
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.Serializable;
import javax.servlet.Servlet;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import io.soluble.pjb.bridge.ISession;
import io.soluble.pjb.bridge.JavaBridgeFactory;
import io.soluble.pjb.bridge.Request;
import io.soluble.pjb.bridge.http.ContextFactory;
import io.soluble.pjb.bridge.http.IContext;
import io.soluble.pjb.bridge.http.IContextFactory;
import io.soluble.pjb.bridge.http.IContextFactoryVisitor;
/**
* Create session contexts for servlets.
* This ContextFactory can be used in environments where no custom class loaders and no threads are allowed.
*
* @author jostb
* @see io.soluble.pjb.bridge.http.ContextFactory
* @see io.soluble.pjb.bridge.http.ContextServer
*/
public class RemoteHttpServletContextFactory extends JavaBridgeFactory implements IContextFactory, Serializable {
public static final String CONTEXT_FACTORY_ATTRIBUTE = RemoteHttpServletContextFactory.class.getName() + ".ROOT";
private static final long serialVersionUID = -7009009517347609467L;
/**
* The PhpCGIServlet
*/
protected Servlet servlet;
/**
* The ServletContext of the PhpCGIServlet
*/
protected ServletContext kontext;
/**
* The session proxy (HttpServletRequest) of the PhpCGIServlet or the PhpJavaServlet
*/
protected HttpServletRequest proxy;
/**
* The PhpCGIServlet request
*/
protected HttpServletRequest req;
/**
* The PhpCGIServlet response
*/
protected HttpServletResponse res;
/**
* The PhpJavaServlet response
*/
protected HttpServletResponse out;
private IContext context;
private ISession session;
private IContextFactoryVisitor impl;
private String id;
public RemoteHttpServletContextFactory(Servlet servlet,
ServletContext ctx, HttpServletRequest proxy,
HttpServletRequest req, HttpServletResponse res) {
super();
this.kontext = ctx;
this.proxy = proxy;
this.req = req;
this.out = this.res = res;
this.servlet = servlet;
this.id = ContextFactory.EMPTY_CONTEXT_NAME; // dummy
}
protected void accept(IContextFactoryVisitor impl) {
this.impl = impl;
impl.visit(this);
}
/**
* Create and add a new ContextFactory.
*
* @param servlet The servlet
* @param kontext The servlet context
* @param proxy The request proxy
* @param req The HttpServletRequest
* @param res The HttpServletResponse
* @return The created ContextFactory
*/
public static IContextFactory addNew(Servlet servlet,
ServletContext kontext, HttpServletRequest proxy,
HttpServletRequest req, HttpServletResponse res, IContextFactoryVisitor impl) {
RemoteHttpServletContextFactory factory = new RemoteHttpServletContextFactory(servlet, kontext, proxy, req, res);
factory.accept(impl);
return factory;
}
/**
* {@inheritDoc}
*/
public String getId() {
return id;
}
/**
* {@inheritDoc}
*/
public ISession getSimpleSession(String name, short clientIsNew,
int timeout) {
throw new IllegalStateException("Named sessions not supported by servlet.");
}
/**
* {@inheritDoc}
*/
public ISession getSession(String name, short clientIsNew, int timeout) {
// if name != null return a "named" php session which is not shared with jsp
if (name != null) return getSimpleSession(name, clientIsNew, timeout);
if (session != null) return session;
if (proxy == null) throw new NullPointerException("This context " + getId() + " doesn't have a session proxy.");
return session = HttpSessionFacade.getFacade(this, kontext, proxy, res, clientIsNew, timeout);
}
/**
* Return the http session handle;
*
* @return The session handle
* @throws IllegalStateException if java_session has not been called at the beginning of the PHP script
*/
HttpSession getCurrentSession() {
if (session != null) return ((HttpSessionFacade) session).getCachedSession();
SimpleServletContextFactory.throwJavaSessionException();
return null;
}
/**
* {@inheritDoc}
*/
public void initialize() {/*empty*/}
/**
* {@inheritDoc}
*/
public void invalidate() {/*empty*/}
/**
* {@inheritDoc}
*/
public void recycle(String id) {/*empty*/}
/**
* {@inheritDoc}
*/
public void release() {
if (impl != null) impl.release();
}
/**
* {@inheritDoc}
*/
public void releaseManaged() throws InterruptedException {
if (impl != null) impl.releaseManaged();
}
/**
* {@inheritDoc}
*/
public void waitFor(long timeout) throws InterruptedException {
}
/**
* {@inheritDoc}
*/
public void parseHeader(Request req, InputStream in) throws IOException {
throw new IllegalStateException("parseHeader");
}
/**
* {@inheritDoc}
*/
public void setContext(IContext context) {
if (impl != null) impl.setContext(context);
this.context = context;
}
/**
* {@inheritDoc}
*/
public IContext getContext() {
if (context != null) return context;
if (impl != null) context = impl.getContext();
else setContext(createContext());
context.setAttribute(IContext.JAVA_BRIDGE, getBridge(), IContext.ENGINE_SCOPE);
return context;
}
/**
* {@inheritDoc}
*/
public void destroy() {
super.destroy();
}
/**
* Return an emulated JSR223 context.
*
* @return The context.
* @see io.soluble.pjb.servlet.HttpContext
*/
private IContext createContext() {
IContext ctx = new HttpContext(kontext, req, res);
ctx.setAttribute(IContext.SERVLET_CONTEXT, kontext, IContext.ENGINE_SCOPE);
ctx.setAttribute(IContext.SERVLET_CONFIG, servlet.getServletConfig(), IContext.ENGINE_SCOPE);
ctx.setAttribute(IContext.SERVLET, servlet, IContext.ENGINE_SCOPE);
ctx.setAttribute(IContext.SERVLET_REQUEST, new HttpServletRequestWrapper(req) {
/*
* Return the session obtained from the servlet.
*/
public HttpSession getSession() {
return RemoteHttpServletContextFactory.this.getCurrentSession();
}
/*
* Return the old session or give up.
*/
public HttpSession getSession(boolean clientIsNew) {
HttpSession session = getSession();
if (clientIsNew && !session.isNew())
throw new IllegalStateException("To obtain a new session call java_session() at the beginning of your PHP script.");
return session;
}
}, IContext.ENGINE_SCOPE);
ctx.setAttribute(IContext.SERVLET_RESPONSE, new RemoteHttpServletResponse(res), IContext.ENGINE_SCOPE);
return ctx;
}
/**
* {@inheritDoc}
*/
public void flushBuffer() throws IOException {
out.flushBuffer();
}
/**
* Set the current response
*
* @param out the PhpJavaServlet response
*/
public void setResponse(HttpServletResponse out) {
this.out = out;
}
/**
* Handle requests from the InputStream, write the responses to OutputStream
*
* @param in the InputStream
* @param out the OutputStream
* @throws IOException Example:
*
*
* protected void doPut (HttpServletRequest req, HttpServletResponse res) throws ServletException, IOException {
* IContextFactory ctx = new RemoteHttpServletContextFactory(this, getServletContext(), req, req, res);
* res.setHeader("X_JAVABRIDGE_CONTEXT", ctx.getId());
* res.setHeader("Pragma", "no-cache");
* res.setHeader("Cache-Control", "no-cache");
* try { ctx.handleRequests(req.getInputStream(), res.getOutputStream()); } finally { ctx.destroy(); }
* }
*
*
*/
public void handleRequests(InputStream in, OutputStream out) throws IOException {
getBridge().handleRequests(in, out);
}
}