io.soluble.pjb.bridge.http.RemoteHttpContextFactory Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of php-java-bridge Show documentation
PHPJavaBridge server (soluble fork)
There is a newer version: 7.1.3
/*-*- mode: Java; tab-width:8 -*-*/

package io.soluble.pjb.bridge.http;

/*
 * 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.Serializable;

import io.soluble.pjb.bridge.ISession;
import io.soluble.pjb.bridge.Request;
import io.soluble.pjb.bridge.SessionFactory;

/**
 * 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 RemoteHttpContextFactory extends SessionFactory implements IContextFactory, Serializable {

    /**
     * The response
     */
    private HttpResponse out;

    private static final long serialVersionUID = -7009009517347609467L;
    private IContext context;
    private IContextFactoryVisitor impl;
    private String id;

    public RemoteHttpContextFactory(HttpRequest req, HttpResponse res) {
        super();
        this.out = res;

        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 req The HttpRequest
     * @param res The HttpResponse
     * @return The created ContextFactory
     */
    public static IContextFactory addNew(HttpRequest req, HttpResponse res, IContextFactoryVisitor impl) {
        RemoteHttpContextFactory factory = new RemoteHttpContextFactory(req, res);
        factory.accept(impl);
        return factory;
    }

    /**
     * {@inheritDoc}
     */
    public String getId() {
        return id;
    }

    /**
     * {@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() {
        return new Context();
    }

    /**
     * {@inheritDoc}
     */
    public void flushBuffer() throws IOException {
        out.flushBuffer();
    }

    /**
     * Set the current response
     *
     * @param out the PhpJavaServlet response
     */
    public void setResponse(HttpResponse out) {
        this.out = out;
    }

    /**
     * {@inheritDoc}
     */
    public ISession getSimpleSession(String name, short clientIsNew,
                                     int timeout) {
        return super.getSession(name, clientIsNew, timeout);
    }
}