Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- A - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- ABBR - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- AbstractActionQueue - Interface in com.renomad.minum.queue
-
This class provides the ability to pop items into a queue thread-safely and know they'll happen later.
- AbstractDb<T> - Class in com.renomad.minum.database
-
The abstract database class is a representation of the essential capabilities of a Minum database.
- AbstractDb(Path, Context, T) - Constructor for class com.renomad.minum.database.AbstractDb
- accept(T) - Method in interface com.renomad.minum.web.ThrowingConsumer
- ActionQueue - Class in com.renomad.minum.queue
-
This class provides the ability to pop items into a queue thread-safely and know they'll happen later.
- ActionQueue(String, Context) - Constructor for class com.renomad.minum.queue.ActionQueue
-
See the
ActionQueuedescription for more detail. - ActionQueueKiller - Class in com.renomad.minum.queue
-
This class exists to properly kill off multiple action queues
- ActionQueueKiller(Context) - Constructor for class com.renomad.minum.queue.ActionQueueKiller
- ActionQueueState - Class in com.renomad.minum.queue
-
This class tracks the overall state of the
ActionQueues that are in use throughout the system. - ActionQueueState() - Constructor for class com.renomad.minum.queue.ActionQueueState
- add(String) - Method in class com.renomad.minum.logging.TestLoggerQueue
- add(T) - Method in class com.renomad.minum.utils.ConcurrentSet
- add(T) - Method in class com.renomad.minum.utils.RingBuffer
- addMimeForSuffix(String, String) - Method in class com.renomad.minum.web.WebFramework
-
This allows users to add extra mappings between file suffixes and mime types, in case a user needs one that was not provided.
- ADDRESS - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- addToIndexes(T) - Method in class com.renomad.minum.database.AbstractDb
-
add the data to registered indexes.
- addToSetOfSws(ISocketWrapper) - Method in interface com.renomad.minum.web.IServer
- apply(T) - Method in interface com.renomad.minum.web.ThrowingFunction
- aqQueueAsString() - Method in class com.renomad.minum.queue.ActionQueueState
- AREA - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- ARTICLE - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- asBytes() - Method in class com.renomad.minum.web.Body
-
Returns the raw bytes of this HTTP message's body.
- asBytes(String) - Method in class com.renomad.minum.web.Body
-
Return the bytes of this request body by its key.
- ASIDE - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- assertEqualByteArray(byte[], byte[]) - Static method in class com.renomad.minum.testing.TestFramework
-
Compares two byte arrays for equality
- assertEqualByteArray(byte[], byte[], String) - Static method in class com.renomad.minum.testing.TestFramework
- assertEquals(List<T>, List<T>) - Static method in class com.renomad.minum.testing.TestFramework
-
asserts that two lists are equal in value and order.
- assertEquals(List<T>, List<T>, String) - Static method in class com.renomad.minum.testing.TestFramework
-
asserts that two lists are equal in value and order.
- assertEquals(T, T) - Static method in class com.renomad.minum.testing.TestFramework
-
A helper for testing - assert two generics are equal.
- assertEqualsDisregardOrder(List<? extends CharSequence>, List<? extends CharSequence>) - Static method in class com.renomad.minum.testing.TestFramework
-
asserts two lists are equal, ignoring the order.
- assertEqualsDisregardOrder(List<? extends CharSequence>, List<? extends CharSequence>, String) - Static method in class com.renomad.minum.testing.TestFramework
- assertFalse(boolean) - Static method in class com.renomad.minum.testing.TestFramework
- assertFalse(boolean, String) - Static method in class com.renomad.minum.testing.TestFramework
- assertThrows(Class<T>, ThrowingRunnable) - Static method in class com.renomad.minum.testing.TestFramework
-
assert that a particular chunk of code throws a particular exception.
- assertThrows(Class<T>, String, ThrowingRunnable) - Static method in class com.renomad.minum.testing.TestFramework
- assertTrue(boolean) - Static method in class com.renomad.minum.testing.TestFramework
- assertTrue(boolean, String) - Static method in class com.renomad.minum.testing.TestFramework
-
Assert that something is true, and show a message if it fails.
- asString() - Method in class com.renomad.minum.web.Body
-
Return the entire raw contents of the body of this request, as a string.
- asString(String) - Method in class com.renomad.minum.web.Body
-
Return the value for a key, as a string.
- ASYNC_ERROR - Enum constant in enum class com.renomad.minum.logging.LoggingLevel
-
Represents an error that occurs in a separate thread, so that we are not able to catch it bubbling up
- atNextIndex() - Method in class com.renomad.minum.utils.RingBuffer
-
Returns the value at the slot pointed to by the "nextIndex".
- AUDIO - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- AUDIT - Enum constant in enum class com.renomad.minum.logging.LoggingLevel
-
Information marked audit is for business-related stuff.
B
- B - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- BASE - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- BDI - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- BDO - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- block() - Method in class com.renomad.minum.web.FullSystem
-
A blocking call for our multi-threaded application.
- BLOCKQUOTE - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- body() - Method in record class com.renomad.minum.web.FunctionalTesting.TestResponse
-
Returns the value of the
bodyrecord component. - Body - Class in com.renomad.minum.web
-
This class represents the body of an HTML message.
- Body(Map<String, byte[]>, byte[], List<Partition>, BodyType) - Constructor for class com.renomad.minum.web.Body
-
Build a body for an HTTP message
- BODY - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- BodyType - Enum Class in com.renomad.minum.web
-
The type of HTTP request body
- BR - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- buildContext() - Static method in class com.renomad.minum.web.FullSystem
-
Builds a context object that is appropriate as a parameter to constructing a
FullSystem - buildLargeFileResponse(Map<String, String>, String, Headers) - Static method in class com.renomad.minum.web.Response
-
This will send a large file to the client as a stream.
- buildLargeFileResponse(Map<String, String>, String, String, Headers) - Static method in class com.renomad.minum.web.Response
-
This will send a large file to the client as a stream.
- buildLeanResponse(StatusLine.StatusCode) - Static method in class com.renomad.minum.web.Response
-
Build a
Responsewith only a status code, with no body and no extra headers. - buildLeanResponse(StatusLine.StatusCode, Map<String, String>) - Static method in class com.renomad.minum.web.Response
-
Build a
Responsewith just a status code and headers, without a body - buildProcessor(String) - Static method in class com.renomad.minum.templating.TemplateProcessor
-
Builds a
TemplateProcessorfrom a string containing a proper template. - buildResponse(StatusLine.StatusCode, Map<String, String>, byte[]) - Static method in class com.renomad.minum.web.Response
-
A constructor for situations where the developer wishes to send a small (less than a megabyte) byte array to the client.
- buildResponse(StatusLine.StatusCode, Map<String, String>, String) - Static method in class com.renomad.minum.web.Response
-
Build an ordinary response, with a known body
- buildStreamingResponse(StatusLine.StatusCode, Map<String, String>, ThrowingConsumer<ISocketWrapper>) - Static method in class com.renomad.minum.web.Response
-
This factory method is intended for situations where the user wishes to stream data but lacks the content length.
- buildStreamingResponse(StatusLine.StatusCode, Map<String, String>, ThrowingConsumer<ISocketWrapper>, long) - Static method in class com.renomad.minum.web.Response
-
Similar to
Response.buildStreamingResponse(StatusLine.StatusCode, Map, ThrowingConsumer)but here we know the body length, so that will be sent to the client as content-length. - buildTestingContext(String) - Static method in class com.renomad.minum.testing.TestFramework
-
This builds a context very similarly to
FullSystem.buildContext(), except that it usesTestLoggerinstead ofLogger - buildTestingContext(String, Properties) - Static method in class com.renomad.minum.testing.TestFramework
-
This builds a context very similarly to
FullSystem.buildContext(), except that it usesTestLoggerinstead ofLogger. - BUTTON - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- byteArrayToString(byte[]) - Static method in class com.renomad.minum.utils.StringUtils
-
Converts an array of bytes to a string.
- byteListToArray(List<Byte>) - Static method in class com.renomad.minum.utils.ByteUtils
-
A helper method to reduce some of the boilerplate code when converting a list of bytes to an array.
- byteListToString(List<Byte>) - Static method in class com.renomad.minum.utils.StringUtils
-
Converts a list of bytes to a string.
- bytesToHex(byte[]) - Static method in class com.renomad.minum.utils.CryptoUtils
-
Converts an array of bytes to their corresponding hex string
- ByteUtils - Class in com.renomad.minum.utils
-
Handy helpers when working with bytes
C
- CANVAS - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- CAPTION - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- CHARACTERS - Enum constant in enum class com.renomad.minum.htmlparsing.ParseNodeType
-
String content inside an HTML element
- checkFileIsWithinDirectory(String, String) - Static method in class com.renomad.minum.utils.FileUtils
-
This method is to provide assurance that the file specified by the path parameter is within the directory specified by directoryPath.
- checkForBadFilePatterns(String) - Static method in class com.renomad.minum.utils.FileUtils
-
Checks that the path string avoids bad patterns and meets our whitelist for acceptable characters.
- CITE - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- clientRequest() - Method in record class com.renomad.minum.web.PreHandlerInputs
-
Returns the value of the
clientRequestrecord component. - close() - Method in interface com.renomad.minum.web.ISocketWrapper
- close() - Method in class com.renomad.minum.web.SocketWrapper
- close() - Method in class com.renomad.minum.web.StreamingMultipartPartition
-
By "close", we will read from the
InputStreamuntil we have finished the body, so that our InputStream has been read until the start of the next partition. - close() - Method in class com.renomad.minum.web.UrlEncodedDataGetter
-
By "close", we will read from the
InputStreamuntil we have finished the body, so that our InputStream has been read until the start of the next partition. - code - Variable in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- CODE_100_CONTINUE - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_101_SWITCHING_PROTOCOLS - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_102_PROCESSING - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_103_EARLY_HINTS - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_200_OK - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_201_CREATED - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_202_ACCEPTED - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_203_NON_AUTHORITATIVE_INFORMATION - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_204_NO_CONTENT - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_205_RESET_CONTENT - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_206_PARTIAL_CONTENT - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_207_MULTI_STATUS - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_208_ALREADY_REPORTED - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_226_IM_USED - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_300_MULTIPLE_CHOICES - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_301_MOVED_PERMANENTLY - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_302_FOUND - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_303_SEE_OTHER - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
-
Used a lot after receiving a post response.
- CODE_304_NOT_MODIFIED - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_305_USE_PROXY - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_306_UNUSED - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_307_TEMPORARY_REDIRECT - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_308_PERMANENT_REDIRECT - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_400_BAD_REQUEST - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_401_UNAUTHORIZED - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_402_PAYMENT_REQUIRED - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_403_FORBIDDEN - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_404_NOT_FOUND - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_405_METHOD_NOT_ALLOWED - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_406_NOT_ACCEPTABLE - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_407_PROXY_AUTHENTICATION_REQUIRED - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_408_REQUEST_TIMEOUT - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_409_CONFLICT - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_410_GONE - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_411_LENGTH_REQUIRED - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_412_PRECONDITION_FAILED - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_413_PAYLOAD_TOO_LARGE - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_414_URI_TOO_LONG - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_415_UNSUPPORTED_MEDIA_TYPE - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_416_RANGE_NOT_SATISFIABLE - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_417_EXPECTATION_FAILED - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_418_IM_A_TEAPOT - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_421_MISDIRECTED_REQUEST - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_422_UNPROCESSABLE_CONTENT - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_423_LOCKED - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_424_FAILED_DEPENDENCY - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_425_TOO_EARLY - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_426_UPGRADE_REQUIRED - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_428_PRECONDITION_REQUIRED - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_429_TOO_MANY_REQUESTS - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_431_REQUEST_HEADER_FIELDS_TOO_LARGE - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_451_UNAVAILABLE_FOR_LEGAL_REASONS - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_500_INTERNAL_SERVER_ERROR - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_501_NOT_IMPLEMENTED - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_502_BAD_GATEWAY - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_503_SERVICE_UNAVAILABLE - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_504_GATEWAY_TIMEOUT - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_505_HTTP_VERSION_NOT_SUPPORTED - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_506_VARIANT_ALSO_NEGOTIATES - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_507_INSUFFICIENT_STORAGE - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_508_LOOP_DETECTED - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_510_NOT_EXTENDED - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- CODE_511_NETWORK_AUTHENTICATION_REQUIRED - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
- COL - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- COLGROUP - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- com.renomad.minum - module com.renomad.minum
- com.renomad.minum - package com.renomad.minum
-
Minum is a web library with all the components needed to build a web application, including a web server and a database.
- com.renomad.minum.database - package com.renomad.minum.database
-
This package contains classes for data persistence capabilities.
- com.renomad.minum.htmlparsing - package com.renomad.minum.htmlparsing
-
Converts HTML text into a Java data structure.
- com.renomad.minum.logging - package com.renomad.minum.logging
-
These classes enable outputting messages during the program run, labeled to indicate the category.
- com.renomad.minum.queue - package com.renomad.minum.queue
-
This package contains classes for
ActionQueue, which is a background task processor. - com.renomad.minum.security - package com.renomad.minum.security
-
Code for handling the harsh internet environment.
- com.renomad.minum.state - package com.renomad.minum.state
-
This package holds classes that help hold necessary system state.
- com.renomad.minum.templating - package com.renomad.minum.templating
-
Text templating capability.
- com.renomad.minum.testing - package com.renomad.minum.testing
-
Automated software testing
- com.renomad.minum.utils - package com.renomad.minum.utils
-
Generally-useful utilities.
- com.renomad.minum.web - package com.renomad.minum.web
-
Code and data for HTTP web serving.
- COMMAND - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- ConcurrentSet<T> - Class in com.renomad.minum.utils
-
This uses a [ConcurrentHashMap] as its base.
- ConcurrentSet() - Constructor for class com.renomad.minum.utils.ConcurrentSet
- Constants - Class in com.renomad.minum.state
-
Very important system design decisions are made here.
- Constants() - Constructor for class com.renomad.minum.state.Constants
- Constants(Properties) - Constructor for class com.renomad.minum.state.Constants
- contains(List<T>) - Method in class com.renomad.minum.utils.RingBuffer
-
Returns true if the data in the "myList" parameter is found within the RingBuffer.
- containsAt(List<T>, int) - Method in class com.renomad.minum.utils.RingBuffer
-
Returns true if the data in the "myList" parameter is found within the RingBuffer at the index provided.
- ContentDisposition - Class in com.renomad.minum.web
-
This class represents the information in the Content-Disposition header of a multipart/form-data partition.
- ContentDisposition(String, String) - Constructor for class com.renomad.minum.web.ContentDisposition
- contentLength() - Method in class com.renomad.minum.web.Headers
-
Given the list of headers, find the one with the length of the body of the POST and return that value as an integer.
- contentType() - Method in class com.renomad.minum.web.Headers
-
Gets the one content-type header, or returns an empty string
- context - Variable in class com.renomad.minum.database.AbstractDb
-
Holds some system-wide information that is beneficial for components of the database
- Context - Class in com.renomad.minum.state
-
Holds important system-wide data and methods, such as the logger, constants, and the
FullSysteminstance. - Context(ExecutorService, Constants, ILogger) - Constructor for class com.renomad.minum.state.Context
- createPasswordHash(String, String) - Static method in class com.renomad.minum.utils.CryptoUtils
-
Hash the input string with the provided PBKDF2 algorithm, and return a string representation Note that the PBKDF2WithHmacSHA1 algorithm is specifically designed to take a long time, to slow down an attacker.
- CryptoUtils - Class in com.renomad.minum.utils
-
Handy helpers for dealing with cryptographic functions
D
- data - Variable in class com.renomad.minum.database.AbstractDb
-
The internal data structure of the database that resides in memory.
- DATALIST - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- Db<T> - Class in com.renomad.minum.database
-
a memory-based disk-persisted database class.
- Db(Path, Context, T) - Constructor for class com.renomad.minum.database.Db
-
Constructs an in-memory disk-persisted database.
- DbData<T> - Class in com.renomad.minum.database
-
An abstract data type meant to be used with
Db - DbData() - Constructor for class com.renomad.minum.database.DbData
- dbDirectory - Variable in class com.renomad.minum.database.AbstractDb
-
The directory of the database on disk
- dbDirectory - Variable in class com.renomad.minum.state.Constants
-
This is the root directory of our database
- DbEngine2<T> - Class in com.renomad.minum.database
-
a memory-based disk-persisted database class.
- DbEngine2(Path, Context, T) - Constructor for class com.renomad.minum.database.DbEngine2
-
Constructs an in-memory disk-persisted database.
- DbException - Exception Class in com.renomad.minum.database
-
Exceptions that occur in the
Db - DbException(String) - Constructor for exception class com.renomad.minum.database.DbException
-
A
RuntimeExceptionscoped to the Minum database package. - DbException(String, Throwable) - Constructor for exception class com.renomad.minum.database.DbException
-
A
RuntimeExceptionscoped to the Minum database package. - DbException(Throwable) - Constructor for exception class com.renomad.minum.database.DbException
-
A
RuntimeExceptionscoped to the Minum database package. - DD - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- DEBUG - Enum constant in enum class com.renomad.minum.logging.LoggingLevel
-
Information useful for debugging.
- decode(String) - Static method in class com.renomad.minum.utils.StringUtils
-
Decodes URL-encoded UTF-8 text, except that we first check if the string value is the token %NULL%, which is our way to signify null.
- DEL - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- delete(T) - Method in class com.renomad.minum.database.AbstractDb
-
Delete data
- delete(T) - Method in class com.renomad.minum.database.Db
-
Delete data
- delete(T) - Method in class com.renomad.minum.database.DbEngine2
-
Delete data
- DELETE - Enum constant in enum class com.renomad.minum.web.RequestLine.Method
- deleteDirectoryRecursivelyIfExists(Path) - Method in class com.renomad.minum.utils.FileUtils
-
Deletes a directory, deleting everything inside it recursively afterwards.
- deleteFromMemory(T) - Method in class com.renomad.minum.database.AbstractDb
-
Remove a particular item from the internal data structure in memory
- deserialize(String) - Method in class com.renomad.minum.database.DbData
-
deserializes the text back into an object.
- deserialize(String) - Method in class com.renomad.minum.security.Inmate
- deserializeHelper(String) - Static method in class com.renomad.minum.utils.SerializationUtils
-
Splits up a string based on a pipe character.
- DETAILS - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- DFN - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- DIV - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- DL - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- DOCTYPE - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
-
In HTML, the doctype is the required preamble found at the top of all documents.
- doesMessageExist(String) - Method in class com.renomad.minum.logging.TestLogger
-
Whether the given string exists in the log messages.
- doesMessageExist(String, int) - Method in class com.renomad.minum.logging.TestLogger
-
Whether the given string exists in the log messages.
- DT - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
E
- ELEMENT - Enum constant in enum class com.renomad.minum.htmlparsing.ParseNodeType
-
An HTML element.
- EM - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- EMBED - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- empty - Static variable in class com.renomad.minum.web.PathDetails
- EMPTY - Static variable in class com.renomad.minum.htmlparsing.HtmlParseNode
- EMPTY - Static variable in class com.renomad.minum.htmlparsing.TagInfo
-
a null object
- EMPTY - Static variable in class com.renomad.minum.security.Inmate
-
Builds an empty version of this class, except that it has a current Context object
- EMPTY - Static variable in class com.renomad.minum.web.Body
-
An empty body instance, useful when you need an instantiated body.
- EMPTY - Static variable in record class com.renomad.minum.web.FunctionalTesting.TestResponse
- EMPTY - Static variable in class com.renomad.minum.web.Headers
- EMPTY - Static variable in class com.renomad.minum.web.RequestLine
- emptyInstance - Variable in class com.renomad.minum.database.AbstractDb
-
An empty instance of the type of data stored by this database, used for better handling of generics.
- enableSystemRunningMarker - Variable in class com.renomad.minum.state.Constants
-
This flag controls whether the system will write a file to disk indicating that the program is running, and delete that file when the program ends.
- encode(String) - Static method in class com.renomad.minum.utils.StringUtils
-
Encodes UTF-8 text using URL-encoding
- ENCRYPTED_HTTP - Enum constant in enum class com.renomad.minum.web.HttpServerType
-
Represents an HTTPS encrypted TLS conversation
- endpoint() - Method in record class com.renomad.minum.web.PreHandlerInputs
-
Returns the value of the
endpointrecord component. - enqueue(String, ThrowingRunnable) - Method in interface com.renomad.minum.queue.AbstractActionQueue
-
Adds something to the queue to be processed.
- enqueue(String, ThrowingRunnable) - Method in class com.renomad.minum.queue.ActionQueue
-
Adds something to the queue to be processed.
- equals(Object) - Method in class com.renomad.minum.htmlparsing.HtmlParseNode
- equals(Object) - Method in class com.renomad.minum.htmlparsing.TagInfo
- equals(Object) - Method in class com.renomad.minum.security.Inmate
- equals(Object) - Method in class com.renomad.minum.state.Constants
- equals(Object) - Method in class com.renomad.minum.web.Body
- equals(Object) - Method in class com.renomad.minum.web.ContentDisposition
- equals(Object) - Method in record class com.renomad.minum.web.FunctionalTesting.TestResponse
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class com.renomad.minum.web.Headers
- equals(Object) - Method in record class com.renomad.minum.web.LastMinuteHandlerInputs
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class com.renomad.minum.web.Partition
- equals(Object) - Method in class com.renomad.minum.web.PathDetails
- equals(Object) - Method in record class com.renomad.minum.web.PreHandlerInputs
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class com.renomad.minum.web.Request
- equals(Object) - Method in class com.renomad.minum.web.RequestLine
- equals(Object) - Method in class com.renomad.minum.web.Response
- equals(Object) - Method in record class com.renomad.minum.web.StatusLine
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class com.renomad.minum.web.UrlEncodedKeyValue
- example: - Search tag in class com.renomad.minum.testing.StopwatchUtils
- Section
- Example: - Search tag in class com.renomad.minum.queue.ActionQueue
- Section
- extractData(InputStream, Headers) - Method in interface com.renomad.minum.web.IBodyProcessor
-
read the body if one exists
There are really only two ways to read the body. - extractRequestLine(String) - Method in class com.renomad.minum.web.RequestLine
-
Given the string value of a Request Line (like GET /hello HTTP/1.1) validate and extract the values for our use.
- extractStatusLine(String) - Static method in class com.renomad.minum.web.FunctionalTesting
-
Parses a string value of a status line from an HTTP server.
- extraMimeMappings - Variable in class com.renomad.minum.state.Constants
-
These are key-value pairs for mappings between a file suffix and a mime type.
F
- FIELDSET - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- FIGCAPTION - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- FIGURE - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- FileReader - Class in com.renomad.minum.utils
-
Reads files from disk, optionally storing into a LRU cache.
- FileReader(Map<String, byte[]>, boolean, ILogger) - Constructor for class com.renomad.minum.utils.FileReader
- fileUtils - Variable in class com.renomad.minum.database.AbstractDb
-
Used for handling some file utilities in the database like creating directories
- FileUtils - Class in com.renomad.minum.utils
-
Helper functions for working with files.
- FileUtils(ILogger, Constants) - Constructor for class com.renomad.minum.utils.FileUtils
- find(String, String) - Static method in class com.renomad.minum.testing.RegexUtils
-
Helper to find a value in a string using a Regex.
- find(String, String, String) - Static method in class com.renomad.minum.testing.RegexUtils
-
Find a value by regular expression, for testing
- findExactlyOne(String, String) - Method in class com.renomad.minum.database.AbstractDb
-
A utility to find exactly one item from the database.
- findExactlyOne(String, String, Callable<T>) - Method in class com.renomad.minum.database.AbstractDb
-
Find one item, with an alternate value if null
This utility will search the indexes for a particular data by indexName and indexKey. - findExactlyOne(Stream<T>, Predicate<? super T>) - Static method in class com.renomad.minum.utils.SearchUtils
-
This helper method will give you the one item in this list, or null if there are none.
- findExactlyOne(Stream<T>, Predicate<? super T>, Callable<T>) - Static method in class com.renomad.minum.utils.SearchUtils
-
This is similar to
SearchUtils.findExactlyOne(Stream, Predicate)except that you can provide what gets returned if there are none found - so instead of returning null, it can return something else. - findFirstMessageThatContains(String) - Method in class com.renomad.minum.logging.TestLogger
-
Looks back through the last 3 log messages for one that contains the provided value.
- findFirstMessageThatContains(String, int) - Method in class com.renomad.minum.logging.TestLogger
-
Provides an ability to search over the recent past log messages, case-insensitively.
- findMatchingTagname(String) - Static method in enum class com.renomad.minum.htmlparsing.TagName
- flush() - Method in class com.renomad.minum.database.DbEngine2
-
This command calls
DatabaseAppender.flush(), which will force any in-memory-buffered data to be written to disk. - flush() - Method in interface com.renomad.minum.web.ISocketWrapper
-
Send the data in the outgoing buffer into the socket.
- flush() - Method in class com.renomad.minum.web.SocketWrapper
- FOOTER - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- ForbiddenUseException - Exception Class in com.renomad.minum.security
-
This is thrown when the user action is prevented by a restriction we put on the system.
- ForbiddenUseException(String) - Constructor for exception class com.renomad.minum.security.ForbiddenUseException
- FORM - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- FORM_URL_ENCODED - Enum constant in enum class com.renomad.minum.web.BodyType
-
key-value pairs joined by ampersands, with the values encoded using URL encoding, also known as percent encoding.
- FullSystem - Class in com.renomad.minum.web
-
This class is responsible for instantiating necessary classes for a valid system, in the proper order.
- FullSystem(Context) - Constructor for class com.renomad.minum.web.FullSystem
-
This constructor requires a
Contextobject, but it is easier and recommended to useFullSystem.initialize()instead. - FunctionalTesting - Class in com.renomad.minum.web
-
Tools to enable system-wide integration testing
- FunctionalTesting(Context, String, int) - Constructor for class com.renomad.minum.web.FunctionalTesting
-
Allows the user to set the host and port to target for testing.
- FunctionalTesting.TestResponse - Record Class in com.renomad.minum.web
-
A
Responsedesigned to work withFunctionalTesting - Further explanation: - Search tag in com.renomad.minum.web.IRequest.getBody()
- Section
- Further explanation: - Search tag in com.renomad.minum.web.IRequest.getBody()
- Section
G
- generateSecureRandomString(int) - Static method in class com.renomad.minum.utils.StringUtils
- get() - Method in interface com.renomad.minum.logging.ThrowingSupplier
- get(String) - Method in class com.renomad.minum.web.FunctionalTesting
-
Send a GET request (as a client to the server)
- get(String, List<String>) - Method in class com.renomad.minum.web.FunctionalTesting
-
Send a GET request (as a client to the server)
- GET - Enum constant in enum class com.renomad.minum.web.RequestLine.Method
- getActionQueueState() - Method in class com.renomad.minum.state.Context
- getActiveLogLevels() - Method in interface com.renomad.minum.logging.ILogger
-
This method can be used to adjust the active log levels, which is a mapping of keys of
LoggingLevelto boolean values. - getActiveLogLevels() - Method in class com.renomad.minum.logging.Logger
- getAttribute(String) - Method in class com.renomad.minum.htmlparsing.TagInfo
- getAttributes() - Method in class com.renomad.minum.htmlparsing.TagInfo
- getBody() - Method in interface com.renomad.minum.web.IRequest
-
This getter will process the body data fully on the first call, and cache that data for subsequent calls.
- getBody() - Method in interface com.renomad.minum.web.IResponse
-
Returns the bytes of the Response body being sent to the client
- getBody() - Method in class com.renomad.minum.web.Request
- getBody() - Method in class com.renomad.minum.web.Response
- getBodyLength() - Method in interface com.renomad.minum.web.IResponse
-
Gets the length of the body for this response.
- getBodyLength() - Method in class com.renomad.minum.web.Response
- getBodyType() - Method in class com.renomad.minum.web.Body
-
Returns the
BodyType, which is necessary to distinguish which methods to run for accessing data. - getCentralLoopFuture() - Method in interface com.renomad.minum.web.IServer
-
Obtain the
Futureof the central loop of this server object - getClientId() - Method in class com.renomad.minum.security.Inmate
- getConfiguredProperties() - Static method in class com.renomad.minum.state.Constants
- getConstants() - Method in class com.renomad.minum.state.Context
- getContent() - Method in class com.renomad.minum.web.Partition
- getContentAsString() - Method in class com.renomad.minum.web.Partition
- getContentDisposition() - Method in class com.renomad.minum.web.Partition
- getContentDisposition() - Method in class com.renomad.minum.web.StreamingMultipartPartition
- getContext() - Method in class com.renomad.minum.web.FullSystem
-
A convenience function to get the
Contextused in this class's construction - getDb(String, T) - Method in class com.renomad.minum.state.Context
-
This is a helper method to instantiate a
Dbclass, avoiding the need for a user to provide the root database directory and the context. - getDb2(String, T) - Method in class com.renomad.minum.state.Context
-
This is a helper method to instantiate a
DbEngine2class, using the engine2 database implementation. - getExecutorService() - Method in class com.renomad.minum.state.Context
- getExtraHeaders() - Method in interface com.renomad.minum.web.IResponse
-
Any extra headers set on the Response by the developer
- getExtraHeaders() - Method in class com.renomad.minum.web.Response
- getFilename() - Method in class com.renomad.minum.web.ContentDisposition
- getFullSystem() - Method in class com.renomad.minum.state.Context
- getHeaders() - Method in interface com.renomad.minum.web.IRequest
-
Get a
Headersobject, which contains all the headers in the request - getHeaders() - Method in class com.renomad.minum.web.Partition
- getHeaders() - Method in class com.renomad.minum.web.Request
- getHeaders() - Method in class com.renomad.minum.web.StreamingMultipartPartition
- getHeaderStrings() - Method in class com.renomad.minum.web.Headers
- getHost() - Method in interface com.renomad.minum.web.IServer
-
Get the string version of the address of this server.
- getHostName() - Method in interface com.renomad.minum.web.ISocketWrapper
-
The hostname of the server, as set in the configuration file of key HOST_NAME in
Constants.hostName - getHostName() - Method in class com.renomad.minum.web.SocketWrapper
- getIndex() - Method in class com.renomad.minum.database.DbData
-
We need an index so that each piece of data is distinct, even if it has the same data.
- getIndex() - Method in class com.renomad.minum.security.Inmate
- getIndexedData(String, String) - Method in class com.renomad.minum.database.AbstractDb
-
Given the name of a registered index (see
AbstractDb.registerIndex(String, Function)), use the key to find the collection of data that matches it. - getIndexedData(String, String) - Method in class com.renomad.minum.database.Db
-
Given the name of a registered index (see
Db.registerIndex(String, Function)), use the key to find the collection of data that matches it. - getIndexedData(String, String) - Method in class com.renomad.minum.database.DbEngine2
- getInmates() - Method in interface com.renomad.minum.security.ITheBrig
-
Get the current list of ip addresses that have been judged as having carried out attacks on the system.
- getInmates() - Method in class com.renomad.minum.security.TheBrig
- getInnerContent() - Method in class com.renomad.minum.htmlparsing.HtmlParseNode
-
The inner content is the data between the opening and closing tags of this element, comprised of potentially other complex elements and/or characters or a mix (or nothing at all, which will return an empty list).
- getInnerTemplate(String) - Method in class com.renomad.minum.templating.TemplateProcessor
-
Returns the reference to an inner template, to enable registering data and sub-templates.
- getInputStream() - Method in interface com.renomad.minum.web.ISocketWrapper
-
Returns this socket's input stream for more granular access
- getInputStream() - Method in class com.renomad.minum.web.SocketWrapper
- getIsolatedPath() - Method in class com.renomad.minum.web.PathDetails
-
Provides the path by itself, without the query string.
- getKey() - Method in class com.renomad.minum.web.UrlEncodedKeyValue
- getKeys() - Method in class com.renomad.minum.web.Body
-
Get all the keys for the key-value pairs in the body
- getLimit() - Method in class com.renomad.minum.utils.RingBuffer
- getLocalPort() - Method in interface com.renomad.minum.web.ISocketWrapper
-
Get the port of the server
- getLocalPort() - Method in class com.renomad.minum.web.SocketWrapper
- getLogger() - Method in class com.renomad.minum.state.Context
- getLruCache() - Static method in class com.renomad.minum.utils.LRUCache
-
Builds a map that functions as a least-recently used cache.
- getLruCache(int) - Static method in class com.renomad.minum.utils.LRUCache
-
Creates an LRUCache, allowing you to specify the max size.
- getMethod() - Method in class com.renomad.minum.web.RequestLine
-
Return the method of this request-line.
- getMethod(String) - Static method in enum class com.renomad.minum.web.RequestLine.Method
-
Get the correct HTTP method for a string provided by the user
- getMultipartIterable() - Method in interface com.renomad.minum.web.IRequest
-
This method provides an
Iterablefor getting the partitions of a multipart-form formatted body in an HTTP request. - getMultipartIterable() - Method in class com.renomad.minum.web.Request
- getMultiPartIterable(InputStream, String, int) - Method in interface com.renomad.minum.web.IBodyProcessor
-
Return an iterable for stepping through the multipart partitions.
- getName() - Method in class com.renomad.minum.web.ContentDisposition
- getOriginalText() - Method in class com.renomad.minum.templating.TemplateProcessor
-
Returns the original unchanged template string
- getPartitionByName(String) - Method in class com.renomad.minum.web.Body
-
A helper method for getting the partitions with a particular name set in its content-disposition.
- getPartitionHeaders() - Method in class com.renomad.minum.web.Body
-
If the body is of type form/multipart, return the partitions
- getPathDetails() - Method in class com.renomad.minum.web.RequestLine
-
This returns an object which contains essential information about the path in the request line.
- getPort() - Method in interface com.renomad.minum.web.IServer
- getQueryString() - Method in class com.renomad.minum.web.PathDetails
-
This returns the query string portion of the request line as a map, with case-sensitive keys.
- getQueue() - Method in interface com.renomad.minum.queue.AbstractActionQueue
-
Get the
Queueof data that is supposed to get processed. - getQueue() - Method in class com.renomad.minum.queue.ActionQueue
- getRawQueryString() - Method in class com.renomad.minum.web.PathDetails
-
Returns the raw query string.
- getRawValue() - Method in class com.renomad.minum.web.RequestLine
-
Get the string value of this request line, such as "GET /sample.html HTTP/1.1"
- getReleaseTime() - Method in class com.renomad.minum.security.Inmate
- getRemoteAddr() - Method in interface com.renomad.minum.web.ISocketWrapper
-
Returns a string of the remote host address without port
- getRemoteAddr() - Method in class com.renomad.minum.web.SocketWrapper
- getRemoteAddrWithPort() - Method in interface com.renomad.minum.web.ISocketWrapper
-
Returns a
SocketAddress, which includes the client's address and port - getRemoteAddrWithPort() - Method in class com.renomad.minum.web.SocketWrapper
- getRemoteRequester() - Method in interface com.renomad.minum.web.IRequest
-
Gets a string of the ip address of the client sending this request.
- getRemoteRequester() - Method in class com.renomad.minum.web.Request
- getRequestLine() - Method in interface com.renomad.minum.web.IRequest
-
Obtain information about the first line.
- getRequestLine() - Method in class com.renomad.minum.web.Request
- getServer() - Method in class com.renomad.minum.web.FullSystem
-
Returns current information on the non-encrypted server
- getServerType() - Method in interface com.renomad.minum.web.IServer
- getServerType() - Method in interface com.renomad.minum.web.ISocketWrapper
- getServerType() - Method in class com.renomad.minum.web.SocketWrapper
- getSetOfIndexes() - Method in class com.renomad.minum.database.AbstractDb
-
Get a set of the currently-registered indexes on this database, useful for debugging.
- getSocketWrapper() - Method in interface com.renomad.minum.web.IRequest
-
This getter is expected to be used for situations required finer-grained control over the socket, such as when dealing with streaming input like a game or chat, or receiving a very large file like a video.
- getSocketWrapper() - Method in class com.renomad.minum.web.Request
- getSslServer() - Method in class com.renomad.minum.web.FullSystem
-
Returns current information on the encrypted server
- getStatusCode() - Method in interface com.renomad.minum.web.IResponse
-
The
StatusLine.StatusCodeset by the developer for this Response. - getStatusCode() - Method in class com.renomad.minum.web.Response
- getSuffixToMimeMappings() - Method in class com.renomad.minum.web.WebFramework
- getTagInfo() - Method in class com.renomad.minum.htmlparsing.HtmlParseNode
-
Returns the
TagInfo, which contains valuable information like the type of element (p, a, div, and so on) and attributes like class, id, etc. - getTagName() - Method in class com.renomad.minum.htmlparsing.TagInfo
- getTestCount() - Method in class com.renomad.minum.logging.TestLogger
- getTextContent() - Method in class com.renomad.minum.htmlparsing.HtmlParseNode
-
If the
ParseNodeTypeisParseNodeType.CHARACTERS, then this will have text content. - getTheBrig() - Method in class com.renomad.minum.web.FullSystem
-
A convenience method to get the instance registered for this property
- getTimestampIsoInstant() - Static method in class com.renomad.minum.utils.TimeUtils
- getType() - Method in class com.renomad.minum.htmlparsing.HtmlParseNode
-
Gets the type of this node - either it's an element, with opening and closing tags and attributes and an inner content, or it's just plain text.
- getUedg() - Method in class com.renomad.minum.web.UrlEncodedKeyValue
- getUrlEncodedDataIterable(InputStream, long) - Method in interface com.renomad.minum.web.IBodyProcessor
-
Return an iterable for stepping through the key-value pairs of URL-encoded data.
- getUrlEncodedIterable() - Method in interface com.renomad.minum.web.IRequest
-
This method provides an
Iterablefor getting the key-value pairs of a URL-encoded body in an HTTP request. - getUrlEncodedIterable() - Method in class com.renomad.minum.web.Request
- getVersion() - Method in class com.renomad.minum.web.RequestLine
-
Gets the HTTP version, either 1.0 or 1.1
- getWebFramework() - Method in class com.renomad.minum.web.FullSystem
-
A convenience method to get the instance registered for this property
H
- H1 - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- H2 - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- H3 - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- H4 - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- H5 - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- H6 - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- hadToInterrupt() - Method in class com.renomad.minum.queue.ActionQueueKiller
-
A helpful indicator of whether this object was interrupted while looping through the list of action queues
- hasAccessedBody() - Method in class com.renomad.minum.web.Request
-
Returns true if the body has been accessed, either by running the
Request.getBody()method, by accessing theISocketWrapperusingRequest.getSocketWrapper(), or by runningRequest.getMultipartIterable()orRequest.getUrlEncodedIterable() - hasConnectionClose() - Method in class com.renomad.minum.web.Headers
-
Indicates whether the headers in this request have a Connection: close
- hashCode() - Method in class com.renomad.minum.htmlparsing.HtmlParseNode
- hashCode() - Method in class com.renomad.minum.htmlparsing.TagInfo
- hashCode() - Method in class com.renomad.minum.security.Inmate
- hashCode() - Method in class com.renomad.minum.state.Constants
- hashCode() - Method in class com.renomad.minum.web.Body
- hashCode() - Method in class com.renomad.minum.web.ContentDisposition
- hashCode() - Method in record class com.renomad.minum.web.FunctionalTesting.TestResponse
-
Returns a hash code value for this object.
- hashCode() - Method in class com.renomad.minum.web.Headers
- hashCode() - Method in record class com.renomad.minum.web.LastMinuteHandlerInputs
-
Returns a hash code value for this object.
- hashCode() - Method in class com.renomad.minum.web.Partition
- hashCode() - Method in class com.renomad.minum.web.PathDetails
- hashCode() - Method in record class com.renomad.minum.web.PreHandlerInputs
-
Returns a hash code value for this object.
- hashCode() - Method in class com.renomad.minum.web.Request
- hashCode() - Method in class com.renomad.minum.web.RequestLine
- hashCode() - Method in class com.renomad.minum.web.Response
- hashCode() - Method in record class com.renomad.minum.web.StatusLine
-
Returns a hash code value for this object.
- hashCode() - Method in class com.renomad.minum.web.UrlEncodedKeyValue
- hasKeepAlive() - Method in class com.renomad.minum.web.Headers
-
Indicates whether the headers in this request have a Connection: Keep-Alive
- HEAD - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- HEAD - Enum constant in enum class com.renomad.minum.web.RequestLine.Method
- HEADER - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- headers() - Method in record class com.renomad.minum.web.FunctionalTesting.TestResponse
-
Returns the value of the
headersrecord component. - Headers - Class in com.renomad.minum.web
-
Details extracted from the headers.
- Headers(List<String>) - Constructor for class com.renomad.minum.web.Headers
- Headers(List<String>, ILogger) - Constructor for class com.renomad.minum.web.Headers
- HGROUP - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- hostName - Variable in class com.renomad.minum.state.Constants
-
This is returned as the "host:" attribute in an HTTP request
- HR - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- HTML - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- htmlOk(String) - Static method in class com.renomad.minum.web.Response
-
If you are returning HTML text with a 200 ok, this is a helper that lets you skip some of the boilerplate.
- htmlOk(String, Map<String, String>) - Static method in class com.renomad.minum.web.Response
-
If you are returning HTML text with a 200 ok, this is a helper that lets you skip some of the boilerplate.
- HtmlParseNode - Class in com.renomad.minum.htmlparsing
-
Represents the expected types of things we may encounter when parsing an HTML string, which for our purposes is
ParseNodeType. - HtmlParseNode(ParseNodeType, TagInfo, List<HtmlParseNode>, String) - Constructor for class com.renomad.minum.htmlparsing.HtmlParseNode
- HtmlParser - Class in com.renomad.minum.htmlparsing
-
Converts HTML strings to object trees.
- HtmlParser() - Constructor for class com.renomad.minum.htmlparsing.HtmlParser
- HttpServerType - Enum Class in com.renomad.minum.web
-
An enum to represent the mode of conversation for HTTP - plain text or encrypted (TLS)
- HttpVersion - Enum Class in com.renomad.minum.web
-
The HTTP versions we handle
I
- I - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- IBodyProcessor - Interface in com.renomad.minum.web
-
An interface for the
BodyProcessorimplementation. - IFileReader - Interface in com.renomad.minum.utils
- IFRAME - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- ILogger - Interface in com.renomad.minum.logging
-
Logging code interface
- IMG - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- index - Variable in class com.renomad.minum.database.AbstractDb
-
The current index, used when creating new data items.
- initialize() - Method in interface com.renomad.minum.queue.AbstractActionQueue
-
Start the queue's processing
- initialize() - Method in class com.renomad.minum.queue.ActionQueue
- initialize() - Method in interface com.renomad.minum.security.ITheBrig
- initialize() - Method in class com.renomad.minum.security.TheBrig
- initialize() - Static method in class com.renomad.minum.web.FullSystem
-
This is the typical entry point for system instantiation.
- Inmate - Class in com.renomad.minum.security
-
Represents an inmate in our "jail".
- Inmate(Long, String, Long) - Constructor for class com.renomad.minum.security.Inmate
-
Represents an inmate in our "jail".
- innerClientSend(ISocketWrapper, RequestLine.Method, String, byte[], List<String>) - Method in class com.renomad.minum.web.FunctionalTesting
- innerText() - Method in class com.renomad.minum.htmlparsing.HtmlParseNode
-
Return the inner text of a node
- INPUT - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- INS - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- InvalidRangeException - Exception Class in com.renomad.minum.web
-
This exception is thrown if the range of bytes provided for a request is improper - such as if the range values were negative, wrongly-ordered, and so on.
- InvalidRangeException(String) - Constructor for exception class com.renomad.minum.web.InvalidRangeException
- InvariantException - Exception Class in com.renomad.minum.utils
-
An exception specific to our invariants.
- InvariantException(String) - Constructor for exception class com.renomad.minum.utils.InvariantException
- Invariants - Class in com.renomad.minum.utils
-
Utilities for asserting invariants within the code.
- IRequest - Interface in com.renomad.minum.web
-
An HTTP request.
- IResponse - Interface in com.renomad.minum.web
-
An interface for
Response. - isAqQueueEmpty() - Method in class com.renomad.minum.queue.ActionQueueState
- isBodyText() - Method in interface com.renomad.minum.web.IResponse
-
Whether the body is text (rather than binary) If true, a method like
Response.buildResponse(StatusLine.StatusCode, Map, String)was used, meaning the body would benefit from compression (if large enough to warrant the performance hit from compressing it) - isBodyText() - Method in class com.renomad.minum.web.Response
- IServer - Interface in com.renomad.minum.web
-
An interface for the
Serverimplementation. - isFound(String, String) - Static method in class com.renomad.minum.testing.RegexUtils
-
Returns whether the regular expression matched the data Note: This is a poor-performance method, mainly used as a quick helper where performance concerns don't exist,since each call to this method will compile the regular expression.
- isInJail(String) - Method in interface com.renomad.minum.security.ITheBrig
-
Return true if a particular client ip address is found in the list.
- isInJail(String) - Method in class com.renomad.minum.security.TheBrig
- ISocketWrapper - Interface in com.renomad.minum.web
-
This is the public interface to
ISocketWrapper, whose purpose is to make our lives easier when working withSocket. - isStopped() - Method in interface com.renomad.minum.queue.AbstractActionQueue
-
Indicate whether this has had its
AbstractActionQueue.stop()method completed. - isStopped() - Method in class com.renomad.minum.queue.ActionQueue
- isTheBrigEnabled - Variable in class com.renomad.minum.state.Constants
-
TheBrig is what puts client ip's in jail, if we feel they are attacking us.
- isVoidElement - Variable in enum class com.renomad.minum.htmlparsing.TagName
-
Void elements are disallowed to have closing tags
- iterator() - Method in class com.renomad.minum.utils.ConcurrentSet
- iterator() - Method in class com.renomad.minum.utils.RingBuffer
- ITheBrig - Interface in com.renomad.minum.security
-
Monitors the inmates who have misbehaved in our system.
K
- KBD - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- keepAliveTimeoutSeconds - Variable in class com.renomad.minum.state.Constants
-
We include this value in the keep-alive header.
- KEYGEN - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- keystorePassword - Variable in class com.renomad.minum.state.Constants
-
The password of the keystore, used for TLS
- keystorePath - Variable in class com.renomad.minum.state.Constants
-
The path to the keystore, required for encrypted TLS communication
- killAllQueues() - Method in class com.renomad.minum.queue.ActionQueueKiller
-
Systematically stops and kills all the action queues that have been instantiated in this call tree.
L
- LABEL - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- LastMinuteHandlerInputs - Record Class in com.renomad.minum.web
-
The parameters required to set up a handler that is run after everything else in the web framework.
- LastMinuteHandlerInputs(IRequest, IResponse) - Constructor for record class com.renomad.minum.web.LastMinuteHandlerInputs
-
Creates an instance of a
LastMinuteHandlerInputsrecord class. - LEGEND - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- LI - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- LINK - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- loadData() - Method in class com.renomad.minum.database.AbstractDb
-
Grabs all the data from disk and returns it as a list.
- loadData() - Method in class com.renomad.minum.database.Db
-
This is what loads the data from disk the first time someone needs it.
- loadData() - Method in class com.renomad.minum.database.DbEngine2
-
This is what loads the data from disk the first time someone needs it.
- logAsyncError(ThrowingSupplier<String, Exception>) - Method in interface com.renomad.minum.logging.ILogger
-
Logs helpful debugging information inside threads
- logAsyncError(ThrowingSupplier<String, Exception>) - Method in class com.renomad.minum.logging.Logger
- logAsyncError(ThrowingSupplier<String, Exception>) - Method in class com.renomad.minum.logging.TestLogger
- logAudit(ThrowingSupplier<String, Exception>) - Method in interface com.renomad.minum.logging.ILogger
-
This is for logging business-related topics
- logAudit(ThrowingSupplier<String, Exception>) - Method in class com.renomad.minum.logging.Logger
- logAudit(ThrowingSupplier<String, Exception>) - Method in class com.renomad.minum.logging.TestLogger
- logDebug(ThrowingSupplier<String, Exception>) - Method in interface com.renomad.minum.logging.ILogger
-
Logs helpful debugging information
- logDebug(ThrowingSupplier<String, Exception>) - Method in class com.renomad.minum.logging.Logger
- logDebug(ThrowingSupplier<String, Exception>) - Method in class com.renomad.minum.logging.TestLogger
- logger - Variable in class com.renomad.minum.database.AbstractDb
-
Used for providing logging throughout the database
- Logger - Class in com.renomad.minum.logging
-
Implementation of
ILogger - Logger(Logger) - Constructor for class com.renomad.minum.logging.Logger
-
A constructor meant for use by descendant classes
- Logger(Constants, ExecutorService, String) - Constructor for class com.renomad.minum.logging.Logger
-
Constructor
- loggingActionQueue - Variable in class com.renomad.minum.logging.Logger
-
The
LoggingActionQueuethat handles all our messages thread-safely by taking them off the top of a queue. - LoggingLevel - Enum Class in com.renomad.minum.logging
-
An enumeration of the levels of logging our system provides.
- logLevels - Variable in class com.renomad.minum.state.Constants
-
The default logging levels
- logTrace(ThrowingSupplier<String, Exception>) - Method in interface com.renomad.minum.logging.ILogger
-
Logs helpful debugging information
- logTrace(ThrowingSupplier<String, Exception>) - Method in class com.renomad.minum.logging.Logger
- logTrace(ThrowingSupplier<String, Exception>) - Method in class com.renomad.minum.logging.TestLogger
- LRUCache<K,
V> - Class in com.renomad.minum.utils -
A Least-Recently Used Cache See LRU
M
- makeDirectory(Path) - Method in class com.renomad.minum.utils.FileUtils
-
Creates a directory if it doesn't already exist.
- MAP - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- MARK - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- MATH - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- MAX_BODY_KEYS_URL_ENCODED - Static variable in interface com.renomad.minum.web.IBodyProcessor
-
Just providing a sane upper limit, with a little extra for safety factor.
- MAX_CACHE_SIZE - Static variable in class com.renomad.minum.logging.TestLogger
- MAX_KEY_SIZE_BYTES - Static variable in interface com.renomad.minum.web.IBodyProcessor
-
The largest size name we will allow is 50 bytes, that is 50 ascii characters.
- MAX_SIZE_DATA_RETURNED_IN_EXCEPTION - Static variable in interface com.renomad.minum.web.IBodyProcessor
-
When parsing fails, we would like to send the raw text back to the user so the development team can determine why parsing went awry.
- maxAppendCount - Variable in class com.renomad.minum.state.Constants
-
This is the maximum count of database entries that will be appended to a file before switching to a new file.
- maxElementsLruCacheStaticFiles - Variable in class com.renomad.minum.state.Constants
- maxLinesPerConsolidatedDatabaseFile - Variable in class com.renomad.minum.state.Constants
-
This number is the maximum count of lines we will allow in a consolidated database file, to support the needs of the database.
- maxReadLineSizeBytes - Variable in class com.renomad.minum.state.Constants
-
this is the most bytes we'll read on a single line, when reading by line.
- maxReadSizeBytes - Variable in class com.renomad.minum.state.Constants
-
this is the most bytes we'll read while parsing the Request body
- MENU - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- META - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- METER - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- MinumSecurityException - Exception Class in com.renomad.minum.security
-
A
RuntimeExceptionscoped to the security package - MinumSecurityException(String) - Constructor for exception class com.renomad.minum.security.MinumSecurityException
- MULTIPART - Enum constant in enum class com.renomad.minum.web.BodyType
-
Splits up the content into partitions separated by a boundary value that is specified by sender.
- mustBeFalse(boolean, String) - Static method in class com.renomad.minum.utils.Invariants
-
Specify something which must be false
- mustBeTrue(boolean, String) - Static method in class com.renomad.minum.utils.Invariants
-
Specify something which must be true.
- mustNotBeNull(T) - Static method in class com.renomad.minum.utils.Invariants
-
specifies that the parameter must be not null.
- MyThread - Class in com.renomad.minum.utils
-
This class exists just to avoid needing to handle the exception when I use a regular Thread.sleep()
N
- NAV - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- NONE - Enum constant in enum class com.renomad.minum.web.BodyType
-
Indicates there is no body
- NONE - Enum constant in enum class com.renomad.minum.web.HttpVersion
- NONE - Enum constant in enum class com.renomad.minum.web.RequestLine.Method
-
Represents the null value of Method
- NOSCRIPT - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- NULL - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
-
Used to indicate no tag
- NULL - Enum constant in enum class com.renomad.minum.web.StatusLine.StatusCode
-
The null object, meant to represent "no status code"
O
- OBJECT - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- offerToQueue(AbstractActionQueue) - Method in class com.renomad.minum.queue.ActionQueueState
- OL - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- ONE_DOT_ONE - Enum constant in enum class com.renomad.minum.web.HttpVersion
- ONE_DOT_ZERO - Enum constant in enum class com.renomad.minum.web.HttpVersion
- OPTGROUP - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- OPTION - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- OPTIONS - Enum constant in enum class com.renomad.minum.web.RequestLine.Method
- OUTPUT - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
P
- P - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- PARAM - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- parse(String) - Method in class com.renomad.minum.htmlparsing.HtmlParser
-
Given any HTML input, scan through and generate a tree of HTML nodes.
- ParseNodeType - Enum Class in com.renomad.minum.htmlparsing
-
The different kinds of things in an HTML document.
- ParsingException - Exception Class in com.renomad.minum.htmlparsing
-
Thrown if a failure occurs parsing
- ParsingException(String) - Constructor for exception class com.renomad.minum.htmlparsing.ParsingException
-
Construct an exception during parsing
- Partition - Class in com.renomad.minum.web
-
Represents a single partition in a multipart/form-data body response
- Partition(Headers, byte[], ContentDisposition) - Constructor for class com.renomad.minum.web.Partition
- partitioningMap - Variable in class com.renomad.minum.database.AbstractDb
-
This map holds the functions that are registered to indexes, which are used to construct the mappings between string values and items in the database.
- PATCH - Enum constant in enum class com.renomad.minum.web.RequestLine.Method
- PathDetails - Class in com.renomad.minum.web
-
Some essential characteristics of the path portion of the start line
- PathDetails(String, String, Map<String, String>) - Constructor for class com.renomad.minum.web.PathDetails
-
Basic constructor
- PLAIN_TEXT_HTTP - Enum constant in enum class com.renomad.minum.web.HttpServerType
-
Represents a plain text, non-encrypted HTTP conversation
- pollFromQueue() - Method in class com.renomad.minum.queue.ActionQueueState
- post(String, String) - Method in class com.renomad.minum.web.FunctionalTesting
-
Send a POST request (as a client to the server) using url encoding
- post(String, String, List<String>) - Method in class com.renomad.minum.web.FunctionalTesting
-
Send a POST request (as a client to the server) using url encoding
- POST - Enum constant in enum class com.renomad.minum.web.RequestLine.Method
- PRE - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- PreHandlerInputs - Record Class in com.renomad.minum.web
-
The input parameters that are required to add a pre-handler.
- PreHandlerInputs(IRequest, ThrowingFunction<IRequest, IResponse>, ISocketWrapper) - Constructor for record class com.renomad.minum.web.PreHandlerInputs
-
Creates an instance of a
PreHandlerInputsrecord class. - print() - Method in class com.renomad.minum.htmlparsing.HtmlParseNode
-
Return a list of strings of the text content of the tree.
- processDataIndex(T) - Method in class com.renomad.minum.database.AbstractDb
-
When new data comes in, we look at its "index" value.
- PROGRESS - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- PUT - Enum constant in enum class com.renomad.minum.web.RequestLine.Method
Q
- Q - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- queryString() - Method in class com.renomad.minum.web.RequestLine
-
Returns a map of the key-value pairs in the URL, for example in
http://foo.com?name=aliceyou have a key of name and a value of alice.
R
- rawValue() - Method in record class com.renomad.minum.web.StatusLine
-
Returns the value of the
rawValuerecord component. - read() - Method in class com.renomad.minum.web.StreamingMultipartPartition
-
Reads from the inputstream using a buffer for checking whether we've hit the end of a multpart partition.
- read() - Method in class com.renomad.minum.web.UrlEncodedDataGetter
-
Mostly similar behavior to
InputStream.read() - readAllBytes() - Method in class com.renomad.minum.web.StreamingMultipartPartition
- readAllBytes() - Method in class com.renomad.minum.web.UrlEncodedDataGetter
- readBinaryFile(String) - Method in class com.renomad.minum.utils.FileUtils
-
Read a binary file, return as a byte array
- readFile(String) - Method in class com.renomad.minum.utils.FileReader
- readFile(String) - Method in interface com.renomad.minum.utils.IFileReader
-
Reads a file from disk.
- readTextFile(String) - Method in class com.renomad.minum.utils.FileUtils
-
Read a text file from the given path, return as a string.
- redirectTo(String) - Static method in class com.renomad.minum.web.Response
-
A helper method to create a response that returns a 303 status code ("see other").
- RegexUtils - Class in com.renomad.minum.testing
-
Handy helpers to make regular expression marginally easier / more efficient, etc.
- registerData(List<Map<String, String>>) - Method in class com.renomad.minum.templating.TemplateProcessor
-
Assign data.
- registeredIndexes - Variable in class com.renomad.minum.database.AbstractDb
-
This data structure is a nested map used for providing indexed data search.
- registerIndex(String, Function<T, String>) - Method in class com.renomad.minum.database.AbstractDb
-
Register an index in the database for higher performance data access.
- registerIndex(String, Function<T, String>) - Method in class com.renomad.minum.database.Db
-
Register an index in the database for higher performance data access.
- registerIndex(String, Function<T, String>) - Method in class com.renomad.minum.database.DbEngine2
- registerInnerTemplate(String, TemplateProcessor) - Method in class com.renomad.minum.templating.TemplateProcessor
-
Binds an inner template to a key of this template.
- registerLastMinuteHandler(ThrowingFunction<LastMinuteHandlerInputs, IResponse>) - Method in class com.renomad.minum.web.WebFramework
-
Sets a handler to be executed after running the ordinary handler, just before sending the response.
- registerPartialPath(RequestLine.Method, String, ThrowingFunction<IRequest, IResponse>) - Method in class com.renomad.minum.web.WebFramework
-
Similar to
WebFramework.registerPath(RequestLine.Method, String, ThrowingFunction)except that the paths registered here may be partially matched. - registerPath(RequestLine.Method, String, ThrowingFunction<IRequest, IResponse>) - Method in class com.renomad.minum.web.WebFramework
-
Add a new handler in the web application for a combination of a
RequestLine.Method, a path, and then provide the code to handle a request. - registerPreHandler(ThrowingFunction<PreHandlerInputs, IResponse>) - Method in class com.renomad.minum.web.WebFramework
-
Sets a handler to process all requests across the board.
- remove(T) - Method in class com.renomad.minum.utils.ConcurrentSet
- removeEldestEntry(Map.Entry<K, V>) - Method in class com.renomad.minum.utils.LRUCache
- removeMyRecord(ISocketWrapper) - Method in interface com.renomad.minum.web.IServer
-
When we first create a SocketWrapper in Server, we provide it a reference back to this object, so that it can call this command.
- renderTemplate() - Method in class com.renomad.minum.templating.TemplateProcessor
-
Recursively assembles the template and sub-templates
- renderTemplate(boolean) - Method in class com.renomad.minum.templating.TemplateProcessor
-
Render the template and any nested sub-templates.
- renderTemplate(List<Map<String, String>>) - Method in class com.renomad.minum.templating.TemplateProcessor
-
Given a list of maps of key names -> value, render a template multiple times.
- renderTemplate(Map<String, String>) - Method in class com.renomad.minum.templating.TemplateProcessor
-
Given a map of key names -> value, render a template.
- request() - Method in record class com.renomad.minum.web.LastMinuteHandlerInputs
-
Returns the value of the
requestrecord component. - Request - Class in com.renomad.minum.web
-
An implementation of
IRequest. - Request(Headers, RequestLine, String, ISocketWrapper, IBodyProcessor) - Constructor for class com.renomad.minum.web.Request
-
Constructor for a HTTP request
- RequestLine - Class in com.renomad.minum.web
-
This class holds data and methods for dealing with the "start line" in an HTTP request.
- RequestLine(RequestLine.Method, PathDetails, HttpVersion, String, ILogger) - Constructor for class com.renomad.minum.web.RequestLine
- RequestLine.Method - Enum Class in com.renomad.minum.web
-
These are the HTTP methods we handle.
- response() - Method in record class com.renomad.minum.web.LastMinuteHandlerInputs
-
Returns the value of the
responserecord component. - Response - Class in com.renomad.minum.web
-
Represents an HTTP response.
- Response syntax - Search tag in class com.renomad.minum.web.Response
- Section
- RingBuffer<T> - Class in com.renomad.minum.utils
- RingBuffer(int, Class<T>) - Constructor for class com.renomad.minum.utils.RingBuffer
-
Build a
RingBuffer - RP - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- RT - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- RUBY - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- run() - Method in class com.renomad.minum.utils.RunnableWithDescription
- run() - Method in interface com.renomad.minum.utils.ThrowingRunnable
-
The reason this throws an exception is so that lambdas don't need to try-catch their thrown exceptions when they use this.
- RunnableWithDescription - Class in com.renomad.minum.utils
-
This class is to improve maintainability in the system.
- RunnableWithDescription(ThrowingRunnable, String) - Constructor for class com.renomad.minum.utils.RunnableWithDescription
-
By constructing a
ThrowingRunnablehere, you can provide a description of the runnable that will be reviewable during debugging.
S
- S - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- safeAttr(String) - Static method in class com.renomad.minum.utils.StringUtils
-
Replace dangerous text that would go inside an HTML attribute.
- safeHtml(String) - Static method in class com.renomad.minum.utils.StringUtils
-
Returns text that has three symbols replaced - the less-than, greater-than, and ampersand.
- safeResolve(String, String) - Static method in class com.renomad.minum.utils.FileUtils
-
This helper method will ensure that the requested path is within the parent directory and using safe characters
- SAMP - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- SCRIPT - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- search(TagName, Map<String, String>) - Method in class com.renomad.minum.htmlparsing.HtmlParseNode
-
Return a list of
HtmlParseNodenodes in the HTML that match provided attributes. - search(TagName, Map<String, String>) - Method in record class com.renomad.minum.web.FunctionalTesting.TestResponse
-
Presuming the response body is HTML, search for all HTML elements with the given tag name and attributes.
- search(List<HtmlParseNode>, TagName, Map<String, String>) - Method in class com.renomad.minum.htmlparsing.HtmlParser
-
Search the node tree for matching elements.
- searchOne(TagName, Map<String, String>) - Method in record class com.renomad.minum.web.FunctionalTesting.TestResponse
-
Presuming the response body is HTML, search for a single HTML element with the given tag name and attributes.
- SearchUtils - Class in com.renomad.minum.utils
-
Utilities for searching collections of data
- SECTION - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- secureServerPort - Variable in class com.renomad.minum.state.Constants
-
The port for our encrypted server
- SELECT - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- send(byte[]) - Method in interface com.renomad.minum.web.ISocketWrapper
-
Simply send the bytes on the socket, simple as that.
- send(byte[]) - Method in class com.renomad.minum.web.SocketWrapper
- send(byte[], int, int) - Method in interface com.renomad.minum.web.ISocketWrapper
- send(byte[], int, int) - Method in class com.renomad.minum.web.SocketWrapper
- send(int) - Method in interface com.renomad.minum.web.ISocketWrapper
- send(int) - Method in class com.renomad.minum.web.SocketWrapper
- send(RequestLine.Method, String) - Method in class com.renomad.minum.web.FunctionalTesting
-
Send a request as a client to the server
- send(RequestLine.Method, String, byte[], List<String>) - Method in class com.renomad.minum.web.FunctionalTesting
-
Send a request as a client to the server
- send(String) - Method in interface com.renomad.minum.web.ISocketWrapper
-
Convert the provided string value into bytes using the default charset, and send on the socket.
- send(String) - Method in class com.renomad.minum.web.SocketWrapper
- sendBody(ISocketWrapper) - Method in interface com.renomad.minum.web.IResponse
-
By calling this method with a
ISocketWrapperparameter, the method will send bytes on the associated socket. - sendBody(ISocketWrapper) - Method in class com.renomad.minum.web.Response
- sendHttpLine(String) - Method in interface com.renomad.minum.web.ISocketWrapper
-
Sends a line of text, with carriage-return and line-feed appended to the end, required for the HTTP protocol.
- sendHttpLine(String) - Method in class com.renomad.minum.web.SocketWrapper
- sendToJail(String, long) - Method in interface com.renomad.minum.security.ITheBrig
-
Put a client in jail for some infraction, for a specified time.
- sendToJail(String, long) - Method in class com.renomad.minum.security.TheBrig
- SerializationUtils - Class in com.renomad.minum.utils
- serialize() - Method in class com.renomad.minum.database.DbData
-
Serializes this object into a string representation.
- serialize() - Method in class com.renomad.minum.security.Inmate
- serializeHelper(Object...) - Static method in class com.renomad.minum.utils.SerializationUtils
-
This is a helper that will encode the values you give it in preparation for storage in a database file.
- serverPort - Variable in class com.renomad.minum.state.Constants
-
The port for our regular, non-encrypted server
- setFullSystem(FullSystem) - Method in class com.renomad.minum.state.Context
- setIndex(long) - Method in class com.renomad.minum.database.DbData
-
It is necessary for this method to exist because it is used by the
Dbcode to add the new index into this data. - setIndex(long) - Method in class com.renomad.minum.security.Inmate
- shortDescription - Variable in enum class com.renomad.minum.web.StatusLine.StatusCode
- shutdown() - Method in class com.renomad.minum.web.FullSystem
-
Shut down the system, set up to be run by a hook during initialization
- shutdownTestingContext(Context) - Static method in class com.renomad.minum.testing.TestFramework
-
A helper to close down resources that are opened up by running the
TestFramework.buildTestingContext(java.lang.String)methods. - size() - Method in class com.renomad.minum.utils.ConcurrentSet
- sleep(long) - Static method in class com.renomad.minum.utils.MyThread
-
Same behavior as
Thread.sleep(long), but wrapped so that it prints the exception's stacktrace instead of letting it bubble up. - SMALL - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- socketTimeoutMillis - Variable in class com.renomad.minum.state.Constants
-
How long will we let a socket live before we crash it closed? See
Socket.setSoTimeout(int) - SocketWrapper - Class in com.renomad.minum.web
-
This wraps Sockets to make them more particular to our use case
- SocketWrapper(Socket, IServer, ILogger, int, String) - Constructor for class com.renomad.minum.web.SocketWrapper
-
Constructor
- SOURCE - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- SPAN - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- stackTraceToString(StackTraceElement[]) - Static method in class com.renomad.minum.utils.StacktraceUtils
-
Converts an array of
StackTraceElementto a single string, joining them with a semicolon as delimiter. - stackTraceToString(Throwable) - Static method in class com.renomad.minum.utils.StacktraceUtils
-
grabs the stacktrace out of a
Throwableas a string - StacktraceUtils - Class in com.renomad.minum.utils
-
Helper functions for manipulating stack traces.
- start() - Method in class com.renomad.minum.web.FullSystem
-
This method runs the necessary methods for starting the Minum web server.
- start() - Method in interface com.renomad.minum.web.IServer
-
This is where the central loop of our server is started
- startTime - Variable in class com.renomad.minum.state.Constants
-
This value is the result of running System.currentTimeMillis() when this class gets instantiated, and that is done at the very beginning.
- startTimer() - Method in class com.renomad.minum.testing.StopwatchUtils
- staticFileCacheTime - Variable in class com.renomad.minum.state.Constants
-
Length of time, in seconds, for static files to be cached, per the provisions of the Cache-Control header, e.g.
- staticFilesDirectory - Variable in class com.renomad.minum.state.Constants
-
Root directory of static files
- status() - Method in record class com.renomad.minum.web.StatusLine
-
Returns the value of the
statusrecord component. - statusLine() - Method in record class com.renomad.minum.web.FunctionalTesting.TestResponse
-
Returns the value of the
statusLinerecord component. - StatusLine - Record Class in com.renomad.minum.web
-
This class represents the text that is sent back in a
Response - StatusLine(StatusLine.StatusCode, HttpVersion, String) - Constructor for record class com.renomad.minum.web.StatusLine
-
Creates an instance of a
StatusLinerecord class. - StatusLine.StatusCode - Enum Class in com.renomad.minum.web
-
See Status Codes
- stop() - Method in class com.renomad.minum.database.AbstractDb
-
Used to cleanly stop the database.
- stop() - Method in class com.renomad.minum.database.Db
-
This function will stop the minum.database persistence cleanly.
- stop() - Method in class com.renomad.minum.database.DbEngine2
-
This is here to match the contract of
Dbbut all it does is tell the interior file writer to write its data to disk. - stop() - Method in interface com.renomad.minum.logging.ILogger
-
When we are shutting down the system it is necessary to explicitly stop the logger.
- stop() - Method in class com.renomad.minum.logging.Logger
- stop() - Method in interface com.renomad.minum.queue.AbstractActionQueue
-
This will prevent any new actions being queued (by setting the stop flag to true and thus causing an exception to be thrown when a call is made to [enqueue]) and will block until the queue is empty.
- stop() - Method in class com.renomad.minum.queue.ActionQueue
-
This will prevent any new actions being queued (by setting the stop flag to true and thus causing an exception to be thrown when a call is made to [enqueue]) and will block until the queue is empty.
- stop() - Method in interface com.renomad.minum.security.ITheBrig
-
Kills the infinite loop running inside this class.
- stop() - Method in class com.renomad.minum.security.TheBrig
- stop(int, int) - Method in class com.renomad.minum.database.AbstractDb
-
Used to cleanly stop the database, with extra allowance of time for cleanup.
- stop(int, int) - Method in class com.renomad.minum.database.Db
-
Similar to
Db.stop()but gives more control over how long we'll wait before crashing it closed. - stop(int, int) - Method in class com.renomad.minum.database.DbEngine2
-
No real difference to
DbEngine2.stop()but here to have a similar contract toDb - stop(int, int) - Method in interface com.renomad.minum.queue.AbstractActionQueue
-
Stops the action queue
- stop(int, int) - Method in class com.renomad.minum.queue.ActionQueue
-
Stops the action queue
- stopTimer() - Method in class com.renomad.minum.testing.StopwatchUtils
- StopwatchUtils - Class in com.renomad.minum.testing
-
This class provides some tools for running a virtual stopwatch while code is running, to examine code speed.
- StopwatchUtils() - Constructor for class com.renomad.minum.testing.StopwatchUtils
- StreamingMultipartPartition - Class in com.renomad.minum.web
-
This class represents a single partition in a multipart/form Request body, when read as an InputStream.
- StringUtils - Class in com.renomad.minum.utils
-
Some helper methods for Strings.
- STRONG - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- STYLE - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- SUB - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- SUMMARY - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- SUP - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- suspiciousErrors - Variable in class com.renomad.minum.state.Constants
-
These are a list of error messages that often indicate unusual behavior, maybe an attacker
- suspiciousPaths - Variable in class com.renomad.minum.state.Constants
-
These are a list of paths that often indicate unusual behavior, maybe an attacker
- SVG - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- sw() - Method in record class com.renomad.minum.web.PreHandlerInputs
-
Returns the value of the
swrecord component.
T
- TABLE - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- TagInfo - Class in com.renomad.minum.htmlparsing
-
tagname and attributes inside an HTML5 tag
- TagInfo(TagName, Map<String, String>) - Constructor for class com.renomad.minum.htmlparsing.TagInfo
- TagName - Enum Class in com.renomad.minum.htmlparsing
-
Possible tag names per the W3C HTML spec.
- TBODY - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- TD - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- TEMPLATE - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- TemplateParseException - Exception Class in com.renomad.minum.templating
-
Thrown when failing to parse something in a template
- TemplateParseException(String) - Constructor for exception class com.renomad.minum.templating.TemplateParseException
- TemplateProcessor - Class in com.renomad.minum.templating
-
This class provides methods for working with templates.
- TemplateRenderException - Exception Class in com.renomad.minum.templating
-
This exception is thrown for any failures during the rendering of a template.
- TemplateRenderException(String) - Constructor for exception class com.renomad.minum.templating.TemplateRenderException
- test(String) - Method in class com.renomad.minum.logging.TestLogger
-
A helper function to log a test title prefixed with "TEST:"
Also collects data about the previously-run test - TestFailureException - Exception Class in com.renomad.minum.testing
-
Thrown when a test fails
- TestFailureException(String) - Constructor for exception class com.renomad.minum.testing.TestFailureException
-
This constructor allows you to provide a text message for insight into what exceptional situation took place.
- TestFailureException(String, Throwable) - Constructor for exception class com.renomad.minum.testing.TestFailureException
-
This constructor allows users to provide a message and also the cause of the exception.
- TestFramework - Class in com.renomad.minum.testing
-
These are utility functions for basic automated testing.
- TestLogger - Class in com.renomad.minum.logging
-
This implementation of
Loggerhas a few extra functions that only apply to tests, likeTestLogger.test(String) - TestLogger(Constants, ExecutorService, String) - Constructor for class com.renomad.minum.logging.TestLogger
-
See
TestLogger - TestLoggerException - Exception Class in com.renomad.minum.logging
-
An implementation of
RuntimeException, scoped for the TestLogger. - TestLoggerException(String) - Constructor for exception class com.renomad.minum.logging.TestLoggerException
- TestLoggerQueue - Class in com.renomad.minum.logging
-
Used in
TestLoggeras a circular queue to store the most recent log statements for analysis. - TestLoggerQueue(int) - Constructor for class com.renomad.minum.logging.TestLoggerQueue
- TestResponse(StatusLine, Headers, Body) - Constructor for record class com.renomad.minum.web.FunctionalTesting.TestResponse
-
Creates an instance of a
TestResponserecord class. - TEXTAREA - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- TFOOT - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- TH - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- THEAD - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- TheBrig - Class in com.renomad.minum.security
-
See
ITheBrig - TheBrig(int, Context) - Constructor for class com.renomad.minum.security.TheBrig
- TheBrig(Context) - Constructor for class com.renomad.minum.security.TheBrig
-
In this class we create a thread that runs throughout the lifetime of the application, in an infinite loop removing keys from the list under consideration.
- ThrowingConsumer<T> - Interface in com.renomad.minum.web
-
This exists so that we are able to better manage exceptions in a highly threaded system.
- ThrowingFunction<T,
R> - Interface in com.renomad.minum.web -
This exists so that we are able to better manage exceptions in a highly threaded system.
- ThrowingRunnable - Interface in com.renomad.minum.utils
-
This exists so that we are able to slightly better manage exceptions in a highly threaded system.
- throwingRunnableWrapper(ThrowingRunnable, ILogger) - Static method in interface com.renomad.minum.utils.ThrowingRunnable
- ThrowingSupplier<T,
E> - Interface in com.renomad.minum.logging -
a functional interface used in
ILogger, allows exceptions to bubble up. - TIME - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- TimeUtils - Class in com.renomad.minum.utils
- TITLE - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- tokenizer(String, char, int) - Static method in class com.renomad.minum.utils.SerializationUtils
-
Splits up a string into tokens.
- toString() - Method in class com.renomad.minum.htmlparsing.HtmlParseNode
- toString() - Method in class com.renomad.minum.htmlparsing.TagInfo
- toString() - Method in class com.renomad.minum.logging.TestLogger
- toString() - Method in class com.renomad.minum.queue.ActionQueue
- toString() - Method in class com.renomad.minum.security.Inmate
- toString() - Method in class com.renomad.minum.utils.RunnableWithDescription
- toString() - Method in class com.renomad.minum.web.Body
- toString() - Method in class com.renomad.minum.web.ContentDisposition
- toString() - Method in record class com.renomad.minum.web.FunctionalTesting.TestResponse
-
Returns a string representation of this record class.
- toString() - Method in class com.renomad.minum.web.Headers
- toString() - Method in record class com.renomad.minum.web.LastMinuteHandlerInputs
-
Returns a string representation of this record class.
- toString() - Method in class com.renomad.minum.web.Partition
- toString() - Method in class com.renomad.minum.web.PathDetails
- toString() - Method in record class com.renomad.minum.web.PreHandlerInputs
-
Returns a string representation of this record class.
- toString() - Method in class com.renomad.minum.web.Request
- toString() - Method in class com.renomad.minum.web.RequestLine
- toString() - Method in class com.renomad.minum.web.Response
- toString() - Method in class com.renomad.minum.web.SocketWrapper
-
Note that since we are indicating just the remote address as the unique value, in cases like tests where we are operating as sometimes server or client, you might see the server as the remote.
- toString() - Method in record class com.renomad.minum.web.StatusLine
-
Returns a string representation of this record class.
- TR - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- TRACE - Enum constant in enum class com.renomad.minum.logging.LoggingLevel
-
Information marked as trace is pretty much entered for the same reason as DEBUG - i.e.
- TRACE - Enum constant in enum class com.renomad.minum.web.RequestLine.Method
- TRACK - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
U
- U - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- UL - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- UNKNOWN - Enum constant in enum class com.renomad.minum.web.HttpServerType
-
Indicates an unknown state
- UNRECOGNIZED - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
-
A special tag, meant for cases where we are scanning through unfamiliar namespaces, like svg or math.
- UNRECOGNIZED - Enum constant in enum class com.renomad.minum.web.BodyType
-
a body exists but does not correspond to any known encoding
- UrlEncodedDataGetter - Class in com.renomad.minum.web
-
This class enables pulling key-value pairs one at a time from the Request body.
- UrlEncodedKeyValue - Class in com.renomad.minum.web
-
Represents a key-value pair with URL-encoding.
- UrlEncodedKeyValue(String, UrlEncodedDataGetter) - Constructor for class com.renomad.minum.web.UrlEncodedKeyValue
- useCacheForStaticFiles - Variable in class com.renomad.minum.state.Constants
-
Whether we will use caching for the static files.
- UtilsException - Exception Class in com.renomad.minum.utils
- UtilsException(String) - Constructor for exception class com.renomad.minum.utils.UtilsException
- UtilsException(Throwable) - Constructor for exception class com.renomad.minum.utils.UtilsException
V
- valueByKey(String) - Method in class com.renomad.minum.web.Headers
-
Allows a user to obtain any header value by its key, case-insensitively
- valueOf(String) - Static method in enum class com.renomad.minum.htmlparsing.ParseNodeType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.renomad.minum.htmlparsing.TagName
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.renomad.minum.logging.LoggingLevel
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.renomad.minum.web.BodyType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.renomad.minum.web.HttpServerType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.renomad.minum.web.HttpVersion
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.renomad.minum.web.RequestLine.Method
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.renomad.minum.web.StatusLine.StatusCode
-
Returns the enum constant of this class with the specified name.
- values() - Method in class com.renomad.minum.database.AbstractDb
-
This method provides read capability for the values of a database.
- values() - Method in class com.renomad.minum.database.Db
- values() - Method in class com.renomad.minum.database.DbEngine2
-
This method provides read capability for the values of a database.
- values() - Static method in enum class com.renomad.minum.htmlparsing.ParseNodeType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.renomad.minum.htmlparsing.TagName
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.renomad.minum.logging.LoggingLevel
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.renomad.minum.web.BodyType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.renomad.minum.web.HttpServerType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.renomad.minum.web.HttpVersion
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.renomad.minum.web.RequestLine.Method
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.renomad.minum.web.StatusLine.StatusCode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VAR - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- version() - Method in record class com.renomad.minum.web.StatusLine
-
Returns the value of the
versionrecord component. - VIDEO - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- vulnSeekingJailDuration - Variable in class com.renomad.minum.state.Constants
-
If a client does something that we consider an indicator for attacking, put them in jail for a longer duration.
W
- WBR - Enum constant in enum class com.renomad.minum.htmlparsing.TagName
- WebFramework - Class in com.renomad.minum.web
-
This class is responsible for the HTTP handling after socket connection.
- WebServerException - Exception Class in com.renomad.minum.web
-
This is just a
RuntimeExceptionthat is scoped for our web server. - WebServerException(String) - Constructor for exception class com.renomad.minum.web.WebServerException
- WebServerException(String, Throwable) - Constructor for exception class com.renomad.minum.web.WebServerException
- WebServerException(Throwable) - Constructor for exception class com.renomad.minum.web.WebServerException
- write(T) - Method in class com.renomad.minum.database.AbstractDb
-
Write data to the database.
- write(T) - Method in class com.renomad.minum.database.Db
-
Write data to the database.
- write(T) - Method in class com.renomad.minum.database.DbEngine2
-
Write data to the database.
- writeString(Path, String) - Method in class com.renomad.minum.utils.FileUtils
-
Write a string to a path on disk.
- writeToMemory(T, boolean) - Method in class com.renomad.minum.database.AbstractDb
-
Write database data into memory
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form