Skip navigation links
A B C D E F G H I J K L M N O P Q R S T U V W X 

A

accepts(InetAddress) - Method in class sirius.web.http.IPRange.RangeSet
Checks if the given address if accepted by one of the declared ranges, or if the range is completely empty.
ActiveHTTPConnection - Interface in sirius.web.http
Used by WebServer.getOpenConnections() to provide detailed information about an open HTTP connection.
addAttachment(DataSource) - Method in class sirius.web.mails.Mails.MailSender
Adds an attachment to the email.
addAttachments(DataSource...) - Method in class sirius.web.mails.Mails.MailSender
Adds an array of attachments to the email.
addAttachments(List<DataSource>) - Method in class sirius.web.mails.Mails.MailSender
Adds a list of attachments to the email.
addEnumItem(Class<E>) - Method in class sirius.web.controller.Facet
Adds the enum constants of the given enum to the facet.
addFacet(String, String, ValueComputer<String, String>) - Method in class sirius.web.controller.Page
Adds a filter facet with the given name, title and translator.
addFacet(Facet) - Method in class sirius.web.controller.Page
Adds a filter facet to this result page.
addFieldError(String, String) - Method in class sirius.web.security.UserContext
Adds an error for a given field
addFieldErrorMessage(String, String) - Method in class sirius.web.security.UserContext
Adds an error message for the given field
addFileToCleanup(File) - Method in class sirius.web.http.WebContext
Adds a file to the cleanup list.
addHeader(CharSequence, Object) - Method in class sirius.web.http.Response
Adds the specified header.
addHeader(String, String) - Method in class sirius.web.mails.Attachment
Adds a header to the attachment.
addHeader(String, String) - Method in class sirius.web.mails.Mails.MailSender
Adds an individual header to the SMTP message.
addHeader(String, String) - Method in class sirius.web.services.JSONCall
Adds a custom header field to the call
addHeaderIfNotExists(CharSequence, Object) - Method in class sirius.web.http.Response
Only adds the given header if no header with the given name does exist yet.
addItem(String, String, long) - Method in class sirius.web.controller.Facet
Adds a facet item
addItems(Iterable<String>) - Method in class sirius.web.controller.Facet
Adds the given collections of items.
addMessage(Message) - Method in class sirius.web.security.UserContext
Adds a message to be shown to the user.
addOpenConnection(WebServerHandler) - Static method in class sirius.web.http.WebServer
 
addP3PHeader - Static variable in class sirius.web.http.WebContext
 
addResourceAsAttachment(String, String, String) - Method in class sirius.web.mails.Mails.MailSender
Adds a resource as attachment.
addRow(Object...) - Method in class sirius.web.templates.ExcelExport
Adds the given array of objects as a row.
addRowAsList(Collection<?>) - Method in class sirius.web.templates.ExcelExport
Adds the given collection of objects as a row.
addTiming(String, long) - Method in interface sirius.web.tasks.ManagedTaskContext
Increments the given performance counter by one and supplies a loop duration in milliseconds.
addToBuffer(Context) - Method in class sirius.web.crunchlog.CrunchlogKernel
 
alternativeTemplate(String, String, Object...) - Method in class sirius.web.http.Response
Tries to render the given Rythm template and sends the output as response.
APPLICATION_PDF - Static variable in class sirius.web.http.MimeHelper
Mime type of PDF files
APPLICATION_X_SHOCKWAVE_FLASH - Static variable in class sirius.web.http.MimeHelper
Mime type of flash (swf) files.
applyContext(Context) - Method in class sirius.web.templates.Templates.Generator
Applies the context to the generator.
applyProfiles(Collection<String>) - Static method in class sirius.web.security.Permissions
Expands all permission profiles to obtain the effective set of permissions for a given list or permission and profile names.
applyProfilesAndPublicRoles(Collection<String>) - Static method in class sirius.web.security.Permissions
Expands all permission profiles just like Permissions.applyProfiles(java.util.Collection).
assertNotNull(Object) - Method in class sirius.web.controller.BasicController
Asserts that the given object is non-null.
assertPermission(String) - Method in class sirius.web.controller.BasicController
Asserts that the current user has the given permission.
assertPermission(String) - Method in class sirius.web.security.UserInfo
Asserts that the user has the given permission.
AssetsDispatcher - Class in sirius.web.dispatch
Dispatches all URLs below /assets.
AssetsDispatcher() - Constructor for class sirius.web.dispatch.AssetsDispatcher
 
asyncClient - Static variable in class sirius.web.http.Response
 
Attachment - Class in sirius.web.mails
Encapsulates all information required to add an attachment to a mail being sent.
Attachment(String, String, boolean) - Constructor for class sirius.web.mails.Attachment
Generates a new attachment with the given name, mime type and contents.
attachments - Variable in class sirius.web.mails.Mails.MailSender
 
attachToSession(UserInfo, WebContext) - Method in class sirius.web.security.GenericUserManager
Attaches the given user to the current session.
attachToSession(UserInfo, WebContext) - Method in class sirius.web.security.PublicUserManager
 
attachToSession(UserInfo, WebContext) - Method in interface sirius.web.security.UserManager
Makes the currently authenticated user persistent by storing the required information in the session.
attachUserToSession() - Method in class sirius.web.security.UserContext
Binds the currently active user to the session.
AutocompleteHelper - Class in sirius.web.controller
Used to generate a response expected by autocomplete-able input fields.
AutocompleteHelper.Completion - Class in sirius.web.controller
Represents a suggestion or completion of a given keyword
AutocompleteHelper.ItemSearch - Interface in sirius.web.controller
Called to generate completions for a given query.
available() - Method in class sirius.web.http.InputStreamHandler
 
awaitTermination() - Method in class sirius.web.crunchlog.CrunchlogKernel
 
awaitTermination() - Method in class sirius.web.health.Cluster
 
awaitTermination() - Method in class sirius.web.http.WebServer
 
awaitTermination() - Method in class sirius.web.templates.rythm.RythmConfig
 

B

BandwidthUpdater() - Constructor for class sirius.web.http.WebServer.BandwidthUpdater
 
BaseRythmExtension - Class in sirius.web.templates.rythm
Provides a set of implicitely defined parameters which are available in all rythm templates.
BaseRythmExtension() - Constructor for class sirius.web.templates.rythm.BaseRythmExtension
 
BasicController - Class in sirius.web.controller
Basic implementation of Controller providing convenience methods and default routing.
BasicController() - Constructor for class sirius.web.controller.BasicController
Creates a new instance of the controller and tries to determine the DefaultRoute which is used in case another route throws an error.
before(WebContext, boolean, Controller, Method) - Method in interface sirius.web.controller.Interceptor
Invoked before the call to the given method would be performed.
beforePermissionError(String, WebContext, boolean, Controller, Method) - Method in interface sirius.web.controller.Interceptor
Invoked before the request is aborted due to a missing permission.
beginResult() - Method in class sirius.web.services.JSONStructuredOutput
 
beginResult(String) - Method in class sirius.web.services.JSONStructuredOutput
 
bindToRequest(WebContext) - Method in class sirius.web.controller.Page
Binds the page to the request.
bindToRequest(WebContext) - Method in class sirius.web.security.GenericUserManager
 
bindToRequest(WebContext) - Method in class sirius.web.security.PublicUserManager
 
bindToRequest(WebContext) - Method in interface sirius.web.security.UserManager
Tries to find the current user in the current session or by checking the request for valid credentials
blocks - Static variable in class sirius.web.http.WebServer
 
bounceToken - Variable in class sirius.web.mails.Mails.MailSender
 
buffer - Variable in class sirius.web.crunchlog.CrunchlogKernel
 
BUFFER_SIZE - Static variable in class sirius.web.http.Response
Size of the internally used transfer buffers
BufferedAttachment - Class in sirius.web.mails
Encapsulates all information required to add an attachment to a mail being sent.
BufferedAttachment(String, String, byte[], boolean) - Constructor for class sirius.web.mails.BufferedAttachment
Generates a new attachment with the given name, mime type and contents.
build() - Method in class sirius.web.security.UserInfo.Builder
Builds the user, with the previously given settings.
buildDefaultUser() - Method in class sirius.web.security.GenericUserManager
 
bytesIn - Static variable in class sirius.web.http.WebServer
 
bytesOut - Static variable in class sirius.web.http.WebServer
 

C

cached() - Method in class sirius.web.http.Response
Marks this response as cachable.
cachedForSeconds(int) - Method in class sirius.web.http.Response
Marks this response as cachable for the given amount of time.
call(ServiceCall, StructuredOutput) - Method in class sirius.web.health.console.ConsoleService
 
call(ServiceCall, StructuredOutput) - Method in class sirius.web.health.NodeInfoService
 
call(ServiceCall, StructuredOutput) - Method in interface sirius.web.services.StructuredService
Handles the incoming call while using out to generate the result.
cancel() - Method in interface sirius.web.tasks.ManagedTask
Cancels the execution of the task.
category - Variable in class sirius.web.tasks.ManagedTaskSetup
 
channelRead(ChannelHandlerContext, Object) - Method in class sirius.web.http.HttpPipeliningHandler
 
channelRead(ChannelHandlerContext, Object) - Method in class sirius.web.http.WebsocketHandler
 
channelUnregistered(ChannelHandlerContext) - Method in class sirius.web.http.WebsocketHandler
 
checkCode(String, String) - Method in class sirius.web.security.OTPVerifier
Verifies the given OTP against the given secret key.
chunks - Static variable in class sirius.web.http.WebServer
 
ClasspathCustomizationResolver - Class in sirius.web.templates
Simple resolver which tries to find the given resource in the classpath of the enabled customizations.
ClasspathCustomizationResolver() - Constructor for class sirius.web.templates.ClasspathCustomizationResolver
 
ClasspathResolver - Class in sirius.web.templates
Simple resolver which tries to find the given resource in the classpath.
ClasspathResolver() - Constructor for class sirius.web.templates.ClasspathResolver
 
cleanup() - Method in interface sirius.web.http.ContentHandler
Invoked once the request is completely handled or the underlying channel was closed.
cleanup() - Method in class sirius.web.http.InputStreamHandler
 
clearRolesForUser(UserInfo, WebContext) - Method in class sirius.web.security.ConfigUserManager
 
clearRolesForUser(UserInfo, WebContext) - Method in class sirius.web.security.GenericUserManager
Removes previously stored roles from the session.
clearSession() - Method in class sirius.web.http.WebContext
Clears (invalidated) the client session by removing all values.
clientErrors - Static variable in class sirius.web.http.WebServer
 
close() - Method in class sirius.web.http.InputStreamHandler
 
closeAsyncClient() - Static method in class sirius.web.http.Response
 
Cluster - Class in sirius.web.health
Manages and monitors the state of a cluster of machines.
Cluster() - Constructor for class sirius.web.health.Cluster
 
collectAllCompletedFiles(Consumer<File>) - Method in class sirius.web.crunchlog.Crunchlog
Iterates over all completely written files (excluding the one currently being written to).
collectAllCompletedFiles(Consumer<File>) - Method in class sirius.web.crunchlog.CrunchlogKernel
collectExtensionNames(BiConsumer<String, Class<?>>) - Method in class sirius.web.templates.rythm.BaseRythmExtension
 
collectExtensionNames(BiConsumer<String, Class<?>>) - Method in interface sirius.web.templates.rythm.RythmExtension
Enumerates all variables paired with their according type.
collectExtensionValues(BiConsumer<String, Object>) - Method in class sirius.web.templates.rythm.BaseRythmExtension
 
collectExtensionValues(BiConsumer<String, Object>) - Method in interface sirius.web.templates.rythm.RythmExtension
Enumerates all variables paired with their according value.
Completion(String, String, String) - Constructor for class sirius.web.controller.AutocompleteHelper.Completion
Generates a new suggestion
completionCallback - Variable in class sirius.web.http.WebContext
 
computeCode(String) - Method in class sirius.web.security.OTPVerifier
Computes an OTP code for the given secret and current interval.
computePermissionsFromAnnotations(AnnotatedElement) - Static method in class sirius.web.security.Permissions
Parses all available permission annotations for the given element.
computeRoles(WebContext, String) - Method in class sirius.web.security.ConfigUserManager
 
computeRoles(WebContext, String) - Method in class sirius.web.security.GenericUserManager
Tries to compute the roles for the given user and request.
computeSecret(Map<String, String>) - Method in interface sirius.web.http.SessionSecretComputer
Computes or provides a secret based on the decoded session.
computeSSOHashInput(WebContext, String, Tuple<String, String>) - Method in class sirius.web.security.GenericUserManager
Computes the input for the hash function used to generate the auth hash.
computeSSOHashInput(WebContext, String, Tuple<String, String>) - Method in class sirius.web.security.SSOUserManager
 
config - Variable in class sirius.web.security.GenericUserManager
 
config(WebContext, String) - Method in class sirius.web.security.ScopeDefaultConfigController
Shows the default scope config for the given config file.
ConfigUserManager - Class in sirius.web.security
Uses the system configuration to authenticate users.
ConfigUserManager(ScopeInfo, Extension) - Constructor for class sirius.web.security.ConfigUserManager
 
ConfigUserManager.Factory - Class in sirius.web.security
Creates a new user manager for the given scope and configuration.
connections - Static variable in class sirius.web.http.WebServer
 
console(WebContext) - Method in class sirius.web.health.SystemController
 
ConsoleService - Class in sirius.web.health.console
Provides the glue logic between the system console UI and the Commands.
ConsoleService() - Constructor for class sirius.web.health.console.ConsoleService
 
constantResource(String, String, URL) - Static method in class sirius.web.templates.Resource
Creates a new constant resource for the given scope, path and resulting url.
contains(String) - Method in interface sirius.web.templates.SmartRow
Checks if a given column is present and filled in the complete dataset
containsKey(Object) - Method in class sirius.web.templates.ScriptingContext
 
content - Variable in class sirius.web.http.WebContext
 
ContentContextExtender - Interface in sirius.web.templates
Can be supplied to the content model (using the Register annotation) in order to extend (initialize) the contexts used by the Templates.Generator.
ContentHandler - Interface in sirius.web.http
Consumes the content supplied by a POST or PUT request.
contentHandler - Variable in class sirius.web.http.WebContext
 
ContentHandler - Interface in sirius.web.templates
Used to effectively generate the output as described by a given Templates.Generator.
ContentHelper - Class in sirius.web.templates
Provides helper methods used in Velocity Macros.
context - Variable in class sirius.web.mails.Mails.MailSender
 
Controller - Interface in sirius.web.controller
A Controller is responsible for handling incoming HTTP requests.
ControllerDispatcher - Class in sirius.web.controller
Dispatches incoming requests to the appropriate Controller.
ControllerDispatcher() - Constructor for class sirius.web.controller.ControllerDispatcher
 
cookiesOut - Variable in class sirius.web.http.WebContext
 
corsAllowAll - Static variable in class sirius.web.http.WebContext
 
create() - Method in class sirius.web.http.session.SessionManager
Creates a new session.
create(String, InputStream) - Static method in class sirius.web.templates.LineBasedProcessor
Generates an appropriate LineBasedProcessor based on the file extension of the given file.
createEmail() - Method in class sirius.web.mails.Mails
Creates a new builder which is used to specify the mail to send.
createManagedTaskSetup(String) - Method in class sirius.web.tasks.ManagedTasks
Creates a new setup which is used to start a new task.
createManager(ScopeInfo, Extension) - Method in class sirius.web.security.ConfigUserManager.Factory
 
createManager(ScopeInfo, Extension) - Method in class sirius.web.security.LDAPUserManager.Factory
 
createManager(ScopeInfo, Extension) - Method in class sirius.web.security.PublicUserManager.Factory
 
createManager(ScopeInfo, Extension) - Method in class sirius.web.security.SSOUserManager.Factory
 
createManager(ScopeInfo, Extension) - Method in interface sirius.web.security.UserManagerFactory
Creates a new user manager for the given scope and config settings (the block in security.scope.
createNextPageQueryString() - Method in class sirius.web.controller.Page
Creates a query string containing all filters, the search query and a start parameter selecting the next page.
createOutput() - Method in class sirius.web.services.ServiceCall
Creates the output used to render the result of the service call.
createPrevPageQueryString() - Method in class sirius.web.controller.Page
Creates a query string containing all filters, the search query and a start parameter selecting the previous page.
createQueryString() - Method in class sirius.web.controller.Page
Creates a query string containing all filters and the search query and a start parameter selecting the current page.
createQueryString(String, String, boolean) - Method in class sirius.web.controller.Page
Creates a query string containing all filters and the search query along with a given custom field.
createQueryStringForConfigurableStart() - Method in class sirius.web.controller.Page
Creates an incomplete query string to be completed by appending the start index.
createSession() - Method in class sirius.web.http.session.SessionManager.MemorySessionStorage
 
createSession() - Method in interface sirius.web.http.session.SessionStorage
Creates a new session.
createSession(ChannelHandlerContext, HttpRequest) - Method in interface sirius.web.http.WebsocketDispatcher
Creates a new session for a given channel (context) and request.
createToggleQueryString(FacetItem) - Method in class sirius.web.controller.Facet
Creates a query string which can be appended to a link in order to toggle the given item.
createUser(String) - Static method in class sirius.web.security.UserInfo.Builder
Creates a new builder and initializes it with an id for the user.
Crunchlog - Class in sirius.web.crunchlog
Provides a facility to write large amounts of semi structured data into log files to be queried later.
Crunchlog() - Constructor for class sirius.web.crunchlog.Crunchlog
 
Crunchlog.LogBuilder - Class in sirius.web.crunchlog
Creates a new builder for a log entry in the crunchlog.
CrunchlogKernel - Class in sirius.web.crunchlog
Contains the implementation of the CrunchLog.
CrunchlogKernel() - Constructor for class sirius.web.crunchlog.CrunchlogKernel
 
ctx - Variable in class sirius.web.services.ServiceCall
 

D

DEFAULT_SCOPE - Static variable in class sirius.web.security.ScopeInfo
If no distinct scope is recognized by the current ScopeDetector or if no detector is installed, this scope is used.
defaultConfig(WebContext) - Method in class sirius.web.security.ScopeDefaultConfigController
Shows the default scope config for the first of the known default config file.
DefaultContentContextExtender - Class in sirius.web.templates
Supplies the contexts of the Templates.Generator with default variables.
DefaultContentContextExtender() - Constructor for class sirius.web.templates.DefaultContentContextExtender
 
DefaultDispatcher - Class in sirius.web.dispatch
Sends a 404 (not found) for all unhandled URIs.
DefaultDispatcher() - Constructor for class sirius.web.dispatch.DefaultDispatcher
 
defaultRoles - Variable in class sirius.web.security.GenericUserManager
 
defaultRoute - Variable in class sirius.web.controller.BasicController
 
DefaultRoute - Annotation Type in sirius.web.controller
Used by BasicController and its subclasses to identify a fallback route.
DefaultSMTPConfig() - Constructor for class sirius.web.mails.Mails.DefaultSMTPConfig
 
defaultUser - Variable in class sirius.web.security.GenericUserManager
 
deleteCookie(String) - Method in class sirius.web.http.WebContext
Removes the given cookie from the cookies sent back to the client.
DeleteOldCrunchlogs - Class in sirius.web.crunchlog
Deletes crunchlog files older than one year.
DeleteOldCrunchlogs() - Constructor for class sirius.web.crunchlog.DeleteOldCrunchlogs
 
detach() - Method in class sirius.web.http.WebContext
 
detach() - Method in class sirius.web.security.UserContext
 
detachFromSession(UserInfo, WebContext) - Method in class sirius.web.security.GenericUserManager
Removes all stored user information from the current session.
detachFromSession(UserInfo, WebContext) - Method in class sirius.web.security.PublicUserManager
 
detachFromSession(UserInfo, WebContext) - Method in interface sirius.web.security.UserManager
Removes all stored data from the session This can be considered a logout operation.
detachUserFromSession() - Method in class sirius.web.security.UserContext
Removes the authentication and user identity from the session.
detectScope(WebContext) - Method in interface sirius.web.security.ScopeDetector
Detects the scope for the given request.
determineRolesOfDefaultUser() - Method in class sirius.web.security.GenericUserManager
 
direct(HttpResponseStatus, String) - Method in class sirius.web.http.Response
Directly sends the given string as response, without any content type.
direct(String, String) - Method in class sirius.web.templates.Templates.Generator
Sets the template code to be used directly as string.
dispatch(WebContext) - Method in class sirius.web.controller.ControllerDispatcher
 
dispatch(WebContext) - Method in class sirius.web.dispatch.AssetsDispatcher
 
dispatch(WebContext) - Method in class sirius.web.dispatch.DefaultDispatcher
 
dispatch(WebContext) - Method in class sirius.web.dispatch.HelpDispatcher
 
dispatch(WebContext) - Method in interface sirius.web.http.WebDispatcher
Invoked in order to handle the given request.
dispatch(WebContext) - Method in class sirius.web.services.ServiceDispatcher
 
download(String) - Method in class sirius.web.http.Response
Instructs the browser to treat the response as download with the given file name.
doWork() - Method in class sirius.web.crunchlog.CrunchlogKernel
 
dynamicResource(String, String, URL) - Static method in class sirius.web.templates.Resource
Creates a new dynamic resource for the given scope, path and resulting url.

E

enableTiming(String) - Method in class sirius.web.http.WebContext
Enables microtiming for this request.
ENCODING - Static variable in class sirius.web.templates.Templates
If a specific output encoding is required (other than the system encoding - most definitely UTF-8) a variable using this key can be supplied to the generator, specifying the name of the encoding to use.
encoding(String) - Method in class sirius.web.templates.Templates.Generator
Sets the output encoding which is used to generate the output files.
endArray(String) - Method in class sirius.web.services.JSONStructuredOutput
 
endObject(String) - Method in class sirius.web.services.JSONStructuredOutput
 
endResult() - Method in class sirius.web.services.JSONStructuredOutput
 
enumerateKeys() - Method in class sirius.web.templates.velocity.VelocityResourceCache
 
equals(Object) - Method in class sirius.web.templates.Resource
 
ERROR - Static variable in class sirius.web.controller.Message
Declares a message as error.
error(String) - Static method in class sirius.web.controller.Message
Factory method to create an error message
error(Throwable) - Static method in class sirius.web.controller.Message
Factory method to create an error message
error(HttpResponseStatus) - Method in class sirius.web.http.Response
Sends the given HTTP status as error.
error(HttpResponseStatus, HandledException) - Method in class sirius.web.http.Response
Sends the given HTTP status as error.
error(HttpResponseStatus, String) - Method in class sirius.web.http.Response
Sends the given HTTP status as error.
error(Object) - Method in interface sirius.web.tasks.ManagedTaskContext
Adds an error to the task log.
ErrorCodeException - Exception in sirius.web
Can be thrown in StructuredServices or in JSON calls (Routed.jsonCall()).
ErrorCodeException(String, String) - Constructor for exception sirius.web.ErrorCodeException
Creates a new exception with the given code and message.
escapeString(String) - Static method in class sirius.web.templates.rythm.EscapeStringTransformer
In contrast to escape JS / JavaScript, this only escapes a single quote, but not a double quote.
EscapeStringTransformer - Class in sirius.web.templates.rythm
Escapes JS strings by only replacing single quotes not double quotes (this would otherwise result in invalid JavaScript (which is produced by escape("JS")).
escapeXML(Object) - Static method in class sirius.web.templates.ContentHelper
Removes all XML characters (<, >, ", ', &) from the input and replaces it with the well known replacement characters.
ExcelExport - Class in sirius.web.templates
Generates an Excel file which can be sent as a response for a WebContext
ExcelExport() - Constructor for class sirius.web.templates.ExcelExport
Generates a new Export
exceptionCaught(ChannelHandlerContext, Throwable) - Method in class sirius.web.http.WebsocketHandler
 
execute(Command.Output, String...) - Method in class sirius.web.health.console.HTTPCommand
 
execute(Command.Output, String...) - Method in class sirius.web.http.session.SessionCommand
 
execute(ManagedTaskExecution) - Method in class sirius.web.tasks.ManagedTasks
 
execute(Consumer<ManagedTaskContext>) - Method in class sirius.web.tasks.ManagedTaskSetup
Creates the managed task for the given consumer which will be supplied with a ManagedTaskContext and executed in the background.
execute(Templates.Generator) - Method in class sirius.web.templates.JavaScriptBasedContentHandler
Executes the template as JavaScript code
export(WebContext, String) - Method in class sirius.web.tools.TranslationController
Exports all loaded translations matching the given filter into a xls file containing all supported languages
export(WebContext) - Method in class sirius.web.tools.TranslationController
Exports all loaded translations into a xls file containing all supported languages
extend(Context) - Method in interface sirius.web.templates.ContentContextExtender
Invoked once for each generated context to be supplied with pre-defined variables.
extend(Context) - Method in class sirius.web.templates.DefaultContentContextExtender
 
extractChallengeAndResponse(WebContext) - Method in class sirius.web.security.GenericUserManager
 

F

Facet - Class in sirius.web.controller
Represents a filter facet used by search / query results.
Facet(String, String, String, ValueComputer<String, String>) - Constructor for class sirius.web.controller.Facet
Creates a new faced with the given parameters.
FacetItem - Class in sirius.web.controller
Represents a single item of a Facet.
FacetItem(String, String, long, boolean) - Constructor for class sirius.web.controller.FacetItem
Creates a new FacesItem.
Factory() - Constructor for class sirius.web.security.ConfigUserManager.Factory
 
Factory() - Constructor for class sirius.web.security.LDAPUserManager.Factory
 
Factory() - Constructor for class sirius.web.security.PublicUserManager.Factory
 
Factory() - Constructor for class sirius.web.security.SSOUserManager.Factory
 
fail(WebContext, HandledException) - Method in class sirius.web.controller.BasicController
Aborts the request with an error.
fail(WebContext) - Method in class sirius.web.health.SystemController
Can be used to forcefully create an error.
failForInvalidEmail(String, String) - Method in class sirius.web.mails.Mails
Determines if the given email address and the optional name is valid.
FIELD_DATE - Static variable in class sirius.web.crunchlog.Crunchlog
This field will be automatically added to each record, containing the timestamp when is was logged.
FIELD_TYPE - Static variable in class sirius.web.crunchlog.Crunchlog
It is highly recommended to add a value for this field in each record to better support filtering for similar events.
file(File) - Method in class sirius.web.http.Response
Sends the given file as response.
fillField(String, Function<Value, T>, Consumer<T>, T) - Method in interface sirius.web.templates.SmartRow
Fills an object's field from the last Value of a given column
fillField(String, int, Function<Value, T>, Consumer<T>, T) - Method in interface sirius.web.templates.SmartRow
Fills an object's field from the n-th Value of a given column
fillFieldIfPresent(String, Function<Value, T>, Consumer<T>) - Method in interface sirius.web.templates.SmartRow
Fills an object's field from the last Value of a given column, but only if the column exists
fillFieldIfPresent(String, int, Function<Value, T>, Consumer<T>) - Method in interface sirius.web.templates.SmartRow
Fills an object's field from the n-th Value of a given column, but only if the column exists
findSession(String) - Method in class sirius.web.http.session.SessionManager
Returns the existing session with the given ID, without marking it as "accessed".
findSession(String) - Method in class sirius.web.http.session.SessionManager.MemorySessionStorage
 
findSession(String) - Method in interface sirius.web.http.session.SessionStorage
Returns the session for the given ID or null if no such session exists.
findTask(String) - Method in class sirius.web.tasks.ManagedTasks
Tries to find a managed task with the given id.
findUserByCredentials(WebContext, String, String) - Method in class sirius.web.security.ConfigUserManager
 
findUserByCredentials(WebContext, String, String) - Method in class sirius.web.security.LDAPUserManager
 
findUserByCredentials(WebContext, String, String) - Method in class sirius.web.security.PublicUserManager
 
findUserByCredentials(WebContext, String, String) - Method in class sirius.web.security.SSOUserManager
 
findUserByCredentials(WebContext, String, String) - Method in interface sirius.web.security.UserManager
Tries to find a user with the given credentials.
findUserByName(WebContext, String) - Method in class sirius.web.security.ConfigUserManager
 
findUserByName(WebContext, String) - Method in class sirius.web.security.LDAPUserManager
 
findUserByName(WebContext, String) - Method in class sirius.web.security.PublicUserManager
 
findUserByName(WebContext, String) - Method in class sirius.web.security.SSOUserManager
 
findUserByName(WebContext, String) - Method in interface sirius.web.security.UserManager
Tries to find a user with the given username.
findUserForRequest(WebContext) - Method in class sirius.web.security.GenericUserManager
 
findUserForRequest(WebContext) - Method in interface sirius.web.security.UserManager
Tries to find the current user in the current session.
findUserInSession(WebContext) - Method in class sirius.web.security.GenericUserManager
Tries to fetch the current user from the current session.
flushCache(String, String) - Method in class sirius.web.templates.Resources
Deletes the cached resource for the given scope and uri.
forceHSTS - Static variable in class sirius.web.http.WebContext
 
fork() - Method in class sirius.web.http.WebContext
 
fork() - Method in class sirius.web.security.UserContext
 
fork(String, Runnable) - Method in interface sirius.web.tasks.ManagedTaskContext
Forks a sub task in the given executor (category).
from(String, String) - Method in class sirius.web.mails.Mails.MailSender
 
fromEmail(String) - Method in class sirius.web.mails.Mails.MailSender
Sets the email address used as sender of the email.
fromName(String) - Method in class sirius.web.mails.Mails.MailSender
Sets the name used as sender of the mail.

G

gather(MetricsCollector) - Method in class sirius.web.crunchlog.CrunchlogKernel
 
gather(MetricsCollector) - Method in class sirius.web.http.WebServer
 
gather(MetricsCollector) - Method in class sirius.web.mails.Mails
 
generate(Templates.Generator, OutputStream) - Method in interface sirius.web.templates.ContentHandler
Generates the appropriate output if the settings of the generator match.
generate(Templates.Generator, OutputStream) - Method in class sirius.web.templates.JavaScriptContentHandler
 
generate(Templates.Generator, OutputStream) - Method in class sirius.web.templates.JsXMLContentHandler
 
generate() - Method in class sirius.web.templates.Templates.Generator
Invokes the appropriate ContentHandler and returns the generated content handler as string.
generate(Templates.Generator, OutputStream) - Method in class sirius.web.templates.velocity.VelocityContentHandler
 
generate(Templates.Generator, OutputStream) - Method in class sirius.web.templates.velocity.VelocityPDFContentHandler
 
generateAttachment(String) - Method in class sirius.web.templates.Templates.Generator
Convenience method to directly create an Attachment which can be added to an email.
generateLocalId() - Method in class sirius.web.http.WebContext
Generates an ID (numeric value) which is unique withing this HTTP request.
generateSharedSecret() - Method in class sirius.web.security.OTPVerifier
Returns a randomly generated key which can be used as shared secret.
generateTo(OutputStream) - Method in class sirius.web.templates.Templates.Generator
Calls the appropriate ContentHandler to generate the output which is written into the given output stream.
generator() - Method in class sirius.web.templates.Templates
Creates a new generator which can be used to generate a template based output.
Generator() - Constructor for class sirius.web.templates.Templates.Generator
 
GenericUserManager - Class in sirius.web.security
Base class for various implementations of UserManager.
GenericUserManager(ScopeInfo, Extension) - Constructor for class sirius.web.security.GenericUserManager
 
get(String) - Method in class sirius.web.http.WebContext
Returns a value or parameter supplied by the request.
get(String) - Method in class sirius.web.http.WebsocketSession
Reads the given parameter from the query string of the underlying request.
get() - Static method in class sirius.web.security.UserContext
Retrieves the current UserContext from the CallContext.
get(String...) - Method in class sirius.web.services.ServiceCall
Returns the value provided for the given key(s).
get(String) - Method in class sirius.web.templates.ScriptingContext
 
get(Object) - Method in class sirius.web.templates.velocity.VelocityResourceCache
 
getAction() - Method in class sirius.web.controller.Message
Returns the action associated with the message
getActionLabel() - Method in class sirius.web.controller.Message
Returns the label to be used for the action
getActiveTasks() - Method in class sirius.web.tasks.ManagedTasks
Returns a list of all managed tasks visible to the current user.
getAll() - Method in interface sirius.web.templates.SmartRow
Retrieves the complete row
getAll(String) - Method in interface sirius.web.templates.SmartRow
Retrieves all Values under a given column name
getAsAuthURL(String, String) - Method in class sirius.web.security.OTPVerifier
Generates an OTPAUTH-URL which can be used to generate a QR code for a mobile device.
getAsyncClient() - Static method in class sirius.web.http.Response
 
getAvgResponseTime() - Static method in class sirius.web.http.WebServer
Returns the average response time of the last requests.
getBaseURL() - Method in class sirius.web.http.WebContext
Returns the base url (the protocol + host) for which this request was made.
getBestAvailableNode() - Method in class sirius.web.health.Cluster
Returns the best node which is still functional and has the highest priority (lowest number).
getBlockedConnections() - Static method in class sirius.web.http.WebServer
Returns the total number of connections blocked so far
getBytesIn() - Method in interface sirius.web.http.ActiveHTTPConnection
Returns the number of bytes received.
getBytesIn() - Static method in class sirius.web.http.WebServer
Returns the total bytes received so far
getBytesOut() - Method in interface sirius.web.http.ActiveHTTPConnection
Returns the number of bytes send.
getBytesOut() - Static method in class sirius.web.http.WebServer
Returns the total bytes sent so far
getCategory() - Method in interface sirius.web.tasks.ManagedTask
Returns the category (executor) in which the task was started.
getChunks() - Static method in class sirius.web.http.WebServer
Returns the total number of HTTP chunks received
getClientErrors() - Static method in class sirius.web.http.WebServer
Returns the number of HTTP responses with an 4xx status code.
getClusterState() - Method in class sirius.web.health.Cluster
Returns the overall state of the cluster.
getClusterState() - Method in class sirius.web.health.NodeInfo
Returns the state of the cluster as seen by this node.
getCode() - Method in exception sirius.web.ErrorCodeException
Obtains the error code of this exception.
getColumnMapping() - Method in class sirius.web.templates.SmartLineBasedProcessor
 
getColumnMapping() - Method in interface sirius.web.templates.SmartRow
 
getConfigKeyName() - Method in class sirius.web.crunchlog.DeleteOldCrunchlogs
 
getConnectedSince() - Method in interface sirius.web.http.ActiveHTTPConnection
Returns the duration of the connection.
getConnections() - Static method in class sirius.web.http.WebServer
Returns the total number of connections opened so far
getContent() - Method in class sirius.web.http.WebContext
Provides the body of the request as stream.
getContent() - Method in class sirius.web.templates.Resource
Returns the contents of the resource as byte array.
getContentAsFile() - Method in class sirius.web.http.WebContext
Returns the content of the HTTP request as file on disk.
getContentAsString() - Method in class sirius.web.templates.Resource
Returns the contents of the resource as string.
getContentCharset() - Method in class sirius.web.http.WebContext
Returns the charset of the body of the request
getContentSize() - Method in class sirius.web.http.WebContext
Returns the size in bytes of the body of the request.
getContentType() - Method in class sirius.web.mails.Attachment
 
getContext() - Method in class sirius.web.services.ServiceCall
Provides access to the underlying request.
getContext() - Method in class sirius.web.templates.Templates.Generator
Can be used by a ContentHandler to access the context which contains all previously set variables.
getContextPrefix() - Static method in class sirius.web.http.WebContext
Returns the context prefix (constant path prefix).
getCookie(String) - Method in class sirius.web.http.WebContext
Returns a cookie with the given name, sent by the client
getCookies() - Method in class sirius.web.http.WebContext
Returns all cookies submitted by the client
getCookieValue(String) - Method in class sirius.web.http.WebContext
Returns the data of the given client cookie wrapped as Value
getCount() - Method in class sirius.web.controller.FacetItem
Returns the number of matches of the represented key.
getCreationTime() - Method in interface sirius.web.http.session.ServerSession
Returns the timestamp of the sessions creation
getCtx() - Method in class sirius.web.http.WebContext
Provides access to the underlying ChannelHandlerContext
getCurrentPageNumber() - Method in class sirius.web.controller.Page
Calculates the current page number
getCurrentScope() - Static method in class sirius.web.security.UserContext
Boilerplate method to quickly access the current scope.
getCurrentUser() - Static method in class sirius.web.security.UserContext
Boilerplate method to quickly access the current user.
getDateHeader(CharSequence) - Method in class sirius.web.http.WebContext
Returns the value of a date header as UNIX timestamp in milliseconds.
getDefaulScopeConfigContents(String) - Static method in class sirius.web.security.ScopeInfo
Returns the original contents of the given default config file.
getDefaultScopeConfigFiles() - Static method in class sirius.web.security.ScopeInfo
Lists the names of all loaded default config files.
getDescription() - Method in class sirius.web.controller.AutocompleteHelper.Completion
Returns the description of the suggestion
getDescription() - Method in class sirius.web.health.console.HTTPCommand
 
getDescription() - Method in class sirius.web.http.session.SessionCommand
 
getDetails() - Method in class sirius.web.controller.Message
Returns detailed infos for this message
getDownlink() - Method in interface sirius.web.http.ActiveHTTPConnection
Returns the downlink (outgoing) bandwidth.
getDuration() - Method in class sirius.web.controller.Page
Returns the search duration.
getDynamicAssetToken() - Method in class sirius.web.http.WebContext
Returns a token which can be added to dynamic asset-URLS (/asset/dynamic/TOKEN/...) to force a reload of the specified resource.
getEmail() - Method in class sirius.web.security.UserInfo
The email address of the user
getEncoding() - Method in class sirius.web.templates.Templates.Generator
Can be used by a ContentHandler to determine the effective encoding used for the generated output.
getEnd() - Method in class sirius.web.controller.Page
Returns the absolute index (1 based) of the last item on this page.
getEndpoint() - Method in class sirius.web.health.NodeInfo
Returns the endpoint of the node.
getEngine() - Method in class sirius.web.templates.JavaScriptBasedContentHandler
Returns a JavaScript engine as selected by the config key content.script-engine
getEngine() - Static method in class sirius.web.templates.velocity.VelocityHelper
Returns the velocity engine.
getExtensions(String) - Method in class sirius.web.templates.Templates
Returns a list of all extensions provided for the given key.
getFacets() - Method in class sirius.web.controller.Page
Returns all filter facets available.
getFieldErrorMessage(String) - Method in class sirius.web.security.UserContext
Returns an error message for the given field
getFieldValue(String, Object) - Method in class sirius.web.security.UserContext
Returns the originally submitted field value even if it was rejected due to an error.
getFieldValue(String) - Method in class sirius.web.security.UserContext
Returns the originally submitted field value even if it was rejected due to an error.
getFieldValues(String) - Method in class sirius.web.security.UserContext
Returns all values submitted for the given field
getFileData(String) - Method in class sirius.web.http.WebContext
Returns the file upload supplied for the given key.
getFirst(String) - Method in interface sirius.web.templates.SmartRow
Retrieves a Value from this row
getFirstFilled(String...) - Method in class sirius.web.http.WebContext
Returns the first non empty value for the given keys.
getFirstOrDefault(String, Object) - Method in interface sirius.web.templates.SmartRow
Retrieves a Value from this row
getHandlerType() - Method in class sirius.web.templates.Templates.Generator
Contains the handler type.
getHeader(CharSequence) - Method in class sirius.web.http.WebContext
Returns the request header with the given name
getHeaders() - Method in class sirius.web.mails.Attachment
Returns all headers declared for this attachment.
getHeaderValue(CharSequence) - Method in class sirius.web.http.WebContext
Returns the request header wrapped as Value
getHelper(Class<T>) - Method in class sirius.web.security.ScopeInfo
Retrieves the helper of the given type.
getHelper(String) - Method in class sirius.web.security.ScopeInfo
Retrieves the helper of the given name.
getHelper(Class<H>) - Static method in class sirius.web.security.UserContext
Returns the helper of the given class for the current scope.
getHelper(String) - Static method in class sirius.web.security.UserContext
Returns the helper with the given name for the current scope.
getHelperType() - Method in interface sirius.web.security.HelperFactory
Returns the type of helpers produced by this factory.
getHttpData(String) - Method in class sirius.web.http.WebContext
Returns the posted part with the given key.
getHttpDataFactory() - Static method in class sirius.web.http.WebServer
Returns the data factory used to handle file uploads and posts.
getId() - Method in interface sirius.web.http.session.ServerSession
Returns the unique session id
getId() - Method in interface sirius.web.tasks.ManagedTask
Contains the unique ID of the task.
getIdleTimeouts() - Static method in class sirius.web.http.WebServer
Returns the number of idle connections killed
getInput() - Method in class sirius.web.services.JSONCall
Provides access to the JSON answer of the call.
getInputStream() - Method in class sirius.web.mails.BufferedAttachment
 
getInputStream() - Method in class sirius.web.mails.ResourceAttachment
 
getIPFilter() - Static method in class sirius.web.http.WebServer
Returns an ip filter which determines which IPs may connect to the web server.
getItems() - Method in class sirius.web.controller.Facet
Returns all items collected for this facet.
getItems() - Method in class sirius.web.controller.Page
Returns the items on this page.
getJSONContent() - Method in class sirius.web.http.WebContext
Returns the body of the HTTP request as JSON data.
getKeepalives() - Static method in class sirius.web.http.WebServer
Returns the number of keepalives supported
getKey() - Method in class sirius.web.controller.FacetItem
Returns the content value represented by this item.
getKeys() - Method in interface sirius.web.http.session.ServerSession
Returns a list of all keys for which a value is stored in the session
getKeys() - Method in class sirius.web.templates.ScriptingContext
 
getLabel() - Method in class sirius.web.controller.AutocompleteHelper.Completion
Returns the label shown to the user
getLabelClass() - Method in enum sirius.web.tasks.ManagedTask.State
 
getLang() - Method in class sirius.web.http.WebContext
Returns the accepted language of the client as two-letter language code.
getLang() - Method in class sirius.web.security.ScopeInfo
Returns the two letter language code of this scope as understood by NLS.setDefaultLanguage(String).
getLang() - Method in class sirius.web.security.UserInfo
The language code of the user.
getLast(String) - Method in interface sirius.web.templates.SmartRow
Retrieves a Value from this row
getLastAccessedTime() - Method in interface sirius.web.http.session.ServerSession
Returns the timestamp when the session was last accessed
getLastLogs() - Method in interface sirius.web.tasks.ManagedTask
Returns the latest log entries.
getLastLogs() - Method in interface sirius.web.tasks.ManagedTaskContext
Returns the latest log entries.
getLastModified() - Method in class sirius.web.templates.Resource
Computes the last modified date.
getLastModified(Resource) - Method in class sirius.web.templates.velocity.VelocityResourceLoader
 
getLastModified(String) - Method in class sirius.web.templates.velocity.VelocityResourceLoader
Provides the last change time of the requested resource.
getLastOrDefault(String, Object) - Method in interface sirius.web.templates.SmartRow
Retrieves a Value from this row
getLastPing() - Method in class sirius.web.health.NodeInfo
Returns the timestamp of the last successful call to obtain the node state.
getLatency() - Method in interface sirius.web.http.ActiveHTTPConnection
Returns latency information as a pair of numbers like "8ms / 5ms".
getMailHost() - Method in class sirius.web.mails.Mails.DefaultSMTPConfig
 
getMailHost() - Method in interface sirius.web.mails.SMTPConfiguration
Returns the hostname of the mail server to be used.
getMailPassword() - Method in class sirius.web.mails.Mails.DefaultSMTPConfig
 
getMailPassword() - Method in interface sirius.web.mails.SMTPConfiguration
Returns the password used to authenticate against the mail server
getMailPort() - Method in class sirius.web.mails.Mails.DefaultSMTPConfig
 
getMailPort() - Method in interface sirius.web.mails.SMTPConfiguration
Returns the port used to connect to the mail server
getMailSender() - Method in class sirius.web.mails.Mails.DefaultSMTPConfig
 
getMailSender() - Method in interface sirius.web.mails.SMTPConfiguration
Returns the sender address used when no other address is supplied.
getMailSenderName() - Method in class sirius.web.mails.Mails.DefaultSMTPConfig
 
getMailSenderName() - Method in interface sirius.web.mails.SMTPConfiguration
Returns the sender name which is used when no other sender name is supplied.
getMailUser() - Method in class sirius.web.mails.Mails.DefaultSMTPConfig
 
getMailUser() - Method in interface sirius.web.mails.SMTPConfiguration
Returns the username used to authenticate against the mail server
getMaxInactiveInterval() - Method in interface sirius.web.http.session.ServerSession
Returns the max. time span a session is permitted to be inactive (not accessed) before it is eligible for invalidation.
getMaxUploadSize() - Static method in class sirius.web.http.WebServer
Returns the maximal upload size in bytes
getMessage() - Method in class sirius.web.controller.Message
Returns the message for the user.
getMessage() - Method in class sirius.web.tasks.TaskLogEntry
Returns the message of the log entry.
getMessage(ITemplate, String, Object...) - Method in class sirius.web.templates.rythm.I18nResourceResolver
 
getMessages() - Method in class sirius.web.security.UserContext
Returns all messages to be shown to the user.
getMessagesIn() - Static method in class sirius.web.http.WebServer
Returns the total messages (packets) sent so far
getMessagesOut() - Static method in class sirius.web.http.WebServer
Returns the total messages (packets) received so far
getMetrics() - Method in class sirius.web.health.NodeInfo
Returns all metrics known for this node.
getMicrotimingKey(WebContext) - Method in enum sirius.web.http.WebServer.MicrotimingMode
 
getMicrotimingMode() - Static method in class sirius.web.http.WebServer
Returns the WebServer.MicrotimingMode used by the web server
getMinUploadFreespace() - Static method in class sirius.web.http.WebServer
Returns the minimal value of free disk space accepted until an upload is aborted.
getName() - Method in class sirius.web.controller.Facet
Returns the name of this facet.
getName() - Method in class sirius.web.crunchlog.CrunchlogKernel
 
getName() - Method in class sirius.web.health.Cluster
 
getName() - Method in class sirius.web.health.console.HTTPCommand
 
getName() - Method in class sirius.web.health.NodeInfo
Returns the name of the node.
getName() - Method in class sirius.web.http.session.SessionCommand
 
getName() - Method in class sirius.web.http.WebServer
 
getName() - Method in class sirius.web.mails.Attachment
 
getName() - Method in interface sirius.web.security.HelperFactory
Returns a short and descriptive name which can be used to fetch the helper in templates.
getName() - Method in interface sirius.web.tasks.ManagedTask
Returns a descriptive name of the task.
getName() - Method in class sirius.web.templates.rythm.RythmConfig
 
getNextStart() - Method in class sirius.web.controller.Page
Returns the index of the next page.
getNodeInfos() - Method in class sirius.web.health.Cluster
Reports infos for all known cluster members.
getNodePriority() - Method in class sirius.web.health.Cluster
Returns the priority of this node.
getNodeState() - Method in class sirius.web.health.Cluster
Returns the determined state of this node.
getNodeState() - Method in class sirius.web.health.NodeInfo
Returns the state of the node.
getNth(String, int) - Method in interface sirius.web.templates.SmartRow
Retrieves a Value from this row
getNthOrDefault(String, int, Object) - Method in interface sirius.web.templates.SmartRow
Retrieves a Value from this row
getNumberOfOpenConnections() - Static method in class sirius.web.http.WebServer
Returns the number of currently open connection
getNumberOfSessions() - Method in class sirius.web.http.session.SessionManager
Returns the total number of active sessions
getNumberOfSessions() - Method in class sirius.web.http.session.SessionManager.MemorySessionStorage
 
getNumberOfSessions() - Method in interface sirius.web.http.session.SessionStorage
Returns the number of active sessions
getNumberOfWebsockets() - Static method in class sirius.web.http.WebServer
Returns the number of currently open websockets
getNumKeepAlive() - Method in interface sirius.web.http.ActiveHTTPConnection
Returns the number of keep-alives performed on this connection.
getOpenConnections() - Static method in class sirius.web.http.WebServer
Returns all currently open connections of the HTTP server.
getOutCookies() - Method in class sirius.web.http.WebContext
Returns all cookies to be sent to the client.
getOutput() - Method in class sirius.web.services.JSONCall
Can be used to generate the JSON request.
getOutputStream() - Method in class sirius.web.mails.Attachment
 
getPageSize() - Method in class sirius.web.controller.Page
Returns the total page size.
getParameter(String) - Method in class sirius.web.http.WebContext
Returns the query string or POST parameter with the given name.
getParameterNames() - Method in class sirius.web.http.WebContext
Returns a collection of all parameters names.
getParameters(String) - Method in class sirius.web.http.WebContext
Returns all query string or POST parameters with the given name.
getParameters(String...) - Method in class sirius.web.services.ServiceCall
Returns all query string or POST parameters provided for the given key(s).
getPath() - Method in class sirius.web.templates.Resource
Returns the path which was used to lookup the resource.
getPermissions() - Method in class sirius.web.security.UserInfo
Returns a set of all permissions granted to the user.
getPingFailures() - Method in class sirius.web.health.NodeInfo
Returns the number of failed attempts to connect to the node.
getPlainInput() - Method in class sirius.web.services.JSONCall
Returns the response of the call as plain text.
getPort() - Static method in class sirius.web.http.WebServer
Returns the port used by the web server
getPostDecoder() - Method in class sirius.web.http.WebContext
Returns the post decoder used to decode the posted data.
getPreviousStart() - Method in class sirius.web.controller.Page
Returns the index of the previous page.
getPriority() - Method in class sirius.web.controller.ControllerDispatcher
The priority of this controller is PriorityCollector.DEFAULT_PRIORITY + 10 as it is quite complex to check each request against each route.
getPriority() - Method in interface sirius.web.controller.Interceptor
 
getPriority() - Method in class sirius.web.dispatch.AssetsDispatcher
 
getPriority() - Method in class sirius.web.dispatch.DefaultDispatcher
 
getPriority() - Method in class sirius.web.dispatch.HelpDispatcher
 
getPriority() - Method in class sirius.web.health.Cluster
 
getPriority() - Method in class sirius.web.health.NodeInfo
Returns the priority of the node within the cluster (lower is better).
getPriority() - Method in interface sirius.web.http.WebDispatcher
Returns the priority to determine the position in the dispatcher list.
getPriority() - Method in class sirius.web.http.WebServer
 
getPriority() - Method in interface sirius.web.security.HelperFactory
 
getPriority() - Method in class sirius.web.services.ServiceDispatcher
 
getPriority() - Method in class sirius.web.templates.ClasspathCustomizationResolver
 
getPriority() - Method in class sirius.web.templates.ClasspathResolver
 
getPriority() - Method in class sirius.web.templates.JavaScriptContentHandler
 
getPriority() - Method in class sirius.web.templates.JsXMLContentHandler
 
getPriority() - Method in class sirius.web.templates.LocalPathResolver
 
getPriority() - Method in class sirius.web.templates.rythm.RythmConfig
 
getPriority() - Method in class sirius.web.templates.velocity.VelocityContentHandler
 
getPriority() - Method in class sirius.web.templates.velocity.VelocityPDFContentHandler
 
getProxyIPs() - Static method in class sirius.web.http.WebServer
Returns all proxy IPs as IPRange.RangeSet
getQuery() - Method in class sirius.web.controller.Page
Returns the query string which was used to create the result set.
getQueryString() - Method in class sirius.web.http.WebContext
Returns the original query string sent by the client.
getRange() - Method in class sirius.web.controller.Page
Returns a string representation naming the first and last index contained on this page.
getRemoteAddress() - Method in interface sirius.web.http.ActiveHTTPConnection
Returns the remote address which opened the connection.
getRemoteIP() - Method in class sirius.web.http.WebContext
Returns the remote address which sent the request
getRequest() - Method in class sirius.web.http.WebContext
Provides access to the underlying netty HttpRequest
getRequestedSessionId() - Method in class sirius.web.http.WebContext
Returns the session id requested by the client.
getRequestedURI() - Method in class sirius.web.http.WebContext
Returns the requested URI of the underlying HTTP request, without the query string
getRequestedURL() - Method in class sirius.web.http.WebContext
Returns the complete URL as requested by the browser.
getRequestEncoding() - Method in class sirius.web.http.WebContext
Tries to determine the charset used for the INCOMING request.
getRequests() - Static method in class sirius.web.http.WebServer
Returns the total number of HTTP requests received by the web server
getResourceAsInlineString(String) - Method in class sirius.web.templates.ContentHelper
Returns the contents of the given template as a single line string which can be embedded into a string enclosed by ' (e.g. a JavaScript string).
getResourceStream(String) - Method in class sirius.web.templates.velocity.VelocityResourceLoader
 
getScheduled() - Method in interface sirius.web.tasks.ManagedTask
Returns the timestamp when the task was scheduled (started in the users eye).
getScope() - Method in class sirius.web.security.UserContext
Returns the currently active scope.
getScopeDefaultConfig() - Static method in class sirius.web.security.ScopeInfo
Returns the default config for all scopes.
getScopeId() - Method in class sirius.web.security.ScopeInfo
Returns the unique ID of the scope
getScopeId() - Method in class sirius.web.templates.Resource
Returns the scope id which was set when resolving the resource.
getScopeName() - Method in class sirius.web.security.ScopeInfo
Returns the representative name of the scope
getScopeObject(Class<T>) - Method in class sirius.web.security.ScopeInfo
Returns the associated scope object.
getScopeSettings() - Method in class sirius.web.security.GenericUserManager
 
getScopeType() - Method in class sirius.web.security.ScopeInfo
Returns the type of the scope.
getServerErrors() - Static method in class sirius.web.http.WebServer
Returns the number of HTTP responses with an 5xx status code.
getServerSession(boolean) - Method in class sirius.web.http.WebContext
Returns the server sided session based on the session parameter or cookie.
getServerSession() - Method in class sirius.web.http.WebContext
Returns the server sided session based on the session parameter or cookie.
getServerSessionSource() - Method in class sirius.web.http.WebContext
Returns the source from which the server session id was obtained.
getSession(String) - Method in class sirius.web.http.session.SessionManager
Returns the session for the given id.
getSession(String) - Method in class sirius.web.http.session.SessionManager.MemorySessionStorage
 
getSession(String) - Method in interface sirius.web.http.session.SessionStorage
Returns the session associated with the given id or an empty value if no such session exists.
getSessionKeys() - Method in class sirius.web.http.WebContext
Returns a list of all known session keys for the current session
getSessions() - Method in class sirius.web.http.session.SessionManager
Returns a list of all available sessions
getSessions() - Method in class sirius.web.http.session.SessionManager.MemorySessionStorage
 
getSessions() - Method in interface sirius.web.http.session.SessionStorage
Returns a stream of all known session ids.
getSessionValue(String) - Method in class sirius.web.http.WebContext
Loads a value from the client session
getSettings() - Method in class sirius.web.security.ScopeInfo
Returns the scope specific configuration.
getSettings() - Static method in class sirius.web.security.UserContext
Returns the configuration with is specific to the current user.
getSettings() - Method in class sirius.web.security.UserInfo
Obtains the user specific config.
getSMTPTransport(Session, SMTPConfiguration) - Method in class sirius.web.mails.Mails
 
getSSOHashFunction() - Method in class sirius.web.security.GenericUserManager
Determines which hash function is used to compute and verify SSO tokens.
getStart() - Method in class sirius.web.controller.Page
Returns the absolute index (1 based) of the first item on this page.
getStarted() - Method in interface sirius.web.tasks.ManagedTask
Returns the timestamp when the execution of the task started.
getState() - Method in interface sirius.web.tasks.ManagedTask
Returns the state of the task.
getStateString() - Method in interface sirius.web.tasks.ManagedTask
Returns a short textual description of what the task is currently doing.
getTemplate() - Method in class sirius.web.templates.Templates.Generator
Uses the Resolver implementations or the classloader to load the template as input stream.
getTemplateCode() - Method in class sirius.web.templates.Templates.Generator
Can be used by a ContentHandler to obtain a preset templateCode.
getTemplateName() - Method in class sirius.web.templates.Templates.Generator
Can be used by a ContentHandler to obtain a preset templateName.
getTenantId() - Method in class sirius.web.security.UserInfo
The unique ID of the tenant.
getTenantId() - Method in interface sirius.web.tasks.ManagedTask
Contains the unique ID of the tenant the user who started the task belongs to if present.
getTenantName() - Method in class sirius.web.security.UserInfo
The name of the tenant.
getTerminated() - Method in interface sirius.web.tasks.ManagedTask
Returns the timestamp when the execution of the task finished.
getTimings() - Method in interface sirius.web.tasks.ManagedTask
Returns a list of all recorded performance counters.
getTimings() - Method in interface sirius.web.tasks.ManagedTaskContext
Returns a list of all recorded performance counters.
getTitle() - Method in class sirius.web.controller.Facet
Returns the title of this fact.
getTitle() - Method in class sirius.web.controller.FacetItem
Returns the title shown to the user when displaying this item.
getTod() - Method in class sirius.web.tasks.TaskLogEntry
Returns the timestamp (time of day) when the message was logged.
getTrustedRanges() - Static method in class sirius.web.http.WebServer
Returns all trusted IPs as IPRange.RangeSet
getType() - Method in class sirius.web.controller.Message
Returns the type of the message
getType() - Method in class sirius.web.tasks.TaskLogEntry
Returns the type of the log entry.
getUplink() - Method in interface sirius.web.http.ActiveHTTPConnection
Returns the uplink (incoming) bandwidth.
getUptime() - Method in class sirius.web.health.NodeInfo
Returns the uptime of the node as a string.
getURL() - Method in interface sirius.web.http.ActiveHTTPConnection
Returns the url currently being processed.
getUrl() - Method in class sirius.web.templates.Resource
Returns the effective URL pointing to the resolved content
getUser() - Method in class sirius.web.controller.BasicController
Obtains the currently active user.
getUser() - Method in class sirius.web.security.UserContext
Returns the current user.
getUserAgent() - Method in class sirius.web.http.WebContext
Returns UserAgent for easy access to the user agent used for this request.
getUserAgentString() - Method in class sirius.web.http.session.UserAgent
Returns user agent as String.
getUserForScope(ScopeInfo) - Method in class sirius.web.security.UserContext
Returns the used which would be the current user if the space with the given id would be active.
getUserId() - Method in class sirius.web.security.UserInfo
Returns the unique ID of the user.
getUserId() - Method in interface sirius.web.tasks.ManagedTask
Contains the unique ID of the user that started the task.
getUserManager() - Method in class sirius.web.security.ScopeInfo
Returns the UserManager responsible for this scope.
getUserManager() - Method in class sirius.web.security.UserContext
Determines and returns the current user manager.
getUserName() - Method in class sirius.web.security.UserInfo
Returns the login or descriptive name of the user.
getUsername() - Method in interface sirius.web.tasks.ManagedTask
Returns the name of the user that started the task.
getUserObject(UserInfo) - Method in class sirius.web.security.ConfigUserManager
 
getUserObject(UserInfo) - Method in class sirius.web.security.GenericUserManager
Resolves the given user info back into the original (underlying) user object.
getUserObject(UserInfo) - Method in class sirius.web.security.LDAPUserManager
 
getUserObject(UserInfo) - Method in class sirius.web.security.PublicUserManager
 
getUserObject(UserInfo) - Method in class sirius.web.security.SSOUserManager
 
getUserObject(Class<T>) - Method in class sirius.web.security.UserInfo
Fetches the underlying user object of the given type.
getUserSettings(UserSettings, UserInfo) - Method in class sirius.web.security.GenericUserManager
Fetches the user specific configuration if available.
getValue() - Method in class sirius.web.controller.AutocompleteHelper.Completion
Returns the effective value of the suggestion
getValue() - Method in class sirius.web.controller.Facet
Returns the selected value.
getValue(String) - Method in interface sirius.web.http.session.ServerSession
Fetches a previously stored value from the session.
getWebsocketUri() - Method in interface sirius.web.http.WebsocketDispatcher
Returns the URI which is used to determine if a request is eligble for upgrading to web sockets.
getXMLContent() - Method in class sirius.web.http.WebContext
Returns the body of the HTTP request as XML data.
guessMimeType(String) - Static method in class sirius.web.http.MimeHelper
Tries to guess the mime type for the given file, path or url based on its file ending.

H

handle(WebContext, AutocompleteHelper.ItemSearch) - Static method in class sirius.web.controller.AutocompleteHelper
Handles the given request and generates the appropriate JSON as expected by the select2 binding.
handle(ByteBuf, boolean) - Method in interface sirius.web.http.ContentHandler
Handles the given chunk of data.
handle(ByteBuf, boolean) - Method in class sirius.web.http.InputStreamHandler
 
handle(Throwable) - Static method in class sirius.web.security.UserContext
Handles the given exception by passing it to Exceptions and by creating an appropriate message for the user.
handle(String, Throwable) - Method in class sirius.web.services.ServiceCall
Handles the given exception by creating an error response.
handler(String) - Method in class sirius.web.templates.Templates.Generator
Specifies which ContentHandler is used to generate the content.
handleRow(int, SmartRow) - Method in interface sirius.web.templates.NamedRowProcessor
Called the handle a row of an input file.
handleRow(int, Values) - Method in interface sirius.web.templates.RowProcessor
Called the handle a row of an input file.
handleRow(int, Values) - Method in class sirius.web.templates.SmartLineBasedProcessor
 
hasContent() - Method in class sirius.web.http.WebContext
Determines if a content is available for this request.
hasError(String) - Method in class sirius.web.security.UserContext
Determines if there is an error or error message for the given field
hasFacets() - Method in class sirius.web.controller.Page
Determines if there is at least one filter facet with filter items.
hashCode() - Method in class sirius.web.templates.Resource
 
hashFunction - Variable in class sirius.web.security.GenericUserManager
 
hasItems() - Method in class sirius.web.controller.Facet
Determines if this facet has at least one item
hasKey(String) - Method in interface sirius.web.http.session.ServerSession
Determines if a key with the given name is already present.
hasLess() - Method in class sirius.web.controller.Page
Determines if there is a previous page.
hasMore() - Method in class sirius.web.controller.Page
Determines if there is a next page.
hasParameter(String) - Method in class sirius.web.http.WebContext
Determines if the parameter with the given name is contained in the request.
hasPermission(String) - Method in class sirius.web.controller.BasicController
Determines if the current user has the given permission.
hasPermission(String) - Method in class sirius.web.security.UserInfo
Determines if the user has the given permission.
hasPermissionOfSetting(String) - Method in class sirius.web.security.UserSettings
Determines if the current user has the permission given in the setting with the given key.
hasPermissions(String...) - Method in class sirius.web.security.UserInfo
Determines if the user has the requested permissions
hasResource(String) - Method in class sirius.web.templates.velocity.VelocityResourceLoader
Determines if the resource exists.
headers() - Method in class sirius.web.http.Response
 
headers(MultiMap<String, Object>) - Method in class sirius.web.http.Response
Adds all given headers
headers - Variable in class sirius.web.mails.Mails.MailSender
 
HelpDispatcher - Class in sirius.web.dispatch
Takes care of all /help URIs and sub-uris.
HelpDispatcher() - Constructor for class sirius.web.dispatch.HelpDispatcher
 
Helper - Annotation Type in sirius.web.security
Marks a field in a helper class as filled with another helper of the given type for the same scope.
HelperConfig - Annotation Type in sirius.web.security
Marks a field in a helper class as filled via the config of the current scope.
HelperFactory<H> - Interface in sirius.web.security
Helpers are used by the ScopeInfo to perform certain tasks.
hidePost - Variable in class sirius.web.http.WebContext
 
hidePost() - Method in class sirius.web.http.WebContext
Hide the fact that this request is a POST request.
hstsMaxAge - Static variable in class sirius.web.http.WebContext
 
html - Variable in class sirius.web.mails.Mails.MailSender
 
htmlContent(String) - Method in class sirius.web.mails.Mails.MailSender
Sets the HTML content of the email.
HTTP_CACHE - Static variable in class sirius.web.http.Response
Default cache duration for responses which can be cached
HTTP_CACHE_INFINITE - Static variable in class sirius.web.http.Response
Expires value used to indicate that a resource can be infinitely long cached
HTTP_DATE_FORMAT - Static variable in class sirius.web.http.WebContext
Date format used by HTTP date headers
HTTPCommand - Class in sirius.web.health.console
Console command which reports statistics for the web server
HTTPCommand() - Constructor for class sirius.web.health.console.HTTPCommand
 
HttpPipeliningHandler - Class in sirius.web.http
Adds support for HTTP pipelining by ensuring that only requests are passed on, after a response for the last request was sent.
HttpPipeliningHandler() - Constructor for class sirius.web.http.HttpPipeliningHandler
 

I

I18nResourceResolver - Class in sirius.web.templates.rythm
Adapter to make @i18n commands use NLS.get
I18nResourceResolver() - Constructor for class sirius.web.templates.rythm.I18nResourceResolver
 
idleTimeouts - Static variable in class sirius.web.http.WebServer
 
IMAGE_JPEG - Static variable in class sirius.web.http.MimeHelper
Mime type of JPEG images
IMAGE_PNG - Static variable in class sirius.web.http.MimeHelper
Mime type of PNG images
inc(String) - Method in interface sirius.web.tasks.ManagedTaskContext
Increments the given performance counter by one.
includeHTMLPart - Variable in class sirius.web.mails.Mails.MailSender
 
includeHTMLPart(boolean) - Method in class sirius.web.mails.Mails.MailSender
Determines whether the HTML part should be included in the email or not.
incPingFailures() - Method in class sirius.web.health.NodeInfo
Increment the ping failure counter.
infinitelyCached() - Method in class sirius.web.http.Response
Marks this response as infinitely cachable.
INFO - Static variable in class sirius.web.controller.Message
Declares a message as information.
info(String) - Static method in class sirius.web.controller.Message
Factory method to create a info message
info(WebContext) - Method in class sirius.web.health.SystemController
Reports useful information for the current user agent and request.
init(ExtendedProperties) - Method in class sirius.web.templates.velocity.VelocityResourceLoader
 
INITIAL_URI - Static variable in interface sirius.web.http.session.ServerSession
Fixed field used to store the initial URI used to create this session
initialize(RuntimeServices) - Method in class sirius.web.templates.velocity.VelocityResourceCache
 
inline(String) - Method in class sirius.web.http.Response
Instructs the browser to treat the response as inline-download with the given file name.
InputStreamHandler - Class in sirius.web.http
Default implementation of ContentHandler used by ControllerDispatcher.
InputStreamHandler() - Constructor for class sirius.web.http.InputStreamHandler
Creates a new handler with default settings for buffer size and timeouts.
InputStreamHandler(int, int, int, TimeUnit) - Constructor for class sirius.web.http.InputStreamHandler
Creates a new handler with the given buffer size and timeouts.
INSTANCE - Static variable in class sirius.web.templates.ContentHelper
Contains the instance which is passed into the velocity context as "helper".
Interceptor - Interface in sirius.web.controller
Can be used to intercept calls to controllers (Controller)
invalidate() - Method in interface sirius.web.http.session.ServerSession
Deletes this session.
invoke(StructuredService) - Method in class sirius.web.services.ServiceCall
Calls the given service.
IPRange - Class in sirius.web.http
Represents a range of IP addresses in CIDR notation.
IPRange() - Constructor for class sirius.web.http.IPRange
 
IPRange.RangeSet - Class in sirius.web.http
Represents a set of IP ranges.
IPV4_LOCALHOST - Static variable in class sirius.web.http.IPRange
Represents the IP address of the localhost in an IPv4 environment
IPV6_LOCALHOST - Static variable in class sirius.web.http.IPRange
Represents the IP address of the localhost in an IPv6 environment
is(Class<?>) - Method in class sirius.web.security.ScopeInfo
 
is(Class<?>) - Method in class sirius.web.security.UserInfo
 
isActionJavascript() - Method in class sirius.web.controller.Message
Determines if the action is an URL or a piece of JavaScript
isActive() - Method in class sirius.web.controller.FacetItem
Determines if this item is an currently active filter.
isAlternative() - Method in class sirius.web.mails.Attachment
Determines if this is an "alternative" to the text content of the mail or a "real" attachment
isAndroid() - Method in class sirius.web.http.session.UserAgent
Determines whether the user agent hints to an Android device.
isBestAvailableNode() - Method in class sirius.web.health.Cluster
Determines if the current node is the best (highest priority, still functional) cluster node.
isCompressable(String) - Static method in class sirius.web.http.MimeHelper
Determines if it is recommended to compress data of the given mime type.
isContentProbablyXML() - Method in class sirius.web.http.WebContext
Determines if the content body might contain XML (rather than JSON).
isCurrentRequestSSL() - Static method in class sirius.web.http.WebContext
Determines if the current request is secured by SSL.
isDesktop() - Method in class sirius.web.http.session.UserAgent
 
isEmpty() - Method in class sirius.web.http.IPRange.RangeSet
Determines if a filter range is given or not
isErroneous() - Method in interface sirius.web.tasks.ManagedTaskContext
Determines if the current task is erroneous
isFailed() - Method in class sirius.web.http.InputStreamHandler
Determines if this stream is in an ERROR state or not.
isIOS() - Method in class sirius.web.http.session.UserAgent
Determines whether the user agent hints to an iOS device.
isKeepLoginSupported() - Method in class sirius.web.security.GenericUserManager
 
isKeepLoginSupported() - Method in interface sirius.web.security.UserManager
Determines if the login can be stored longer than a usual session.
isLocked() - Method in interface sirius.web.security.MaintenanceInfo
Determines if this scope is currently locked / closed for maintenance or disaster reasons.
isLoggedIn() - Method in class sirius.web.security.UserInfo
Determines if the user is logged in.
isLoginSupported() - Method in class sirius.web.security.GenericUserManager
 
isLoginSupported() - Method in class sirius.web.security.PublicUserManager
 
isLoginSupported() - Method in class sirius.web.security.SSOUserManager
 
isLoginSupported() - Method in interface sirius.web.security.UserManager
Determines if a login via username and password is possible.
isLongCall() - Method in class sirius.web.http.WebContext
Determines if this request was marked as long call.
isMobile() - Method in class sirius.web.http.session.UserAgent
Determines whether the user agent hints to a mobile device.
isNew() - Method in interface sirius.web.http.session.ServerSession
Determines if the session is new.
isPhone() - Method in class sirius.web.http.session.UserAgent
Determines whether the user agent hints to a phone.
isPOST() - Method in class sirius.web.http.WebContext
Determines if the current request is a POST request.
isResponseCommitted() - Method in class sirius.web.http.WebContext
Determines if a response was already committed.
isSourceModified(Resource) - Method in class sirius.web.templates.velocity.VelocityResourceLoader
 
isSSL() - Method in class sirius.web.http.WebContext
Determines if this is an HTTPS (SSL protected) call.
isTablet() - Method in class sirius.web.http.session.UserAgent
Determines whether the user agent hints to a tablet.
isTemplateEndsWith(String) - Method in class sirius.web.templates.Templates.Generator
Can be used by a ContentHandler to determine the effective ending of the underlying template name.
isTemplateFileExtension(String) - Method in class sirius.web.templates.Templates.Generator
Can be used by a ContentHandler to determine the file ending of the selected template.
isTrusted() - Method in class sirius.web.http.WebContext
Determines if the request is from a trusted IP.
isUserAgentBot() - Method in interface sirius.web.http.session.ServerSession
Determines if the user agent which belongs to the session is likely a bot.
isUserAttached() - Method in interface sirius.web.http.session.ServerSession
Determines if a user is attached to the session.
isUserPresent() - Method in class sirius.web.security.UserContext
Determines if the user is present.
isUserStillValid(String) - Method in class sirius.web.security.GenericUserManager
Determines if the cached user object for the given ID is still valid.
isUseSenderAndEnvelopeFrom() - Method in class sirius.web.mails.Mails.DefaultSMTPConfig
 
isUseSenderAndEnvelopeFrom() - Method in interface sirius.web.mails.SMTPConfiguration
Determines if mails sent via this configuration use a "Sender" and "Envelope-From" header with the mail sender / senderName or not.
isValid() - Method in class sirius.web.http.WebContext
Determines if this context is attached to a request or not.
isValidMailAddress(String, String) - Method in class sirius.web.mails.Mails
Determines if the given address is a valid eMail address.

J

JavaScriptBasedContentHandler - Class in sirius.web.templates
Base class for ContentHandler implementations which rely on JavaScript.
JavaScriptBasedContentHandler() - Constructor for class sirius.web.templates.JavaScriptBasedContentHandler
 
JavaScriptContentHandler - Class in sirius.web.templates
Executes the given JavaScript script (most probably without generating any output).
JavaScriptContentHandler() - Constructor for class sirius.web.templates.JavaScriptContentHandler
 
JS - Static variable in class sirius.web.templates.JavaScriptContentHandler
Contains the name (type) of this handler
json() - Method in class sirius.web.http.Response
Creates a JSON output which can be used to generate well formed json.
JSONCall - Class in sirius.web.services
Simple call to send JSON to a server (URL) and receive JSON back.
JSONStructuredOutput - Class in sirius.web.services
Encoder to generate JSON via the StructuredOutput interface.
JSONStructuredOutput(OutputStream, String, String) - Constructor for class sirius.web.services.JSONStructuredOutput
Generates a new output, writing to the given output stream.
JSONStructuredOutput(Writer, String) - Constructor for class sirius.web.services.JSONStructuredOutput
Generates a new output, writing to the given writer.
JsXMLContentHandler - Class in sirius.web.templates
Generates XML output by evaluating a given JavaScript.
JsXMLContentHandler() - Constructor for class sirius.web.templates.JsXMLContentHandler
 

K

keepalives - Static variable in class sirius.web.http.WebServer
 
keepLoginEnabled - Variable in class sirius.web.security.GenericUserManager
 

L

lang - Variable in class sirius.web.mails.Mails.MailSender
 
LDAPUserManager - Class in sirius.web.security
Uses an LDAP directory to authenticate users.
LDAPUserManager(ScopeInfo, Extension) - Constructor for class sirius.web.security.LDAPUserManager
 
LDAPUserManager.Factory - Class in sirius.web.security
Used to create ldap user managers.
LIFECYCLE_PRIORITY - Static variable in class sirius.web.http.WebServer
Determines the priority of the start of the web server.
LineBasedProcessor - Class in sirius.web.templates
Processes line based input files like MS Excel or CSV.
LineBasedProcessor() - Constructor for class sirius.web.templates.LineBasedProcessor
 
LineBasedProcessor.XLSProcessor - Class in sirius.web.templates
In charge of processing XLS (MS Excel) files.
LOCALHOST - Static variable in class sirius.web.http.IPRange
Constant for a range which only accepts localhost.
LocalPathResolver - Class in sirius.web.templates
Tries to resolve a given path into a file locally stored on disk.
LocalPathResolver() - Constructor for class sirius.web.templates.LocalPathResolver
 
LOG - Static variable in class sirius.web.controller.ControllerDispatcher
 
LOG - Static variable in class sirius.web.crunchlog.Crunchlog
 
log(String) - Method in class sirius.web.crunchlog.Crunchlog
Creates a new builder to create a log message using fluid method calls.
LOG - Static variable in class sirius.web.health.Cluster
 
LOG - Static variable in class sirius.web.http.WebServer
Used to log all web / http relevant messages
LOG - Static variable in class sirius.web.mails.Mails
Contains the logger mail used by the mailing framework.
log(String, Object...) - Method in class sirius.web.security.GenericUserManager
Used to write a debug log.
LOG - Static variable in class sirius.web.security.UserContext
Contains the logger user used by the auth framework
LOG - Static variable in class sirius.web.services.ServiceCall
 
LOG - Static variable in class sirius.web.tasks.ManagedTasks
Contains the log being used by this framework
LOG - Static variable in class sirius.web.templates.Resources
 
LOG - Static variable in class sirius.web.templates.rythm.RythmConfig
Contains the logger for all rythm related output
LOG - Static variable in class sirius.web.templates.Templates
 
LogBuilder(String) - Constructor for class sirius.web.crunchlog.Crunchlog.LogBuilder
 
loginCookieTTL - Variable in class sirius.web.security.GenericUserManager
 
LoginRequired - Annotation Type in sirius.web.security
Boilerplate annotation for {@literal @}Permission(UserInfo.PERMISSION_LOGGED_IN).
logLimited(Object) - Method in interface sirius.web.tasks.ManagedTaskContext
Logs the given message unless the method is called to frequently.
logSentMail(boolean, String, String, String, String, String, String, String, String, String) - Method in interface sirius.web.mails.MailLog
Invoked once a mail was tried to be sent.

M

mailExtension - Variable in class sirius.web.mails.Mails.MailSender
 
MailLog - Interface in sirius.web.mails
Implementations of this interface can be registered in the component model and will be notified once a mail is tried to be sent.
Mails - Class in sirius.web.mails
Used to send mails using predefined templates.
Mails() - Constructor for class sirius.web.mails.Mails
 
Mails.DefaultSMTPConfig - Class in sirius.web.mails
Used as bridge between the given parameters and JavaMail
Mails.MailSender - Class in sirius.web.mails
Implements the builder pattern to specify the mail to send.
MailSender() - Constructor for class sirius.web.mails.Mails.MailSender
 
MaintenanceInfo - Interface in sirius.web.security
A ScopeInfo can additionally implement this interface to signal the current maintenance status of a scope.
maintenanceMessage() - Method in interface sirius.web.security.MaintenanceInfo
Returns a message to be shown to all users indicating the current maintenance state of the current scope.
make(ScopeInfo) - Method in interface sirius.web.security.HelperFactory
Creates a new helper for the given scope.
ManagedTask - Interface in sirius.web.tasks
A managed task is essentially a background job or task with some metadata attached.
ManagedTask.State - Enum in sirius.web.tasks
Enuemrates possible states of a task.
ManagedTaskContext - Interface in sirius.web.tasks
Provides an execution context for managed tasks.
ManagedTasks - Class in sirius.web.tasks
Executes background tasks which can be monitored via the user interface.
ManagedTasks() - Constructor for class sirius.web.tasks.ManagedTasks
 
managedTasks - Variable in class sirius.web.tasks.ManagedTaskSetup
 
ManagedTasksController - Class in sirius.web.tasks
Used to view and manage tasks.
ManagedTasksController() - Constructor for class sirius.web.tasks.ManagedTasksController
 
ManagedTaskSetup - Class in sirius.web.tasks
A builder pattern to create a ManagedTask.
ManagedTaskSetup(ManagedTasks, String) - Constructor for class sirius.web.tasks.ManagedTaskSetup
 
mark(int) - Method in class sirius.web.http.InputStreamHandler
 
markAsLongCall() - Method in class sirius.web.http.WebContext
Marks the request as long call.
markAsUserSession() - Method in interface sirius.web.http.session.ServerSession
Signals the system that this session belongs to a user which logged in.
markCallFailed(StructuredOutput, String) - Method in class sirius.web.services.ServiceCall
Marks the call as failed by adding the well known error, successfalse and message properties to the given output.
markCallSuccessful(StructuredOutput) - Method in class sirius.web.services.ServiceCall
Marks the call as failed by adding the well known error and successfalse properties to the given output.
markSupported() - Method in class sirius.web.http.InputStreamHandler
 
matches(InetAddress) - Method in class sirius.web.http.IPRange
Checks if the given IP is within the described ip range.
maxCallFrequency() - Method in class sirius.web.crunchlog.CrunchlogKernel
 
MDC_SCOPE - Static variable in class sirius.web.security.UserContext
The key used to store the current scope in the MDC
MDC_USER_ID - Static variable in class sirius.web.security.UserContext
The key used to store the current user id in the MDC
MDC_USER_NAME - Static variable in class sirius.web.security.UserContext
The key used to store the current user name in the MDC
MemorySessionStorage() - Constructor for class sirius.web.http.session.SessionManager.MemorySessionStorage
 
Message - Class in sirius.web.controller
Used by the UserContext to collect error or success messages.
Message(String, String, String) - Constructor for class sirius.web.controller.Message
Creates a new message with the given content, details info and message type.
message(Message) - Static method in class sirius.web.security.UserContext
Adds a message to the current UserContext.
messagesIn - Static variable in class sirius.web.http.WebServer
 
messagesOut - Static variable in class sirius.web.http.WebServer
 
metric(WebContext, String) - Method in class sirius.web.health.SystemController
Sends the value for the requested metric for /system/metric/[name]
microtimingKey - Variable in class sirius.web.http.WebContext
 
microtimingMode - Static variable in class sirius.web.http.WebServer
 
MimeHelper - Class in sirius.web.http
Guesses mime types based on file extensions.
monitorCluster(WebContext) - Method in class sirius.web.health.SystemController
Sends the current cluster state for /system/monitor/cluster
monitorNode(WebContext) - Method in class sirius.web.health.SystemController
Sends the current node state for /system/monitor

N

name - Variable in class sirius.web.tasks.ManagedTaskSetup
 
named(String) - Method in class sirius.web.http.Response
Forces the use of a given name.
NamedRowProcessor - Interface in sirius.web.templates
Invoked by a SmartLineBasedProcessor to handle one row.
NEW_ENTRY_NLS_KEY - Static variable in class sirius.web.controller.AutocompleteHelper
Can be used with NLS.get(String) to obtain a "(new)" text to be used in the "description" field
nl2br(String) - Method in class sirius.web.templates.ContentHelper
Replaces new line with <br> tags.
nlsTemplate(String, Object...) - Method in class sirius.web.http.Response
Tries to find an appropriate Rythm template for the current language and sends the output as response.
NO_FILTER - Static variable in class sirius.web.http.IPRange
Constant for a "non filtering" range set which accepts all IP addresses
NOBODY - Static variable in class sirius.web.security.UserInfo
Fallback user if no user is currently available.
NodeInfo - Class in sirius.web.health
Contains the state of a cluster member.
NodeInfo() - Constructor for class sirius.web.health.NodeInfo
 
NodeInfoService - Class in sirius.web.health
Provides statistics for this node.
NodeInfoService() - Constructor for class sirius.web.health.NodeInfoService
 
noKeepalive() - Method in class sirius.web.http.Response
Disables keep-alive protocol (even if it would have been otherwise supported).
notCached() - Method in class sirius.web.http.Response
Marks this response as not-cachable.
NotPermission - Annotation Type in sirius.web.security
Expects the absence of the given permission in oder to execute the annotated element.
NotPermissionList - Annotation Type in sirius.web.security
Container annotation for NotPermission annotations.

O

ok(WebContext) - Method in class sirius.web.health.SystemController
Simply responds with OK for /system/ok This can be used to monitoring tools the check the system health.
onComplete(Callback<CallContext>) - Method in class sirius.web.http.WebContext
Used to provide a handle which is invoked once the call is completely handled.
onError(WebContext, HandledException) - Method in class sirius.web.controller.BasicController
 
onError(WebContext, HandledException) - Method in interface sirius.web.controller.Controller
In case processing a request via a method fails (throws an exception), this method will be called.
onError(WebContext, HandledException) - Method in class sirius.web.templates.QRCodeController
 
onFrame(WebSocketFrame) - Method in class sirius.web.http.WebsocketSession
Invoked for each frame received via the websocket.
onWebsocketClosed() - Method in class sirius.web.http.WebsocketSession
Tirggered when the websocket is closed.
onWebsocketOpened() - Method in class sirius.web.http.WebsocketSession
Triggered when the websocket was sucessfully initialized.
openConnections - Static variable in class sirius.web.http.WebServer
 
openStream() - Method in class sirius.web.templates.Resource
Returns the contents of the resource as InputStream.
OTPVerifier - Class in sirius.web.security
Utility class to support two factor authentication (aka One Time Passwords).
OTPVerifier() - Constructor for class sirius.web.security.OTPVerifier
 
outputStream(HttpResponseStatus, String) - Method in class sirius.web.http.Response
Creates an OutputStream which is sent to the client.

P

Page<E> - Class in sirius.web.controller
Represents a slice of a result set which is being "paged through" and can provide filter facets.
Page() - Constructor for class sirius.web.controller.Page
 
paraseRangeSet(String) - Static method in class sirius.web.http.IPRange
Compiles the given list of ranges into a range set.
parent - Variable in class sirius.web.controller.Facet
 
parseRange(String) - Static method in class sirius.web.http.IPRange
Parses a CIDR expression and returns an IPRange
parseUserAgent() - Method in class sirius.web.http.session.UserAgent
 
PDF_VM - Static variable in class sirius.web.templates.velocity.VelocityPDFContentHandler
Contains the name (type) of this handler
Permission - Annotation Type in sirius.web.security
Expects the presence of the given permission in oder to execute the annotated element.
PERMISSION_ALL_TASKS - Static variable in class sirius.web.tasks.ManagedTasks
This permission needed to view all running tasks.
PERMISSION_BABELFISH - Static variable in class sirius.web.tools.TranslationController
Describes the permission required to view and export translations.
PERMISSION_LOGGED_IN - Static variable in class sirius.web.security.UserInfo
This permission represents a user which was successfully authenticated by its user manager.
PERMISSION_SYSTEM_CONSOLE - Static variable in class sirius.web.health.SystemController
Describes the permission required to access the system console.
PERMISSION_SYSTEM_NOTIFY_STATE - Static variable in class sirius.web.security.UserContext
Determines the permission required to be notified (see an error in the wondergem UI) when the system state goes to red.
PERMISSION_SYSTEM_SCRIPTING - Static variable in class sirius.web.tasks.ManagedTasksController
This permission is needed to access the scripting facility of the system.
PERMISSION_SYSTEM_STATE - Static variable in class sirius.web.health.SystemController
Describes the permission required to view the system state.
PERMISSION_VIEW_SCOPE_DEFAULT_CONFIG - Static variable in class sirius.web.security.ScopeDefaultConfigController
Describes the permission required to view the default scope config.
PermissionList - Annotation Type in sirius.web.security
Container annotation for Permission annotations.
Permissions - Class in sirius.web.security
Helper class to parse permission based annotations and the expand permission profiles.
pingSucceeded() - Method in class sirius.web.health.NodeInfo
Resets the ping failure counter and sets the lastPing value to now
postDecoder - Variable in class sirius.web.http.WebContext
 
preDispatch(WebContext) - Method in class sirius.web.controller.ControllerDispatcher
 
preDispatch(WebContext) - Method in class sirius.web.dispatch.AssetsDispatcher
 
preDispatch(WebContext) - Method in class sirius.web.dispatch.DefaultDispatcher
 
preDispatch(WebContext) - Method in class sirius.web.dispatch.HelpDispatcher
 
preDispatch(WebContext) - Method in interface sirius.web.http.WebDispatcher
Invoked as soon as the complete request but not its contents are available.
preDispatch(WebContext) - Method in class sirius.web.services.ServiceDispatcher
 
privateCached() - Method in class sirius.web.http.Response
Marks this response as only privately cachable (only the browser may cache it, but not a proxy etc.)
profilesCache - Static variable in class sirius.web.security.Permissions
 
publicRoles - Variable in class sirius.web.security.GenericUserManager
 
publicRoles - Static variable in class sirius.web.security.Permissions
 
PublicUserManager - Class in sirius.web.security
A simple user manager which always returns the same user with a defined set of roles.
PublicUserManager(ScopeInfo, Extension) - Constructor for class sirius.web.security.PublicUserManager
 
PublicUserManager.Factory - Class in sirius.web.security
Used to create public user managers.
put(String, Object) - Method in class sirius.web.templates.ScriptingContext
 
put(String, Object) - Method in class sirius.web.templates.Templates.Generator
Adds a variable with the given name (key) and value to the internal context.
put(Object, Resource) - Method in class sirius.web.templates.velocity.VelocityResourceCache
 
putValue(String, Object) - Method in interface sirius.web.http.session.ServerSession
Stores the given name value pair in the session.

Q

qr(WebContext) - Method in class sirius.web.templates.QRCodeController
Creates an QR code for the given content.
QRCodeController - Class in sirius.web.templates
Used to generate QR codes by responding to /qr
QRCodeController() - Constructor for class sirius.web.templates.QRCodeController
 

R

read() - Method in class sirius.web.http.InputStreamHandler
 
read(byte[], int, int) - Method in class sirius.web.http.InputStreamHandler
 
receiverEmail - Variable in class sirius.web.mails.Mails.MailSender
 
receiverName - Variable in class sirius.web.mails.Mails.MailSender
 
recordUserLogin(WebContext, UserInfo) - Method in class sirius.web.security.GenericUserManager
Provides a method which can track logins of users.
redirectPermanently(String) - Method in class sirius.web.http.Response
Sends a 301 (permanent redirect) to the given url as result.
redirectTemporarily(String) - Method in class sirius.web.http.Response
Sends a 307 (temporary redirect) or 302 (found) to the given url as result, depending on the given HTTP protocol in the request.
redirectToGet(String) - Method in class sirius.web.http.Response
Sends 302 (found) to the given url as result.
REMOTE_IP - Static variable in interface sirius.web.http.session.ServerSession
Fixed field storing the IP which was used to create the session
remove(Object) - Method in class sirius.web.templates.ScriptingContext
 
remove(Object) - Method in class sirius.web.templates.velocity.VelocityResourceCache
 
removeOpenConnection(WebServerHandler) - Static method in class sirius.web.http.WebServer
 
removeSession(MemoryServerSession) - Method in class sirius.web.http.session.SessionManager.MemorySessionStorage
 
removeValue(String) - Method in interface sirius.web.http.session.ServerSession
Deletes the stored value for the given key.
request - Variable in class sirius.web.http.WebContext
 
requests - Static variable in class sirius.web.http.WebServer
 
require(String...) - Method in class sirius.web.http.WebContext
Returns the value provided for the given key(s) or reports an error if no non empty value was found.
require(String...) - Method in class sirius.web.services.ServiceCall
Returns the value provided for the given key(s) or reports an error if no non empty value was found.
reset(WebContext) - Method in class sirius.web.health.SystemController
Clears the server and client session.
reset() - Method in class sirius.web.http.InputStreamHandler
 
resolve(String, String) - Method in class sirius.web.templates.ClasspathCustomizationResolver
 
resolve(String, String) - Method in class sirius.web.templates.ClasspathResolver
 
resolve(String, String) - Method in class sirius.web.templates.LocalPathResolver
 
resolve(String, String) - Method in interface sirius.web.templates.Resolver
Resolves the given resource into an URL.
resolve(String) - Method in class sirius.web.templates.Resources
Tries to resolve a template or content-file into a Resource
resolve(String, String) - Method in class sirius.web.templates.Resources
Tries to resolve a template or content-file into a Resource
resolve(String) - Method in class sirius.web.templates.velocity.VelocityResourceLoader
Resolves the given relative path into an URL.
Resolver - Interface in sirius.web.templates
Resolves a given resource name to an URL.
resource(URLConnection) - Method in class sirius.web.http.Response
Sends the given resource (potentially from classpath) as result.
Resource - Class in sirius.web.templates
Wraps an resolved URL as resource.
ResourceAttachment - Class in sirius.web.mails
Encapsulates all information required to add an attachment to a mail being sent.
ResourceAttachment(String, String, Resource, boolean) - Constructor for class sirius.web.mails.ResourceAttachment
Generates a new attachment with the given name, mime type and contents.
Resources - Class in sirius.web.templates
Resolves template names into URLs.
Resources() - Constructor for class sirius.web.templates.Resources
 
respondWith() - Method in class sirius.web.http.WebContext
Creates a response for this request.
Response - Class in sirius.web.http
Represents a response which is used to reply to a HTTP request.
Response(WebContext) - Constructor for class sirius.web.http.Response
Creates a new response for the given request.
responseCommitted - Variable in class sirius.web.http.WebContext
 
responseCompleted - Variable in class sirius.web.http.WebContext
 
responseTime - Static variable in class sirius.web.http.WebServer
 
Routed - Annotation Type in sirius.web.controller
Attaches a URI to a Controller method.
RowProcessor - Interface in sirius.web.templates
Invoked by a LineBasedProcessor to handle one row.
run(RowProcessor) - Method in class sirius.web.templates.LineBasedProcessor
Starts processing and sends each line to the given rowProcessor.
run(RowProcessor) - Method in class sirius.web.templates.LineBasedProcessor.XLSProcessor
 
runAs(UserInfo, Runnable) - Method in class sirius.web.security.UserContext
Executes the given section as the given user.
runTimer() - Method in class sirius.web.crunchlog.DeleteOldCrunchlogs
 
runTimer() - Method in class sirius.web.health.Cluster
 
runTimer() - Method in class sirius.web.http.session.SessionManager
 
runTimer() - Method in class sirius.web.http.WebServer.BandwidthUpdater
 
RythmConfig - Class in sirius.web.templates.rythm
Initializes and configures Rythm (http://www.rythmengine.org).
RythmConfig() - Constructor for class sirius.web.templates.rythm.RythmConfig
 
RythmExtension - Interface in sirius.web.templates.rythm
Defines an extension which provides auto-declared variables to Rythm templates.

S

safeLog(String, Callback<Crunchlog.LogBuilder>) - Method in class sirius.web.crunchlog.Crunchlog
Implements a safe way of logging to the crunchlog.
scope - Variable in class sirius.web.security.GenericUserManager
 
ScopeDefaultConfigController - Class in sirius.web.security
Provides a GUI to inspect the default config provided for all scopes.
ScopeDefaultConfigController() - Constructor for class sirius.web.security.ScopeDefaultConfigController
 
ScopeDetector - Interface in sirius.web.security
Detects the current ScopeInfo for a given request.
ScopeInfo - Class in sirius.web.security
Represents the scope the current call is being processed in.
ScopeInfo(String, String, String, String, Function<ScopeInfo, Config>, Function<ScopeInfo, Object>) - Constructor for class sirius.web.security.ScopeInfo
Creates a new ScopeInfo with the given parameters.
scriptEngine - Variable in class sirius.web.templates.JavaScriptBasedContentHandler
Can be used to tweak the scripting engine used.
scripting(WebContext) - Method in class sirius.web.tasks.ManagedTasksController
Displays the system scripting facility.
ScriptingContext - Class in sirius.web.templates
Simple adapter for ScriptContext (javax.scripting) and Context (Velocity).
ScriptingContext() - Constructor for class sirius.web.templates.ScriptingContext
 
scriptingExecute(WebContext, JSONStructuredOutput) - Method in class sirius.web.tasks.ManagedTasksController
Executes the given script.
search(String, Consumer<AutocompleteHelper.Completion>) - Method in interface sirius.web.controller.AutocompleteHelper.ItemSearch
 
send() - Method in class sirius.web.mails.Mails.MailSender
Sends the mail using the given settings.
sendContent(String) - Method in class sirius.web.http.Response
Tries to resolve the given name into a Resource using the Resources lookup framework.
senderEmail - Variable in class sirius.web.mails.Mails.MailSender
 
senderName - Variable in class sirius.web.mails.Mails.MailSender
 
sendMailAsync(SMTPConfiguration) - Method in class sirius.web.mails.Mails.MailSender
 
sendMessage(String) - Method in class sirius.web.http.WebsocketSession
Sents a given string as text frame to the client.
sendTemplateContent(HttpResponseStatus, String, String) - Method in class sirius.web.http.Response
 
serverErrors - Static variable in class sirius.web.http.WebServer
 
ServerSession - Interface in sirius.web.http.session
Represents a server sided session.
ServiceCall - Class in sirius.web.services
Provides access to the underlying request of a call to a StructuredService
ServiceCall(WebContext) - Constructor for class sirius.web.services.ServiceCall
 
ServiceDispatcher - Class in sirius.web.services
Dispatches calls to the JSON / XML Service-Framework (/service).
ServiceDispatcher() - Constructor for class sirius.web.services.ServiceDispatcher
 
SESSION_STORAGE_TYPE_CLIENT - Static variable in class sirius.web.security.GenericUserManager
Defines the name used to signal that the user should be stored in the client session (cookie)
SESSION_STORAGE_TYPE_SERVER - Static variable in class sirius.web.security.GenericUserManager
Defines the name used to signal that the user should be stored in the server session
SessionCommand - Class in sirius.web.http.session
Lists all server-sided sessions in the system console.
SessionCommand() - Constructor for class sirius.web.http.session.SessionCommand
 
sessionCreated(ServerSession) - Method in interface sirius.web.http.session.SessionListener
Notifies the listener, that a new session was created.
sessionInvalidated(ServerSession) - Method in interface sirius.web.http.session.SessionListener
Notifies the listener, that a new session was invalidated.
SessionListener - Interface in sirius.web.http.session
Listeners can be registered to be notified when a session was created or invalidated.
SessionManager - Class in sirius.web.http.session
Manages server-sided sessions generated by the WebServer.
SessionManager() - Constructor for class sirius.web.http.session.SessionManager
 
SessionManager.MemorySessionStorage - Class in sirius.web.http.session
Default implementation which uses heap based maps for session storage
SessionSecretComputer - Interface in sirius.web.http
Permits to compute a http session secret per user or per session.
SessionStorage - Interface in sirius.web.http.session
Can be used to change the behaviour of the session storage.
sessionStorage - Variable in class sirius.web.security.GenericUserManager
 
set(String, Object) - Method in class sirius.web.crunchlog.Crunchlog.LogBuilder
Sets a given field and value in the log entry.
setActive(boolean) - Method in class sirius.web.controller.FacetItem
Sets the active flag indicating if this is currently an active filter.
setAttribute(String, Object) - Method in class sirius.web.http.WebContext
Sets an attribute for the current request.
setBounceToken(String) - Method in class sirius.web.mails.Mails.MailSender
Sets a bounce token.
setClusterState(MetricState) - Method in class sirius.web.health.NodeInfo
Sets the state of the cluster as seen by this node.
setContentCharset(Charset) - Method in class sirius.web.http.WebContext
Sets the charset of the body of the request.
setContentHandler(ContentHandler) - Method in class sirius.web.http.WebContext
Can be set from within WebDispatcher.preDispatch(WebContext) to manually handle incoming content.
setCookie(Cookie) - Method in class sirius.web.http.WebContext
Sets the given cookie to be sent back to the client
setCookie(String, String, long) - Method in class sirius.web.http.WebContext
Sets a http only cookie value to be sent back to the client.
setCount(long) - Method in class sirius.web.controller.FacetItem
Sets the number of matches.
setCtx(ChannelHandlerContext) - Method in class sirius.web.http.WebContext
Sets the ChannelHandlerContext for this context.
setCurrentScope(ScopeInfo) - Method in class sirius.web.security.UserContext
Installs the given scope as current scope.
setCurrentUser(UserInfo) - Method in class sirius.web.security.UserContext
Installs the given user as current user.
setCustomSessionCookieTTL(Duration) - Method in class sirius.web.http.WebContext
Sets an explicit session cookie TTL (time to live).
setDescription(String) - Method in class sirius.web.controller.AutocompleteHelper.Completion
Sets the description for the suggestion
setEndpoint(String) - Method in class sirius.web.health.NodeInfo
Sets the endpoint of the node.
setErrorMessage(String, String) - Static method in class sirius.web.security.UserContext
Adds an error message for the given field
setFieldError(String, Object) - Static method in class sirius.web.security.UserContext
Adds a field error to the current UserContext.
setHeader(CharSequence, Object) - Method in class sirius.web.http.Response
Sets the specified header.
setHTTPSessionCookie(String, String) - Method in class sirius.web.http.WebContext
Sets a http only cookie value to be sent back to the client.
setKey(String) - Method in class sirius.web.controller.FacetItem
Sets the key or content represented by this item.
setLabel(String) - Method in class sirius.web.controller.AutocompleteHelper.Completion
Sets the label for the suggestion
setLang(String...) - Method in class sirius.web.mails.Mails.MailSender
Sets the language used to perform NLS lookups when rendering templates.
setLogWriter(Writer) - Method in interface sirius.web.tasks.ManagedTaskContext
Installs a writer into the running context which is supplied with all logged messages.
setMaxInactiveInterval(int) - Method in interface sirius.web.http.session.ServerSession
Overwrites the max. inactivity period allowed for this session.
setMicrotimingMode(WebServer.MicrotimingMode) - Static method in class sirius.web.http.WebServer
Changes the microtiming mode.
setName(String) - Method in class sirius.web.health.NodeInfo
Sets the name of the node
setNodeState(MetricState) - Method in class sirius.web.health.NodeInfo
Sets the state of the node.
setPriority(int) - Method in class sirius.web.health.NodeInfo
Sets the priority of the node.
setRequest(HttpRequest) - Method in class sirius.web.http.WebContext
Sets the underlying HttpRequest
setSessionCookie(String, String) - Method in class sirius.web.http.WebContext
Sets a cookie value to be sent back to the client The generated cookie will be a session cookie and varnish once the user agent is closed
setSessionValue(String, Object) - Method in class sirius.web.http.WebContext
Stores a value in the client session.
setTitle(String) - Method in class sirius.web.controller.FacetItem
Sets the title shown to the user when displaying this item.
setUptime(String) - Method in class sirius.web.health.NodeInfo
Sets the uptime of the node.
setValue(String) - Method in class sirius.web.controller.AutocompleteHelper.Completion
Sets the value for the suggestion
shouldExecuteRoute(WebContext, boolean, Controller) - Method in interface sirius.web.controller.Interceptor
Determines if a matched routing should be executed.
showDeletedMessage() - Method in class sirius.web.controller.BasicController
Displays a genric "Object was deleted" message.
showSavedMessage() - Method in class sirius.web.controller.BasicController
Displays a generic "Changes have been saved" message.
signalFieldError(String) - Method in class sirius.web.security.UserContext
Returns "has-error" if an error was added for the given field.
simulate - Variable in class sirius.web.mails.Mails.MailSender
 
simulate(boolean) - Method in class sirius.web.mails.Mails.MailSender
Sets the simulation flag.
sirius.web - package sirius.web
 
sirius.web.controller - package sirius.web.controller
Provides the controller part of a simple MVC framework.
sirius.web.crunchlog - package sirius.web.crunchlog
 
sirius.web.dispatch - package sirius.web.dispatch
Default dispatchers provided by the framework.
sirius.web.health - package sirius.web.health
System health monitoring Provides tools to collect metrics and to monitor a cluster of machines.
sirius.web.health.console - package sirius.web.health.console
Commands for the built-in console Contains commands for the web-based console (/system/console).
sirius.web.http - package sirius.web.http
Built-in HTTP server based on netty.
sirius.web.http.session - package sirius.web.http.session
Server sided session handling.
sirius.web.mails - package sirius.web.mails
 
sirius.web.security - package sirius.web.security
 
sirius.web.services - package sirius.web.services
Framework for providing structured services via the HTTP interface.
sirius.web.tasks - package sirius.web.tasks
 
sirius.web.templates - package sirius.web.templates
Provides access to various template engines which generate HTML, text or PDF files.
sirius.web.templates.rythm - package sirius.web.templates.rythm
 
sirius.web.templates.velocity - package sirius.web.templates.velocity
 
sirius.web.tools - package sirius.web.tools
 
size(String) - Method in interface sirius.web.templates.SmartRow
Retrieves the number of columns with the given name
skip(long) - Method in class sirius.web.http.InputStreamHandler
 
sleepMillis(long) - Method in interface sirius.web.tasks.ManagedTaskContext
Blocks the current task for the given number of milliseconds.
SmartLineBasedProcessor - Class in sirius.web.templates
Provides an additional processing step within a LineBasedProcessor to transform rows into maps.
SmartLineBasedProcessor() - Constructor for class sirius.web.templates.SmartLineBasedProcessor
 
SmartRow - Interface in sirius.web.templates
a row of a dataset that supports multiple same-named columns.
SMTPConfiguration - Interface in sirius.web.mails
Represents a configuration for using a SMTP server.
ssl - Variable in class sirius.web.http.WebContext
 
ssoEnabled - Variable in class sirius.web.security.GenericUserManager
 
ssoGraceInterval - Variable in class sirius.web.security.GenericUserManager
 
ssoSecret - Variable in class sirius.web.security.GenericUserManager
 
SSOUserManager - Class in sirius.web.security
Provides a user manager which only authenticates users by validating a single sign-on token.
SSOUserManager(ScopeInfo, Extension) - Constructor for class sirius.web.security.SSOUserManager
 
SSOUserManager.Factory - Class in sirius.web.security
Used to create sso user managers.
startArray(String) - Method in class sirius.web.services.JSONStructuredOutput
 
started() - Method in class sirius.web.crunchlog.CrunchlogKernel
 
started() - Method in class sirius.web.health.Cluster
 
started - Variable in class sirius.web.http.WebContext
 
started() - Method in class sirius.web.http.WebServer
 
started() - Method in class sirius.web.templates.rythm.RythmConfig
 
startObject(String, Attribute...) - Method in class sirius.web.services.JSONStructuredOutput
 
state(WebContext) - Method in class sirius.web.health.SystemController
Reports the system and cluster state.
status(HttpResponseStatus) - Method in class sirius.web.http.Response
Completes this response by sending the given status code without any content
stopped() - Method in class sirius.web.crunchlog.CrunchlogKernel
 
stopped() - Method in class sirius.web.health.Cluster
 
stopped() - Method in class sirius.web.http.WebServer
 
stopped() - Method in class sirius.web.templates.rythm.RythmConfig
 
storeRolesForUser(UserInfo, WebContext) - Method in class sirius.web.security.ConfigUserManager
 
storeRolesForUser(UserInfo, WebContext) - Method in class sirius.web.security.GenericUserManager
Stores the roles for the current user.
StructuredService - Interface in sirius.web.services
Provides a service which can be called via the HTTP interface and generate a structured output encoded as JSON or XML A StructuredService must be registered using the Register annotation provided with a name, which also defines the URL of the service.
subject - Variable in class sirius.web.mails.Mails.MailSender
 
subject(String) - Method in class sirius.web.mails.Mails.MailSender
Specifies the subject line of the mail.
submit() - Method in class sirius.web.crunchlog.Crunchlog.LogBuilder
Submits the constructed entry to the crunchlog.
submit(Context) - Method in class sirius.web.crunchlog.Crunchlog
Submits a record to the crunchlog which will be eventually persisted to disk.
SystemController - Class in sirius.web.health
Contains the default admin GUI.
SystemController() - Constructor for class sirius.web.health.SystemController
 

T

task(WebContext, String) - Method in class sirius.web.tasks.ManagedTasksController
Displays details to a running task
task - Variable in class sirius.web.tasks.ManagedTaskSetup
 
taskCancel(WebContext, JSONStructuredOutput, String) - Method in class sirius.web.tasks.ManagedTasksController
Cancels the given tasks as response to an AJAX call.
taskInfo(WebContext, JSONStructuredOutput, String) - Method in class sirius.web.tasks.ManagedTasksController
Displays details to a running task as JSON
TaskLogEntry - Class in sirius.web.tasks
Represents a log entry for a managed task.
TaskLogEntry(String, TaskLogEntry.LogType) - Constructor for class sirius.web.tasks.TaskLogEntry
Creates a new entry with the given message and type
TaskLogEntry.LogType - Enum in sirius.web.tasks
Represents the type of an entry
tasks(WebContext) - Method in class sirius.web.tasks.ManagedTasksController
Lists all active tasks
tasksAPI(WebContext, JSONStructuredOutput) - Method in class sirius.web.tasks.ManagedTasksController
Lists all active tasks as JSON
template(String, Object...) - Method in class sirius.web.http.Response
Renders the given Rythm template and sends the output as response.
template(HttpResponseStatus, String, Object...) - Method in class sirius.web.http.Response
Renders the given Rythm template and sends the output as response.
Templates - Class in sirius.web.templates
Content generator which generates output based on templates.
Templates() - Constructor for class sirius.web.templates.Templates
 
Templates.Generator - Class in sirius.web.templates
Used to generate content by either evaluating a template or directly supplied template code.
text - Variable in class sirius.web.mails.Mails.MailSender
 
TEXT_CSS - Static variable in class sirius.web.http.MimeHelper
Mime type of CSS files
TEXT_CSV - Static variable in class sirius.web.http.MimeHelper
Mime type of csv files
TEXT_HTML - Static variable in class sirius.web.http.MimeHelper
Mime type of HTML files
TEXT_JAVASCRIPT - Static variable in class sirius.web.http.MimeHelper
Mime type of javascript (JS) files
TEXT_PLAIN - Static variable in class sirius.web.http.MimeHelper
Mime type of plain text files
TEXT_XML - Static variable in class sirius.web.http.MimeHelper
Mime type of XML files
textContent(String) - Method in class sirius.web.mails.Mails.MailSender
Sets the text content of the email.
to(String, String) - Method in class sirius.web.mails.Mails.MailSender
 
to(URL) - Static method in class sirius.web.services.JSONCall
Creates a new JSONCall for the given url with Content-Type 'application/json'.
to(URL, String) - Static method in class sirius.web.services.JSONCall
Creates a new JSONCall for the given url.
toEmail(String) - Method in class sirius.web.mails.Mails.MailSender
Specifies the email address to send the mail to.
toName(String) - Method in class sirius.web.mails.Mails.MailSender
Specifies the name of the receiver.
toString() - Method in class sirius.web.controller.FacetItem
 
toString() - Method in class sirius.web.controller.Message
 
toString() - Method in class sirius.web.http.IPRange.RangeSet
 
toString() - Method in class sirius.web.http.IPRange
 
toString() - Method in class sirius.web.http.Response
 
toString() - Method in class sirius.web.http.WebContext
 
toString() - Method in enum sirius.web.tasks.ManagedTask.State
 
toString() - Method in class sirius.web.tasks.TaskLogEntry
 
toString() - Method in class sirius.web.templates.Resource
 
transformRoles(Collection<String>, boolean) - Method in class sirius.web.security.GenericUserManager
Applies profile transformations and adds default roles to the set of given roles.
TranslationController - Class in sirius.web.tools
Controller which provides admin tools for the translation engine.
TranslationController() - Constructor for class sirius.web.tools.TranslationController
 
trustedRoles - Variable in class sirius.web.security.GenericUserManager
 
tryAs(Class<A>) - Method in class sirius.web.security.ScopeInfo
 
tryAs(Class<A>) - Method in class sirius.web.security.UserInfo
 
tryBasicAuthentication(String) - Method in class sirius.web.http.WebContext
Tries to perform a HTTP Basic authentication by parsing the Authorization header.
tunnel(String) - Method in class sirius.web.http.Response
Tunnels the contents retrieved from the given URL as result of this response.
tunnel(String, Consumer<Integer>) - Method in class sirius.web.http.Response
Tunnels the contents retrieved from the given URL as result of this response.

U

unauthorized(String) - Method in class sirius.web.http.Response
Sends an 401 UNAUTHORIZED response with a WWW-Authenticate header for the given realm.
updateLoginCookie(WebContext, UserInfo) - Method in class sirius.web.security.GenericUserManager
Updates the lifetime of the login cooke if required.
useMailTemplate(String, Context) - Method in class sirius.web.mails.Mails.MailSender
Specifies the mail template to use.
USER - Static variable in interface sirius.web.http.session.ServerSession
Fixed field storing the name of the current user owning this session
USER_AGENT - Static variable in interface sirius.web.http.session.ServerSession
Fixed field containing the user agent used to request the initial url
UserAgent - Class in sirius.web.http.session
Provides information about user agent and used device for given user agent.
UserAgent(String) - Constructor for class sirius.web.http.session.UserAgent
 
userAgent - Variable in class sirius.web.http.WebContext
 
UserContext - Class in sirius.web.security
Used to access the current user and scope.
UserContext() - Constructor for class sirius.web.security.UserContext
 
userEventTriggered(ChannelHandlerContext, Object) - Method in class sirius.web.http.WebsocketHandler
 
UserInfo - Class in sirius.web.security
Represents an user.
UserInfo() - Constructor for class sirius.web.security.UserInfo
 
UserInfo.Builder - Class in sirius.web.security
Builder pattern to create a new UserInfo.
UserManager - Interface in sirius.web.security
Responsible for authentication and session management.
UserManagerFactory - Interface in sirius.web.security
Creates a new UserManager for a given ScopeInfo.
UserSettings - Class in sirius.web.security
Extends the ExtendedSettings wrapper by a boilerplate method to quickly check for a permission given in the settings.
UserSettings(Config) - Constructor for class sirius.web.security.UserSettings
Creates a new wrapper for the given config.
useTemplate(String) - Method in class sirius.web.templates.Templates.Generator
Determines which template file should be used.

V

valueOf(String) - Static method in enum sirius.web.http.WebContext.ServerSessionSource
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum sirius.web.http.WebServer.MicrotimingMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum sirius.web.tasks.ManagedTask.State
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum sirius.web.tasks.TaskLogEntry.LogType
Returns the enum constant of this type with the specified name.
values() - Static method in enum sirius.web.http.WebContext.ServerSessionSource
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum sirius.web.http.WebServer.MicrotimingMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum sirius.web.tasks.ManagedTask.State
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum sirius.web.tasks.TaskLogEntry.LogType
Returns an array containing the constants of this enum type, in the order they are declared.
VelocityContentHandler - Class in sirius.web.templates.velocity
Generates text output by evaluating a given velocity template.
VelocityContentHandler() - Constructor for class sirius.web.templates.velocity.VelocityContentHandler
 
VelocityHelper - Class in sirius.web.templates.velocity
Used to start our own Velocity instance so that we don't have to touch the global static one.
VelocityPDFContentHandler - Class in sirius.web.templates.velocity
Generates a PDF output by evaluating a given velocity template which must result in a valid XHTML dom.
VelocityPDFContentHandler() - Constructor for class sirius.web.templates.velocity.VelocityPDFContentHandler
 
VelocityResourceCache - Class in sirius.web.templates.velocity
Simple implementation of the resource cache as we might use complex lookups which are not reflected in the template name or url.
VelocityResourceCache() - Constructor for class sirius.web.templates.velocity.VelocityResourceCache
 
VelocityResourceLoader - Class in sirius.web.templates.velocity
Adapter to make Velocity use our Resolver framework.
VelocityResourceLoader() - Constructor for class sirius.web.templates.velocity.VelocityResourceLoader
 
VM - Static variable in class sirius.web.templates.velocity.VelocityContentHandler
Contains the name (type) of this handler

W

waitForForkedTasks() - Method in interface sirius.web.tasks.ManagedTaskContext
Blocks the current thread until all forked tasks have completed.
WARN - Static variable in class sirius.web.controller.Message
Declares a message as warning.
warn(String) - Static method in class sirius.web.controller.Message
Factory method to create a warning as message
warn(Object) - Method in interface sirius.web.tasks.ManagedTaskContext
Adds a warning to the task log.
WebContext - Class in sirius.web.http
Provides access to a request received by the WebServer.
WebContext() - Constructor for class sirius.web.http.WebContext
 
WebContext.ServerSessionSource - Enum in sirius.web.http
Used to specify the source of a server session
WebDispatcher - Interface in sirius.web.http
Participates in the dispatching process for incoming HTTP requests.
WebServer - Class in sirius.web.http
Responsible for setting up and starting netty as HTTP server.
WebServer() - Constructor for class sirius.web.http.WebServer
 
WebServer.BandwidthUpdater - Class in sirius.web.http
Updates the measured bandwidth of all open http(s) connections.
WebServer.MicrotimingMode - Enum in sirius.web.http
Determines how the web server should participate in the microtiming framework.
WebsocketDispatcher - Interface in sirius.web.http
Provides a way to support websockets for the built-in web server.
WebsocketHandler - Class in sirius.web.http
Inserted into the pipeline by the WebServerInitializer if an implementation of WebsocketDispatcher is present.
WebsocketHandler(WebsocketDispatcher) - Constructor for class sirius.web.http.WebsocketHandler
Creates a new handler (one per connection) talking to the given dispatcher.
websockets - Static variable in class sirius.web.http.WebServer
 
WebsocketSession - Class in sirius.web.http
Created per active websocket by a WebsocketDispatcher to handle incoming and outgoing traffic.
WebsocketSession(ChannelHandlerContext, HttpRequest) - Constructor for class sirius.web.http.WebsocketSession
Creates a new session for the given channel and request.
withAction(String, String) - Method in class sirius.web.controller.Message
Adds an action as URL to the message
withCategory(String) - Method in class sirius.web.tasks.ManagedTaskSetup
Used to specify the executor / category of the task.
withColumn(String, String...) - Method in class sirius.web.templates.SmartLineBasedProcessor
Registers a known column and possible aliases.
withContentType(String) - Method in class sirius.web.mails.Attachment
Updates the content type of the attachment.
withDuration(String) - Method in class sirius.web.controller.Page
Specifies the duration (as string) it took to compute (query) the page items.
withEmail(String) - Method in class sirius.web.security.UserInfo.Builder
Sets the email address of the user.
withFactes(List<Facet>) - Method in class sirius.web.controller.Page
Specifies the facets available to further filter the page (or underlying data source).
withFactesSupplier(Supplier<List<Facet>>) - Method in class sirius.web.controller.Page
Specifies the supplier used to compute the facets available to further filter the page (or underlying data source).
withHasMore(boolean) - Method in class sirius.web.controller.Page
Specifies the flag which indicates if "more" items are available.
withItems(List<E>) - Method in class sirius.web.controller.Page
Specifies the effective items this page contains.
withJavascriptAction(String, String) - Method in class sirius.web.controller.Message
Adds an action as URL to the message
withLang(String) - Method in class sirius.web.security.UserInfo.Builder
Sets the language code of the user.
withPageSize(int) - Method in class sirius.web.controller.Page
Specifies the number of items shown per page.
withPermissions(Set<String>) - Method in class sirius.web.security.UserInfo.Builder
Sets the permissions granted to the user.
withProcessor(NamedRowProcessor) - Method in class sirius.web.templates.SmartLineBasedProcessor
Attaches the processor which is supplied with a map of data per row in the input.
withQuery(String) - Method in class sirius.web.controller.Page
Specifies the query used to compute the result list.
withScope() - Method in class sirius.web.crunchlog.Crunchlog.LogBuilder
Adds the id of the current scope to the log entry.
withSettingsSupplier(Function<UserInfo, UserSettings>) - Method in class sirius.web.security.UserInfo.Builder
Sets a config supplier which can provide an individual configuration for the current user.
withStart(int) - Method in class sirius.web.controller.Page
Specifies the index of the first item.
withTenantId(String) - Method in class sirius.web.security.UserInfo.Builder
Sets the id of the tenant the user belongs to.
withTenantName(String) - Method in class sirius.web.security.UserInfo.Builder
Sets the name of the tenant the user belongs to.
withTotalItems(int) - Method in class sirius.web.controller.Page
Specifies the number of total items.
withURI(WebContext) - Method in class sirius.web.crunchlog.Crunchlog.LogBuilder
Adds the uri of the given request.
withURIAndUserAgent(WebContext) - Method in class sirius.web.crunchlog.Crunchlog.LogBuilder
Adds the uri and the user agent of the given request.
withUser() - Method in class sirius.web.crunchlog.Crunchlog.LogBuilder
Adds the id of the current user and tenant to the log entry.
withUsername(String) - Method in class sirius.web.security.UserInfo.Builder
Sets the name of the user.
withUserSupplier(Function<UserInfo, Object>) - Method in class sirius.web.security.UserInfo.Builder
Sets a user supplier which returns the underlying user object (e.g. a database entity).
withValue(String) - Method in class sirius.web.controller.Facet
Specifies the value used for this facet.
withValues(List<String>) - Method in class sirius.web.controller.Facet
Specifies the values used for this facet.
write(ChannelHandlerContext, Object, ChannelPromise) - Method in class sirius.web.http.HttpPipeliningHandler
 
writeProperty(String, Object) - Method in class sirius.web.services.JSONStructuredOutput
 
writeResponseTo(String, WebContext) - Method in class sirius.web.templates.ExcelExport
Writes the generated Excel file to the given web context.
writeToStream(OutputStream) - Method in class sirius.web.templates.ExcelExport
Writes the generated excel file to the given stream.

X

X_BOUNCETOKEN - Static variable in class sirius.web.mails.Mails
Defines a header which can be used to add a bounce token to an email.
XLSProcessor(InputStream, boolean) - Constructor for class sirius.web.templates.LineBasedProcessor.XLSProcessor
 
xml() - Method in class sirius.web.http.Response
Creates a XML output which can be used to generate well formed XML.
XML_JS - Static variable in class sirius.web.templates.JsXMLContentHandler
Contains the name (type) of this handler
A B C D E F G H I J K L M N O P Q R S T U V W X 

Copyright © 2017. All rights reserved.