Index (Snook HTTP Server Utilities 0.4.1 API)

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

ACCESS_CONTROL_ALLOW_CREDENTIALS_HEADER - Static variable in class org.attribyte.snook.auth.CORSAuthenticator: The access control allow credentials header ("Access-Control-Allow-Credentials").
ACCESS_CONTROL_ALLOW_HEADERS_HEADER - Static variable in class org.attribyte.snook.auth.CORSAuthenticator: The access control allow headers header ("Access-Control-Allow-Headers").
ACCESS_CONTROL_ALLOW_METHODS_HEADER - Static variable in class org.attribyte.snook.auth.CORSAuthenticator: The access control allow methods header ("Access-Control-Allow-Methods").
ACCESS_CONTROL_ALLOW_ORIGIN_HEADER - Static variable in class org.attribyte.snook.auth.CORSAuthenticator: The access control allow origin header ("Access-Control-Allow-Origin").
ACCESS_CONTROL_EXPOSE_HEADERS_HEADER - Static variable in class org.attribyte.snook.auth.CORSAuthenticator: The access control expose headers header ("Access-Control-Expose-Headers").
ACCESS_CONTROL_MAX_AGE - Static variable in class org.attribyte.snook.auth.CORSAuthenticator: The access control max age header.
ACCESS_CONTROL_REQUEST_HEADERS_HEADER - Static variable in class org.attribyte.snook.auth.CORSAuthenticator: The access control request headers header ("Access-Control-Request-Headers").
addAllowDomain(String) - Method in class org.attribyte.snook.auth.CORSAuthenticator.Builder: Adds an allowed domain.
addAllowHost(String) - Method in class org.attribyte.snook.auth.CORSAuthenticator.Builder: Adds an allowed host.
addAuthorizedHeaders(HttpServletRequest, HttpServletResponse, Set<CORSAuthenticator.Option>) - Static method in class org.attribyte.snook.auth.CORSAuthenticator: Adds response headers for an authorized request.
addCookie(Cookie) - Method in class org.attribyte.snook.test.TestHttpServletResponse
addCredentials(String, int, HttpServletResponse) - Method in interface org.attribyte.snook.auth.CredentialsSupplier: Adds credentials to a response.
addCredentials(String, int, HttpServletResponse) - Method in class org.attribyte.snook.auth.HMACCookieSupplier
addCustomHeaders(Response) - Method in interface org.attribyte.snook.ErrorHandler.Writer: Adds custom headers to a response.
addDateHeader(String, long) - Method in class org.attribyte.snook.test.TestHttpServletResponse
addDenyDomain(String) - Method in class org.attribyte.snook.auth.CORSAuthenticator.Builder: Adds a denied domain.
addDenyHost(String) - Method in class org.attribyte.snook.auth.CORSAuthenticator.Builder: Adds a denied host.
addHeader(String, String) - Method in class org.attribyte.snook.test.TestHttpServletResponse
addHealthCheckServlet(HealthCheckRegistry, String) - Method in class org.attribyte.snook.Server: Adds a health check servlet to the server.
addIntHeader(String, int) - Method in class org.attribyte.snook.test.TestHttpServletResponse
addMetricsServlet(MetricRegistry, String) - Method in class org.attribyte.snook.Server: Adds a metrics reporting servlet at the specified path.
addStaticAssets(StaticAssetsConfig, String) - Method in class org.attribyte.snook.Server: Adds configuration to serve static assets for a path.
addStaticAssets(StaticAssetsConfig, List<String>) - Method in class org.attribyte.snook.Server: Adds configuration to serve static assets for a list of paths.
ADMIN - Static variable in enum class org.attribyte.snook.auth.Permission: Superuser/admin permission.
AllAuthenticator - Class in org.attribyte.snook.auth: Verify all authenticators in a sequence.
AllAuthenticator(List<Authenticator<?>>) - Constructor for class org.attribyte.snook.auth.AllAuthenticator
ALLOW_ANY_ORGIN - Enum constant in enum class org.attribyte.snook.auth.CORSAuthenticator.Option: Is any origin allowed?
ALLOW_CREDENTIALS - Enum constant in enum class org.attribyte.snook.auth.CORSAuthenticator.Option: Are credentials allowed?
ALLOW_HEADERS_PROP - Static variable in class org.attribyte.snook.auth.CORSAuthenticator: A property with a comma-separated list of hosts to allow ("allowHeaders").
ALLOW_METHODS_PROP - Static variable in class org.attribyte.snook.auth.CORSAuthenticator: A property with a comma-separated list of methods to allow ("allowMethods").
ALLOW_ORIGIN_DOMAIN_PROP - Static variable in class org.attribyte.snook.auth.CORSAuthenticator: A property with a comma-separated list of domains to allow ("allowOriginDomain").
ALLOW_ORIGIN_HOST_PROP - Static variable in class org.attribyte.snook.auth.CORSAuthenticator: A property with a comma-separated list of hosts to allow ("allowOriginHost").
ALLOW_SYMLINKS_PROPERTY - Static variable in class org.attribyte.snook.ServerConfiguration: The property to allow symlinks when searching for static assets ("allowSymlinks").
allowAll() - Method in class org.attribyte.snook.auth.CORSAuthenticator.Builder: Sets to allow all hosts.
AllowAllAuthenticator - Class in org.attribyte.snook.auth: An authenticator that allows all requests.
AllowAllAuthenticator(String) - Constructor for class org.attribyte.snook.auth.AllowAllAuthenticator: Creates an authenticator that allows all requests.
allowed(String) - Method in class org.attribyte.snook.auth.CORSAuthenticator: Determine if an origin is allowed.
allowSymlinks - Variable in class org.attribyte.snook.ServerConfiguration: Allow the use of symlinks when resolving static assets.
allProfiles() - Method in class org.attribyte.snook.auth.Groups: Gets a list of all profiles.
AnyAuthenticator - Class in org.attribyte.snook.auth: Verify authorized by any in a sequence.
AnyAuthenticator(List<Authenticator<?>>) - Constructor for class org.attribyte.snook.auth.AnyAuthenticator
authenticate(HttpServletRequest, String) - Method in class org.attribyte.snook.auth.GroupLoginAuthenticator: Authenticate for a specific group.
authenticate(HttpServletResponse) - Method in class org.attribyte.snook.test.TestHttpServletRequest
authenticatedPermission(String, String) - Method in class org.attribyte.snook.auth.GroupLoginAuthenticator
authenticatedPermission(String, String) - Method in class org.attribyte.snook.auth.PermissionAuthenticator: Gets permissions.
AuthenticationToken - Class in org.attribyte.snook.auth: An authentication token associated with a username.
AuthenticationToken(String) - Constructor for class org.attribyte.snook.auth.AuthenticationToken: Creates a random token.
AuthenticationToken(String, HashCode) - Constructor for class org.attribyte.snook.auth.AuthenticationToken: Creates a token.
AuthenticationToken(String, String) - Constructor for class org.attribyte.snook.auth.AuthenticationToken: Creates a token from a string.
Authenticator<T> - Interface in org.attribyte.snook.auth
authenticators - Variable in class org.attribyte.snook.auth.MultiAuthenticator: The list of authenticators.
authorizationHeader(String, String) - Static method in class org.attribyte.snook.auth.BasicAuthenticator: Creates the standard authorization header to send with a request.
authorized(HttpServletRequest) - Method in class org.attribyte.snook.auth.AllowAllAuthenticator
authorized(HttpServletRequest) - Method in class org.attribyte.snook.auth.AnyAuthenticator
authorized(HttpServletRequest) - Method in interface org.attribyte.snook.auth.Authenticator: Determine if a request is authorized.
authorized(HttpServletRequest) - Method in class org.attribyte.snook.auth.BCryptAuthenticator
authorized(HttpServletRequest) - Method in class org.attribyte.snook.auth.CORSAuthenticator
authorized(HttpServletRequest) - Method in class org.attribyte.snook.auth.DenyAllAuthenticator
authorized(HttpServletRequest) - Method in class org.attribyte.snook.auth.FirstAuthenticator
authorized(HttpServletRequest) - Method in class org.attribyte.snook.auth.GroupLoginAuthenticator
authorized(HttpServletRequest) - Method in class org.attribyte.snook.auth.HMACCookieAuthenticator
authorized(HttpServletRequest) - Method in class org.attribyte.snook.auth.MultiAuthenticator
authorizedUsername(HttpServletRequest) - Method in class org.attribyte.snook.auth.AllAuthenticator
authorizedUsername(HttpServletRequest) - Method in class org.attribyte.snook.auth.AllowAllAuthenticator
authorizedUsername(HttpServletRequest) - Method in class org.attribyte.snook.auth.AnyAuthenticator
authorizedUsername(HttpServletRequest) - Method in interface org.attribyte.snook.auth.Authenticator: Gets the authorized username.
authorizedUsername(HttpServletRequest) - Method in class org.attribyte.snook.auth.BasicAuthenticator
authorizedUsername(HttpServletRequest) - Method in class org.attribyte.snook.auth.BasicBCryptAuthenticator
authorizedUsername(HttpServletRequest) - Method in class org.attribyte.snook.auth.BearerAuthenticator
authorizedUsername(HttpServletRequest) - Method in class org.attribyte.snook.auth.CookieAuthenticator
authorizedUsername(HttpServletRequest) - Method in class org.attribyte.snook.auth.CORSAuthenticator
authorizedUsername(HttpServletRequest) - Method in class org.attribyte.snook.auth.DenyAllAuthenticator
authorizedUsername(HttpServletRequest) - Method in class org.attribyte.snook.auth.FirstAuthenticator
authorizedUsername(HttpServletRequest) - Method in class org.attribyte.snook.auth.GroupLoginAuthenticator
authorizedUsername(HttpServletRequest) - Method in class org.attribyte.snook.auth.HMACCookieAuthenticator
authorizePreFlightRequest(HttpServletRequest, HttpServletResponse, Set<CORSAuthenticator.Option>) - Method in class org.attribyte.snook.auth.CORSAuthenticator: Authorize (or not) a pre-flight request.
authorizeRequest(HttpServletRequest, HttpServletResponse, Set<CORSAuthenticator.Option>) - Method in class org.attribyte.snook.auth.CORSAuthenticator: Authorize (or not) a CORS request.

B

base64Encoding - Static variable in interface org.attribyte.snook.auth.Authenticator: Base64 encoding.
BasicAuthenticator<T> - Class in org.attribyte.snook.auth: Authenticator for 'Basic' auth.
BasicAuthenticator(Set<HashCode>, Function<String, HashCode>) - Constructor for class org.attribyte.snook.auth.BasicAuthenticator: Creates the authenticator.
BasicAuthenticator(Users) - Constructor for class org.attribyte.snook.auth.BasicAuthenticator: Creates an authenticator that uses *hashed tokens* from a credentials file.
BasicBCryptAuthenticator<T> - Class in org.attribyte.snook.auth: Authenticator for 'Basic' auth with password stored with BCrypt.
BasicBCryptAuthenticator(Cache<HashCode, Boolean>, Function<String, String>) - Constructor for class org.attribyte.snook.auth.BasicBCryptAuthenticator: Creates an authenticator.
BasicBCryptAuthenticator(Cache<HashCode, Boolean>, Users) - Constructor for class org.attribyte.snook.auth.BasicBCryptAuthenticator: Creates an authenticator from a credentials file.
BCryptAuthenticator<T> - Class in org.attribyte.snook.auth: An authenticator that checks username + password against a stored BCrypt hash.
BCryptAuthenticator(Cookies.CookieKey, Function<HashCode, String>, ImmutableMap<String, HashCode>, Function<AuthenticationToken, Boolean>) - Constructor for class org.attribyte.snook.auth.BCryptAuthenticator: Creates the authenticator with a map that contains valid password hashes.
BCryptAuthenticator(Cookies.CookieKey, Function<HashCode, String>, Function<String, HashCode>, Function<AuthenticationToken, Boolean>) - Constructor for class org.attribyte.snook.auth.BCryptAuthenticator: Creates the authenticator.
bcryptHashes - Variable in class org.attribyte.snook.auth.Users: An immutable map of BCrypt hash vs username.
BearerAuthenticator<T> - Class in org.attribyte.snook.auth: Authenticator for 'Bearer' auth.
BearerAuthenticator(Function<HashCode, String>) - Constructor for class org.attribyte.snook.auth.BearerAuthenticator: Creates an authenticator with an authentication function.
BearerAuthenticator(Map<HashCode, String>) - Constructor for class org.attribyte.snook.auth.BearerAuthenticator: Creates an authenticator from a map of credentials.
BearerAuthenticator(Map<HashCode, String>, Function<HashCode, String>) - Constructor for class org.attribyte.snook.auth.BearerAuthenticator: Creates an authenticator with a map of credentials (used first) as well as an authentication function.
BearerAuthenticator(Users) - Constructor for class org.attribyte.snook.auth.BearerAuthenticator: Creates an authenticator from a credentials file.
booleanAuthenticator(Cache<HashCode, Boolean>, Function<String, String>) - Static method in class org.attribyte.snook.auth.BasicBCryptAuthenticator: Creates a boolean authenticator.
booleanAuthenticator(Cache<HashCode, Boolean>, Users) - Static method in class org.attribyte.snook.auth.BasicBCryptAuthenticator: Creates a boolean authenticator.
booleanAuthenticator(String, Function<HashCode, String>) - Static method in class org.attribyte.snook.auth.TokenAuthenticator: Creates a boolean authenticator.
booleanAuthenticator(String, Map<HashCode, String>) - Static method in class org.attribyte.snook.auth.TokenAuthenticator: Creates a boolean authenticator.
booleanAuthenticator(String, Map<HashCode, String>, Function<HashCode, String>) - Static method in class org.attribyte.snook.auth.TokenAuthenticator: Creates a boolean authenticator.
booleanAuthenticator(String, Users) - Static method in class org.attribyte.snook.auth.TokenAuthenticator: Creates a boolean authenticator.
booleanAuthenticator(Function<HashCode, String>) - Static method in class org.attribyte.snook.auth.BearerAuthenticator: Creates a boolean authenticator.
booleanAuthenticator(Map<HashCode, String>) - Static method in class org.attribyte.snook.auth.BearerAuthenticator: Creates a boolean authenticator.
booleanAuthenticator(Map<HashCode, String>, Function<HashCode, String>) - Static method in class org.attribyte.snook.auth.BearerAuthenticator: Creates a boolean authenticator.
booleanAuthenticator(Set<HashCode>, Function<String, HashCode>) - Static method in class org.attribyte.snook.auth.BasicAuthenticator: Creates a boolean authenticator.
booleanAuthenticator(Users) - Static method in class org.attribyte.snook.auth.BasicAuthenticator: Creates a boolean authenticator.
booleanAuthenticator(Users) - Static method in class org.attribyte.snook.auth.BearerAuthenticator: Creates a boolean authenticator.
booleanAuthenticator(Cookies.CookieKey, Function<HashCode, String>, ImmutableMap<String, HashCode>, Function<AuthenticationToken, Boolean>) - Static method in class org.attribyte.snook.auth.BCryptAuthenticator
booleanAuthenticator(Cookies.CookieKey, Function<HashCode, String>, Function<String, HashCode>, Function<AuthenticationToken, Boolean>) - Static method in class org.attribyte.snook.auth.BCryptAuthenticator
booleanAuthenticator(Cookies.CookieKey, Function<String, HashFunction>) - Static method in class org.attribyte.snook.auth.HMACCookieAuthenticator
booleanAuthenticator(Cookies.CookieKey, Function<String, HashFunction>, BiFunction<String, String, Boolean>, Function<String, String>) - Static method in class org.attribyte.snook.auth.HMACCookieLoginAuthenticator
booleanAuthenticator(Cookies.CookieKey, Function<String, HashFunction>, BiFunction<String, String, Boolean>, Function<String, String>, EnumSet<Cookies.Option>) - Static method in class org.attribyte.snook.auth.HMACCookieLoginAuthenticator
booleanAuthenticator(Cookies.CookieKey, Map<HashCode, String>, Function<HashCode, String>) - Static method in class org.attribyte.snook.auth.CookieAuthenticator
boostEcl - Variable in class org.attribyte.snook.QRCode.Options
border - Variable in class org.attribyte.snook.QRCode.Options: The border.
BOTH - Enum constant in enum class org.attribyte.snook.ServerConfiguration.ConnectionSecurity: Both secure and insecure connections allowed.
build() - Method in class org.attribyte.snook.auth.CORSAuthenticator.Builder: Builds an immutable authenticator.
build() - Method in class org.attribyte.snook.QRCode.Options.Builder: Builds immutable options.
buildCredentials(String, String) - Static method in class org.attribyte.snook.auth.BasicAuthenticator: Merge a username and password into a single credentials string.
builder() - Static method in class org.attribyte.snook.auth.CORSAuthenticator: Creates an empty builder with defaults.
builder() - Static method in class org.attribyte.snook.QRCode.Options: Creates a new options builder with pre-set defaults.
builder(String[]) - Static method in class org.attribyte.snook.Server: Creates a builder that loads properties from command line arguments.
builder(Properties) - Static method in class org.attribyte.snook.Server: Creates a builder that uses pre-built properties.
Builder() - Constructor for class org.attribyte.snook.auth.CORSAuthenticator.Builder
Builder() - Constructor for class org.attribyte.snook.QRCode.Options.Builder
builderFromMap(Map<String, String>) - Static method in class org.attribyte.snook.QRCode.Options: Creates a builder from a map of (string) parameters.
buildServer() - Method in class org.attribyte.snook.ServerConfiguration: Builds a server instance form this configuration.

C

CACHE_CONTROL_HEADER_PROPERTY - Static variable in class org.attribyte.snook.StaticAssetsConfig: The property that configures the cache control header value ("cacheControl").
cacheControl - Variable in class org.attribyte.snook.StaticAssetsConfig: If non-empty, this Cache-Control header is added to every response.
cacheControlHeader - Variable in class org.attribyte.snook.ErrorHandler: The value sent with the cache control header.
canCreate(HttpServletRequest, String) - Method in class org.attribyte.snook.auth.PermissionAuthenticator: Check for an authorized user and if the user has create permission.
canDelete(HttpServletRequest, String) - Method in class org.attribyte.snook.auth.PermissionAuthenticator: Check for an authorized user and if the user has delete permission.
canRead(HttpServletRequest, String) - Method in class org.attribyte.snook.auth.PermissionAuthenticator: Check for an authorized user and if the user has read permission.
canUpdate(HttpServletRequest, String) - Method in class org.attribyte.snook.auth.PermissionAuthenticator
canWrite(HttpServletRequest, String) - Method in class org.attribyte.snook.auth.PermissionAuthenticator: Check for an authorized user and if the user has update permission.
changeSessionId() - Method in class org.attribyte.snook.test.TestHttpServletRequest
checkKeysFile(HashCode, File, byte[]) - Static method in class org.attribyte.snook.auth.HMACToken: Checks the hash of a keys file for changes.
checkPassword(String, HashCode) - Static method in class org.attribyte.snook.auth.BCryptAuthenticator: Check a password against a hash code.
checkSigFile(File, File, byte[]) - Static method in class org.attribyte.snook.auth.HMACToken: Checks the signature of a keys file.
clear() - Method in class org.attribyte.snook.session.Session: Clears all data.
clearAllCachedCredentials() - Method in class org.attribyte.snook.auth.BasicBCryptAuthenticator: Clears all cached credentials.
clearCachedCredentials(HashCode) - Method in class org.attribyte.snook.auth.BasicBCryptAuthenticator: Clears cached credentials for a hash.
clearCachedCredentials(HttpServletRequest) - Method in class org.attribyte.snook.auth.BasicBCryptAuthenticator: Clears cached credentials after matching the request credentials.
clearExpired(int) - Method in class org.attribyte.snook.session.InMemorySessions
clearExpired(int) - Method in class org.attribyte.snook.session.Sessions: Clear expired tokens.
clientAcceptsHTML(HttpServletRequest) - Static method in class org.attribyte.snook.HTTPUtil: Determines if the client accepts text/html.
command(HttpServletRequest) - Method in class org.attribyte.snook.CommandServlet: The command followed by a list of arguments.
command(HttpServletRequest) - Method in class org.attribyte.snook.UptimeServlet
commandLineParameters(String[], Map<String, String>) - Static method in class org.attribyte.snook.Util: Removes arguments like -username=test from a command line and adds them to a map.
commandLineParameters(String, String[], Map<String, String>) - Static method in class org.attribyte.snook.Util: Removes arguments like --debug=true from a command line and adds them to a map.
CommandServlet - Class in org.attribyte.snook: A servlet that executes commands and returns the console output as the response.
CommandServlet(int) - Constructor for class org.attribyte.snook.CommandServlet: Creates a command servlet with defaults.
CommandServlet(String, int, int) - Constructor for class org.attribyte.snook.CommandServlet: Creates a command servlet.
configure(Properties) - Static method in class org.attribyte.snook.log.Log4jConfigurator: Configures log4j2 from properties.
CONNECTION_SECURITY_PROPERTY - Static variable in class org.attribyte.snook.ServerConfiguration: The connection security property name ("connectionSecurity").
connectionSecurity - Variable in class org.attribyte.snook.ServerConfiguration: The configured connection security.
containsHeader(String) - Method in class org.attribyte.snook.test.TestHttpServletResponse
contentType() - Method in interface org.attribyte.snook.ErrorHandler.Writer: The content type for this writer.
cookie(String) - Method in class org.attribyte.snook.Cookies.CookieKey: Creates a (mutable) cookie with this key.
cookie(String, HttpServletRequest) - Static method in class org.attribyte.snook.Cookies: Gets the first named cookie.
CookieAuthenticator<T> - Class in org.attribyte.snook.auth: Authenticator where a token is sent as the value of a cookie.
CookieAuthenticator(Cookies.CookieKey, Map<HashCode, String>, Function<HashCode, String>) - Constructor for class org.attribyte.snook.auth.CookieAuthenticator: Creates the authenticator.
cookieKey - Variable in class org.attribyte.snook.auth.CookieAuthenticator: The cookie key.
cookieKey - Variable in class org.attribyte.snook.auth.HMACCookieAuthenticator: The cookie key
cookieKey - Variable in class org.attribyte.snook.auth.HMACCookieSupplier: The cookie key
cookieKey - Variable in class org.attribyte.snook.session.Sessions: The session cookie key.
CookieKey(Cookie) - Constructor for class org.attribyte.snook.Cookies.CookieKey: Creates a cookie key from an existing cookie.
CookieKey(String) - Constructor for class org.attribyte.snook.Cookies.CookieKey: Creates a key that applies to any path for the current domain.
CookieKey(String, String, String) - Constructor for class org.attribyte.snook.Cookies.CookieKey: Creates a key.
cookieOptions - Variable in class org.attribyte.snook.session.Sessions: The cookie options.
cookies - Variable in class org.attribyte.snook.test.TestHttpServletResponse: A list of added cookies.
Cookies - Class in org.attribyte.snook: "Cookie" operations.
Cookies() - Constructor for class org.attribyte.snook.Cookies
Cookies.CookieKey - Class in org.attribyte.snook: A key that uniquely identifies a cookie.
Cookies.Option - Enum Class in org.attribyte.snook: Cookie options.
Cookies.SameSiteOption - Enum Class in org.attribyte.snook: Cookie "same site" options.
cookieValue(String, HttpServletRequest) - Static method in class org.attribyte.snook.Cookies: Gets the value of the first named cookie.
CORSAuthenticator - Class in org.attribyte.snook.auth: An authenticator for CORS (the Origin header value) that returns the authorized host as the username, if authorized.
CORSAuthenticator(Collection<String>, Collection<String>, Collection<String>, Collection<String>, boolean, String, String, String, String) - Constructor for class org.attribyte.snook.auth.CORSAuthenticator: Creates the origin auth.
CORSAuthenticator(Properties) - Constructor for class org.attribyte.snook.auth.CORSAuthenticator: Creates origin auth from properties.
CORSAuthenticator.Builder - Class in org.attribyte.snook.auth: Builds immutable instances of the authenticator.
CORSAuthenticator.Option - Enum Class in org.attribyte.snook.auth: CORS options.
CREATE - Enum constant in enum class org.attribyte.snook.auth.Permission: Permission to create.
createCookie(Cookies.CookieKey, String, int, EnumSet<Cookies.Option>) - Static method in class org.attribyte.snook.Cookies: Creates a cookie.
createCookie(Cookies.CookieKey, String, int, EnumSet<Cookies.Option>, Cookies.SameSiteOption) - Static method in class org.attribyte.snook.Cookies: Creates a cookie.
createDefault() - Static method in class org.attribyte.snook.auth.TOTP: Creates an instance with defaults (30s, 6 digits).
createdMillis - Variable in class org.attribyte.snook.session.Session: The time the session was created.
createEightDigit() - Static method in class org.attribyte.snook.auth.TOTP: Creates a eight digit instance with the default time step.
createEightDigit(int) - Static method in class org.attribyte.snook.auth.TOTP: Creates a eight digit instance with a specified time step.
createSessionCookie(Cookies.CookieKey, String, EnumSet<Cookies.Option>) - Static method in class org.attribyte.snook.Cookies: Creates a session (temporary) cookie.
createSessionCookie(Cookies.CookieKey, String, EnumSet<Cookies.Option>, Cookies.SameSiteOption) - Static method in class org.attribyte.snook.Cookies: Creates a session (temporary) cookie with a same-site option.
createSixDigit() - Static method in class org.attribyte.snook.auth.TOTP: Creates a six digit instance with the default time step.
createSixDigit(int) - Static method in class org.attribyte.snook.auth.TOTP: Creates a six digit instance with a specified time step.
credentialHasher - Static variable in interface org.attribyte.snook.auth.Authenticator: The default hash function for credentials.
credentials(HttpServletRequest) - Method in class org.attribyte.snook.auth.AllowAllAuthenticator
credentials(HttpServletRequest) - Method in interface org.attribyte.snook.auth.Authenticator: Gets the credentials from the request.
credentials(HttpServletRequest) - Method in class org.attribyte.snook.auth.CookieAuthenticator
credentials(HttpServletRequest) - Method in class org.attribyte.snook.auth.CORSAuthenticator
credentials(HttpServletRequest) - Static method in class org.attribyte.snook.auth.Credentials: Gets credentials from the 'Authorization' header in a servlet request.
credentials(HttpServletRequest) - Method in class org.attribyte.snook.auth.DenyAllAuthenticator
credentials(HttpServletRequest) - Method in class org.attribyte.snook.auth.GroupLoginAuthenticator
credentials(HttpServletRequest) - Method in class org.attribyte.snook.auth.HeaderAuthenticator: Gets the credentials from the request.
credentials(HttpServletRequest) - Method in class org.attribyte.snook.auth.HMACCookieAuthenticator
credentials(HttpServletRequest) - Method in class org.attribyte.snook.auth.MultiAuthenticator
credentials(String) - Static method in class org.attribyte.snook.auth.Credentials: Creates credentials from a header value of the format [scheme] [credentials].
credentials(String, HttpServletRequest) - Static method in class org.attribyte.snook.auth.HeaderAuthenticator: Gets the credentials from the default (Authorization) header.
credentials(String, String, HttpServletRequest) - Static method in class org.attribyte.snook.auth.HeaderAuthenticator: Gets the credentials from the request.
Credentials - Class in org.attribyte.snook.auth
Credentials(String, String) - Constructor for class org.attribyte.snook.auth.Credentials: Creates credentials.
credentialsHeader() - Method in class org.attribyte.snook.auth.HeaderAuthenticator: The header (name) that contains credentials.
credentialsHeader() - Method in class org.attribyte.snook.auth.TokenAuthenticator
CredentialsSupplier - Interface in org.attribyte.snook.auth
currentToken(SecretKey) - Method in class org.attribyte.snook.auth.TOTP: The current token.

D

darkColor - Variable in class org.attribyte.snook.QRCode.Options: The dark color.
debug - Variable in class org.attribyte.snook.Server: Is the server running in "debug" mode?
debug - Variable in class org.attribyte.snook.ServerConfiguration: Is "debug" mode configured?
debug(String) - Method in class org.attribyte.snook.log.Log4jLogger
DEBUG_PROPERTY - Static variable in class org.attribyte.snook.ServerConfiguration: The "debug" mode property name ("debug").
DEBUG_SYSTEM_PROP - Static variable in class org.attribyte.snook.Server: The system property name that holds the debug flag ("server.debug").
DEFAULT - Static variable in class org.attribyte.snook.QRCode.Options: The default options.
DEFAULT_ADDRESS - Static variable in class org.attribyte.snook.ShutdownMonitor: The default listen address loopback.
DEFAULT_ALLOW_METHODS - Static variable in class org.attribyte.snook.auth.CORSAuthenticator: The default methods to allow.
DEFAULT_ALLOW_SYMLINKS - Static variable in class org.attribyte.snook.ServerConfiguration: The default value for allowing symlinks (false).
DEFAULT_BCRYPT_ROUNDS - Static variable in class org.attribyte.snook.auth.Users: The default number of bcrypt rounds.
DEFAULT_BOOST_ECL - Static variable in class org.attribyte.snook.QRCode: The default ECL boost (true).
DEFAULT_BORDER - Static variable in class org.attribyte.snook.QRCode: The default border (10).
DEFAULT_BYTE_COUNT - Static variable in class org.attribyte.snook.auth.TOTP: The default number of bytes when a key is encoded with the default character count (20).
DEFAULT_CACHE_CONTROL_HEADER - Static variable in class org.attribyte.snook.ErrorHandler: "must-revalidate,no-cache,no-store"
DEFAULT_CHARACTER_COUNT - Static variable in class org.attribyte.snook.auth.TOTP: The default number of characters in the key encoded for a URL (32).
DEFAULT_CHARSET - Static variable in class org.attribyte.snook.ErrorHandler: The default charset.
DEFAULT_CONNECTION_SECURITY - Static variable in class org.attribyte.snook.ServerConfiguration: The default value for connection security ("none").
DEFAULT_CONTENT_TYPE - Static variable in class org.attribyte.snook.CommandServlet: The default content type ("text/plain").
DEFAULT_COOKIE_OPTIONS - Static variable in class org.attribyte.snook.auth.HMACCookieSupplier: The default cookie options to be set with the authentication token cookie.
DEFAULT_DARK - Static variable in class org.attribyte.snook.QRCode: The default dark color (0).
DEFAULT_DARK_TRANSPARENT - Static variable in class org.attribyte.snook.QRCode: The default dark color ().
DEFAULT_DEBUG_MODE - Static variable in class org.attribyte.snook.ServerConfiguration: The default "debug" mode (false).
DEFAULT_IDLE_TIMEOUT - Static variable in class org.attribyte.snook.ServerConfiguration: The default value for idle timeout ("30s").
DEFAULT_LIGHT - Static variable in class org.attribyte.snook.QRCode: The default light color (16777215).
DEFAULT_LISTEN_IP - Static variable in class org.attribyte.snook.ServerConfiguration: The default value for the listen IP "127.0.0.1".
DEFAULT_LISTEN_PORT - Static variable in class org.attribyte.snook.ServerConfiguration: The default listen port 8081.
DEFAULT_LOGIN_FAILED_GROUPS - Static variable in class org.attribyte.snook.auth.GroupLoginAuthenticator: The list of group profiles returned on failed login.
DEFAULT_MASK - Static variable in class org.attribyte.snook.QRCode: The default mask (-1).
DEFAULT_MAX_AGE - Static variable in class org.attribyte.snook.auth.CORSAuthenticator: The defaut value for max age.
DEFAULT_MAX_FORM_CONTENT_SIZE - Static variable in class org.attribyte.snook.ServerConfiguration: The default value for the maximum form content size (10000000).
DEFAULT_MAX_REQUEST_HEADER_SIZE - Static variable in class org.attribyte.snook.ServerConfiguration: The default value for the maximum request header size (8192).
DEFAULT_MAX_RESPONSE_HEADER_SIZE - Static variable in class org.attribyte.snook.ServerConfiguration: The default value for the maximum response header size (8192).
DEFAULT_MAX_VERSION - Static variable in class org.attribyte.snook.QRCode: The default maximum version (40).
DEFAULT_MAX_WAIT_SECONDS - Static variable in class org.attribyte.snook.CommandServlet: The default number of seconds to wait for the command to finish (15).
DEFAULT_MIN_VERSION - Static variable in class org.attribyte.snook.QRCode: The default minimum version (1).
DEFAULT_NUM_DIGITS - Static variable in class org.attribyte.snook.auth.TOTP: The default number of digits (6).
DEFAULT_OUTPUT_BUFFER_SIZE - Static variable in class org.attribyte.snook.ServerConfiguration: The default value for the output buffer size (32768).
DEFAULT_PARAMETER_START - Static variable in class org.attribyte.snook.Util: The default string that starts a parameter ("-").
DEFAULT_PORT - Static variable in class org.attribyte.snook.ShutdownMonitor: The default port 8079.
DEFAULT_SAME_SITE_OPTION - Static variable in class org.attribyte.snook.session.Sessions: The default same-site option for the session cookie ().
DEFAULT_SCALE - Static variable in class org.attribyte.snook.QRCode: The default scale (4).
DEFAULT_SECURE_LISTEN_PORT - Static variable in class org.attribyte.snook.ServerConfiguration: The default listen port for secure connections 8443.
DEFAULT_SEND_DATE_HEADER - Static variable in class org.attribyte.snook.ServerConfiguration: The default value for sending the date header (false).
DEFAULT_SEND_SERVER_VERSION - Static variable in class org.attribyte.snook.ServerConfiguration: The default value for sending the server version (false).
DEFAULT_TIME_STEP_SECONDS - Static variable in class org.attribyte.snook.auth.TOTP: The default time stamp in seconds (30).
DEFAULT_TRANSPARENT_BACKGROUND - Static variable in class org.attribyte.snook.QRCode: The default transparent background (false).
defaultCharset(String) - Static method in class org.attribyte.snook.ErrorHandler: Gets the default charset for a content type.
DELETE - Enum constant in enum class org.attribyte.snook.auth.Permission: Permission to delete.
DENY_ORIGIN_DOMAIN_PROP - Static variable in class org.attribyte.snook.auth.CORSAuthenticator: A property with a comma-separated list of domains to deny ("denyOriginDomain").
DENY_ORIGIN_HOST_PROP - Static variable in class org.attribyte.snook.auth.CORSAuthenticator: A property with a comma-separated list of hosts to deny ("denyOriginHost").
DenyAllAuthenticator<T> - Class in org.attribyte.snook.auth: An authenticator that excludes all requests.
DenyAllAuthenticator() - Constructor for class org.attribyte.snook.auth.DenyAllAuthenticator
destroy() - Method in class org.attribyte.snook.CommandServlet
DIRECTORY_ALLOWED_PROPERTY - Static variable in class org.attribyte.snook.StaticAssetsConfig: The property that indicates if directory listing is allowed ("directoryAllowed").
directoryAllowed - Variable in class org.attribyte.snook.StaticAssetsConfig: Are directory listings allowed?
disable() - Method in class org.attribyte.snook.auth.GroupProfile: Disable this permission.
disableServletName() - Method in class org.attribyte.snook.ErrorHandler: Creates an error handler with servlet name disabled.
disableStackTrace() - Method in class org.attribyte.snook.ErrorHandler: Creates an error handler with stack trace disabled.
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.attribyte.snook.CommandServlet
doLogin(String, String, int, HttpServletResponse) - Method in class org.attribyte.snook.auth.BCryptAuthenticator: Performs a login.
doLogin(String, String, int, HttpServletResponse) - Method in class org.attribyte.snook.auth.GroupLoginAuthenticator
doLogin(String, String, int, HttpServletResponse) - Method in class org.attribyte.snook.auth.HMACCookieLoginAuthenticator
doLogin(String, String, int, HttpServletResponse) - Method in interface org.attribyte.snook.auth.LoginAuthenticator: Performs a login.
doLogout(HttpServletResponse) - Method in class org.attribyte.snook.auth.BCryptAuthenticator
doLogout(HttpServletResponse) - Method in class org.attribyte.snook.auth.GroupLoginAuthenticator
doLogout(HttpServletResponse) - Method in class org.attribyte.snook.auth.HMACCookieLoginAuthenticator
doLogout(HttpServletResponse) - Method in interface org.attribyte.snook.auth.LoginAuthenticator: Performs a logout, if possible.
domain - Variable in class org.attribyte.snook.Cookies.CookieKey: The domain.
domain(String) - Static method in class org.attribyte.snook.Util: Gets the (top, private) domain for the link.
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.attribyte.snook.CommandServlet

E

ecc - Variable in class org.attribyte.snook.QRCode.Options: The ECC level.
EMPTY - Static variable in class org.attribyte.snook.auth.Origin: The empty origin.
ENABLE_FORWARDED_REQUEST_CUSTOMIZER_PROPERTY - Static variable in class org.attribyte.snook.ServerConfiguration: The property name for the enable forwarded request cusomizer flag ("enableForwardedRequestCustomizer".
enabled - Variable in class org.attribyte.snook.auth.GroupProfile: Is the permission enabled?
enableForwardedRequestCustomizer - Variable in class org.attribyte.snook.ServerConfiguration: Is the forwarded request customizer enabled?
enableServletName() - Method in class org.attribyte.snook.ErrorHandler: Creates an error handler with servlet name enabled.
enableStackTrace() - Method in class org.attribyte.snook.ErrorHandler: Creates an error handler with stack trace enabled.
encodeKey(SecretKey) - Method in class org.attribyte.snook.auth.TOTP: Encodes a secret key in the format required for a URL.
encodeRedirectURL(String) - Method in class org.attribyte.snook.test.TestHttpServletResponse
encodeURL(String) - Method in class org.attribyte.snook.test.TestHttpServletResponse
equals(Object) - Method in class org.attribyte.snook.auth.AuthenticationToken
equals(Object) - Method in class org.attribyte.snook.auth.Credentials
equals(Object) - Method in class org.attribyte.snook.auth.HMACToken
equals(Object) - Method in class org.attribyte.snook.auth.Origin
equals(Object) - Method in class org.attribyte.snook.Cookies.CookieKey
error(String) - Method in class org.attribyte.snook.log.Log4jLogger
error(String, Throwable) - Method in class org.attribyte.snook.log.Log4jLogger
errorHandler(ErrorHandler) - Method in class org.attribyte.snook.Server.Builder: Sets a custom error handler.
ErrorHandler - Class in org.attribyte.snook: An error handler that enables custom responses with any content type.
ErrorHandler() - Constructor for class org.attribyte.snook.ErrorHandler: Creates an error handler with default values.
ErrorHandler(String, ErrorHandler.Writer, boolean, boolean, Logger, Collection<Map.Entry<String, ErrorHandler.Writer>>) - Constructor for class org.attribyte.snook.ErrorHandler: Creates an error handler with a list of overrides.
ErrorHandler(String, ErrorHandler.Writer, boolean, Logger, Collection<Map.Entry<String, ErrorHandler.Writer>>) - Constructor for class org.attribyte.snook.ErrorHandler: Creates an error handler with a list of overrides.
ErrorHandler(String, ErrorHandler.Writer, boolean, Logger, Map<String, ErrorHandler.Writer>) - Constructor for class org.attribyte.snook.ErrorHandler: Creates an error handler with a map of overrides.
ErrorHandler.Writer - Interface in org.attribyte.snook: Writes an error message.
etags - Variable in class org.attribyte.snook.StaticAssetsConfig: Are weak ETags generated and handled?
ETAGS_PROPERTY - Static variable in class org.attribyte.snook.StaticAssetsConfig: The property that indicates if weak Etags are enabled by default ("etags").
ExampleServer - Class in org.attribyte.snook
ExampleServer(String[]) - Constructor for class org.attribyte.snook.ExampleServer
expireTimestampSeconds - Variable in class org.attribyte.snook.auth.HMACToken: The expiration timestamp.
EXPOSE_HEADERS_PROP - Static variable in class org.attribyte.snook.auth.CORSAuthenticator: A property with a comma-separated list of hosts to expose ("exposeHeaders").

F

FailServlet - Class in org.attribyte.snook: An example servlet that always throws a RuntimeException.
FailServlet() - Constructor for class org.attribyte.snook.FailServlet
findGroup(String, Collection<GroupProfile>) - Method in class org.attribyte.snook.auth.GroupLoginAuthenticator: Finds a matching group profile.
FirstAuthenticator - Class in org.attribyte.snook.auth: Use the first authenticator in a sequence where credentials are present.
FirstAuthenticator(List<Authenticator<?>>) - Constructor for class org.attribyte.snook.auth.FirstAuthenticator
flushBuffer() - Method in class org.attribyte.snook.test.TestHttpServletResponse
fromProperties(Properties) - Static method in class org.attribyte.snook.auth.CORSAuthenticator: Creates an authenticator from properties, if configured.
fromString(String) - Static method in enum class org.attribyte.snook.auth.Permission: Converts a string to a permission.
fromString(String) - Static method in enum class org.attribyte.snook.ServerConfiguration.ConnectionSecurity: Create connection security from a string.

G

generate(String, OutputStream) - Static method in class org.attribyte.snook.QRCode: Generates a QR code (as a PNG) with default values.
generate(String, QRCode.Options) - Static method in class org.attribyte.snook.QRCode: Generate a QR code to an immutable byte string.
generate(String, QRCode.Options, OutputStream) - Static method in class org.attribyte.snook.QRCode: Generates a QR code (as a PNG) with custom options.
generateFiles(File, File, File, boolean) - Static method in class org.attribyte.snook.auth.Users: Generate a secure and insecure file from an input file.
generateFiles(InputStream, File, File, boolean) - Static method in class org.attribyte.snook.auth.Users: Generate a secure and insecure file from an input stream.
generateHex(String, QRCode.Options) - Static method in class org.attribyte.snook.QRCode: Generates a QR code encoded as base64.
generateImageData(String, QRCode.Options) - Static method in class org.attribyte.snook.QRCode: Generates the value for display as an HTML img.src attribute.
generateKey() - Method in class org.attribyte.snook.auth.TOTP: Generates a secret key with the default size.
generateKey(int) - Method in class org.attribyte.snook.auth.TOTP: Generates a secret key with a specified number of characters when encoded for a URI.
generateKeyBytes(int) - Method in class org.attribyte.snook.auth.TOTP: Generates a secret key with a specified number of bytes.
generateKeys(int) - Static method in class org.attribyte.snook.auth.HMACToken: Generate a map of random keys.
generateKeys(File, int) - Static method in class org.attribyte.snook.auth.HMACToken: Generates a key file.
get(HashCode) - Method in class org.attribyte.snook.session.InMemorySessions
get(HashCode) - Method in class org.attribyte.snook.session.Sessions: Gets a session for a token.
get(String) - Method in class org.attribyte.snook.session.Session: Gets a session value.
get(String, T) - Method in class org.attribyte.snook.session.Session: Gets a session value or a default if none set.
getAsyncContext() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getAttribute(String) - Method in class org.attribyte.snook.test.TestHttpServletRequest
getAttributeNames() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getAuthType() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getBorder() - Method in class org.attribyte.snook.QRCode.Options.Builder
getBufferSize() - Method in class org.attribyte.snook.test.TestHttpServletResponse
getCause(Request) - Static method in class org.attribyte.snook.ErrorHandler: Gets the cause, if available.
getCharacterEncoding() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getCharacterEncoding() - Method in class org.attribyte.snook.test.TestHttpServletResponse
getContentLength() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getContentLengthLong() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getContentType() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getContentType() - Method in class org.attribyte.snook.test.TestHttpServletResponse
getContextPath() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getCookies() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getDarkColor() - Method in class org.attribyte.snook.QRCode.Options.Builder
getDateHeader(String) - Method in class org.attribyte.snook.test.TestHttpServletRequest
getDispatcherType() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getDisplayName() - Method in class org.attribyte.snook.auth.GroupProfile
getEcc() - Method in class org.attribyte.snook.QRCode.Options.Builder
getHeader(String) - Method in class org.attribyte.snook.test.TestHttpServletRequest
getHeader(String) - Method in class org.attribyte.snook.test.TestHttpServletResponse
getHeaderNames() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getHeaderNames() - Method in class org.attribyte.snook.test.TestHttpServletResponse
getHeaders(String) - Method in class org.attribyte.snook.test.TestHttpServletRequest
getHeaders(String) - Method in class org.attribyte.snook.test.TestHttpServletResponse
getInputStream() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getIntHeader(String) - Method in class org.attribyte.snook.test.TestHttpServletRequest
getLightColor() - Method in class org.attribyte.snook.QRCode.Options.Builder
getLocalAddr() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getLocale() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getLocale() - Method in class org.attribyte.snook.test.TestHttpServletResponse
getLocales() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getLocalName() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getLocalPort() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getMask() - Method in class org.attribyte.snook.QRCode.Options.Builder
getMaxVersion() - Method in class org.attribyte.snook.QRCode.Options.Builder
getMethod() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getMetrics() - Method in class org.attribyte.snook.session.Sessions
getMinVersion() - Method in class org.attribyte.snook.QRCode.Options.Builder
getOutputStream() - Method in class org.attribyte.snook.test.TestHttpServletResponse
getParameter(String) - Method in class org.attribyte.snook.test.TestHttpServletRequest
getParameterMap() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getParameterNames() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getParameterValues(String) - Method in class org.attribyte.snook.test.TestHttpServletRequest
getPart(String) - Method in class org.attribyte.snook.test.TestHttpServletRequest
getParts() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getPathInfo() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getPathTranslated() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getProtocol() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getProtocolRequestId() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getQueryString() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getReader() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getRemoteAddr() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getRemoteHost() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getRemotePort() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getRemoteUser() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getRequestDispatcher(String) - Method in class org.attribyte.snook.test.TestHttpServletRequest
getRequestedSessionId() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getRequestId() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getRequestURI() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getRequestURL() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getScale() - Method in class org.attribyte.snook.QRCode.Options.Builder
getScheme() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getServerName() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getServerPort() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getServletConnection() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getServletContext() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getServletName(Request) - Static method in class org.attribyte.snook.ErrorHandler: Gets the servlet name.
getServletPath() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getSession() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getSession(boolean) - Method in class org.attribyte.snook.test.TestHttpServletRequest
getStackTrace(Throwable) - Static method in class org.attribyte.snook.ErrorHandler: Gets the stack trace as a string.
getStatus() - Method in class org.attribyte.snook.test.TestHttpServletResponse
getUserPrincipal() - Method in class org.attribyte.snook.test.TestHttpServletRequest
getWriter() - Method in class org.attribyte.snook.test.TestHttpServletResponse
GLOBAL_GROUP_NAME - Static variable in class org.attribyte.snook.auth.GroupProfile: The name of the global group ("*").
Global Properties - Search tag in class org.attribyte.snook.log.Log4jConfigurator: Section
GroupLoginAuthenticator - Class in org.attribyte.snook.auth: A login authenticator that returns groups/permissions for a user.
GroupLoginAuthenticator(LoginAuthenticator<?>) - Constructor for class org.attribyte.snook.auth.GroupLoginAuthenticator: Creates a group login authenticator.
groupName - Variable in class org.attribyte.snook.auth.GroupProfile: The group name.
GroupProfile - Class in org.attribyte.snook.auth: Immutable group permissions for a user.
GroupProfile(String, String, Set<Permission>, boolean, long, Map<String, String>) - Constructor for class org.attribyte.snook.auth.GroupProfile: Creates a group permission.
GroupProfile(String, String, Set<Permission>, Map<String, String>) - Constructor for class org.attribyte.snook.auth.GroupProfile: Creates an enabled group permission.
groups() - Method in class org.attribyte.snook.auth.Groups: Gets an immutable set of all group names.
Groups - Class in org.attribyte.snook.auth: User groups with permission-per-user.
Groups(File) - Constructor for class org.attribyte.snook.auth.Groups: Create groups from a group file.
Groups(InputStream) - Constructor for class org.attribyte.snook.auth.Groups: Create groups from an input stream (in the group file format).
Groups(Collection<GroupProfile>) - Constructor for class org.attribyte.snook.auth.Groups: Creates the groups from a collection of profiles.
groupsForUser(String) - Method in class org.attribyte.snook.auth.GroupLoginAuthenticator: Gets group membership for an authenticated user.
gzip - Variable in class org.attribyte.snook.StaticAssetsConfig: Is gzip enabled?
GZIP_PROPERTY - Static variable in class org.attribyte.snook.StaticAssetsConfig: The property that indicates if gzip is enabled by default ("gzip").

H

handle(Request, Response, Callback) - Method in class org.attribyte.snook.ErrorHandler
hasAdminPermission() - Method in class org.attribyte.snook.auth.GroupProfile
hasGlobalAdminPermission() - Method in class org.attribyte.snook.auth.GroupProfile
hasGlobalReadPermission() - Method in class org.attribyte.snook.auth.GroupProfile
hasGlobalWritePermission() - Method in class org.attribyte.snook.auth.GroupProfile
hashCode() - Method in class org.attribyte.snook.auth.AuthenticationToken
hashCode() - Method in class org.attribyte.snook.auth.Credentials
hashCode() - Method in class org.attribyte.snook.auth.HMACToken
hashCode() - Method in class org.attribyte.snook.auth.Origin
hashCode() - Method in class org.attribyte.snook.Cookies.CookieKey
hashCredentials() - Method in class org.attribyte.snook.auth.Credentials: Returns a secure hash of the credentials (value - hash excludes the scheme).
hashCredentials(String) - Static method in interface org.attribyte.snook.auth.Authenticator: Securely hash the credentials.
hashKeysFile(File, byte[]) - Static method in class org.attribyte.snook.auth.HMACToken: Hash the keys file.
hasReadPermission() - Method in class org.attribyte.snook.auth.GroupProfile
hasWritePermission() - Method in class org.attribyte.snook.auth.GroupProfile
HeaderAuthenticator<T> - Class in org.attribyte.snook.auth: Authenticate based on the value of an HTTP header.
HeaderAuthenticator() - Constructor for class org.attribyte.snook.auth.HeaderAuthenticator
headerName - Variable in class org.attribyte.snook.auth.TokenAuthenticator: The header name.
headers - Variable in class org.attribyte.snook.test.TestHttpServletResponse: A map of headers.
HIGH - Enum constant in enum class org.attribyte.snook.QRCode.ECC: High error correction.
HMACCookieAuthenticator<T> - Class in org.attribyte.snook.auth: An authenticator that validates an HMACToken sent as a cookie value.
HMACCookieAuthenticator(Cookies.CookieKey, Function<String, HashFunction>) - Constructor for class org.attribyte.snook.auth.HMACCookieAuthenticator: Creates an authenticator.
HMACCookieLoginAuthenticator<T> - Class in org.attribyte.snook.auth: An authenticator that validates an HMACToken sent as a cookie value.
HMACCookieLoginAuthenticator(Cookies.CookieKey, Function<String, HashFunction>, BiFunction<String, String, Boolean>, Function<String, String>) - Constructor for class org.attribyte.snook.auth.HMACCookieLoginAuthenticator: Creates an authenticator.
HMACCookieLoginAuthenticator(Cookies.CookieKey, Function<String, HashFunction>, BiFunction<String, String, Boolean>, Function<String, String>, EnumSet<Cookies.Option>) - Constructor for class org.attribyte.snook.auth.HMACCookieLoginAuthenticator: Creates an authenticator.
HMACCookieSupplier - Class in org.attribyte.snook.auth
HMACCookieSupplier(Cookies.CookieKey, Function<String, HashFunction>, Function<String, String>) - Constructor for class org.attribyte.snook.auth.HMACCookieSupplier: Creates an authenticator.
HMACCookieSupplier(Cookies.CookieKey, Function<String, HashFunction>, Function<String, String>, EnumSet<Cookies.Option>) - Constructor for class org.attribyte.snook.auth.HMACCookieSupplier: Creates an authenticator.
hmacFunctions - Variable in class org.attribyte.snook.auth.HMACCookieAuthenticator: A map of (keyed) HMAC function vs key id.
HMACToken - Class in org.attribyte.snook.auth: Generates HMAC keys and perform verification.
HMACToken(String, int, TimeUnit) - Constructor for class org.attribyte.snook.auth.HMACToken: Creates a token with a lifetime.
host() - Method in class org.attribyte.snook.auth.Origin: The host or an empty string if EMPTY.
host(String) - Static method in class org.attribyte.snook.Util: Gets the host for a link.
HTML_WRITER - Static variable in class org.attribyte.snook.ErrorHandler
htmlWriter() - Method in class org.attribyte.snook.ErrorHandler: Selects the HTML writer.
HTTP_ONLY - Enum constant in enum class org.attribyte.snook.Cookies.Option: Cookie is not accessible to browser scripts.
httpPort - Variable in class org.attribyte.snook.ServerConfiguration: The port this server is listening on.
httpServer - Variable in class org.attribyte.snook.Server: The HTTP server.
httpsPort - Variable in class org.attribyte.snook.ServerConfiguration: The port this server is listening on for secure connections.
HTTPUtil - Class in org.attribyte.snook: HTTP-related utilities.
HTTPUtil() - Constructor for class org.attribyte.snook.HTTPUtil

I

IDLE_TIMEOUT_PROPERTY - Static variable in class org.attribyte.snook.ServerConfiguration: The idle timeout property name ("idleTimeout").
idleTimeout - Variable in class org.attribyte.snook.ServerConfiguration: The maximum idle time in milliseconds.
info(String) - Method in class org.attribyte.snook.log.Log4jLogger
inGroup(String, String) - Method in class org.attribyte.snook.auth.Groups: Determine if a user is in a group.
InMemorySessions - Class in org.attribyte.snook.session: Sessions stored only in-memory.
InMemorySessions(Cookies.CookieKey, EnumSet<Cookies.Option>, int, int) - Constructor for class org.attribyte.snook.session.InMemorySessions: Creates an in-memory session store with the default same-site option.
InMemorySessions(Cookies.CookieKey, EnumSet<Cookies.Option>, Cookies.SameSiteOption, int, int) - Constructor for class org.attribyte.snook.session.InMemorySessions: Creates an in-memory session store with a specific same-site option.
INSTALL_DIR_SYSTEM_PROP - Static variable in class org.attribyte.snook.Util: The system property name that holds the install directory ("server.install.dir").
invalidCredentials(String) - Method in class org.attribyte.snook.auth.BCryptAuthenticator: Supplies credentials for an invalid login.
invalidCredentials(String) - Method in class org.attribyte.snook.auth.HMACCookieAuthenticator: Supplies credentials for an invalid login.
invalidCredentials(String) - Method in class org.attribyte.snook.auth.HMACCookieLoginAuthenticator: Supplies credentials for an invalid login.
isAsyncStarted() - Method in class org.attribyte.snook.test.TestHttpServletRequest
isAsyncSupported() - Method in class org.attribyte.snook.test.TestHttpServletRequest
isBoostEcl() - Method in class org.attribyte.snook.QRCode.Options.Builder
isCommitted() - Method in class org.attribyte.snook.test.TestHttpServletResponse
isDefault() - Method in class org.attribyte.snook.auth.GroupProfile
isExpired() - Method in class org.attribyte.snook.auth.HMACToken
isReadWrite(HttpServletRequest, String) - Method in class org.attribyte.snook.auth.PermissionAuthenticator: Check for an authorized user and if the user has read/write permission.
isRequestedSessionIdFromCookie() - Method in class org.attribyte.snook.test.TestHttpServletRequest
isRequestedSessionIdFromURL() - Method in class org.attribyte.snook.test.TestHttpServletRequest
isRequestedSessionIdValid() - Method in class org.attribyte.snook.test.TestHttpServletRequest
isSecure() - Method in class org.attribyte.snook.auth.Origin
isSecure() - Method in class org.attribyte.snook.test.TestHttpServletRequest
isSuper(HttpServletRequest, String) - Method in class org.attribyte.snook.auth.PermissionAuthenticator: Check for an authorized user and if the user has admin permission.
isTransparentBackground() - Method in class org.attribyte.snook.QRCode.Options.Builder
isUserInRole(String) - Method in class org.attribyte.snook.test.TestHttpServletRequest

J

join() - Method in class org.attribyte.snook.Server: Join with the calling thread.
JSON_WRITER - Static variable in class org.attribyte.snook.ErrorHandler
jsonWriter() - Method in class org.attribyte.snook.ErrorHandler: Selects the JSON writer.

K

KEYSTORE_CHECK_PROPERTY - Static variable in class org.attribyte.snook.ServerConfiguration: The property name for the keystore check interval ("keystoreCheckInterval").
KEYSTORE_FILE_PROPERTY - Static variable in class org.attribyte.snook.ServerConfiguration: The property name for the path to the keystore ("keystore.File").
KEYSTORE_PASSWORD_PROPERTY - Static variable in class org.attribyte.snook.ServerConfiguration: The property name for the keystore password ("keystorePassword").
KEYSTORE_PROVIDER_PROPERTY - Static variable in class org.attribyte.snook.ServerConfiguration: The property name for the keystore provider, e.g.
keyStoreCheckInterval - Variable in class org.attribyte.snook.ServerConfiguration: The time between checks for a key store change.
keyStoreCheckIntervalMillis - Variable in class org.attribyte.snook.ServerConfiguration: The keystore check interval in milliseconds.
KeyStoreMonitor - Class in org.attribyte.snook: Monitors the key store for changes and reloads.
KeyStoreMonitor() - Constructor for class org.attribyte.snook.KeyStoreMonitor
keyStorePasswordWasSpecified - Variable in class org.attribyte.snook.ServerConfiguration: Identifies if a password was specified for the key store.
keyStorePath - Variable in class org.attribyte.snook.ServerConfiguration: The path to the key store.
keyStoreProvider - Variable in class org.attribyte.snook.ServerConfiguration: The key store provider.

L

lastUpdateTimestamp - Variable in class org.attribyte.snook.auth.GroupProfile: The last time the permission was updated.
lightColor - Variable in class org.attribyte.snook.QRCode.Options: The light color.
LISTEN_IP_PROPERTY - Static variable in class org.attribyte.snook.ServerConfiguration: The listen IP property name ("listenIP").
LISTEN_PORT_PROPERTY - Static variable in class org.attribyte.snook.ServerConfiguration: The listen port property name ("httpPort").
listenIP - Variable in class org.attribyte.snook.ServerConfiguration: The IP this server is listening on.
loadFunctionMap(File) - Static method in class org.attribyte.snook.auth.HMACToken: Loads a previously generated key file.
loadFunctionMap(InputStream) - Static method in class org.attribyte.snook.auth.HMACToken: Loads from an input stream.
loadFunctionMap(List<String>) - Static method in class org.attribyte.snook.auth.HMACToken: Loads from a list of lines.
loadIds(File) - Static method in class org.attribyte.snook.auth.HMACToken: Loads the set of ids from an input file.
loadIds(InputStream) - Static method in class org.attribyte.snook.auth.HMACToken: Loads the set of ids from an input stream.
loadIds(List<String>) - Static method in class org.attribyte.snook.auth.HMACToken: Loads the set of available ids.
Log4jConfigurator - Class in org.attribyte.snook.log: Configures log4j2 programmatically from snook properties.
Log4jConfigurator() - Constructor for class org.attribyte.snook.log.Log4jConfigurator
log4jLogger(String, Level) - Static method in class org.attribyte.snook.Server: Create a log4j-based logger.
Log4jLogger - Class in org.attribyte.snook.log
Log4jLogger(String) - Constructor for class org.attribyte.snook.log.Log4jLogger: Creates a logger from a named log4j logger with INFO as the minimum level.
Log4jLogger(String, Level) - Constructor for class org.attribyte.snook.log.Log4jLogger: Creates a logger from a named log4j logger.
Log4jLogger(Logger) - Constructor for class org.attribyte.snook.log.Log4jLogger: Create a logger from an existing log4j logger with minimum level INFO.
Log4jLogger(Logger, Level) - Constructor for class org.attribyte.snook.log.Log4jLogger: Create a logger from an existing log4j logger.
logError(String) - Method in class org.attribyte.snook.Server: Logs an error message to System.err and the logger, if configured.
logError(String, Throwable) - Method in class org.attribyte.snook.Server: Logs an error to System.err and the logger, if configured and prints the stack trace.
logger - Variable in class org.attribyte.snook.ErrorHandler: An optional logger.
logger - Variable in class org.attribyte.snook.Server: The configured logger.
logger - Variable in class org.attribyte.snook.ShutdownMonitor: A logger.
logger(Logger) - Method in class org.attribyte.snook.Server.Builder: Sets a pre-built logger.
loggerName(String) - Method in class org.attribyte.snook.Server.Builder: Sets the logger name (creates a log4j logger).
login(String, String) - Method in class org.attribyte.snook.test.TestHttpServletRequest
login(String, String, String, int, HttpServletResponse) - Method in class org.attribyte.snook.auth.GroupLoginAuthenticator: Perform login with a username and password for a specific group.
loginAuthenticator - Variable in class org.attribyte.snook.auth.GroupLoginAuthenticator: The request authenticator.
LoginAuthenticator<T> - Interface in org.attribyte.snook.auth
loginFailedGroups() - Method in class org.attribyte.snook.auth.GroupLoginAuthenticator: Gets the groups returned on failed login.
logInfo(String) - Method in class org.attribyte.snook.Server: Logs an informational message to System.out and the logger, if configured.
logout() - Method in class org.attribyte.snook.test.TestHttpServletRequest
LOW - Enum constant in enum class org.attribyte.snook.QRCode.ECC: Low error correction.

M

main(String[]) - Static method in class org.attribyte.snook.auth.HMACToken: Generates random HMAC keys.
main(String[]) - Static method in class org.attribyte.snook.ExampleServer
main(String[]) - Static method in class org.attribyte.snook.QRCode: Generate a QR code from the command line.
mask - Variable in class org.attribyte.snook.QRCode.Options
MAX_AGE_PROP - Static variable in class org.attribyte.snook.auth.CORSAuthenticator: A property that sets the maximum age of a pre-flight request in seconds.
MAX_FORM_CONTENT_SIZE_PROPERTY - Static variable in class org.attribyte.snook.ServerConfiguration: The maximum form content size property name ("maxFormContentSize").
MAX_REQUEST_HEADER_PROPERTY - Static variable in class org.attribyte.snook.ServerConfiguration: The maximum request header size property name ("maxRequestHeaderSize").
MAX_RESPONSE_HEADER_PROPERTY - Static variable in class org.attribyte.snook.ServerConfiguration: The maximum response header size property name ("maxResponseHeaderSize").
maxFormContentSize - Variable in class org.attribyte.snook.ServerConfiguration: The maximum size allowed for posted forms.
maxVersion - Variable in class org.attribyte.snook.QRCode.Options
MEDIUM - Enum constant in enum class org.attribyte.snook.QRCode.ECC: Medium error correction.
metrics() - Method in class org.attribyte.snook.CommandServlet: Gets metrics recorded for this servlet.
MIN_PASSWORD_LENGTH - Static variable in class org.attribyte.snook.auth.Users: The minimum password length.
MIN_TOKEN_LENGTH - Static variable in class org.attribyte.snook.auth.Users: The minimum token length.
minVersion - Variable in class org.attribyte.snook.QRCode.Options
MultiAuthenticator - Class in org.attribyte.snook.auth: Base class for sequences of authenticators.
MultiAuthenticator(List<Authenticator<?>>, String) - Constructor for class org.attribyte.snook.auth.MultiAuthenticator

N

name - Variable in class org.attribyte.snook.Cookies.CookieKey: The cookie name.
name() - Method in interface org.attribyte.snook.ErrorHandler.Writer: The name of the writer.
nextToken(SecretKey) - Method in class org.attribyte.snook.auth.TOTP: The next token.
NONE - Enum constant in enum class org.attribyte.snook.ServerConfiguration.ConnectionSecurity: No secure connections.
NONE - Static variable in enum class org.attribyte.snook.auth.Permission: No permissions.
NOOP - Static variable in interface org.attribyte.snook.auth.CredentialsSupplier: A credentials supplier that does nothing.

O

Options(QRCode.ECC, int, int, int, int, int, int, int, boolean, boolean) - Constructor for class org.attribyte.snook.QRCode.Options
org.attribyte.snook - package org.attribyte.snook
org.attribyte.snook.auth - package org.attribyte.snook.auth
org.attribyte.snook.log - package org.attribyte.snook.log
org.attribyte.snook.session - package org.attribyte.snook.session
org.attribyte.snook.test - package org.attribyte.snook.test
origin(HttpServletRequest) - Static method in class org.attribyte.snook.auth.CORSAuthenticator: Gets the origin header value.
Origin - Class in org.attribyte.snook.auth: An immutable origin for a request.
Origin(String) - Constructor for class org.attribyte.snook.auth.Origin: Creates an origin from a string that must be a valid URI.
Origin(String, int, boolean) - Constructor for class org.attribyte.snook.auth.Origin: Create an origin from a known host and port.
Origin(URI) - Constructor for class org.attribyte.snook.auth.Origin: Creates an origin from a parsed URI.
OUTPUT_BUFFER_SIZE_PROPERTY - Static variable in class org.attribyte.snook.ServerConfiguration: The listen output buffer size property name ("outputBufferSize").
outputBufferSize - Variable in class org.attribyte.snook.ServerConfiguration: The size of the buffer into which httpResponse content is aggregated before being sent to the client.
outputStream - Variable in class org.attribyte.snook.test.TestHttpServletResponse: The output stream.
overrideWriter(String) - Method in class org.attribyte.snook.ErrorHandler: Override the writer based on path.
overrideWriters - Variable in class org.attribyte.snook.ErrorHandler: A list of path prefix, writer pairs - matched in order.

P

parseProperties(String) - Static method in class org.attribyte.snook.auth.Groups: Parse the properties token.
path - Variable in class org.attribyte.snook.Cookies.CookieKey: The path.
path(String) - Static method in class org.attribyte.snook.Util: Gets the path for a link, excluding the query string, if any.
PATHS_PROPERTY - Static variable in class org.attribyte.snook.StaticAssetsConfig: The property name for a comma-separated list of resource paths ("paths").
Per-Logger Properties (prefix: logger.key.) - Search tag in class org.attribyte.snook.log.Log4jConfigurator: Section
permission(HttpServletRequest, String) - Method in class org.attribyte.snook.auth.PermissionAuthenticator: Check for an authorized user and return permission.
permission(String) - Method in class org.attribyte.snook.auth.Groups: Gets an immutable map of profile vs user for a group.
permission(String, String) - Method in class org.attribyte.snook.auth.Groups: Gets a profile for a user in a group.
Permission - Enum Class in org.attribyte.snook.auth: A CRUD permission.
PermissionAuthenticator - Class in org.attribyte.snook.auth: An authenticator that returns permissions based on authentication status.
PermissionAuthenticator(Authenticator<?>) - Constructor for class org.attribyte.snook.auth.PermissionAuthenticator: Creates the permission authenticator.
permissions - Variable in class org.attribyte.snook.auth.GroupProfile: The permission.
port() - Method in class org.attribyte.snook.auth.Origin
previousToken(SecretKey) - Method in class org.attribyte.snook.auth.TOTP: The previous token.
properties - Variable in class org.attribyte.snook.auth.GroupProfile: Additional properties associated with the user,group.
propertyDocumentation() - Static method in class org.attribyte.snook.ServerConfiguration: Returns formatted documentation of all server configuration properties.
props - Variable in class org.attribyte.snook.Server: The resolved properties.
propsResource(String) - Method in class org.attribyte.snook.Server.Builder: Sets the default properties resource name.
put(String, Object) - Method in class org.attribyte.snook.session.Session: Puts a session value, replacing the existing, if any.

Q

QRCode - Class in org.attribyte.snook: Generate QR codes.
QRCode() - Constructor for class org.attribyte.snook.QRCode
QRCode.ECC - Enum Class in org.attribyte.snook: The error correction level.
QRCode.Options - Class in org.attribyte.snook: QR code generation options.
QRCode.Options.Builder - Class in org.attribyte.snook

R

RANDOM_BCRYPT_HASH - Static variable in class org.attribyte.snook.auth.Users: A BCrypt hash code generated for a random password.
RANDOM_BCRYPT_STRING - Static variable in class org.attribyte.snook.auth.Users: A BCrypt hash generated for a random password.
randomKey(SecureRandom) - Static method in class org.attribyte.snook.auth.HMACToken: Generate a random HMAC key.
randomKeyId() - Static method in class org.attribyte.snook.auth.HMACToken: Generates a random key id.
randomToken() - Static method in class org.attribyte.snook.auth.AuthenticationToken: Generates a random token.
randomToken() - Static method in class org.attribyte.snook.session.Session: Generates a random token.
READ - Enum constant in enum class org.attribyte.snook.auth.Permission: Permission to read.
READ_ONLY - Static variable in enum class org.attribyte.snook.auth.Permission: Read-only permission.
READ_WRITE - Static variable in enum class org.attribyte.snook.auth.Permission: Read-write permission.
REDIRECT - Enum constant in enum class org.attribyte.snook.ServerConfiguration.ConnectionSecurity: Redirect to a secure connection.
remove(String) - Method in class org.attribyte.snook.session.Session: Removes a session value.
removeAllCookies(HttpServletRequest, HttpServletResponse) - Static method in class org.attribyte.snook.Cookies: Removes all cookies sent with a request.
removeAttribute(String) - Method in class org.attribyte.snook.test.TestHttpServletRequest
removeCookie(String, HttpServletResponse) - Static method in class org.attribyte.snook.Cookies: Removes a previously set cookie that applies to the current domain and any path.
removeCookie(Cookies.CookieKey, HttpServletResponse) - Static method in class org.attribyte.snook.Cookies: Removes a previously set cookie.
removeCredentials(HttpServletResponse) - Method in interface org.attribyte.snook.auth.CredentialsSupplier: Remove credentials from the response, if possible.
removeCredentials(HttpServletResponse) - Method in class org.attribyte.snook.auth.HMACCookieSupplier
request(HttpServletRequest, HttpServletResponse) - Method in class org.attribyte.snook.CommandServlet
REQUEST_LOG_BASE_DEFAULT - Static variable in class org.attribyte.snook.Server: The request log base default value ("server").
REQUEST_LOG_BASE_PROPERTY - Static variable in class org.attribyte.snook.Server: The request log base name property name ("requestLogBase").
REQUEST_LOG_DIRECTORY_PROPERTY - Static variable in class org.attribyte.snook.Server: The request log directory property name ("requestLog.Dir").
REQUEST_LOG_EXTENDED_DEFAULT - Static variable in class org.attribyte.snook.Server: The request log extended option default value (true).
REQUEST_LOG_EXTENDED_PROPERTY - Static variable in class org.attribyte.snook.Server: The request log extended option property ("requestLogExtended").
REQUEST_LOG_OUTPUT_PROPERTY - Static variable in class org.attribyte.snook.Server: The request output format property name ("requestLogOutput").
REQUEST_LOG_RETAIN_DAYS_DEFAULT - Static variable in class org.attribyte.snook.Server: The default request log retain days (180).
REQUEST_LOG_RETAIN_DAYS_PROPERTY - Static variable in class org.attribyte.snook.Server: The request log retain days property name ("requestLogRetainDays").
REQUEST_LOG_TIMEZONE_PROPERTY - Static variable in class org.attribyte.snook.Server: The request log time zone property ("requestLogTimeZone").
requestHeader(String, String, String) - Static method in class org.attribyte.snook.auth.HeaderAuthenticator: Creates a credentials header to be added to a request.
requestHeader(String) - Method in class org.attribyte.snook.auth.HeaderAuthenticator: Creates a credentials header to be added to a request.
requestHeader(String, String) - Method in class org.attribyte.snook.auth.BasicAuthenticator: Creates the appropriate request header to send with a request.
requestHeader(String, String) - Method in class org.attribyte.snook.auth.BasicBCryptAuthenticator: Creates a request header.
requestHeaderSize - Variable in class org.attribyte.snook.ServerConfiguration: The maximum size of a request header.
REQUIRE_SECURE_ORIGIN_PROP - Static variable in class org.attribyte.snook.auth.CORSAuthenticator: A property that indicates if a secure origin is required ("requireSecureOrigin").
reset() - Method in class org.attribyte.snook.test.TestHttpServletResponse
resetBuffer() - Method in class org.attribyte.snook.test.TestHttpServletResponse
resolveEnvironmentVariables(Properties) - Static method in class org.attribyte.snook.Util: Examines configuration values for possible environment variables.
resolveRelativeFiles(Properties) - Static method in class org.attribyte.snook.Util: Examines configuration keys for those that represent files/directories to add system install path if not absolute.
RESOURCE_DIRECTORY_PROPERTY - Static variable in class org.attribyte.snook.StaticAssetsConfig: The property name for the directory containing static resources ("resourceDirectory").
resourceDirectory - Variable in class org.attribyte.snook.StaticAssetsConfig: The path to the directory containing static resources.
responseHeaders(HttpServletRequest) - Method in class org.attribyte.snook.CommandServlet: A list of headers to add to the response.
responseHeaderSize - Variable in class org.attribyte.snook.ServerConfiguration: The maximum size of a request header.
rootContext - Variable in class org.attribyte.snook.Server: The root context.
run() - Method in class org.attribyte.snook.ShutdownMonitor

S

SAME_SITE_LAX - Enum constant in enum class org.attribyte.snook.Cookies.SameSiteOption: Cookie Same-Site set to "Lax".
SAME_SITE_NONE - Enum constant in enum class org.attribyte.snook.Cookies.SameSiteOption: Cookie Same-Site set to "None".
SAME_SITE_STRICT - Enum constant in enum class org.attribyte.snook.Cookies.SameSiteOption: Cookie Same-Site set to "Strict".
sameSiteOption - Variable in class org.attribyte.snook.session.Sessions: The same-site cookie option.
sanitizeMarkup(String) - Static method in interface org.attribyte.snook.ErrorHandler.Writer: Sanitize HTML/XML markup.
save(Session) - Method in class org.attribyte.snook.session.InMemorySessions
save(Session) - Method in class org.attribyte.snook.session.Sessions: Saves a session.
scale - Variable in class org.attribyte.snook.QRCode.Options: The scale.
scheme - Variable in class org.attribyte.snook.auth.Credentials: The scheme.
scheme() - Method in class org.attribyte.snook.auth.BasicAuthenticator
scheme() - Method in class org.attribyte.snook.auth.BasicBCryptAuthenticator
scheme() - Method in class org.attribyte.snook.auth.BearerAuthenticator
scheme() - Method in class org.attribyte.snook.auth.HeaderAuthenticator: The authentication scheme.
scheme() - Method in class org.attribyte.snook.auth.TokenAuthenticator
SCHEME - Static variable in class org.attribyte.snook.auth.BasicAuthenticator: The scheme name ("Basic").
schemeName - Variable in class org.attribyte.snook.auth.MultiAuthenticator: The scheme name.
schemeName() - Method in class org.attribyte.snook.auth.AllowAllAuthenticator
schemeName() - Method in interface org.attribyte.snook.auth.Authenticator: The authentication scheme name.
schemeName() - Method in class org.attribyte.snook.auth.BasicAuthenticator
schemeName() - Method in class org.attribyte.snook.auth.BasicBCryptAuthenticator
schemeName() - Method in class org.attribyte.snook.auth.BCryptAuthenticator
schemeName() - Method in class org.attribyte.snook.auth.BearerAuthenticator
schemeName() - Method in class org.attribyte.snook.auth.CookieAuthenticator
schemeName() - Method in class org.attribyte.snook.auth.CORSAuthenticator
schemeName() - Method in class org.attribyte.snook.auth.DenyAllAuthenticator
schemeName() - Method in class org.attribyte.snook.auth.GroupLoginAuthenticator
schemeName() - Method in class org.attribyte.snook.auth.HMACCookieAuthenticator
schemeName() - Method in class org.attribyte.snook.auth.MultiAuthenticator
schemeName() - Method in class org.attribyte.snook.auth.TokenAuthenticator
secretKey(byte[]) - Method in class org.attribyte.snook.auth.TOTP: Creates a secret key from key bytes.
SECURE_LISTEN_PORT_PROPERTY - Static variable in class org.attribyte.snook.ServerConfiguration: The listen port for secure connections property name ("httpsPort").
SECURE_ONLY - Enum constant in enum class org.attribyte.snook.Cookies.Option: Cookie is only sent if the connection is secure.
SECURE_ONLY - Enum constant in enum class org.attribyte.snook.ServerConfiguration.ConnectionSecurity: Only secure connections allowed.
secureOriginRequired() - Method in class org.attribyte.snook.auth.CORSAuthenticator.Builder: Require a secure origin.
selectBuiltInWriter(String) - Static method in class org.attribyte.snook.ErrorHandler: Selects one of the built-in writers for a content type.
selectWriter(String) - Method in class org.attribyte.snook.ErrorHandler: Selects the writer based on content type.
send(Request, int, String, boolean, Logger, Response, Callback) - Method in interface org.attribyte.snook.ErrorHandler.Writer: Send an error response.
SEND_DATE_HEADER_PROPERTY - Static variable in class org.attribyte.snook.ServerConfiguration: The send date header property name ("sendDateHeader").
SEND_SERVER_VERSION_PROPERTY - Static variable in class org.attribyte.snook.ServerConfiguration: The send server version property name ("sendServerVersion").
sendBasicUnauthorized(HttpServletResponse, String) - Static method in class org.attribyte.snook.HTTPUtil: Sends HTTP unauthorized for Basic auth with a message.
sendBasicUnauthorized(HttpServletResponse, String, String) - Static method in class org.attribyte.snook.HTTPUtil: Sends HTTP unauthorized for Basic auth with a message.
sendBearerUnauthorized(HttpServletResponse, boolean) - Static method in class org.attribyte.snook.HTTPUtil: Sends HTTP unauthorized for Basic auth with a message.
sendBearerUnauthorized(HttpServletResponse, String, boolean) - Static method in class org.attribyte.snook.HTTPUtil: Sends HTTP unauthorized for Basic auth with a message.
sendDateHeader - Variable in class org.attribyte.snook.ServerConfiguration: Should a Date header be sent with responses?
sendError(int) - Method in class org.attribyte.snook.test.TestHttpServletResponse
sendError(int, String) - Method in class org.attribyte.snook.test.TestHttpServletResponse
sendHTTPUnauthorized(HttpServletRequest, HttpServletResponse, String) - Static method in class org.attribyte.snook.HTTPUtil: Sends HTTP unauthorized for Basic auth.
sendRedirect(String) - Method in class org.attribyte.snook.test.TestHttpServletResponse
sendServerVersion - Variable in class org.attribyte.snook.ServerConfiguration: Should the server version be sent with responses?
sendShutdownSignal() - Static method in class org.attribyte.snook.ShutdownMonitor: Sends the shutdown signal to the default address and port.
sendShutdownSignal(InetAddress, int) - Static method in class org.attribyte.snook.ShutdownMonitor: Sends the shutdown signal.
Server - Class in org.attribyte.snook
Server(String[], String, String, boolean) - Constructor for class org.attribyte.snook.Server: Deprecated.
Use Server.builder(String[]) instead.
Server(String[], String, String, boolean, ErrorHandler) - Constructor for class org.attribyte.snook.Server: Deprecated.
Use Server.builder(String[]) instead.
Server(String[], String, Logger, boolean) - Constructor for class org.attribyte.snook.Server: Deprecated.
Use Server.builder(String[]) instead.
Server(String[], String, Logger, boolean, ErrorHandler) - Constructor for class org.attribyte.snook.Server: Deprecated.
Use Server.builder(String[]) instead.
Server(Properties, Logger, boolean) - Constructor for class org.attribyte.snook.Server: Deprecated.
Use Server.builder(Properties) instead.
Server(Server.Builder) - Constructor for class org.attribyte.snook.Server: Creates the server from a builder.
Server.Builder - Class in org.attribyte.snook: A builder for configuring server options.
serverConfiguration - Variable in class org.attribyte.snook.Server: The server configuration.
ServerConfiguration - Class in org.attribyte.snook: HTTP server configuration.
ServerConfiguration() - Constructor for class org.attribyte.snook.ServerConfiguration: Creates a server configuration with default values.
ServerConfiguration(String, Properties) - Constructor for class org.attribyte.snook.ServerConfiguration: Creates a server configuration from properties.
ServerConfiguration.ConnectionSecurity - Enum Class in org.attribyte.snook: The connection security option.
service(HttpServletRequest, HttpServletResponse) - Method in class org.attribyte.snook.FailServlet
session(HttpServletRequest) - Method in class org.attribyte.snook.session.Sessions: Gets the session for a request.
Session - Class in org.attribyte.snook.session: A thread-safe session.
Session() - Constructor for class org.attribyte.snook.session.Session: Creates an empty session with a random token.
Session(HashCode, Map<String, Object>) - Constructor for class org.attribyte.snook.session.Session: Creates a session with a previously generated token and data.
Session(Map<String, Object>) - Constructor for class org.attribyte.snook.session.Session: Creates a session a random token and data.
sessionOrNew(HttpServletRequest, HttpServletResponse) - Method in class org.attribyte.snook.session.Sessions: Gets the session for a request.
sessionOrNew(HttpServletRequest, Map<String, Object>, HttpServletResponse) - Method in class org.attribyte.snook.session.Sessions: Gets the session for a request.
Sessions - Class in org.attribyte.snook.session: Manages sessions.
Sessions(Cookies.CookieKey, EnumSet<Cookies.Option>, Cookies.SameSiteOption, int, int) - Constructor for class org.attribyte.snook.session.Sessions: Creates a sessions store.
setAllowAll(boolean) - Method in class org.attribyte.snook.auth.CORSAuthenticator.Builder: Sets to allow all hosts.
setAllowDomains(Collection<String>) - Method in class org.attribyte.snook.auth.CORSAuthenticator.Builder: Sets the allowed domains.
setAllowHeaders(String) - Method in class org.attribyte.snook.auth.CORSAuthenticator.Builder: Sets a comma-separated list of allowed headers.
setAllowHost(Collection<String>) - Method in class org.attribyte.snook.auth.CORSAuthenticator.Builder: Sets the allowed hosts.
setAllowMethods(String) - Method in class org.attribyte.snook.auth.CORSAuthenticator.Builder: Sets a comma-separated list of allowed methods.
setAttribute(String, Object) - Method in class org.attribyte.snook.test.TestHttpServletRequest
setBasicUnauthorized(HttpServletResponse, String) - Static method in class org.attribyte.snook.HTTPUtil: Sets the status code and header value for failed Basic auth.
setBoostEcl(boolean) - Method in class org.attribyte.snook.QRCode.Options.Builder
setBorder(int) - Method in class org.attribyte.snook.QRCode.Options.Builder
setBufferSize(int) - Method in class org.attribyte.snook.test.TestHttpServletResponse
setCharacterEncoding(String) - Method in class org.attribyte.snook.test.TestHttpServletRequest
setCharacterEncoding(String) - Method in class org.attribyte.snook.test.TestHttpServletResponse
setContentLength(int) - Method in class org.attribyte.snook.test.TestHttpServletResponse
setContentLengthLong(long) - Method in class org.attribyte.snook.test.TestHttpServletResponse
setContentType(String) - Method in class org.attribyte.snook.test.TestHttpServletResponse
setCookie(String, String, int, EnumSet<Cookies.Option>, HttpServletResponse) - Static method in class org.attribyte.snook.Cookies: Sets a cookie that applies to the current domain and any path.
setCookie(String, String, int, EnumSet<Cookies.Option>, Cookies.SameSiteOption, HttpServletResponse) - Static method in class org.attribyte.snook.Cookies: Sets a cookie that applies to the current domain and any path with a same-site option.
setCookie(Cookies.CookieKey, String, int, EnumSet<Cookies.Option>, HttpServletResponse) - Static method in class org.attribyte.snook.Cookies: Sets a cookie.
setCookie(Cookies.CookieKey, String, int, EnumSet<Cookies.Option>, Cookies.SameSiteOption, HttpServletResponse) - Static method in class org.attribyte.snook.Cookies: Sets a cookie with a same-site option.
setDarkColor(int) - Method in class org.attribyte.snook.QRCode.Options.Builder
setDateHeader(String, long) - Method in class org.attribyte.snook.test.TestHttpServletResponse
setDenyDomains(Collection<String>) - Method in class org.attribyte.snook.auth.CORSAuthenticator.Builder: Sets the set of denied domains.
setDenyHosts(Collection<String>) - Method in class org.attribyte.snook.auth.CORSAuthenticator.Builder: Sets the set of denied hosts.
setEcc(QRCode.ECC) - Method in class org.attribyte.snook.QRCode.Options.Builder
setExposeHeaders(String) - Method in class org.attribyte.snook.auth.CORSAuthenticator.Builder: Sets a comma-separated list of exposed headers.
setFromString(String) - Static method in enum class org.attribyte.snook.auth.Permission: Create a set of permissions from a string.
setHeader(String, String) - Method in class org.attribyte.snook.test.TestHttpServletResponse
setIntHeader(String, int) - Method in class org.attribyte.snook.test.TestHttpServletResponse
setLightColor(int) - Method in class org.attribyte.snook.QRCode.Options.Builder
setLocale(Locale) - Method in class org.attribyte.snook.test.TestHttpServletResponse
setMask(int) - Method in class org.attribyte.snook.QRCode.Options.Builder
setMaxAgeSeconds(int) - Method in class org.attribyte.snook.auth.CORSAuthenticator.Builder: Sets the maximum age in seconds.
setMaxVersion(int) - Method in class org.attribyte.snook.QRCode.Options.Builder
setMinVersion(int) - Method in class org.attribyte.snook.QRCode.Options.Builder
setScale(int) - Method in class org.attribyte.snook.QRCode.Options.Builder
setSecureOriginRequired(boolean) - Method in class org.attribyte.snook.auth.CORSAuthenticator.Builder: Sets if a secure origin is required.
setSessionCookie(String, String, EnumSet<Cookies.Option>, HttpServletResponse) - Static method in class org.attribyte.snook.Cookies: Sets a session (temporary) cookie that applies to the current domain and any path.
setSessionCookie(String, String, EnumSet<Cookies.Option>, Cookies.SameSiteOption, HttpServletResponse) - Static method in class org.attribyte.snook.Cookies: Sets a session (temporary) cookie that applies to the current domain and any path.
setSessionCookie(Cookies.CookieKey, String, EnumSet<Cookies.Option>, HttpServletResponse) - Static method in class org.attribyte.snook.Cookies: Sets a session (temporary) cookie.
setSessionCookie(Cookies.CookieKey, String, EnumSet<Cookies.Option>, Cookies.SameSiteOption, HttpServletResponse) - Static method in class org.attribyte.snook.Cookies: Sets a session (temporary) cookie with a same-site option.
setStatus(int) - Method in class org.attribyte.snook.test.TestHttpServletResponse
setToString(Set<Permission>) - Static method in enum class org.attribyte.snook.auth.Permission: Convert a set of permissions to the compact string.
setTransparentBackground(boolean) - Method in class org.attribyte.snook.QRCode.Options.Builder
sha256Hashes - Variable in class org.attribyte.snook.auth.Users: An immutable map of sha256 hash vs username.
shutdown() - Method in class org.attribyte.snook.ExampleServer
shutdown() - Method in class org.attribyte.snook.KeyStoreMonitor: Shutdown the key store monitor.
shutdown() - Method in class org.attribyte.snook.Server: Called on server shutdown.
shutdown() - Method in class org.attribyte.snook.session.Sessions: Shutdown sessions.
shutdown() - Method in class org.attribyte.snook.ShutdownMonitor: Called on shutdown.
ShutdownMonitor - Class in org.attribyte.snook: A thread that listens for a shutdown signal on a specified port.
ShutdownMonitor() - Constructor for class org.attribyte.snook.ShutdownMonitor: Creates a server monitor with defaults and no logger.
ShutdownMonitor(InetAddress, int, Logger) - Constructor for class org.attribyte.snook.ShutdownMonitor: Creates the server monitor.
ShutdownMonitor(Logger) - Constructor for class org.attribyte.snook.ShutdownMonitor: Creates a server monitor with defaults and a logger.
splitPath(HttpServletRequest) - Static method in class org.attribyte.snook.HTTPUtil: Splits the path components.
splitPath(String) - Static method in class org.attribyte.snook.HTTPUtil: Splits the path components.
STANDARD_TRANSPARENT - Static variable in class org.attribyte.snook.QRCode.Options: Black on transparent background with all other default settings.
start() - Method in class org.attribyte.snook.Server: Starts the server.
start(ErrorHandler) - Method in class org.attribyte.snook.Server: Starts the server with a custom error handler.
start(ServerConfiguration, Logger) - Method in class org.attribyte.snook.KeyStoreMonitor: Starts the key store monitor.
startAsync() - Method in class org.attribyte.snook.test.TestHttpServletRequest
startAsync(ServletRequest, ServletResponse) - Method in class org.attribyte.snook.test.TestHttpServletRequest
startWithJoin() - Method in class org.attribyte.snook.Server: Starts the server, then joins.
startWithJoin(ErrorHandler) - Method in class org.attribyte.snook.Server: Starts the server with a custom error handler, then joins.
StaticAssetsConfig - Class in org.attribyte.snook: Configuration for a servlet that handles static files.
StaticAssetsConfig(String) - Constructor for class org.attribyte.snook.StaticAssetsConfig: Creates the default configuration.
StaticAssetsConfig(String, Properties) - Constructor for class org.attribyte.snook.StaticAssetsConfig: Creates file servlet configuration from properties.
status - Variable in class org.attribyte.snook.test.TestHttpServletResponse: The HTTP status.
SUPER - Enum constant in enum class org.attribyte.snook.auth.Permission: Permission to do anything.
SUPPRESS_STACK_TRACE_PROPERTY - Static variable in class org.attribyte.snook.ServerConfiguration: The property name to suppress stack trace output for unhandled exceptions.
suppressStackTrace - Variable in class org.attribyte.snook.ServerConfiguration: Are stack traces for unhandled exceptions suppressed?
systemInstallDir() - Static method in class org.attribyte.snook.Util: Gets the system install directory.

T

testAuthenticator(String, String) - Static method in class org.attribyte.snook.auth.TestAuthenticators: Creates a single-user test authenticator that always authorizes the user.
TestAuthenticators - Class in org.attribyte.snook.auth: A simple authenticator for testing.
TestAuthenticators() - Constructor for class org.attribyte.snook.auth.TestAuthenticators
testHMACCookieAuthenticator(String, String, String) - Static method in class org.attribyte.snook.auth.TestAuthenticators: Creates a single-user HMAC-Cookie authenticator.
TestHttpServletRequest - Class in org.attribyte.snook.test: Helper to test methods that expect servlet requests.
TestHttpServletRequest() - Constructor for class org.attribyte.snook.test.TestHttpServletRequest
TestHttpServletResponse - Class in org.attribyte.snook.test: A test servlet response.
TestHttpServletResponse() - Constructor for class org.attribyte.snook.test.TestHttpServletResponse
TEXT_WRITER - Static variable in class org.attribyte.snook.ErrorHandler
textWriter() - Method in class org.attribyte.snook.ErrorHandler: Selects the text writer.
toCookieValue(String, HashFunction) - Method in class org.attribyte.snook.auth.HMACToken: Generate the cookie value for this token.
toImage(QrCode, int, int) - Static method in class org.attribyte.snook.QRCode: Returns a raster image depicting the specified QR Code, with the specified module scale and border modules.
toImage(QrCode, QRCode.Options) - Static method in class org.attribyte.snook.QRCode: Copied from: https://github.com/nayuki/QR-Code-generator/blob/master/java/QrCodeGeneratorDemo.java Returns a raster image depicting the specified QR Code, with the specified module scale and border modules.
toJSON(Map<String, String>) - Static method in class org.attribyte.snook.auth.Groups: Convert a properties map to JSON.
token - Variable in class org.attribyte.snook.auth.AuthenticationToken: The token.
token - Variable in class org.attribyte.snook.session.Session: The unique session token.
TOKEN_BYTES - Static variable in class org.attribyte.snook.auth.AuthenticationToken: The number of bytes in a token (16).
TOKEN_BYTES - Static variable in class org.attribyte.snook.session.Session: The number of bytes in a token (16).
TokenAuthenticator<T> - Class in org.attribyte.snook.auth: Authenticator where a token is the value of a cookie (with no scheme, unlike 'Bearer').
TokenAuthenticator(String, Function<HashCode, String>) - Constructor for class org.attribyte.snook.auth.TokenAuthenticator: Creates an authenticator with an authentication function.
TokenAuthenticator(String, Map<HashCode, String>) - Constructor for class org.attribyte.snook.auth.TokenAuthenticator: Creates an authenticator from a map of credentials.
TokenAuthenticator(String, Map<HashCode, String>, Function<HashCode, String>) - Constructor for class org.attribyte.snook.auth.TokenAuthenticator: Creates the authenticator.
TokenAuthenticator(String, Users) - Constructor for class org.attribyte.snook.auth.TokenAuthenticator: Creates an authenticator from a credentials file.
toString() - Method in class org.attribyte.snook.auth.AuthenticationToken
toString() - Method in class org.attribyte.snook.auth.CORSAuthenticator
toString() - Method in class org.attribyte.snook.auth.Credentials
toString() - Method in class org.attribyte.snook.auth.GroupProfile
toString() - Method in class org.attribyte.snook.auth.HMACToken
toString() - Method in class org.attribyte.snook.auth.Origin
toString() - Method in class org.attribyte.snook.Cookies.CookieKey
toString() - Method in class org.attribyte.snook.QRCode.Options
toString() - Method in class org.attribyte.snook.ServerConfiguration
toString() - Method in class org.attribyte.snook.session.Session
toString() - Method in class org.attribyte.snook.ShutdownMonitor
toString() - Method in class org.attribyte.snook.test.TestHttpServletResponse
TOTP - Class in org.attribyte.snook.auth
transparentBackground() - Method in class org.attribyte.snook.QRCode.Options
TRUSTSTORE_FILE_PROPERTY - Static variable in class org.attribyte.snook.ServerConfiguration: The property name for the path to the truststore ("truststore.File").
TRUSTSTORE_PASSWORD_PROPERTY - Static variable in class org.attribyte.snook.ServerConfiguration: The property name for the truststore password ("truststorePassword").
TRUSTSTORE_RESOURCE_PROPERTY - Static variable in class org.attribyte.snook.ServerConfiguration: The property name for a truststore resource URL ("truststoreResource").
trustStorePasswordWasSpecified - Variable in class org.attribyte.snook.ServerConfiguration: Identifies if a password was specified for the trust store.
trustStorePath - Variable in class org.attribyte.snook.ServerConfiguration: The path to the trust store.
trustStoreResource - Variable in class org.attribyte.snook.ServerConfiguration: The URL for a trust store resource.

U

unauthenticatedPermission(String) - Method in class org.attribyte.snook.auth.PermissionAuthenticator: Gets the permissions for unauthenticated requests.
UPDATE - Enum constant in enum class org.attribyte.snook.auth.Permission: Permission to update.
upgrade(Class<T>) - Method in class org.attribyte.snook.test.TestHttpServletRequest
UptimeServlet - Class in org.attribyte.snook: An example command servlet that calls the "uptime" command.
uri(SecretKey, String, String) - Method in class org.attribyte.snook.auth.TOTP: Creates a URI in the format required for a QR code.
useCharset(Request, String) - Static method in class org.attribyte.snook.ErrorHandler: Determine the charset for the response.
userForHash - Variable in class org.attribyte.snook.auth.Users: A map of username vs hash.
userForHash(HashCode) - Method in class org.attribyte.snook.auth.Users: Gets the user for a hash.
username - Variable in class org.attribyte.snook.auth.AuthenticationToken: The username.
username - Variable in class org.attribyte.snook.auth.GroupProfile: The username.
username - Variable in class org.attribyte.snook.auth.HMACToken: The username.
username(HttpServletRequest) - Method in class org.attribyte.snook.auth.BasicAuthenticator
usernamePassword(HttpServletRequest) - Static method in class org.attribyte.snook.auth.BasicAuthenticator: Gets a pair containing the username and password sent with the request or null if none.
usernamePassword(String) - Static method in class org.attribyte.snook.auth.BasicAuthenticator: Gets the username and password from previously extracted header value.
usernamePassword(Credentials) - Static method in class org.attribyte.snook.auth.BasicAuthenticator: Gets the username and password from previously extracted credentials.
Users - Class in org.attribyte.snook.auth: A credentials file is of the following format.
Users(File) - Constructor for class org.attribyte.snook.auth.Users: Creates a users file.
Users(InputStream) - Constructor for class org.attribyte.snook.auth.Users: Creates a users file from a stream.
Util - Class in org.attribyte.snook
Util() - Constructor for class org.attribyte.snook.Util

V

validate(String, Function<String, HashFunction>) - Static method in class org.attribyte.snook.auth.HMACToken: Validate a cookie value and create a token only if valid.
validCredentials(String) - Method in class org.attribyte.snook.auth.BCryptAuthenticator: Supplies credentials for a valid login.
validCredentials(String) - Method in class org.attribyte.snook.auth.HMACCookieAuthenticator: Supplies credentials for a valid login.
validCredentials(String) - Method in class org.attribyte.snook.auth.HMACCookieLoginAuthenticator: Supplies credentials for a valid login.
value - Variable in class org.attribyte.snook.auth.Credentials: The value.
valueOf(String) - Static method in enum class org.attribyte.snook.auth.CORSAuthenticator.Option: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.attribyte.snook.auth.Permission: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.attribyte.snook.Cookies.Option: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.attribyte.snook.Cookies.SameSiteOption: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.attribyte.snook.QRCode.ECC: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.attribyte.snook.ServerConfiguration.ConnectionSecurity: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.attribyte.snook.auth.CORSAuthenticator.Option: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.attribyte.snook.auth.Permission: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.attribyte.snook.Cookies.Option: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.attribyte.snook.Cookies.SameSiteOption: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.attribyte.snook.QRCode.ECC: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.attribyte.snook.ServerConfiguration.ConnectionSecurity: Returns an array containing the constants of this enum class, in the order they are declared.

W

warn(String) - Method in class org.attribyte.snook.log.Log4jLogger
warn(String, Throwable) - Method in class org.attribyte.snook.log.Log4jLogger
withAllowHeaders(String) - Method in class org.attribyte.snook.auth.CORSAuthenticator: Adds a comma-separated list of allow headers.
withAllowHeaders(Collection<String>) - Method in class org.attribyte.snook.auth.CORSAuthenticator: Adds a collection of allow headers.
withAllowMethods(String) - Method in class org.attribyte.snook.auth.CORSAuthenticator: Adds a comma-separated list of allow headers.
withAllowMethods(Collection<String>) - Method in class org.attribyte.snook.auth.CORSAuthenticator: Adds a collection of allow headers.
withCacheControl(String) - Method in class org.attribyte.snook.StaticAssetsConfig: Create a new config with a cache control header value.
withDirectoryAllowed(boolean) - Method in class org.attribyte.snook.StaticAssetsConfig: Create a new config with a new directory allowed setting.
withETags(boolean) - Method in class org.attribyte.snook.StaticAssetsConfig: Create a new config with a new etags setting.
withExposeHeaders(String) - Method in class org.attribyte.snook.auth.CORSAuthenticator: Adds a comma-separated list of exposed headers.
withExposeHeaders(Collection<String>) - Method in class org.attribyte.snook.auth.CORSAuthenticator: Adds a collection of exposed headers.
withGzip(boolean) - Method in class org.attribyte.snook.Server.Builder: Enables or disables gzip handling.
withGzip(boolean) - Method in class org.attribyte.snook.StaticAssetsConfig: Create a new config with a new gzip setting.
withLogger(Logger) - Method in class org.attribyte.snook.ErrorHandler: Creates an error handler with a logger.
withOverrides(List<Map.Entry<String, ErrorHandler.Writer>>) - Method in class org.attribyte.snook.ErrorHandler: Adds overrides to this writer from a list of map entries.
withOverrides(Map<String, ErrorHandler.Writer>) - Method in class org.attribyte.snook.ErrorHandler: Adds overrides to this writer from a map.
withPermission(Set<Permission>) - Method in class org.attribyte.snook.auth.GroupProfile: Change access permission.
withScaleAndBorder(int, int) - Method in class org.attribyte.snook.QRCode.Options: Change the scale and border.
withServletName - Variable in class org.attribyte.snook.ErrorHandler: Should the servlet name be included?
withStackTrace - Variable in class org.attribyte.snook.ErrorHandler: Should stack traces be included?
write(PrintWriter, int, String, String, String, Throwable, boolean, boolean, Logger) - Method in interface org.attribyte.snook.ErrorHandler.Writer: Write the message.
WRITE_ONLY - Static variable in enum class org.attribyte.snook.auth.Permission: Write-only permission.
writeStackTrace(Throwable, PrintWriter) - Static method in class org.attribyte.snook.ErrorHandler: Writes the stack trace.

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form