Uses of Class
sirius.web.http.WebContext

Packages that use WebContext

Package	Description
sirius.tagliatelle
sirius.web.controller	Provides the controller part of a simple MVC framework.
sirius.web.crunchlog
sirius.web.data
sirius.web.dispatch	Default dispatchers provided by the framework.
sirius.web.health	System health monitoring Provides tools to collect metrics and to monitor a cluster of machines.
sirius.web.http	Built-in HTTP server based on netty.
sirius.web.security
sirius.web.services	Framework for providing structured services via the HTTP interface.
sirius.web.tasks
sirius.web.util

Uses of WebContext in sirius.tagliatelle

Methods in sirius.tagliatelle with parameters of type WebContext

Modifier and Type	Method and Description
void	TagliatelleController.onError(WebContext ctx, sirius.kernel.health.HandledException error)
void	TagliatelleController.overview(WebContext ctx) Renders a list of all known tags.
void	TagliatelleController.tagInfo(WebContext ctx, String tagLib, String tag) Renders details for the given tag.
void	TagliatelleController.tagState(WebContext ctx)

Uses of WebContext in sirius.web.controller

Fields in sirius.web.controller with type parameters of type WebContext

Modifier and Type	Field and Description
protected Consumer<WebContext>	BasicController.defaultRoute

Methods in sirius.web.controller that return types with arguments of type WebContext

Modifier and Type	Method and Description
sirius.kernel.commons.Callback<WebContext>	ControllerDispatcher.preparePreDispatch(WebContext ctx)

Methods in sirius.web.controller with parameters of type WebContext

Modifier and Type	Method and Description
boolean	Interceptor.before(WebContext ctx, boolean jsonCall, Controller controller, Method method) Invoked before the call to the given method would be performed.
boolean	Interceptor.beforePermissionError(String permission, WebContext ctx, boolean jsonCall, Controller controller, Method method) Invoked before the request is aborted due to a missing permission.
Page<E>	Page.bindToRequest(WebContext ctx) Binds the page to the request.
boolean	ControllerDispatcher.dispatch(WebContext ctx)
void	BasicController.fail(WebContext ctx, sirius.kernel.health.HandledException error) Aborts the request with an error.
static void	AutocompleteHelper.handle(WebContext ctx, AutocompleteHelper.ItemSearch search) Handles the given request and generates the appropriate JSON as expected by the select2 binding.
protected List<Object>	Route.matches(WebContext ctx, String requestedURI, boolean preDispatch) Determines if this route matches the current request.
void	BasicController.onError(WebContext ctx, sirius.kernel.health.HandledException error)
void	Controller.onError(WebContext ctx, sirius.kernel.health.HandledException error) In case processing a request via a method fails (throws an exception), this method will be called.
sirius.kernel.commons.Callback<WebContext>	ControllerDispatcher.preparePreDispatch(WebContext ctx)
boolean	Interceptor.shouldExecuteRoute(WebContext ctx, boolean jsonCall, Controller controller) Determines if a matched routing should be executed.

Uses of WebContext in sirius.web.crunchlog

Methods in sirius.web.crunchlog with parameters of type WebContext

Modifier and Type	Method and Description
Crunchlog.LogBuilder	Crunchlog.LogBuilder.withURI(WebContext ctx) Adds the uri of the given request.
Crunchlog.LogBuilder	Crunchlog.LogBuilder.withURIAndUserAgent(WebContext ctx) Adds the uri and the user agent of the given request.

Uses of WebContext in sirius.web.data

Methods in sirius.web.data with parameters of type WebContext

Modifier and Type	Method and Description
void	ExcelExport.writeResponseTo(String name, WebContext ctx) Writes the generated Excel file to the given web context.

Uses of WebContext in sirius.web.dispatch

Methods in sirius.web.dispatch with parameters of type WebContext

Modifier and Type	Method and Description
boolean	AssetsDispatcher.dispatch(WebContext ctx)
boolean	HelpDispatcher.dispatch(WebContext ctx)
boolean	DefaultDispatcher.dispatch(WebContext ctx)

Uses of WebContext in sirius.web.health

Methods in sirius.web.health with parameters of type WebContext

Modifier and Type	Method and Description
void	SystemController.console(WebContext ctx)
void	SystemController.fail(WebContext ctx) Can be used to forcefully create an error.
void	SystemController.info(WebContext ctx) Reports useful information for the current user agent and request.
void	SystemController.metric(WebContext ctx, String key) Sends the value for the requested metric for /system/metric/[name]
void	SystemController.monitorNode(WebContext ctx) Determines if there is currently an ALARM present or not for: /system/monitor Either reports OK or ERROR, if the cluster state is RED for at least two intervals (minutes).
void	SystemController.ok(WebContext ctx) Simply responds with OK for /system/ok This can be used to monitoring tools the check the system health.
void	SystemController.reset(WebContext ctx) Clears the server and client session.
void	SystemController.state(WebContext ctx) Reports the system and cluster state.
void	SystemController.timing(WebContext ctx) Provides a list of recorded micro timings.

Uses of WebContext in sirius.web.http

Fields in sirius.web.http declared as WebContext

Modifier and Type	Field and Description
protected WebContext	Response.wc

Methods in sirius.web.http that return WebContext

Modifier and Type	Method and Description
WebContext	WebContext.enableTiming(String key) Enables microtiming for this request.
WebContext	WebContext.withCustomPath(String path) Overwrites the path with the given one.
WebContext	WebContext.withCustomURI(String uri) Overwrites the uri with the given one.

Methods in sirius.web.http that return types with arguments of type WebContext

Modifier and Type	Method and Description
default sirius.kernel.commons.Callback<WebContext>	WebDispatcher.preparePreDispatch(WebContext ctx) Invoked as soon as the complete request but not its contents are available.

Methods in sirius.web.http with parameters of type WebContext

Modifier and Type	Method and Description
boolean	WebDispatcher.dispatch(WebContext ctx) Invoked in order to handle the given request.
default void	WebDispatcher.dispatch(WebContext ctx, Consumer<WebContext> startOfPipeline, Consumer<WebContext> nextStage) Invoked in order to handle the given request.
String	CSRFHelper.getCSRFToken(WebContext ctx) Returns the CSRF security-token of the current session.
protected String	WebServer.MicrotimingMode.getMicrotimingKey(WebContext context)
boolean	Firewall.handleRateLimiting(WebContext ctx, String realm) Performs rate limiting for the given request and realm.
boolean	Firewall.isIPBlacklisted(WebContext ctx) Determines if the remote IP of the given request is blacklisted
default sirius.kernel.commons.Callback<WebContext>	WebDispatcher.preparePreDispatch(WebContext ctx) Invoked as soon as the complete request but not its contents are available.

Method parameters in sirius.web.http with type arguments of type WebContext

Modifier and Type	Method and Description
default void	WebDispatcher.dispatch(WebContext ctx, Consumer<WebContext> startOfPipeline, Consumer<WebContext> nextStage) Invoked in order to handle the given request.
default void	WebDispatcher.dispatch(WebContext ctx, Consumer<WebContext> startOfPipeline, Consumer<WebContext> nextStage) Invoked in order to handle the given request.

Constructors in sirius.web.http with parameters of type WebContext

Constructor and Description
Response(WebContext wc) Creates a new response for the given request.

Uses of WebContext in sirius.web.security

Methods in sirius.web.security with parameters of type WebContext

Modifier and Type	Method and Description
void	PublicUserManager.attachToSession(UserInfo user, WebContext ctx)
void	UserManager.attachToSession(UserInfo user, WebContext ctx) Makes the currently authenticated user persistent by storing the required information in the session.
void	GenericUserManager.attachToSession(UserInfo user, WebContext ctx) Attaches the given user to the current session.
UserInfo	PublicUserManager.bindToRequest(WebContext ctx)
UserInfo	UserManager.bindToRequest(WebContext ctx) Tries to find the current user in the current session or by checking the request for valid credentials
UserInfo	GenericUserManager.bindToRequest(WebContext ctx)
protected String	PublicUserManager.computeLang(WebContext ctx, String userId)
protected abstract String	GenericUserManager.computeLang(WebContext ctx, String userId) Compues the langange code of the given user and request.
protected Set<String>	PublicUserManager.computeRoles(WebContext ctx, String userId)
protected abstract Set<String>	GenericUserManager.computeRoles(WebContext ctx, String userId) Tries to compute the roles for the given user and request.
protected String	PublicUserManager.computeTenantname(WebContext ctx, String tenantId)
protected abstract String	GenericUserManager.computeTenantname(WebContext ctx, String tenantId) Compues the name of the given tenant and request.
protected String	PublicUserManager.computeUsername(WebContext ctx, String userId)
protected abstract String	GenericUserManager.computeUsername(WebContext ctx, String userId) Compues the name of the given user and request.
void	ScopeDefaultConfigController.config(WebContext ctx, String name) Shows the default scope config for the given config file.
void	ScopeDefaultConfigController.defaultConfig(WebContext ctx) Shows the default scope config for the first of the known default config file.
void	PublicUserManager.detachFromSession(UserInfo user, WebContext ctx)
void	UserManager.detachFromSession(UserInfo user, WebContext ctx) Removes all stored data from the session This can be considered a logout operation.
void	GenericUserManager.detachFromSession(UserInfo user, WebContext ctx) Removes all stored user information from the current session.
ScopeInfo	ScopeDetector.detectScope(WebContext request) Detects the scope for the given request.
protected sirius.kernel.commons.Tuple<String,String>	GenericUserManager.extractChallengeAndResponse(WebContext ctx)
UserInfo	PublicUserManager.findUserByCredentials(WebContext ctx, String user, String password)
UserInfo	UserManager.findUserByCredentials(WebContext ctx, String user, String password) Tries to find a user with the given credentials.
UserInfo	PublicUserManager.findUserByName(WebContext ctx, String user)
UserInfo	UserManager.findUserByName(WebContext ctx, String user) Tries to find a user with the given username.
UserInfo	UserManager.findUserForRequest(WebContext ctx) Tries to find the current user in the current session.
UserInfo	GenericUserManager.findUserForRequest(WebContext ctx)
protected UserInfo	GenericUserManager.findUserInSession(WebContext ctx) Tries to fetch the current user from the current session.
SAMLResponse	SAMLHelper.parseSAMLResponse(WebContext ctx) Parses a SAML 2 response from the given request.
protected void	GenericUserManager.recordUserLogin(WebContext ctx, UserInfo user) Provides a method which can track logins of users.
protected void	GenericUserManager.updateLoginCookie(WebContext ctx, UserInfo user) Updates the lifetime of the login cooke if required.

Uses of WebContext in sirius.web.services

Fields in sirius.web.services declared as WebContext

Modifier and Type	Field and Description
protected WebContext	ServiceCall.ctx

Methods in sirius.web.services that return WebContext

Modifier and Type	Method and Description
WebContext	ServiceCall.getContext() Provides access to the underlying request.

Methods in sirius.web.services with parameters of type WebContext

Modifier and Type	Method and Description
boolean	ServiceDispatcher.dispatch(WebContext ctx)

Constructors in sirius.web.services with parameters of type WebContext

Constructor and Description
ServiceCall(WebContext ctx)

Uses of WebContext in sirius.web.tasks

Methods in sirius.web.tasks with parameters of type WebContext

Modifier and Type	Method and Description
void	ManagedTasksController.scripting(WebContext ctx) Displays the system scripting facility.
void	ManagedTasksController.scriptingExecute(WebContext ctx, JSONStructuredOutput json) Executes the given script.
void	ManagedTasksController.task(WebContext ctx, String taskId) Displays details to a running task
void	ManagedTasksController.taskCancel(WebContext ctx, JSONStructuredOutput json, String taskId) Cancels the given tasks as response to an AJAX call.
void	ManagedTasksController.taskInfo(WebContext ctx, JSONStructuredOutput json, String taskId) Displays details to a running task as JSON
void	ManagedTasksController.tasks(WebContext ctx) Lists all active tasks
void	ManagedTasksController.tasksAPI(WebContext ctx, JSONStructuredOutput json) Lists all active tasks as JSON

Uses of WebContext in sirius.web.util

Methods in sirius.web.util with parameters of type WebContext

Modifier and Type	Method and Description
void	TranslationController.export(WebContext ctx) Exports all loaded translations into a xls file containing all supported languages
void	TranslationController.export(WebContext ctx, String filter) Exports all loaded translations matching the given filter into a xls file containing all supported languages
void	QRCodeController.onError(WebContext ctx, sirius.kernel.health.HandledException error)
void	QRCodeController.qr(WebContext ctx) Creates an QR code for the given content.