Package com.google.cloud.functions.invoker

Class BackgroundFunctionExecutor

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.google.cloud.functions.invoker.BackgroundFunctionExecutor

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public final class BackgroundFunctionExecutor
extends javax.servlet.http.HttpServlet

Executes the user's background function.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
static BackgroundFunctionExecutor	forClass(Class<?> functionClass)	Makes a BackgroundFunctionExecutor for the given class.
static Optional<BackgroundFunctionExecutor>	maybeForClass(Class<?> functionClass)	Optionally makes a BackgroundFunctionExecutor for the given class, if it implements one of BackgroundFunction, RawBackgroundFunction, or CloudEventsFunction.
void	service(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)	Executes the user's background function.

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

maybeForClass

public static Optional<BackgroundFunctionExecutor> maybeForClass(Class<?> functionClass)

Optionally makes a BackgroundFunctionExecutor for the given class, if it implements one of BackgroundFunction, RawBackgroundFunction, or CloudEventsFunction. Otherwise returns Optional.empty().

Parameters:

functionClass - the class of a possible background function implementation.

Throws:

RuntimeException - if the given class does implement one of the required interfaces, but we are unable to construct an instance using its no-arg constructor.

forClass

public static BackgroundFunctionExecutor forClass(Class<?> functionClass)

Makes a BackgroundFunctionExecutor for the given class.

Throws:

RuntimeException - if either the class does not implement one of BackgroundFunction, RawBackgroundFunction, or CloudEventsFunction; or we are unable to construct an instance using its no-arg constructor.

service

public void service(javax.servlet.http.HttpServletRequest req,
                    javax.servlet.http.HttpServletResponse res)
             throws IOException

Executes the user's background function. This can handle all HTTP methods.

Overrides:

service in class javax.servlet.http.HttpServlet

Throws:

IOException