php.java.bridge.http
Interface IContextFactory

All Superinterfaces:

IJavaBridgeFactory

All Known Subinterfaces:

IContextFactoryVisitor

All Known Implementing Classes:

ContextFactory, InteractivePhpScriptContextFactory, InvocablePhpServletContextFactory, PhpScriptContextFactory, PhpServletContextFactory, RemoteServletContextFactory, ServletContextFactory, SimpleContextFactory, SimpleServletContextFactory

public interface IContextFactory
extends IJavaBridgeFactory

Interface that the ContextFactories must implement.

Author:

jostb

Method Summary

java.lang.ClassLoader	getClassLoader() Get the class loader from the servlet.
IContext	getContext() Return a JSR223 context
java.lang.String	getId() Return the serializable ID of the context factory
java.lang.String	getRedirectString() Return the redirect string, for example h:localhost:8080/JavaBridge/test.php
java.lang.String	getRedirectString(java.lang.String webPath) Return the redirect string, for example h:localhost:8080/webPath
ISession	getSession(java.lang.String name, boolean clientIsNew, int timeout) Return a session for the JavaBridge
java.lang.String	getSocketName() Return the socket name, for example 8080
void	initialize() Called when the context runner starts
void	invalidate() Hook is called at the end of the visitor's life cycle.
void	recycle(java.lang.String id) Update the context factory with the new JavaBridge obtained from the servlet
void	release() Releases the context factory.
void	releaseManaged() Wait until this context is finished and release/destroy it.
void	setClassLoader(java.lang.ClassLoader loader) Set the class loader obtained from the current servlet into the context.
void	setContext(IContext context) Set the Context into this factory.
void	waitFor(long timeout) Wait until this context is finished.

Methods inherited from interface php.java.bridge.IJavaBridgeFactory

destroy, getBridge, getJavaBridgeClassLoader, getSession, isNew, recycle

Method Detail

recycle

void recycle(java.lang.String id)

Update the context factory with the new JavaBridge obtained from the servlet

Parameters:

id - The fresh id

See Also:

ContextFactory.recycle(), Request.setBridge(php.java.bridge.JavaBridge), Request.recycle()

release

void release()

Releases the context factory. This method should be called when the factory is not needed anymore. Implementations could then remove any unused context factory from the classloader's list of context factories.

releaseManaged

void releaseManaged()
                    throws java.lang.InterruptedException

Wait until this context is finished and release/destroy it. This method returns immediately if this context is not in use yet or it is no longer in use. Call this method only if Java has initiated the communication and Java have full control over the connection, for example via a ScriptEngine's URLReader or CGIRunner. For Apache/PHP initiated requests use a combination of #waitFor(long) and #release() instead.

Throws:

java.lang.InterruptedException

See Also:

ContextRunner

waitFor

void waitFor(long timeout)
             throws java.lang.InterruptedException

Wait until this context is finished.

Parameters:

timeout - The timeout

Throws:

java.lang.InterruptedException

See Also:

ContextRunner

getId

java.lang.String getId()

Return the serializable ID of the context factory

Returns:

The ID

getContext

IContext getContext()

Return a JSR223 context

Specified by:

getContext in interface IJavaBridgeFactory

Returns:

The context

See Also:

SimpleContextFactory.getContext(), Context

setContext

void setContext(IContext context)

Set the Context into this factory. Should be called by Context.addNew() only.

Parameters:

context -

See Also:

ContextFactory.addNew()

getSession

ISession getSession(java.lang.String name,
                    boolean clientIsNew,
                    int timeout)

Description copied from interface: IJavaBridgeFactory

Return a session for the JavaBridge

Specified by:

getSession in interface IJavaBridgeFactory

Parameters:

name - The session name. If name is null, the name PHPSESSION will be used.

clientIsNew - true if the client wants a new session

timeout - timeout in seconds. If 0 the session does not expire.

Returns:

The session

See Also:

ISession

setClassLoader

void setClassLoader(java.lang.ClassLoader loader)

Set the class loader obtained from the current servlet into the context.

Parameters:

loader - The currentThreadContextClassLoader

getClassLoader

java.lang.ClassLoader getClassLoader()

Get the class loader from the servlet.

Returns:

The currentThreadContextClassLoader of the servlet.

invalidate

void invalidate()

Hook is called at the end of the visitor's life cycle. Either from destroy(), recycle() or from destroyOrphaned().

See Also:

IJavaBridgeFactory.destroy(), IJavaBridgeFactory.recycle()

initialize

void initialize()

Called when the context runner starts

See Also:

releaseManaged(), IJavaBridgeFactory.destroy()

getRedirectString

java.lang.String getRedirectString(java.lang.String webPath)

Return the redirect string, for example h:localhost:8080/webPath

Parameters:

webPath - Usually request.getContextPath()+request.getServletPath()

Returns:

the redirect string

getRedirectString

java.lang.String getRedirectString()

Return the redirect string, for example h:localhost:8080/JavaBridge/test.php

Returns:

the redirect string

getSocketName

java.lang.String getSocketName()

Return the socket name, for example 8080

Returns:

the socket name