php.java.bridge.http
Interface IContextFactory

All Superinterfaces:

IJavaBridgeFactory

All Known Subinterfaces:

IContextFactoryVisitor

All Known Implementing Classes:

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

public interface IContextFactory
extends IJavaBridgeFactory

Interface that the ContextFactories must implement.

Author:

jostb

Method Summary

void	destroy() Removes the context factory from the classloader's list of context factories and destroys its content.
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
ISession	getSession(java.lang.String name, boolean clientIsNew, int timeout) Return a session for the JavaBridge
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	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.
void	waitForInitializedContext() Wait until this context is finished.

Methods inherited from interface php.java.bridge.IJavaBridgeFactory

getBridge, getJavaBridgeClassLoader, recycle

Method Detail

recycle

void recycle(java.lang.String id)
             throws java.lang.SecurityException

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

Parameters:

id - The fresh id

Throws:

java.lang.SecurityException

See Also:

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

destroy

void destroy()

Removes the context factory from the classloader's list of context factories and destroys its content.

Specified by:

destroy in interface IJavaBridgeFactory

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.

waitForInitializedContext

void waitForInitializedContext()
                               throws java.lang.InterruptedException

Wait until this context is finished. This method returns immediately if this context is not in use yet or it is no longer in use. Call this method only if you're sure that the PHP script context is initialized! For example when the PHP script is finished, you can use this method to wait until the remaining communication is finished.

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.