Jetty 12.0.6 · org.eclipse.jetty.server.Context · APIdia, the JavaDoc alternative

A context for handling an Request. Every request has a non-null context, which may initially be the server context, or a context provided by a ContextHandler. A Context:

has an optional context path that is a prefix to all URIs handled by the Context
has an optional list of virtual hosts that the Context is applicable to.
has an optional ClassLoader that that is set as the Thread context ClassLoader for Threads handling the request.
is an java.util.concurrent.Executor that can execute jobs in with the Thread context ClassLoader
is a org.eclipse.jetty.util.Decorator using the DecoratedObjectFactory that can create objects specific to the context.
has the same temporary director specific to the context.

Field Summary

Inherited from org.eclipse.jetty.util.Attributes:: NULL

Method Summary

Modifier and Type	Method and Description
public void	execute(Runnable the task to run task) Redeclares java.util.concurrent.Executor.execute. Executes the given task in a thread scoped to this Context.
public Resource	getBaseResource() Returns: the base resource used to lookup other resources specified by the request URI path
public ClassLoader	getClassLoader() Returns: the `ClassLoader` associated with this Context
public String	getContextPath() Returns: the encoded context path of this `Context` or `null`
public Request.Handler	getErrorHandler() Returns: the error `Request.Handler` associated with this Context
public MimeTypes	getMimeTypes() Returns: the mime types associated with this Context
public default String	Returns: the URI path scoped to this Context, or `null` if the full path does not match this Context. The empty string is returned if the full path is exactly the context path. getPathInContext(String a full URI path that should be canonically encoded as per `org.eclipse.jetty.util.URIUtil#canonicalPath(String)` canonicallyEncodedPath) Returns the URI path scoped to this Context.
public static String	Returns: the URI `encodedPath` scoped to the `encodedContextPath`, or `null` if the `encodedPath` does not match the context. The empty string is returned if the `encodedPath` is exactly the `encodedContextPath`. getPathInContext(String The context path that should be canonically encoded as per `org.eclipse.jetty.util.URIUtil#canonicalPath(String)`. encodedContextPath, String a full URI path that should be canonically encoded as per `org.eclipse.jetty.util.URIUtil#canonicalPath(String)`. encodedPath) Returns the URI path scoped to the passed context path.
public File	getTempDirectory() Returns: a non-`null` temporary directory, configured either for the context, the server or the JVM
public List<String>	getVirtualHosts() Returns: a list of virtual host names associated with this Context
public void	run(Runnable the task to run task) Runs the given task in the current thread scoped to this Context.
public void	run(Runnable the task to run task, Request the HTTP request to use in the scope request) Runs the given task in the current thread scoped to this Context and the given Request.

Inherited from org.eclipse.jetty.util.Attributes:: asAttributeMap clearAttributes equals equals getAttribute getAttributeNameSet hashCode hashCode removeAttribute setAttribute unwrap unwrap
Inherited from org.eclipse.jetty.util.Decorator:: decorate destroy

Method Detail

execute back to summary

execute	back to summary
public void execute(Runnable task) Redeclares java.util.concurrent.Executor.execute. Executes the given task in a thread scoped to this Context. Parameters task:Runnable the task to run Annotations @Override See Also `run(Runnable)`

public void execute(Runnable task)

Redeclares java.util.concurrent.Executor.execute.

Executes the given task in a thread scoped to this Context.

Parameters

task:Runnable: the task to run

Annotations

@Override

See Also

run(Runnable)

getBaseResource	back to summary
public Resource getBaseResource() Returns:Resource the base resource used to lookup other resources specified by the request URI path

getClassLoader	back to summary
public ClassLoader getClassLoader() Returns:ClassLoader the `ClassLoader` associated with this Context

getContextPath	back to summary
public String getContextPath() Returns:String the encoded context path of this `Context` or `null`

getErrorHandler	back to summary
public Request.Handler getErrorHandler() Returns:Request.Handler the error `Request.Handler` associated with this Context

getMimeTypes	back to summary
public MimeTypes getMimeTypes() Returns:MimeTypes the mime types associated with this Context

getPathInContext back to summary

getPathInContext	back to summary
public default String getPathInContext(String canonicallyEncodedPath) Returns the URI path scoped to this Context. Parameters canonicallyEncodedPath:String a full URI path that should be canonically encoded as per `org.eclipse.jetty.util.URIUtil#canonicalPath(String)` Returns:String the URI path scoped to this Context, or `null` if the full path does not match this Context. The empty string is returned if the full path is exactly the context path. See Also `getPathInContext(String, String)`

public default String getPathInContext(String canonicallyEncodedPath)

Returns the URI path scoped to this Context.

Parameters

canonicallyEncodedPath:String: a full URI path that should be canonically encoded as per org.eclipse.jetty.util.URIUtil#canonicalPath(String)

Returns:String

the URI path scoped to this Context, or null if the full path does not match this Context. The empty string is returned if the full path is exactly the context path.

See Also

getPathInContext(String, String)

getPathInContext back to summary

getPathInContext	back to summary
public static String getPathInContext(String encodedContextPath, String encodedPath) Returns the URI path scoped to the passed context path. For example, if the context path passed is `/ctx` then a path of `/ctx/foo/bar` will return `/foo/bar`. Parameters encodedContextPath:String The context path that should be canonically encoded as per `org.eclipse.jetty.util.URIUtil#canonicalPath(String)`. encodedPath:String a full URI path that should be canonically encoded as per `org.eclipse.jetty.util.URIUtil#canonicalPath(String)`. Returns:String the URI `encodedPath` scoped to the `encodedContextPath`, or `null` if the `encodedPath` does not match the context. The empty string is returned if the `encodedPath` is exactly the `encodedContextPath`.

public static String getPathInContext(String encodedContextPath, String encodedPath)

Returns the URI path scoped to the passed context path.

For example, if the context path passed is /ctx then a path of /ctx/foo/bar will return /foo/bar.

Parameters

encodedContextPath:String: The context path that should be canonically encoded as per org.eclipse.jetty.util.URIUtil#canonicalPath(String).
encodedPath:String: a full URI path that should be canonically encoded as per org.eclipse.jetty.util.URIUtil#canonicalPath(String).

Returns:String

the URI encodedPath scoped to the encodedContextPath, or null if the encodedPath does not match the context. The empty string is returned if the encodedPath is exactly the encodedContextPath.

getTempDirectory	back to summary
public File getTempDirectory() Returns:File a non-`null` temporary directory, configured either for the context, the server or the JVM

getVirtualHosts	back to summary
public List<String> getVirtualHosts() Returns:List<String> a list of virtual host names associated with this Context

run back to summary

run	back to summary
public void run(Runnable task) Runs the given task in the current thread scoped to this Context. Parameters task:Runnable the task to run See Also `run(Runnable, Request)`

public void run(Runnable task)

Runs the given task in the current thread scoped to this Context.

Parameters

task:Runnable: the task to run

See Also

run(Runnable, Request)

run	back to summary
public void run(Runnable task, Request request) Runs the given task in the current thread scoped to this Context and the given Request. Parameters task:Runnable the task to run request:Request the HTTP request to use in the scope

run

back to summary

public void run(Runnable task, Request request)

Runs the given task in the current thread scoped to this Context and the given Request.

Parameters

task:Runnable: the task to run
request:Request: the HTTP request to use in the scope

public Interface Context

Field Summary

Method Summary

Method Detail