Description

Configuration of a single path security setup.

Usages

Configuration options

KeyKindTypeDescription
auditVALUEBooleanWhether to audit this request - defaults to false, if enabled, request is audited with event type "request"
audit-event-typeVALUEStringOverride for event-type, defaults to SecurityHandler#DEFAULT_AUDIT_EVENT_TYPE
audit-message-formatVALUEStringOverride for audit message format, defaults to SecurityHandler#DEFAULT_AUDIT_MESSAGE_FORMAT
authenticateVALUEBooleanIf called, request will go through authentication process - defaults to false (even if authorize is true)
authentication-optionalVALUEBooleanIf called, authentication failure will not abort request and will continue as anonymous (defaults to false)
authenticatorVALUEStringUse a named authenticator (as supported by security - if not defined, default authenticator is used)
authorizeVALUEBooleanEnable authorization for this route
authorizerVALUEStringUse a named authorizer (as supported by security - if not defined, default authorizer is used, if none defined, all is permitted)
methodsLISTi.h.w.s.S.PathConfigCustomMethodsHTTP methods to match when applying this configured path
pathVALUEStringPath to secure
roles-allowedLISTStringAn array of allowed roles for this path - must have a security provider supporting roles (either authentication or authorization provider)
socketsLISTStringList of sockets this configuration should be applied to

See the manifest for all available types.