Index

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

A

ABNORMAL - Enum constant in enum class de.craftsblock.craftsnet.api.websocket.ClosureCode

Indicates an abnormal closure, meaning that the connection was closed abruptly without sending or receiving a close frame.

AcceptEncodingHelper - Class in de.craftsblock.craftsnet.api.http.encoding

A parser for the Accept-Encoding http header.

ActivateType - Enum Class in de.craftsblock.craftsnet.builder

Enum representing activation types for various components in the CraftsNet framework.

add(String, WebSocketClient) - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketServer

Adds a WebSocket client to a specified path.

addAlias(String...) - Method in class de.craftsblock.craftsnet.command.Command

Adds an alias to this command

addAllowedHeader(String...) - Method in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Adds one or more http headers to the list of allowed headers for cross-origin requests.

addAllowedMethod(HttpMethod...) - Method in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Adds one or more http methods to the list of allowed methods for cross-origin requests.

addAllowedOrigin(String...) - Method in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Adds one or more origins to the list of allowed origins for cross-origin requests.

addCodeSource(CodeSource) - Method in class de.craftsblock.craftsnet.builder.AddonContainingBuilder

Adds a CodeSource to the code sources list.

addCodeSource(CodeSource) - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Adds a CodeSource to the code sources list.

addDirectly(Collection<AddonConfiguration>) - Method in class de.craftsblock.craftsnet.addon.AddonManager

Adds AddonConfiguration directly to the configurations which will be loaded on startup.

addExposedHeader(String...) - Method in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Adds one or more http headers to the list of headers exposed to the client.

addHeader(String, String) - Method in class de.craftsblock.craftsnet.api.http.Response

Adds a response header with the specified key and value.

addHeader(String, String) - Method in class de.craftsblock.craftsnet.events.requests.shares.ShareRequestEvent

Deprecated, for removal: This API element is subject to removal in a future version.

Use Response.addHeader(String, String) instead.

addLine(String) - Method in class de.craftsblock.craftsnet.logging.mutate.LogStream

Adds a line to the log file.

addon() - Method in record class de.craftsblock.craftsnet.addon.meta.AddonConfiguration

Returns the value of the addon record component.

Addon - Class in de.craftsblock.craftsnet.addon

Abstract class representing an addon that extends the functionality of the application without modifying its core.

Addon() - Constructor for class de.craftsblock.craftsnet.addon.Addon

AddonClassLoader - Class in de.craftsblock.craftsnet.addon.loaders

Class responsible for loading addons dynamically into the CraftsNet framework.

AddonConfiguration - Record Class in de.craftsblock.craftsnet.addon.meta

Represents the configuration details of an Addon, including its metadata, classpath, and dependencies.

AddonConfiguration(Path, Json, URL[], DependencyClassLoader[], Collection<RegisteredService>, AtomicReference<Addon>, AtomicReference<AddonMeta>, AtomicReference<AddonClassLoader>) - Constructor for record class de.craftsblock.craftsnet.addon.meta.AddonConfiguration

Creates an instance of a AddonConfiguration record class.

AddonContainingBuilder - Class in de.craftsblock.craftsnet.builder

Builder class for configuring the CraftsNet with a set of addons.

AddonContainingBuilder(Collection<Class<? extends Addon>>) - Constructor for class de.craftsblock.craftsnet.builder.AddonContainingBuilder

Creates a new instance of AddonContainingBuilder with providing a collection containing Addon classes.

AddonLoader - Class in de.craftsblock.craftsnet.addon.loaders

The AddonLoader class is responsible for loading and managing addons in the application.

AddonLoader(CraftsNet) - Constructor for class de.craftsblock.craftsnet.addon.loaders.AddonLoader

Constructs a new instance of an addon loader

addonManager() - Method in class de.craftsblock.craftsnet.CraftsNet

Deprecated, for removal: This API element is subject to removal in a future version.

Use CraftsNet.getAddonManager() instead. This will be removed in the future.

AddonManager - Class in de.craftsblock.craftsnet.addon

The AddonManager class is responsible for managing addons in the application.

AddonManager(CraftsNet) - Constructor for class de.craftsblock.craftsnet.addon.AddonManager

Constructor for the AddonManager class.

AddonMeta - Record Class in de.craftsblock.craftsnet.addon.meta

Represents metadata information for an addon, such as its name, main class, authors, website, version, and dependencies.

AddonMeta(String, String, String, List<String>, String, String, String[], String[], String[], String[]) - Constructor for record class de.craftsblock.craftsnet.addon.meta.AddonMeta

Creates an instance of a AddonMeta record class.

addRepository(String) - Method in class de.craftsblock.craftsnet.addon.artifacts.ArtifactLoader

Adds a remote repository to the list of repositories used for dependency resolution.

ALL - Enum constant in enum class de.craftsblock.craftsnet.api.http.HttpMethod

Represents all request methods

ALL_RAW - Enum constant in enum class de.craftsblock.craftsnet.api.http.HttpMethod

Represents all request methods + raw request methods

AllAddonsDisabledEvent - Class in de.craftsblock.craftsnet.events.addons

The AllAddonsDisabledEvent class represents an event triggered when all addons are disabled within CraftsNet.

AllAddonsDisabledEvent() - Constructor for class de.craftsblock.craftsnet.events.addons.AllAddonsDisabledEvent

AllAddonsLoadedEvent - Class in de.craftsblock.craftsnet.events.addons

The AddonsLoadedEvent class represents an event triggered when all addons are loaded within CraftsNet.

AllAddonsLoadedEvent() - Constructor for class de.craftsblock.craftsnet.events.addons.AllAddonsLoadedEvent

ALLOW_CREDENTIALS_HEADER - Static variable in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

The http header that indicates whether the response to the request can be exposed when the credentials flag is true.

ALLOW_HEADERS_HEADER - Static variable in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

The http header that defines which custom request headers are allowed during a CORS request.

ALLOW_METHODS_HEADER - Static variable in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

The http header that indicates which http methods are permitted when accessing the resource.

ALLOW_ORIGIN_HEADER - Static variable in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

The http header that specifies which origin sites are allowed to access the resource.

allowAllHeaders() - Method in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Allows all http headers for cross-origin requests, meaning any header can be sent from the client.

allowAllMethods() - Method in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Allows all http methods (e.g., GET, POST, DELETE) for cross-origin requests.

allowAllOrigins() - Method in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Allows all origins for cross-origin requests.

allowCredentials() - Method in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Allows credentials (such as cookies or authentication data) in cross-origin requests.

allowWithoutMapping(boolean) - Method in class de.craftsblock.craftsnet.events.sockets.ClientConnectEvent

Sets whether the websocket client is allowed to connect to the server without a valid endpoint or not.

annotation() - Method in record class de.craftsblock.craftsnet.api.requirements.meta.RequirementInfo

Returns the value of the annotation record component.

appendFrame(Frame) - Method in class de.craftsblock.craftsnet.api.websocket.Frame

Appends the data from the specified frame to the current frame.

APPLICATION_FORM_URLENCODED - Static variable in interface de.craftsblock.craftsnet.api.http.body.ContentType

APPLICATION_JSON - Static variable in interface de.craftsblock.craftsnet.api.http.body.ContentType

applies(Request, RouteRegistry.EndpointMapping) - Method in class de.craftsblock.craftsnet.api.requirements.web.BodyRequirement

Checks if the requirement applies given the specified request and route mapping.

applies(Request, RouteRegistry.EndpointMapping) - Method in class de.craftsblock.craftsnet.api.requirements.web.ContentTypeRequirement

Checks if the requirement applies given the specified request and route mapping.

applies(Request, RouteRegistry.EndpointMapping) - Method in class de.craftsblock.craftsnet.api.requirements.web.CookieRequirement

Checks if the requirement applies given the specified request and endpoint mapping.

applies(Request, RouteRegistry.EndpointMapping) - Method in class de.craftsblock.craftsnet.api.requirements.web.HeadersRequirement

Checks if the requirement applies given the specified request and route mapping.

applies(Request, RouteRegistry.EndpointMapping) - Method in class de.craftsblock.craftsnet.api.requirements.web.HTTPDomainRequirement

Checks if the requirement applies given the specified request and route mapping.

applies(Request, RouteRegistry.EndpointMapping) - Method in class de.craftsblock.craftsnet.api.requirements.web.MethodRequirement

Checks if the requirement applies given the specified request and route mapping.

applies(Request, RouteRegistry.EndpointMapping) - Method in class de.craftsblock.craftsnet.api.requirements.web.QueryParameterRequirement

Checks if the requirement applies given the specified request and endpoint mapping.

applies(Frame, RouteRegistry.EndpointMapping) - Method in class de.craftsblock.craftsnet.api.requirements.websocket.MessageTypeRequirement

Checks if the requirement applies given the specified websocket message and socket mapping.

applies(WebSocketClient, RouteRegistry.EndpointMapping) - Method in class de.craftsblock.craftsnet.api.requirements.websocket.WSDomainRequirement

Checks if the requirement applies given the specified websocket client and socket mapping.

applies(T, R) - Method in class de.craftsblock.craftsnet.api.requirements.Requirement

Determines if this requirement applies to the specified mapping and content.

apply(Exchange) - Method in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Applies the current CORS policy to an Exchange object by adding appropriate headers to the response based on the allowed origins, methods, headers, and credentials.

ApplyDecoder - Annotation Interface in de.craftsblock.craftsnet.api.websocket.annotations

Specifies a WebSocketSafeTypeDecoder to be applied to the second parameter of a WebSocket handler method.

ApplyMiddleware - Annotation Interface in de.craftsblock.craftsnet.api.middlewares.annotation

Annotation to set specific middlewares to be used before the endpoint is performed.

ApplyMiddleware.List - Annotation Interface in de.craftsblock.craftsnet.api.middlewares.annotation

The ApplyMiddleware.List annotation is used to repeat the ApplyMiddleware annotation.

areArgsCompatible(Executable, Class<?>...) - Static method in class de.craftsblock.craftsnet.utils.reflection.ReflectionUtils

Checks whether the provided argument types are compatible with the parameter types of the executable.

ArtifactLoader - Class in de.craftsblock.craftsnet.addon.artifacts

The ArtifactLoader class provides functionality for resolving and loading libraries (artifacts) for addons in a modular system.

ArtifactLoader() - Constructor for class de.craftsblock.craftsnet.addon.artifacts.ArtifactLoader

Creates a new instance of the artifact loader

asCodecSubtype(Class<?>) - Method in class de.craftsblock.craftsnet.api.codec.CodecPair

Casts the given type to a subclass of the target type.

asString(HttpMethod...) - Static method in enum class de.craftsblock.craftsnet.api.http.HttpMethod

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of HttpMethod.join(HttpMethod...).

authors() - Method in record class de.craftsblock.craftsnet.addon.meta.AddonMeta

Returns the value of the authors record component.

AutoRegister - Annotation Interface in de.craftsblock.craftsnet.autoregister.meta

The AutoRegister is an annotation used to mark classes for automatic registration during the startup process.

AutoRegisterHandler<T> - Class in de.craftsblock.craftsnet.autoregister

The AutoRegisterHandler class is an abstract base class designed to handle objects during the auto registration process.

AutoRegisterHandler(CraftsNet) - Constructor for class de.craftsblock.craftsnet.autoregister.AutoRegisterHandler

Constructs an AutoRegisterHandler with the specified CraftsNet instance.

AutoRegisterInfo - Class in de.craftsblock.craftsnet.autoregister.meta

The AutoRegisterInfo holds information about a class to be processed in an auto registration process.

AutoRegisterInfo(String, Collection<Addon>, Annotation, ClassLoader, List<String>) - Constructor for class de.craftsblock.craftsnet.autoregister.meta.AutoRegisterInfo

Constructs an AutoRegisterInfo object with the given parameters.

AutoRegisterLoader - Class in de.craftsblock.craftsnet.autoregister.loaders

A loader class responsible for loading classes from a JAR file that are annotated with a specific annotation (default is AutoRegister) and collecting relevant information about these classes.

AutoRegisterLoader() - Constructor for class de.craftsblock.craftsnet.autoregister.loaders.AutoRegisterLoader

autoRegisterRegistry() - Method in class de.craftsblock.craftsnet.addon.Addon

Deprecated, for removal: This API element is subject to removal in a future version.

Use Addon.getAutoRegisterRegistry() instead. This will be removed in the future.

autoRegisterRegistry() - Method in class de.craftsblock.craftsnet.CraftsNet

Deprecated, for removal: This API element is subject to removal in a future version.

Use CraftsNet.getAutoRegisterRegistry() instead. This will be removed in the future.

AutoRegisterRegistry - Class in de.craftsblock.craftsnet.autoregister

The AutoRegisterRegistry is responsible for managing and invoking AutoRegisterHandler instances based on the provided AutoRegisterInfo.

AutoRegisterRegistry(CraftsNet) - Constructor for class de.craftsblock.craftsnet.autoregister.AutoRegisterRegistry

Constructs an AutoRegisterRegistry that will register default handlers.

availableOrQueue(SessionStorage.JobType, Object...) - Method in class de.craftsblock.craftsnet.api.session.SessionStorage

Checks if the session file is busy.

awakeOrWarn() - Method in class de.craftsblock.craftsnet.api.http.WebServer

Perform necessary actions when the server is awakened or warn if needed.

awakeOrWarn() - Method in class de.craftsblock.craftsnet.api.Server

Perform necessary actions when the server is awakened or warn if needed.

awakeOrWarn() - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketServer

Perform necessary actions when the server is awakened or warn if needed.

B

backlog - Variable in class de.craftsblock.craftsnet.api.Server

BAD_GATEWAY - Enum constant in enum class de.craftsblock.craftsnet.api.websocket.ClosureCode

Indicates that the server is terminating the connection because it received a message that was too large.

BaseExchange - Interface in de.craftsblock.craftsnet.api

Acts as the base for all exchanges that exists.

BINARY - Enum constant in enum class de.craftsblock.craftsnet.api.websocket.Opcode

Indicates a binary frame.

bind(int) - Method in class de.craftsblock.craftsnet.api.Server

Binds the server to the specified port.

bind(int, int) - Method in class de.craftsblock.craftsnet.api.http.WebServer

Binds the server to the specified port and backlog.

bind(int, int) - Method in class de.craftsblock.craftsnet.api.Server

Binds the server to the specified port and backlog.

bind(int, int) - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketServer

Binds the server to the specified port and backlog.

blurIPs(String) - Static method in class de.craftsblock.craftsnet.utils.Utils

Blurs IPv4 and IPv6 ip addresses in an string.

BlurIPsMutator - Class in de.craftsblock.craftsnet.logging.mutate.builtin

A built-in LogStreamMutator that blurs or censors IP addresses in log lines.

BlurIPsMutator() - Constructor for class de.craftsblock.craftsnet.logging.mutate.builtin.BlurIPsMutator

body - Variable in class de.craftsblock.craftsnet.api.http.body.bodies.FormBody

Body - Class in de.craftsblock.craftsnet.api.http.body

The abstract class Body is the base class for all types of HTTP request bodies supported by CraftsNet.

Body(Request) - Constructor for class de.craftsblock.craftsnet.api.http.body.Body

Constructs a new instance of a request body.

BodyAutoRegisterHandler - Class in de.craftsblock.craftsnet.autoregister.builtin.http

A handler for automatically registering BodyParser implementations.

BodyAutoRegisterHandler(CraftsNet) - Constructor for class de.craftsblock.craftsnet.autoregister.builtin.http.BodyAutoRegisterHandler

Constructs a new BodyAutoRegisterHandler.

BodyParser<T extends Body> - Class in de.craftsblock.craftsnet.api.http.body

This abstract class represents a parser for HTTP request or response bodies.

BodyParser(String, String...) - Constructor for class de.craftsblock.craftsnet.api.http.body.BodyParser

Constructs a new BodyParser with the given content types.

bodyRegistry() - Method in class de.craftsblock.craftsnet.addon.Addon

Deprecated, for removal: This API element is subject to removal in a future version.

Use Addon.getBodyRegistry() instead. This will be removed in the future.

bodyRegistry() - Method in class de.craftsblock.craftsnet.CraftsNet

Deprecated, for removal: This API element is subject to removal in a future version.

Use CraftsNet.getBodyRegistry() instead. This will be removed in the future.

BodyRegistry - Class in de.craftsblock.craftsnet.api.http.body

This class represents a registry for body parsers used in HTTP request processing.

BodyRegistry() - Constructor for class de.craftsblock.craftsnet.api.http.body.BodyRegistry

Constructs a new BodyRegistry and registers default body parsers for common body types.

BodyRequirement - Class in de.craftsblock.craftsnet.api.requirements.web

A specific web requirement that checks if the body of an HTTP request matches certain criteria.

BodyRequirement() - Constructor for class de.craftsblock.craftsnet.api.requirements.web.BodyRequirement

Constructs a new body requirement.

BooleanTransformer - Class in de.craftsblock.craftsnet.api.transformers.builtin

A transformer class for converting a string representation of a boolean value to a Boolean object.

BooleanTransformer() - Constructor for class de.craftsblock.craftsnet.api.transformers.builtin.BooleanTransformer

broadcast(String) - Method in record class de.craftsblock.craftsnet.api.websocket.SocketExchange

Broadcasts the given data to all WebSocket clients connected to the same path as the current client.

broadcast(String) - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketServer

Sends a message to all connected WebSocket clients.

broadcast(String, String) - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketServer

Sends a message to all connected WebSocket clients with a specified path.

build() - Method in class de.craftsblock.craftsnet.builder.AddonContainingBuilder

Builds and starts the CraftsNet framework with the configured settings.

build() - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Builds and starts the CraftsNet framework with the configured settings.

ByteArrayBody - Class in de.craftsblock.craftsnet.api.http.body.bodies.typed

The ByteArrayBody class represents an http request body which contains byte[] data.

ByteArrayBody(Request, byte[]) - Constructor for class de.craftsblock.craftsnet.api.http.body.bodies.typed.ByteArrayBody

Constructs a new instance of a TypedBody.

ByteArrayBodyParser - Class in de.craftsblock.craftsnet.api.http.body.parser.typed

This class is a body parser specifically designed to parse ByteArrayBody request bodies.

ByteArrayBodyParser() - Constructor for class de.craftsblock.craftsnet.api.http.body.parser.typed.ByteArrayBodyParser

Constructs a new ByteArrayBodyParser.

ByteBuffer - Class in de.craftsblock.craftsnet.utils

A custom ByteBuffer implementation that provides both read and write operations for byte arrays.

ByteBuffer(byte[]) - Constructor for class de.craftsblock.craftsnet.utils.ByteBuffer

Constructs a new ByteBuffer from an existing byte array.

ByteBuffer(byte[], boolean) - Constructor for class de.craftsblock.craftsnet.utils.ByteBuffer

Constructs a new ByteBuffer from an existing byte array with the option to set the buffer as read-only.

ByteBuffer(byte[], boolean, boolean) - Constructor for class de.craftsblock.craftsnet.utils.ByteBuffer

Constructs a new ByteBuffer from an existing byte array with options for read-only and fixed size.

ByteBuffer(int) - Constructor for class de.craftsblock.craftsnet.utils.ByteBuffer

Constructs a new ByteBuffer with the given initial size.

ByteBuffer(int, boolean) - Constructor for class de.craftsblock.craftsnet.utils.ByteBuffer

Constructs a new ByteBuffer with the given initial size and the option to set a fixed size.

ByteBuffer(int, boolean, boolean) - Constructor for class de.craftsblock.craftsnet.utils.ByteBuffer

Constructs a new ByteBuffer with the given initial size, read-only, and fixed-size flags.

ByteTransformer - Class in de.craftsblock.craftsnet.api.transformers.builtin

A transformer class for converting a string representation of a byte value to a Byte object.

ByteTransformer() - Constructor for class de.craftsblock.craftsnet.api.transformers.builtin.ByteTransformer

byteValue() - Method in enum class de.craftsblock.craftsnet.api.websocket.Opcode

Retrieves the byte value of the opcode.

C

cacheable() - Element in annotation interface de.craftsblock.craftsnet.api.transformers.annotations.Transformer

Specifies whether caching is enabled for the transformation.

canCodecType(Class<?>) - Method in class de.craftsblock.craftsnet.api.codec.CodecPair

Determines whether the given type can be handled by this codec.

canShareAccept(String, HttpMethod) - Method in class de.craftsblock.craftsnet.api.RouteRegistry

Checks if a URL corresponding share is able to accept a specific http method.

castTo(Object, Class<T>) - Static method in class de.craftsblock.craftsnet.utils.reflection.ReflectionUtils

Checks if the object can be cast to a targeted type and casts it.

CHARS - Static variable in class de.craftsblock.craftsnet.utils.PassphraseUtils

The base chars used to created passphrases.

classLoader() - Method in record class de.craftsblock.craftsnet.addon.meta.AddonConfiguration

Returns the value of the classLoader record component.

classpath() - Method in record class de.craftsblock.craftsnet.addon.meta.AddonConfiguration

Returns the value of the classpath record component.

cleanup() - Method in class de.craftsblock.craftsnet.addon.artifacts.ArtifactLoader

Cleanup internal repository cache

cleanUp(Request) - Static method in class de.craftsblock.craftsnet.api.http.body.Body

Closes all bodies corresponding to a specific request.

clearCache() - Method in class de.craftsblock.craftsnet.api.transformers.TransformerPerformer

Clears the transformer cache.

client() - Method in record class de.craftsblock.craftsnet.api.websocket.SocketExchange

Gets the WebSocketClient object associated with this exchange representing the websocket connection.

ClientConnectEvent - Class in de.craftsblock.craftsnet.events.sockets

The ClientConnectEvent class represents an event related to a client connection to a socket.

ClientConnectEvent(SocketExchange) - Constructor for class de.craftsblock.craftsnet.events.sockets.ClientConnectEvent

Constructs a new ClientConnectEvent with the specified SocketExchange and SocketMapping.

ClientDisconnectEvent - Class in de.craftsblock.craftsnet.events.sockets

The ClientDisconnectEvent class represents an event related to a client disconnection from a websocket connection.

ClientDisconnectEvent(SocketExchange, int, String, boolean) - Constructor for class de.craftsblock.craftsnet.events.sockets.ClientDisconnectEvent

Constructs a new ClientDisconnectEvent with the specified SocketExchange and SocketMapping.

clone() - Method in class de.craftsblock.craftsnet.api.websocket.Frame

Creates a deep copy of this frame.

cloneWithName(String) - Method in class de.craftsblock.craftsnet.logging.impl.LoggerImpl

Creates a clone of this Logger with a specified name.

cloneWithName(String) - Method in record class de.craftsblock.craftsnet.logging.impl.NoOpLogger

Creates a clone of this Logger with a specified name.

cloneWithName(String) - Method in record class de.craftsblock.craftsnet.logging.impl.PlainLogger

Creates a clone of this Logger with a specified name.

cloneWithName(String) - Method in interface de.craftsblock.craftsnet.logging.Logger

Creates a clone of this Logger with a specified name.

cloneWithName(String, Object...) - Method in interface de.craftsblock.craftsnet.logging.Logger

Creates a clone of this Logger with a formatted name.

close() - Method in class de.craftsblock.craftsnet.api.http.body.bodies.FormBody

Clears the internal data map when the form body is closed.

close() - Method in class de.craftsblock.craftsnet.api.http.body.Body

Closes the request body.

close() - Method in record class de.craftsblock.craftsnet.api.http.Exchange

Performs last actions before the exchange is closed.

close() - Method in class de.craftsblock.craftsnet.api.http.Request

Closes the Request object, releasing associated resources such as the HttpExchange and request headers.

close() - Method in class de.craftsblock.craftsnet.api.http.Response

Closes the response

close() - Method in class de.craftsblock.craftsnet.api.session.Session

Saves the session data to a persistent file.

close() - Method in record class de.craftsblock.craftsnet.api.websocket.SocketExchange

Performs last actions before the exchange is closed.

close() - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Disconnects the client gracefully without providing any information about the reason.

close() - Method in class de.craftsblock.craftsnet.autoregister.loaders.AutoRegisterLoader

Perform cleanup for the current AutoRegisterLoader when it is no longer used.

close(int, String) - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Disconnects the client gracefully with a specified code and reason.

close(ClosureCode, String) - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Disconnects the client gracefully with a specified pre-defined code and reason.

close(String) - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Disconnects the client gracefully with a specified reason.

CLOSE - Enum constant in enum class de.craftsblock.craftsnet.api.websocket.Opcode

Indicates a Close frame.

ClosureCode - Enum Class in de.craftsblock.craftsnet.api.websocket

Enumeration representing WebSocket closure codes along with their integer values and internal status.

Codec<R,T> - Interface in de.craftsblock.craftsnet.api.codec

A generic base interface for codecs, combining encoding and decoding operations.

CodecPair<T,C extends Codec<?,?>> - Class in de.craftsblock.craftsnet.api.codec

A sealed base class representing a binding between a target type and a corresponding codec.

CodecPair(Class<T>, C) - Constructor for class de.craftsblock.craftsnet.api.codec.CodecPair

Constructs a new CodecPair with the given target type and codec.

Command - Class in de.craftsblock.craftsnet.command

The Command class represents a command that can be executed.

Command(String) - Constructor for class de.craftsblock.craftsnet.command.Command

Constructs a new Command with the specified name.

CommandExecutor - Interface in de.craftsblock.craftsnet.command

The CommandExecutor interface represents an object capable of executing commands.

commandRegistry() - Method in class de.craftsblock.craftsnet.addon.Addon

Deprecated, for removal: This API element is subject to removal in a future version.

Use Addon.getCommandRegistry() instead. This will be removed in the future.

commandRegistry() - Method in class de.craftsblock.craftsnet.CraftsNet

Deprecated, for removal: This API element is subject to removal in a future version.

Use CraftsNet.getCommandRegistry() instead. This will be removed in the future.

CommandRegistry - Class in de.craftsblock.craftsnet.command

The CommandRegistry class manages and provides access to registered commands.

CommandRegistry(CraftsNet) - Constructor for class de.craftsblock.craftsnet.command.CommandRegistry

Constructs a new instance of the command registry.

compareTo(AddonConfiguration) - Method in record class de.craftsblock.craftsnet.addon.meta.AddonConfiguration

Compares this configuration to another based on their addon names.

compareTo(ProtocolVersion) - Method in record class de.craftsblock.craftsnet.api.utils.ProtocolVersion

Compares this protocol version to another.

CONNECT - Enum constant in enum class de.craftsblock.craftsnet.api.http.HttpMethod

Represents the CONNECT request method

ConsoleListener - Class in de.craftsblock.craftsnet.listeners

The ConsoleListener class is responsible for handling console messages and executing commands.

ConsoleListener(CraftsNet) - Constructor for class de.craftsblock.craftsnet.listeners.ConsoleListener

Constructs a new instance of a console listener

ConsoleMessageEvent - Class in de.craftsblock.craftsnet.events

The ConsoleMessageEvent class represents an event related to a console message.

ConsoleMessageEvent(String) - Constructor for class de.craftsblock.craftsnet.events.ConsoleMessageEvent

Constructs a new ConsoleMessageEvent with the specified console message.

ConstructorType - Enum Class in de.craftsblock.craftsnet.autoregister.meta.constructors

Enum representing different types of constructors used in automatic instance creation or dependency injection mechanisms.

contentType() - Method in record class de.craftsblock.craftsnet.api.http.body.bodies.MultipartFormBody.MultipartItem

Returns the value of the contentType record component.

ContentType - Interface in de.craftsblock.craftsnet.api.http.body

This interface defines constants for commonly used Content-Type headers in HTTP requests and responses.

ContentTypeRequirement - Class in de.craftsblock.craftsnet.api.requirements.web

A specific web requirement that checks if the content-type of an HTTP request matches certain criteria.

ContentTypeRequirement() - Constructor for class de.craftsblock.craftsnet.api.requirements.web.ContentTypeRequirement

Constructs a new content type requirement.

contentTypes() - Method in class de.craftsblock.craftsnet.api.http.body.BodyParser

Returns an unmodifiable list of supported content types as patterns.

CONTINUATION - Enum constant in enum class de.craftsblock.craftsnet.api.websocket.Opcode

Indicates a continuation frame.

convert(HttpMethod...) - Static method in enum class de.craftsblock.craftsnet.api.http.HttpMethod

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of HttpMethod.normalize(HttpMethod...).

Cookie - Class in de.craftsblock.craftsnet.api.http.cookies

Represents a http cookie with various attributes such as name, value, path, domain, expiry date, same-site policy, security, and HttpOnly flag.

Cookie(String) - Constructor for class de.craftsblock.craftsnet.api.http.cookies.Cookie

Constructs a new Cookie with the specified name and no value.

Cookie(String, Object) - Constructor for class de.craftsblock.craftsnet.api.http.cookies.Cookie

Constructs a new Cookie with the specified name and value.

CookieRequirement - Class in de.craftsblock.craftsnet.api.requirements.web

A specific web requirement that checks if the cookie list of an HTTP request matches certain criteria.

CookieRequirement() - Constructor for class de.craftsblock.craftsnet.api.requirements.web.CookieRequirement

Constructs a new cookie requirement.

CorsPolicy - Class in de.craftsblock.craftsnet.api.http.cors

Represents a Cross-Origin Resource Sharing (CORS) policy, which defines how requests from other origins (domains) can interact with the server's resources.

CorsPolicy() - Constructor for class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Creates a new, empty CORS policy.

craftsNet - Variable in class de.craftsblock.craftsnet.api.Server

craftsNet - Variable in class de.craftsblock.craftsnet.autoregister.AutoRegisterHandler

craftsNet() - Method in class de.craftsblock.craftsnet.addon.Addon

Deprecated, for removal: This API element is subject to removal in a future version.

Use Addon.getCraftsNet() instead. This will be removed in the future.

CraftsNet - Class in de.craftsblock.craftsnet

CraftsNet class represents the core component of the CraftsNet framework, providing functionalities for managing various aspects of the system.

CraftsNet() - Constructor for class de.craftsblock.craftsnet.CraftsNet

CraftsNetBuilder - Class in de.craftsblock.craftsnet.builder

Builder class for configuring the CraftsNet.

CraftsNetBuilder() - Constructor for class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Constructs a new CraftsNetBuilder instance with default configuration settings.

CraftsNetClassLoader - Class in de.craftsblock.craftsnet.addon.loaders

A specialized class loader for loading classes and resources in the context of a CraftsNet instance.

CraftsNetClassLoader(CraftsNet, URL[]) - Constructor for class de.craftsblock.craftsnet.addon.loaders.CraftsNetClassLoader

Constructs a new CraftsNetClassLoader with the specified CraftsNet instance and URLs.

CraftsNetClassLoader(CraftsNet, URL[], ClassLoader) - Constructor for class de.craftsblock.craftsnet.addon.loaders.CraftsNetClassLoader

Constructs a new CraftsNetClassLoader with the specified CraftsNet instance, URLs, and parent class loader.

create() - Static method in class de.craftsblock.craftsnet.CraftsNet

Creates a new builder instance for configuring CraftsNet.

create(Class<? extends Addon>...) - Static method in class de.craftsblock.craftsnet.CraftsNet

Creates a new builder instance for configuring CraftsNet with the specified addons.

create(Collection<Class<? extends Addon>>) - Static method in class de.craftsblock.craftsnet.CraftsNet

Creates a new builder instance for configuring CraftsNet with the specified addons.

createErrorLog(CraftsNet, Throwable) - Method in class de.craftsblock.craftsnet.logging.mutate.LogStream

Creates an error log file for the given throwable.

createErrorLog(CraftsNet, Throwable, String, String) - Method in class de.craftsblock.craftsnet.logging.mutate.LogStream

Creates an error log file for the given exception.

createErrorLog(CraftsNet, Throwable, Map<String, String>) - Method in class de.craftsblock.craftsnet.logging.mutate.LogStream

Creates an error log file for the given throwable.

createTempFile(String, String, FileAttribute<?>...) - Method in class de.craftsblock.craftsnet.utils.FileHelper

Creates a temporary file with the given prefix and suffix in the appropriate directory.

D

data - Variable in class de.craftsblock.craftsnet.api.http.body.bodies.FormBody

data() - Method in record class de.craftsblock.craftsnet.api.http.body.bodies.MultipartFormBody.MultipartItem

Returns the value of the data record component.

de.craftsblock.craftsnet - package de.craftsblock.craftsnet

de.craftsblock.craftsnet.addon - package de.craftsblock.craftsnet.addon

de.craftsblock.craftsnet.addon.artifacts - package de.craftsblock.craftsnet.addon.artifacts

de.craftsblock.craftsnet.addon.loaders - package de.craftsblock.craftsnet.addon.loaders

de.craftsblock.craftsnet.addon.meta - package de.craftsblock.craftsnet.addon.meta

de.craftsblock.craftsnet.addon.meta.annotations - package de.craftsblock.craftsnet.addon.meta.annotations

de.craftsblock.craftsnet.addon.services - package de.craftsblock.craftsnet.addon.services

de.craftsblock.craftsnet.addon.services.builtin - package de.craftsblock.craftsnet.addon.services.builtin

de.craftsblock.craftsnet.addon.services.builtin.handlers - package de.craftsblock.craftsnet.addon.services.builtin.handlers

de.craftsblock.craftsnet.addon.services.builtin.listeners - package de.craftsblock.craftsnet.addon.services.builtin.listeners

de.craftsblock.craftsnet.api - package de.craftsblock.craftsnet.api

de.craftsblock.craftsnet.api.annotations - package de.craftsblock.craftsnet.api.annotations

de.craftsblock.craftsnet.api.codec - package de.craftsblock.craftsnet.api.codec

de.craftsblock.craftsnet.api.codec.registry - package de.craftsblock.craftsnet.api.codec.registry

de.craftsblock.craftsnet.api.exceptions - package de.craftsblock.craftsnet.api.exceptions

de.craftsblock.craftsnet.api.http - package de.craftsblock.craftsnet.api.http

de.craftsblock.craftsnet.api.http.annotations - package de.craftsblock.craftsnet.api.http.annotations

de.craftsblock.craftsnet.api.http.body - package de.craftsblock.craftsnet.api.http.body

de.craftsblock.craftsnet.api.http.body.bodies - package de.craftsblock.craftsnet.api.http.body.bodies

de.craftsblock.craftsnet.api.http.body.bodies.typed - package de.craftsblock.craftsnet.api.http.body.bodies.typed

de.craftsblock.craftsnet.api.http.body.parser - package de.craftsblock.craftsnet.api.http.body.parser

de.craftsblock.craftsnet.api.http.body.parser.typed - package de.craftsblock.craftsnet.api.http.body.parser.typed

de.craftsblock.craftsnet.api.http.builtin - package de.craftsblock.craftsnet.api.http.builtin

de.craftsblock.craftsnet.api.http.cookies - package de.craftsblock.craftsnet.api.http.cookies

de.craftsblock.craftsnet.api.http.cors - package de.craftsblock.craftsnet.api.http.cors

de.craftsblock.craftsnet.api.http.encoding - package de.craftsblock.craftsnet.api.http.encoding

de.craftsblock.craftsnet.api.http.encoding.builtin - package de.craftsblock.craftsnet.api.http.encoding.builtin

de.craftsblock.craftsnet.api.middlewares - package de.craftsblock.craftsnet.api.middlewares

de.craftsblock.craftsnet.api.middlewares.annotation - package de.craftsblock.craftsnet.api.middlewares.annotation

de.craftsblock.craftsnet.api.requirements - package de.craftsblock.craftsnet.api.requirements

de.craftsblock.craftsnet.api.requirements.meta - package de.craftsblock.craftsnet.api.requirements.meta

de.craftsblock.craftsnet.api.requirements.web - package de.craftsblock.craftsnet.api.requirements.web

de.craftsblock.craftsnet.api.requirements.websocket - package de.craftsblock.craftsnet.api.requirements.websocket

de.craftsblock.craftsnet.api.session - package de.craftsblock.craftsnet.api.session

de.craftsblock.craftsnet.api.session.drivers - package de.craftsblock.craftsnet.api.session.drivers

de.craftsblock.craftsnet.api.session.drivers.builtin - package de.craftsblock.craftsnet.api.session.drivers.builtin

de.craftsblock.craftsnet.api.ssl - package de.craftsblock.craftsnet.api.ssl

de.craftsblock.craftsnet.api.transformers - package de.craftsblock.craftsnet.api.transformers

de.craftsblock.craftsnet.api.transformers.annotations - package de.craftsblock.craftsnet.api.transformers.annotations

de.craftsblock.craftsnet.api.transformers.builtin - package de.craftsblock.craftsnet.api.transformers.builtin

de.craftsblock.craftsnet.api.transformers.exceptions - package de.craftsblock.craftsnet.api.transformers.exceptions

de.craftsblock.craftsnet.api.utils - package de.craftsblock.craftsnet.api.utils

de.craftsblock.craftsnet.api.websocket - package de.craftsblock.craftsnet.api.websocket

de.craftsblock.craftsnet.api.websocket.annotations - package de.craftsblock.craftsnet.api.websocket.annotations

de.craftsblock.craftsnet.api.websocket.codec - package de.craftsblock.craftsnet.api.websocket.codec

de.craftsblock.craftsnet.api.websocket.extensions - package de.craftsblock.craftsnet.api.websocket.extensions

de.craftsblock.craftsnet.api.websocket.extensions.builtin - package de.craftsblock.craftsnet.api.websocket.extensions.builtin

de.craftsblock.craftsnet.autoregister - package de.craftsblock.craftsnet.autoregister

de.craftsblock.craftsnet.autoregister.builtin - package de.craftsblock.craftsnet.autoregister.builtin

de.craftsblock.craftsnet.autoregister.builtin.addons - package de.craftsblock.craftsnet.autoregister.builtin.addons

de.craftsblock.craftsnet.autoregister.builtin.cli - package de.craftsblock.craftsnet.autoregister.builtin.cli

de.craftsblock.craftsnet.autoregister.builtin.events - package de.craftsblock.craftsnet.autoregister.builtin.events

de.craftsblock.craftsnet.autoregister.builtin.http - package de.craftsblock.craftsnet.autoregister.builtin.http

de.craftsblock.craftsnet.autoregister.builtin.sockets - package de.craftsblock.craftsnet.autoregister.builtin.sockets

de.craftsblock.craftsnet.autoregister.builtin.sockets.codec - package de.craftsblock.craftsnet.autoregister.builtin.sockets.codec

de.craftsblock.craftsnet.autoregister.loaders - package de.craftsblock.craftsnet.autoregister.loaders

de.craftsblock.craftsnet.autoregister.meta - package de.craftsblock.craftsnet.autoregister.meta

de.craftsblock.craftsnet.autoregister.meta.constructors - package de.craftsblock.craftsnet.autoregister.meta.constructors

de.craftsblock.craftsnet.builder - package de.craftsblock.craftsnet.builder

de.craftsblock.craftsnet.command - package de.craftsblock.craftsnet.command

de.craftsblock.craftsnet.command.commands - package de.craftsblock.craftsnet.command.commands

de.craftsblock.craftsnet.events - package de.craftsblock.craftsnet.events

de.craftsblock.craftsnet.events.addons - package de.craftsblock.craftsnet.events.addons

de.craftsblock.craftsnet.events.requests - package de.craftsblock.craftsnet.events.requests

de.craftsblock.craftsnet.events.requests.routes - package de.craftsblock.craftsnet.events.requests.routes

de.craftsblock.craftsnet.events.requests.shares - package de.craftsblock.craftsnet.events.requests.shares

de.craftsblock.craftsnet.events.sockets - package de.craftsblock.craftsnet.events.sockets

de.craftsblock.craftsnet.events.sockets.message - package de.craftsblock.craftsnet.events.sockets.message

de.craftsblock.craftsnet.listeners - package de.craftsblock.craftsnet.listeners

de.craftsblock.craftsnet.logging - package de.craftsblock.craftsnet.logging

de.craftsblock.craftsnet.logging.impl - package de.craftsblock.craftsnet.logging.impl

de.craftsblock.craftsnet.logging.mutate - package de.craftsblock.craftsnet.logging.mutate

de.craftsblock.craftsnet.logging.mutate.builtin - package de.craftsblock.craftsnet.logging.mutate.builtin

de.craftsblock.craftsnet.utils - package de.craftsblock.craftsnet.utils

de.craftsblock.craftsnet.utils.reflection - package de.craftsblock.craftsnet.utils.reflection

de.craftsblock.craftsnet.utils.versions - package de.craftsblock.craftsnet.utils.versions

debug(String, Object...) - Method in interface de.craftsblock.craftsnet.logging.Logger

Logs a formatted debug message.

debug(String) - Method in class de.craftsblock.craftsnet.logging.impl.LoggerImpl

Logs a debug message.

debug(String) - Method in record class de.craftsblock.craftsnet.logging.impl.NoOpLogger

Logs a debug message.

debug(String) - Method in record class de.craftsblock.craftsnet.logging.impl.PlainLogger

Logs a debug message.

debug(String) - Method in interface de.craftsblock.craftsnet.logging.Logger

Logs a debug message.

DEBUG - Enum constant in enum class de.craftsblock.craftsnet.logging.LogLevel

Debug level for detailed debugging information.

decode(byte[], Charset) - Static method in class de.craftsblock.craftsnet.utils.SecureEncodingUtils

Decodes the given byte array into a char array using the specified charset.

decode(Frame) - Method in class de.craftsblock.craftsnet.api.websocket.extensions.builtin.PerMessageDeflateExtension

Decodes a WebSocket frame using per-message deflate decompression.

decode(Frame) - Method in class de.craftsblock.craftsnet.api.websocket.extensions.WebSocketExtension

Decodes a WebSocket frame according to the rules of this extension.

decode(T) - Method in interface de.craftsblock.craftsnet.api.codec.Decoder

Decodes the given input into its corresponding output representation.

Decoder<R,T> - Interface in de.craftsblock.craftsnet.api.codec

A generic interface for decoding data from one type into another.

DecoderPair<T> - Class in de.craftsblock.craftsnet.api.codec

A pairing between a specific target type and its associated Decoder.

DecoderPair(Class<T>, Decoder<T, ?>) - Constructor for class de.craftsblock.craftsnet.api.codec.DecoderPair

Constructs a new DecoderPair for the given target type and decoder.

DefaultPingResponder - Class in de.craftsblock.craftsnet.api.websocket

A default implementation of a ping responder for handling incoming ping messages.

DefaultPingResponder() - Constructor for class de.craftsblock.craftsnet.api.websocket.DefaultPingResponder

DefaultRoute - Class in de.craftsblock.craftsnet.api.http.builtin

Represents a default route handler implementation.

DeflateStreamEncoder - Class in de.craftsblock.craftsnet.api.http.encoding.builtin

A concrete implementation of StreamEncoder that performs compression and decompression using the Deflate algorithm.

DeflateStreamEncoder() - Constructor for class de.craftsblock.craftsnet.api.http.encoding.builtin.DeflateStreamEncoder

Constructs a new DeflateStreamEncoder.

DELETE - Enum constant in enum class de.craftsblock.craftsnet.api.http.HttpMethod

Represents the DELETE request method

deleteCookie(String) - Method in class de.craftsblock.craftsnet.api.http.Response

Marks a cookie for deletion by invoking the mark deleted method on the specific cookie.

dependencies() - Method in record class de.craftsblock.craftsnet.addon.meta.AddonMeta

Returns the value of the dependencies record component.

DEPENDENCY - Enum constant in enum class de.craftsblock.craftsnet.addon.meta.ShadowType

Represents a dependency required by an addon.

DependencyClassLoader - Class in de.craftsblock.craftsnet.addon.loaders

Class responsible for loading dependencies dynamically into the CraftsNet framework.

dependencyLoaders() - Method in record class de.craftsblock.craftsnet.addon.meta.AddonConfiguration

Returns the value of the dependencyLoaders record component.

depends() - Method in record class de.craftsblock.craftsnet.addon.meta.AddonMeta

Returns the value of the depends record component.

Depends - Annotation Interface in de.craftsblock.craftsnet.addon.meta.annotations

Declares a dependency for an Addon.

DependsCollection - Annotation Interface in de.craftsblock.craftsnet.addon.meta.annotations

A container annotation for grouping multiple Depends annotations.

description() - Method in record class de.craftsblock.craftsnet.addon.meta.AddonMeta

Returns the value of the description record component.

deserialize() - Method in class de.craftsblock.craftsnet.api.http.body.bodies.FormBody

This method should be implemented by concrete subclasses to handle the deserialization of form data from the input stream and populate the internal data map.

deserialize() - Method in class de.craftsblock.craftsnet.api.http.body.bodies.MultipartFormBody

Deserializes the multipart form body, parsing it into individual parts and storing them in the data map.

deserialize() - Method in class de.craftsblock.craftsnet.api.http.body.bodies.StandardFormBody

Deserializes the input stream, parsing it into individual form fields and values.

destroy() - Method in class de.craftsblock.craftsnet.api.session.SessionStorage

Deletes the persistent session data holder using the currently set driver.

destroy(Session, String) - Method in class de.craftsblock.craftsnet.api.session.drivers.builtin.FileSessionDriver

Deletes the session file corresponding to the given session ID.

destroy(Session, String) - Method in interface de.craftsblock.craftsnet.api.session.drivers.SessionDriver

Destroys or removes the session data associated with the given session identifier from the underlying storage.

DESTROY - Enum constant in enum class de.craftsblock.craftsnet.api.session.SessionStorage.JobType

Indicating a destroy process.

destroyPersistent() - Method in class de.craftsblock.craftsnet.api.session.SessionInfo

Destroys the persistent session by removing it from the cache, deleting the session file, and clearing the session cookie in the HTTP response.

disable() - Method in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Resets the CORS policy by disabling all settings and restoring it to its default state.

DISABLED - Enum constant in enum class de.craftsblock.craftsnet.builder.ActivateType

Indicates that the component is disabled.

disallowAllHeaders() - Method in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Disallows all headers, requiring cross-origin requests to specify only permitted headers.

disallowAllMethods() - Method in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Disallows all http methods, limiting cross-origin requests to only specific methods.

disallowAllOrigins() - Method in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Disallows all origins, restricting cross-origin requests to specific origins if set.

disallowCredentials() - Method in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Disallows credentials in cross-origin requests.

disconnect() - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Disconnects the WebSocket client and performs necessary cleanup operations.

Domain - Annotation Interface in de.craftsblock.craftsnet.api.annotations

Specifies the domain associated with an HTTP request handler or service.

DoubleTransformer - Class in de.craftsblock.craftsnet.api.transformers.builtin

A transformer class for converting a string representation of a double value to a Double object.

DoubleTransformer() - Constructor for class de.craftsblock.craftsnet.api.transformers.builtin.DoubleTransformer

DYNAMIC - Enum constant in enum class de.craftsblock.craftsnet.builder.ActivateType

Indicates that the activation of the component is dynamic, possibly determined at runtime.

E

ENABLE - Enum constant in enum class de.craftsblock.craftsnet.addon.meta.Startup

Represents the enabling stage of the addon load process.

ENABLED - Enum constant in enum class de.craftsblock.craftsnet.builder.ActivateType

Indicates that the component is enabled.

encode(char[], Charset) - Static method in class de.craftsblock.craftsnet.utils.SecureEncodingUtils

Encodes a given array of chars into a byte array.

encode(Frame) - Method in class de.craftsblock.craftsnet.api.websocket.extensions.builtin.PerMessageDeflateExtension

Encodes a WebSocket frame using per-message deflate compression.

encode(Frame) - Method in class de.craftsblock.craftsnet.api.websocket.extensions.WebSocketExtension

Encodes a WebSocket frame according to the rules of this extension.

encode(T) - Method in interface de.craftsblock.craftsnet.api.codec.Encoder

Encodes the given input into its corresponding encoded representation.

encodeInputStream(InputStream) - Method in class de.craftsblock.craftsnet.api.http.encoding.builtin.DeflateStreamEncoder

Encodes the provided InputStream by wrapping it in a DeflaterInputStream.

encodeInputStream(InputStream) - Method in class de.craftsblock.craftsnet.api.http.encoding.builtin.GZIPStreamEncoder

Encodes the provided InputStream by wrapping it in a GZIPInputStream.

encodeInputStream(InputStream) - Method in class de.craftsblock.craftsnet.api.http.encoding.builtin.IdentityStreamEncoder

Returns the raw input stream without applying any encoding.

encodeInputStream(InputStream) - Method in class de.craftsblock.craftsnet.api.http.encoding.StreamEncoder

Encodes the provided InputStream.

encodeOutputStream(OutputStream) - Method in class de.craftsblock.craftsnet.api.http.encoding.builtin.DeflateStreamEncoder

Encodes the provided OutputStream by wrapping it in a DeflaterOutputStream.

encodeOutputStream(OutputStream) - Method in class de.craftsblock.craftsnet.api.http.encoding.builtin.GZIPStreamEncoder

Encodes the provided OutputStream by wrapping it in a GZIPOutputStream.

encodeOutputStream(OutputStream) - Method in class de.craftsblock.craftsnet.api.http.encoding.builtin.IdentityStreamEncoder

Returns the raw output stream without applying any encoding.

encodeOutputStream(OutputStream) - Method in class de.craftsblock.craftsnet.api.http.encoding.StreamEncoder

Encodes the provided OutputStream.

Encoder<R,T> - Interface in de.craftsblock.craftsnet.api.codec

A generic interface for encoding data from one type into another.

EncoderPair<T> - Class in de.craftsblock.craftsnet.api.codec

A pairing between a specific target type and its associated Encoder.

EncoderPair(Class<T>, Encoder<T, ?>) - Constructor for class de.craftsblock.craftsnet.api.codec.EncoderPair

Constructs a new EncoderPair for the given target type and encoder.

EndpointMapping(ProcessPriority.Priority, Method, Handler, Pattern, ConcurrentHashMap<Class<? extends Annotation>, RequirementInfo>, Stack<Middleware>) - Constructor for record class de.craftsblock.craftsnet.api.RouteRegistry.EndpointMapping

Creates an instance of a EndpointMapping record class.

equals(Class<?>, Class<?>) - Static method in class de.craftsblock.craftsnet.utils.reflection.TypeUtils

Determines if two types a and b are equivalent, considering primitive-wrapper equivalence.

equals(Object) - Method in record class de.craftsblock.craftsnet.addon.meta.AddonConfiguration

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class de.craftsblock.craftsnet.addon.meta.AddonMeta

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class de.craftsblock.craftsnet.addon.meta.RegisteredService

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class de.craftsblock.craftsnet.api.http.body.bodies.MultipartFormBody.MultipartData

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class de.craftsblock.craftsnet.api.http.body.bodies.MultipartFormBody.MultipartItem

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in class de.craftsblock.craftsnet.api.http.cookies.Cookie

Compares this cookie to the specified object for equality.

equals(Object) - Method in class de.craftsblock.craftsnet.api.http.encoding.StreamEncoder

Compares this encoder to another object for equality.

equals(Object) - Method in record class de.craftsblock.craftsnet.api.http.Exchange

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class de.craftsblock.craftsnet.api.requirements.meta.RequirementInfo

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class de.craftsblock.craftsnet.api.RouteRegistry.EndpointMapping

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class de.craftsblock.craftsnet.api.RouteRegistry.ShareMapping

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class de.craftsblock.craftsnet.api.utils.ProtocolVersion

Checks if this protocol version is equal to another object.

equals(Object) - Method in record class de.craftsblock.craftsnet.api.websocket.SocketExchange

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in class de.craftsblock.craftsnet.autoregister.meta.AutoRegisterInfo

equals(Object) - Method in record class de.craftsblock.craftsnet.logging.impl.NoOpLogger

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class de.craftsblock.craftsnet.logging.impl.PlainLogger

Indicates whether some other object is "equal to" this one.

erase(byte[]) - Static method in class de.craftsblock.craftsnet.utils.PassphraseUtils

Overwrites the contents of the given byte array with zeros.

erase(char[]) - Static method in class de.craftsblock.craftsnet.utils.PassphraseUtils

Overwrites the contents of the given char array with null characters ('\0').

error(String, Throwable, Object...) - Method in interface de.craftsblock.craftsnet.logging.Logger

Logs a formatted error message along with the associated throwable.

error(String, Object...) - Method in interface de.craftsblock.craftsnet.logging.Logger

Logs a formatted error message.

error(Throwable) - Method in class de.craftsblock.craftsnet.logging.impl.LoggerImpl

Logs an error message along with the associated throwable.

error(Throwable) - Method in record class de.craftsblock.craftsnet.logging.impl.NoOpLogger

Logs an error message along with the associated throwable.

error(Throwable) - Method in record class de.craftsblock.craftsnet.logging.impl.PlainLogger

Logs an error message along with the associated throwable.

error(Throwable) - Method in interface de.craftsblock.craftsnet.logging.Logger

Logs an error message along with the associated throwable.

error(Throwable, String) - Method in interface de.craftsblock.craftsnet.logging.Logger

Deprecated, for removal: This API element is subject to removal in a future version.

Use Logger.error(String, Throwable)

error(String) - Method in class de.craftsblock.craftsnet.logging.impl.LoggerImpl

Logs an error message.

error(String) - Method in record class de.craftsblock.craftsnet.logging.impl.NoOpLogger

Logs an error message.

error(String) - Method in record class de.craftsblock.craftsnet.logging.impl.PlainLogger

Logs an error message.

error(String) - Method in interface de.craftsblock.craftsnet.logging.Logger

Logs an error message.

error(String, Throwable) - Method in class de.craftsblock.craftsnet.logging.impl.LoggerImpl

Logs an error message along with the associated throwable.

error(String, Throwable) - Method in record class de.craftsblock.craftsnet.logging.impl.NoOpLogger

Logs an error message along with the associated throwable.

error(String, Throwable) - Method in record class de.craftsblock.craftsnet.logging.impl.PlainLogger

Logs an error message along with the associated throwable.

error(String, Throwable) - Method in interface de.craftsblock.craftsnet.logging.Logger

Logs an error message along with the associated throwable.

ERROR - Enum constant in enum class de.craftsblock.craftsnet.logging.LogLevel

Error level for error messages indicating problems.

estimateType(Constructor<?>) - Static method in enum class de.craftsblock.craftsnet.autoregister.meta.constructors.ConstructorType

Estimates the constructor type based on the annotations present on the given constructor.

EventWithCancelReason - Class in de.craftsblock.craftsnet.events

An abstract class extending CancellableEvent, providing the ability to set and retrieve a custom cancellation reason.

EventWithCancelReason() - Constructor for class de.craftsblock.craftsnet.events.EventWithCancelReason

EXCEPTION - Enum constant in enum class de.craftsblock.craftsnet.logging.LogLevel

Exception level for fatal errors and exceptions.

exchange - Variable in class de.craftsblock.craftsnet.api.session.Session

Exchange - Record Class in de.craftsblock.craftsnet.api.http

Represents the exchange of data between the client (request) and the server (response).

Exchange(ProtocolVersion, Request, Response, Session) - Constructor for record class de.craftsblock.craftsnet.api.http.Exchange

Creates an instance of a Exchange record class.

exists() - Method in class de.craftsblock.craftsnet.api.session.SessionStorage

Checks if the session exists in the underlying driver.

exists(Session, String) - Method in class de.craftsblock.craftsnet.api.session.drivers.builtin.FileSessionDriver

Check if the corresponding session file exists on the hard drive.

exists(Session, String) - Method in interface de.craftsblock.craftsnet.api.session.drivers.SessionDriver

Checks if the session id exists in the underlying storage.

EXPOSE_HEADERS_HEADER - Static variable in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

The http header that specifies which headers are safe to expose to the client.

extractGeneric(Class<?>, int) - Static method in class de.craftsblock.craftsnet.utils.reflection.ReflectionUtils

Extracts the generic type parameter from a Class.

extractGeneric(Class<?>, Class<?>, int) - Static method in class de.craftsblock.craftsnet.utils.reflection.ReflectionUtils

Extracts the generic type parameter from a Class.

extractGenericInterface(Class<?>, int) - Static method in class de.craftsblock.craftsnet.utils.reflection.ReflectionUtils

Extracts the generic type ReflectionUtils from a given class.

extractSession(Request) - Static method in class de.craftsblock.craftsnet.api.session.SessionInfo

Extracts the session ID from the request cookies.

F

FALLBACK - Enum constant in enum class de.craftsblock.craftsnet.autoregister.meta.constructors.ConstructorType

A constructor marked with FallbackConstructor, which serves as a last resort.

FallbackConstructor - Annotation Interface in de.craftsblock.craftsnet.autoregister.meta.constructors

This annotation is used to mark a constructor as a fallback constructor.

fileHelper() - Method in class de.craftsblock.craftsnet.CraftsNet

Deprecated, for removal: This API element is subject to removal in a future version.

Use CraftsNet.getFileHelper() instead. This will be removed in the future.

FileHelper - Class in de.craftsblock.craftsnet.utils

A utility class that helps manage the creation of temporary files in the file system.

FileHelper(CraftsNet, boolean) - Constructor for class de.craftsblock.craftsnet.utils.FileHelper

Constructs a FileHelper instance that sets up a directory for temporary files.

filepath() - Method in record class de.craftsblock.craftsnet.api.RouteRegistry.ShareMapping

Returns the value of the filepath record component.

FileSessionDriver - Class in de.craftsblock.craftsnet.api.session.drivers.builtin

A file based implementation of SessionDriver that persists session data to disk.

FileSessionDriver() - Constructor for class de.craftsblock.craftsnet.api.session.drivers.builtin.FileSessionDriver

findClass(String) - Method in class de.craftsblock.craftsnet.addon.loaders.AddonClassLoader

Finds the class with the specified binary name.

findConstructor(Class<T>, Class<?>...) - Static method in class de.craftsblock.craftsnet.utils.reflection.ReflectionUtils

Gets the constructor of the specified class with the provided argument types.

findField(Class<?>, String) - Static method in class de.craftsblock.craftsnet.utils.reflection.ReflectionUtils

Finds a field with the given name in the specified class, including inherited classes.

findMethod(Class<?>, String, Class<?>...) - Static method in class de.craftsblock.craftsnet.utils.reflection.ReflectionUtils

Finds a method by name and argument types in the given class, its superclasses, and interfaces.

first() - Method in record class de.craftsblock.craftsnet.api.http.body.bodies.MultipartFormBody.MultipartData

Gets the first item in the multipart data for the field.

FLAG - Enum constant in enum class de.craftsblock.craftsnet.api.requirements.meta.RequirementType

A requirement type indicating that the presence of the annotation alone is the part of the requirement.

FloatTransformer - Class in de.craftsblock.craftsnet.api.transformers.builtin

A transformer class for converting a string representation of a float value to a Float object.

FloatTransformer() - Constructor for class de.craftsblock.craftsnet.api.transformers.builtin.FloatTransformer

format(String, Object...) - Method in record class de.craftsblock.craftsnet.logging.impl.NoOpLogger

Utility method for formatting a string with arguments.

format(String, Object...) - Method in interface de.craftsblock.craftsnet.logging.Logger

Utility method for formatting a string with arguments.

FormBody<T> - Class in de.craftsblock.craftsnet.api.http.body.bodies

The FormBody class is an abstract base class for representing HTTP request bodies that contain form data.

FormBody(Request, InputStream) - Constructor for class de.craftsblock.craftsnet.api.http.body.bodies.FormBody

Constructs a new FormBody with the given input stream and deserializes the form data if it is of the standard form body type.

fragmentFrame(int) - Method in class de.craftsblock.craftsnet.api.websocket.Frame

Fragments the current frame into multiple smaller frames, each with a maximum length specified by the fragmentLength parameter.

Frame - Class in de.craftsblock.craftsnet.api.websocket

Represents a WebSocket frame that contains control information and payload data.

Frame(boolean, boolean, boolean, boolean, boolean, Opcode, byte[]) - Constructor for class de.craftsblock.craftsnet.api.websocket.Frame

Constructs a new Frame with the specified parameters.

Frame(byte[], byte[]) - Constructor for class de.craftsblock.craftsnet.api.websocket.Frame

Constructs a new Frame by decoding the provided frame header and payload data.

fromByte(byte) - Static method in enum class de.craftsblock.craftsnet.api.websocket.Opcode

Retrieves the opcode corresponding to the given byte value.

fromFiles() - Method in class de.craftsblock.craftsnet.addon.AddonManager

Load all addons from the addons folder.

fromInt(int) - Static method in enum class de.craftsblock.craftsnet.api.websocket.ClosureCode

Converts an int to the corresponding ClosureCode.

fromInt(int) - Static method in enum class de.craftsblock.craftsnet.api.websocket.Opcode

Retrieves the opcode corresponding to the given integer value.

G

generateSecure() - Static method in class de.craftsblock.craftsnet.utils.PassphraseUtils

Generates a secure random passphrase with a default length between 12 and 16 characters.

generateSecure(int) - Static method in class de.craftsblock.craftsnet.utils.PassphraseUtils

Generates a secure random passphrase with a specified length and the option to include special characters.

generateSecure(int, int, boolean) - Static method in class de.craftsblock.craftsnet.utils.PassphraseUtils

Generates a secure random passphrase with a specified length range and the option to include special characters.

generateSecure(int, int, String) - Static method in class de.craftsblock.craftsnet.utils.PassphraseUtils

Generates a secure random passphrase with a specified length range.

generateSecure(int, boolean) - Static method in class de.craftsblock.craftsnet.utils.PassphraseUtils

Generates a secure random passphrase with a specified length and the option to include special characters.

generateSecure(boolean) - Static method in class de.craftsblock.craftsnet.utils.PassphraseUtils

Generates a secure random passphrase with a default length between 12 and 16 characters.

GenericHandlerLoader - Class in de.craftsblock.craftsnet.addon.services.builtin.handlers

A concrete implementation of the ServiceLoader interface for managing instances of Handler.

GenericHandlerLoader(CraftsNet) - Constructor for class de.craftsblock.craftsnet.addon.services.builtin.handlers.GenericHandlerLoader

Creates a new instance of GenericHandlerLoader.

GenericRequestEventBase - Interface in de.craftsblock.craftsnet.events.requests

Represents the base for all request events.

GenericSocketEventBase - Interface in de.craftsblock.craftsnet.events.sockets

Represents the base for all websocket events.

GenericSocketMessageEventBase - Interface in de.craftsblock.craftsnet.events.sockets.message

Represents the base for all websocket message events.

GET - Enum constant in enum class de.craftsblock.craftsnet.api.http.HttpMethod

Represents the GET request method

getAddon(Class<T>) - Method in class de.craftsblock.craftsnet.addon.AddonManager

Retrieves an addon of the specified type from the loaded addons.

getAddon(Class<T>) - Method in class de.craftsblock.craftsnet.addon.Addon

Retrieves an addon of the specified type from the loaded addons.

getAddon(String) - Method in class de.craftsblock.craftsnet.addon.Addon

Retrieves an addon by its name from the loaded addons.

getAddon(String) - Method in class de.craftsblock.craftsnet.addon.AddonManager

Retrieves an addon by its name from the loaded addons.

getAddonLoader() - Method in class de.craftsblock.craftsnet.addon.AddonManager

Gets the underlying AddonLoader which is used for loading the addons.

getAddonLoaders() - Static method in class de.craftsblock.craftsnet.addon.loaders.AddonClassLoader

Get a list of all AddonClassLoader which are currently active.

getAddonManager() - Method in class de.craftsblock.craftsnet.addon.Addon

Retrieves the AddonManager instance used by the addon.

getAddonManager() - Method in class de.craftsblock.craftsnet.CraftsNet

Retrieves the addon manager instance for managing addons.

getAddons() - Method in class de.craftsblock.craftsnet.addon.AddonManager

Returns a read-only view of the registered addons in the AddonManager.

getAddons() - Method in class de.craftsblock.craftsnet.builder.AddonContainingBuilder

Gets all the currently registered Addon classes which should be loaded.

getAddonSystem() - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Retrieves the activation type configured for the addon system.

getAllKnownTypes() - Method in class de.craftsblock.craftsnet.api.codec.registry.TypeCodecRegistry

Retrieves all known types currently registered in the codec registry.

getAllowedHeaders() - Method in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Retrieves the list of allowed http headers for cross-origin requests.

getAllowedMethods() - Method in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Retrieves the list of allowed http methods for cross-origin requests.

getAllowedOrigins() - Method in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Retrieves the list of allowed origins for cross-origin requests.

getAnnotation() - Method in class de.craftsblock.craftsnet.api.requirements.Requirement

Gets the annotation class that this requirement is associated with.

getAnnotation() - Method in class de.craftsblock.craftsnet.autoregister.meta.AutoRegisterInfo

Returns the annotation associated with this class.

getAnnotation() - Method in enum class de.craftsblock.craftsnet.autoregister.meta.constructors.ConstructorType

Gets the annotation associated with this constructor type.

getArgsOffset() - Method in class de.craftsblock.craftsnet.api.transformers.TransformerPerformer

Gets the arguments offset.

getAsFile() - Method in record class de.craftsblock.craftsnet.api.http.body.bodies.MultipartFormBody.MultipartItem

Converts the multipart data to a file.

getAsFile(String) - Method in record class de.craftsblock.craftsnet.api.http.body.bodies.MultipartFormBody.MultipartItem

Converts the multipart data to a file with a specified extension.

getAsJsonBody() - Method in class de.craftsblock.craftsnet.api.http.body.Body

Returns this object as a JsonBody if the body is a json object.

getAsMultipartFormBody() - Method in class de.craftsblock.craftsnet.api.http.body.Body

Returns this object as a MultipartFormBody if the body is a multipart form body.

getAsStandardFormBody() - Method in class de.craftsblock.craftsnet.api.http.body.Body

Returns this object as a StandardFormBody if the body is a standard form body.

getAsString() - Method in record class de.craftsblock.craftsnet.api.http.body.bodies.MultipartFormBody.MultipartItem

Converts the multipart data to a string.

getAsType(String, Class<T>) - Method in class de.craftsblock.craftsnet.api.session.Session

Retrieves the value associated with the specified key and attempts to cast it to the specified type.

getAsType(String, T, Class<T>) - Method in class de.craftsblock.craftsnet.api.session.Session

Retrieves the value associated with the specified key and attempts to cast it to the specified type.

getAsType(Class<T>) - Method in class de.craftsblock.craftsnet.api.http.body.Body

Returns this object as a specific type of request body if the body is an instance of the specific request body.

getAutoRegisterRegistry() - Method in class de.craftsblock.craftsnet.addon.Addon

Retrieves the AutoRegisterRegistry instance used by the addon.

getAutoRegisterRegistry() - Method in class de.craftsblock.craftsnet.CraftsNet

Retrieves the auto register registry instance for auto registrable types.

getBacklog() - Method in class de.craftsblock.craftsnet.api.Server

Retrieves the backlog size of the server.

getBodies() - Method in class de.craftsblock.craftsnet.api.http.body.Body

Returns an ConcurrentHashMap containing all parsed bodies for the underlying request.

getBody() - Method in class de.craftsblock.craftsnet.api.http.body.bodies.FormBody

Returns the raw input stream containing the form data.

getBody() - Method in class de.craftsblock.craftsnet.api.http.body.bodies.typed.TypedBody

Retrieves the body data.

getBody() - Method in class de.craftsblock.craftsnet.api.http.Request

Retrieves the HTTP request body, if it exists.

getBodyRegistry() - Method in class de.craftsblock.craftsnet.addon.Addon

Get the BodyRegistry instance used by the addon.

getBodyRegistry() - Method in class de.craftsblock.craftsnet.CraftsNet

Retrieves the body registry instance for manging body types.

getBodyTypes() - Method in class de.craftsblock.craftsnet.api.http.body.Body

Returns a set containing all the valid types this body was parsed for.

getBoundary() - Method in class de.craftsblock.craftsnet.api.http.body.bodies.MultipartFormBody

Gets the boundary string used to separate parts in the multipart request.

getBounding() - Method in class de.craftsblock.craftsnet.autoregister.meta.AutoRegisterInfo

Returns the Addon associated with this class, if any.

getBuffer() - Method in class de.craftsblock.craftsnet.api.websocket.Frame

Gets the payload data of this frame a ByteBuffer.

getBuffer() - Method in interface de.craftsblock.craftsnet.events.sockets.message.GenericSocketMessageEventBase

Gets the incoming message as a ByteBuffer object.

getBuilder() - Method in class de.craftsblock.craftsnet.CraftsNet

Retrieves the builder instance used for configuring CraftsNet.

getCallerClass() - Static method in class de.craftsblock.craftsnet.utils.reflection.ReflectionUtils

Retrieves the class of the immediate caller of the method in which this method is called.

getCallerClass(int) - Static method in class de.craftsblock.craftsnet.utils.reflection.ReflectionUtils

Retrieves the class of the caller at a specified depth in the current thread's stack trace.

getCancelReason() - Method in class de.craftsblock.craftsnet.api.middlewares.MiddlewareCallbackInfo

Gets the custom cancel reason which was set by one of the listeners.

getCancelReason() - Method in class de.craftsblock.craftsnet.events.EventWithCancelReason

Gets the custom cancel reason which was set by one of the listeners.

getClassLoader() - Method in class de.craftsblock.craftsnet.addon.Addon

Get the class loader instance used by the addon.

getClassName() - Method in class de.craftsblock.craftsnet.autoregister.meta.AutoRegisterInfo

Returns the fully qualified class name of the target class.

getClient() - Method in interface de.craftsblock.craftsnet.events.sockets.GenericSocketEventBase

Gets the WebSocketClient which is involved in this event.

getClients() - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketServer

Retrieves the list of all currently connected WebSocketClients.

getCloseCode() - Method in class de.craftsblock.craftsnet.events.sockets.ClientDisconnectEvent

Gets the close code parsed to a ClosureCode why the connection was closed.

getCloseReason() - Method in class de.craftsblock.craftsnet.events.sockets.ClientDisconnectEvent

Gets the reason why the connection was closed.

getCodec() - Method in class de.craftsblock.craftsnet.api.codec.CodecPair

Returns the codec associated with this pair.

getCodec(Class<?>) - Method in class de.craftsblock.craftsnet.api.codec.registry.TypeCodecRegistry

Retrieves the codec associated with the given class type.

getCodecPairs() - Method in class de.craftsblock.craftsnet.api.codec.registry.TypeCodecRegistry

Retrieves all codec pairs currently registered in this registry.

getCodecs() - Method in class de.craftsblock.craftsnet.api.codec.registry.TypeCodecRegistry

Retrieves all codecs currently registered in this registry.

getCodeSources() - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Retrieves the list of CodeSource that should be taken into account.

getCommand(String) - Method in class de.craftsblock.craftsnet.command.CommandRegistry

Retrieves a command by name.

getCommandRegistry() - Method in class de.craftsblock.craftsnet.addon.Addon

Get the CommandRegistry instance used by the addon.

getCommandRegistry() - Method in class de.craftsblock.craftsnet.CraftsNet

Retrieves the command registry instance for managing commands.

getCommandSystem() - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Retrieves the activation type configured for the command system.

getCompressWhenHigher() - Static method in class de.craftsblock.craftsnet.api.websocket.extensions.builtin.PerMessageDeflateExtension

Gets the threshold for compression.

getContentType() - Method in class de.craftsblock.craftsnet.api.http.Request

Retrieves the content type form the http request.

getContentType() - Method in class de.craftsblock.craftsnet.events.requests.shares.ShareFileLoadedEvent

Returns the ShareFileLoadedEvent.contentType if it is not null, otherwise the content type of the file.

getControlMaxAge() - Method in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Retrieves the maximum age in seconds for how long preflight request results can be cached by the client.

getCookies() - Method in class de.craftsblock.craftsnet.api.http.Request

Gets all cookies stored in a map of the request.

getCookies() - Method in class de.craftsblock.craftsnet.api.http.Response

Returns a collection of all cookies currently set for the response.

getCorsPolicy() - Method in class de.craftsblock.craftsnet.api.http.Response

Returns the cors policy added to the header of the response.

getCraftsNet() - Method in class de.craftsblock.craftsnet.addon.Addon

Get the CraftsNet instance on which the addon was registered.

getCraftsNet() - Method in class de.craftsblock.craftsnet.addon.loaders.CraftsNetClassLoader

Retrieves the CraftsNet instance which this class loader is linked to.

getCraftsNet() - Method in class de.craftsblock.craftsnet.api.http.Request

Gets the instance of CraftsNet to which the request was made.

getCraftsNet() - Method in class de.craftsblock.craftsnet.api.http.Response

Gets the instance of CraftsNet which will send the response.

getCraftsNet() - Method in class de.craftsblock.craftsnet.api.requirements.RequirementRegistry

Retrieves the instance of CraftsNet bound to the registry.

getCraftsNet() - Method in class de.craftsblock.craftsnet.api.RouteRegistry

Retrieves the instance of CraftsNet bound to the registry.

getCraftsNet() - Method in class de.craftsblock.craftsnet.api.Server

Retrieves the instance of CraftsNet bound to the server.

getCraftsNet() - Method in class de.craftsblock.craftsnet.api.session.SessionInfo

Retrieves the CraftsNet instance associated with this session, if available.

getCraftsNet() - Method in class de.craftsblock.craftsnet.autoregister.AutoRegisterHandler

Gets the CraftsNet instance associated with this handler.

getCraftsNet() - Method in class de.craftsblock.craftsnet.logging.mutate.LogStream

The instance of CraftsNet which is owning the LogStream.

getCustomLogger() - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Retrieves the custom logger which should be used by CraftsNet.

getData() - Method in class de.craftsblock.craftsnet.api.http.body.bodies.FormBody

Returns the concurrent hash map containing the form fields and their values.

getData() - Method in class de.craftsblock.craftsnet.api.websocket.Frame

Gets the raw payload data of this frame.

getData() - Method in interface de.craftsblock.craftsnet.events.sockets.message.GenericSocketMessageEventBase

Gets the incoming message as a byte array.

getDataFolder() - Method in class de.craftsblock.craftsnet.addon.Addon

Retrieves the data folder for this addon as a File object.

getDataPath() - Method in class de.craftsblock.craftsnet.addon.Addon

Retrieves the data directory for this addon as a Path.

getDeflateFlush() - Static method in class de.craftsblock.craftsnet.api.websocket.extensions.builtin.PerMessageDeflateExtension

Gets the deflate flush mode.

getDeflateLevel() - Static method in class de.craftsblock.craftsnet.api.websocket.extensions.builtin.PerMessageDeflateExtension

Gets the deflate compression level.

getDeflateStrategy() - Static method in class de.craftsblock.craftsnet.api.websocket.extensions.builtin.PerMessageDeflateExtension

Gets the deflate compression strategy.

getDependenciesLoaders() - Static method in class de.craftsblock.craftsnet.addon.loaders.DependencyClassLoader

Get a list of all DependencyClassLoader which are currently active.

getDomain() - Method in class de.craftsblock.craftsnet.api.http.cookies.Cookie

Returns the domain of the cookie.

getDomain() - Method in class de.craftsblock.craftsnet.api.http.Request

Gets the domain through which the route was accessed.

getDomain() - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Returns the domain used by the connected client.

getDriver() - Method in class de.craftsblock.craftsnet.api.session.SessionStorage

Retrieves the SessionDriver instance associated with this session file.

getEncodingName() - Method in class de.craftsblock.craftsnet.api.http.encoding.StreamEncoder

Gets the name of the encoding method used by this encoder.

getEndpoint() - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Retrieves the registered endpoint corresponding to the given header.

getEndpoints(Class<? extends Server>) - Method in class de.craftsblock.craftsnet.api.RouteRegistry

Gets an immutable copy of the registered endpoints for the specific server type in the registry.

getExchange() - Method in class de.craftsblock.craftsnet.api.http.Request

Gets the Exchange managing this request.

getExchange() - Method in class de.craftsblock.craftsnet.api.http.Response

Gets the Exchange managing this response.

getExchange() - Method in class de.craftsblock.craftsnet.api.session.Session

Retrieves the BaseExchange instance associated with this session.

getExchange() - Method in interface de.craftsblock.craftsnet.events.requests.GenericRequestEventBase

Gets the Exchange which stores the involved request, response and some other data.

getExchange() - Method in class de.craftsblock.craftsnet.events.requests.PostRequestEvent

Gets the Exchange which stores the involved request, response and some other data.

getExchange() - Method in class de.craftsblock.craftsnet.events.requests.PreRequestEvent

Gets the Exchange which stores the involved request, response and some other data.

getExchange() - Method in class de.craftsblock.craftsnet.events.requests.routes.RouteRequestEvent

Gets the Exchange which stores the involved request, response and some other data.

getExchange() - Method in class de.craftsblock.craftsnet.events.requests.shares.ShareFileLoadedEvent

Gets the Exchange which stores the involved request, response and some other data.

getExchange() - Method in class de.craftsblock.craftsnet.events.requests.shares.ShareRequestEvent

Gets the Exchange which stores the involved request, response and some other data.

getExchange() - Method in class de.craftsblock.craftsnet.events.sockets.ClientConnectEvent

Gets the SocketExchange which stores the involved client, server and some other data.

getExchange() - Method in class de.craftsblock.craftsnet.events.sockets.ClientDisconnectEvent

Gets the SocketExchange which stores the involved client, server and some other data.

getExchange() - Method in interface de.craftsblock.craftsnet.events.sockets.GenericSocketEventBase

Gets the SocketExchange which stores the involved client, server and some other data.

getExchange() - Method in class de.craftsblock.craftsnet.events.sockets.message.IncomingSocketMessageEvent

Gets the SocketExchange which stores the involved client, server and some other data.

getExchange() - Method in class de.craftsblock.craftsnet.events.sockets.message.OutgoingSocketMessageEvent

Gets the SocketExchange which stores the involved client, server and some other data.

getExchange() - Method in class de.craftsblock.craftsnet.events.sockets.message.ReceivedPingMessageEvent

Gets the SocketExchange which stores the involved client, server and some other data.

getExchange() - Method in class de.craftsblock.craftsnet.events.sockets.message.ReceivedPongMessageEvent

Gets the SocketExchange which stores the involved client, server and some other data.

getExecutor() - Method in class de.craftsblock.craftsnet.command.Command

Retrieves the executor associated with this command.

getExpiresAt() - Method in class de.craftsblock.craftsnet.api.http.cookies.Cookie

Returns the expiry date of the cookie.

getExposedHeaders() - Method in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Retrieves the list of exposed headers that the client can access.

getExtensionByName(String) - Method in class de.craftsblock.craftsnet.api.websocket.extensions.WebSocketExtensionRegistry

Retrieves a WebSocket extension by its protocol name.

getExtensions() - Method in class de.craftsblock.craftsnet.api.websocket.extensions.WebSocketExtensionRegistry

Retrieves all registered WebSocket extensions.

getField(String) - Method in class de.craftsblock.craftsnet.api.http.body.bodies.FormBody

Retrieves the value of a specific field from the form data.

getField(String) - Method in class de.craftsblock.craftsnet.api.http.body.bodies.MultipartFormBody

Retrieves the multipart data for a specific field.

getField(String) - Method in class de.craftsblock.craftsnet.api.http.body.bodies.StandardFormBody

Retrieves the value of a specific field from the form data.

getFile() - Method in class de.craftsblock.craftsnet.events.requests.shares.ShareFileLoadedEvent

Gets the loaded file associated with this event.

getFileExtension() - Method in record class de.craftsblock.craftsnet.api.http.body.bodies.MultipartFormBody.MultipartItem

Gets the file extension for the multipart item.

getFileHelper() - Method in class de.craftsblock.craftsnet.addon.Addon

Get the FileHelper instance used by the addon.

getFileHelper() - Method in class de.craftsblock.craftsnet.CraftsNet

Returns the FileHelper instance used for handling temporary files.

getFilePath() - Method in class de.craftsblock.craftsnet.events.requests.shares.ShareRequestEvent

Gets the relativ path on the file system associated with the share request.

getFragmentSize() - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Returns the size which should every fragment of a frame should have.

getFragmentSize() - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketServer

Returns the size which should every fragment of a frame should have.

getFrame() - Method in interface de.craftsblock.craftsnet.events.sockets.message.GenericSocketMessageEventBase

Gets the incoming message as a Frame object.

getFrame() - Method in class de.craftsblock.craftsnet.events.sockets.message.IncomingSocketMessageEvent

Gets the incoming message as a Frame object.

getFrame() - Method in class de.craftsblock.craftsnet.events.sockets.message.OutgoingSocketMessageEvent

Gets the incoming message as a Frame object.

getFrame() - Method in class de.craftsblock.craftsnet.events.sockets.message.ReceivedPingMessageEvent

Gets the incoming message as a Frame object.

getFrame() - Method in class de.craftsblock.craftsnet.events.sockets.message.ReceivedPongMessageEvent

Gets the incoming message as a Frame object.

getGroupNames(String) - Static method in class de.craftsblock.craftsnet.utils.Utils

Extracts the group names of a Pattern.

getGroupNames(Pattern) - Static method in class de.craftsblock.craftsnet.utils.Utils

Extracts the group names of a Pattern.

getHeader(String) - Method in class de.craftsblock.craftsnet.api.http.Response

Gets the value of the response header with the specified key.

getHeader(String) - Method in class de.craftsblock.craftsnet.api.http.Request

Retrieves the value of the specified header from the request.

getHeader(String) - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Retrieves the value of the given header key from the client's headers.

getHeader(String) - Method in class de.craftsblock.craftsnet.events.requests.shares.ShareRequestEvent

Deprecated, for removal: This API element is subject to removal in a future version.

Use Response.getHeaders(String) instead.

getHeaders() - Method in class de.craftsblock.craftsnet.api.http.Request

Gets all the headers which are present on the request.

getHeaders() - Method in class de.craftsblock.craftsnet.api.http.Response

Allows raw access to the underlying Headers object, which stores the response headers.

getHeaders() - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Returns a List containing all the headers received from the client.

getHeaders() - Method in class de.craftsblock.craftsnet.events.requests.shares.ShareRequestEvent

Deprecated, for removal: This API element is subject to removal in a future version.

Use Response.getHeaders() instead.

getHeaders(String) - Method in class de.craftsblock.craftsnet.api.http.Response

Get all the values from the response headers for the specified header name.

getHttpMethod() - Method in class de.craftsblock.craftsnet.api.http.Request

Gets the http method which is used to access this route.

getHttpPath() - Method in class de.craftsblock.craftsnet.events.requests.shares.ShareRequestEvent

Gets the url that is used to access the share

getInstance() - Static method in class de.craftsblock.craftsnet.api.http.builtin.DefaultRoute

Returns the singleton instance of DefaultRoute.

getInstantiated(CraftsNet) - Method in class de.craftsblock.craftsnet.autoregister.meta.AutoRegisterInfo

Returns an instance of the target class.

getIp() - Method in class de.craftsblock.craftsnet.api.http.Request

Retrieves the IP address of the client sending the request.

getIp() - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Returns the IP address of the connected client.

getJarFileAt(Path) - Method in class de.craftsblock.craftsnet.utils.FileHelper

Creates and returns a JarFile instance from the provided directory or file path.

getListenerRegistry() - Method in class de.craftsblock.craftsnet.addon.Addon

Get the ListenerRegistry instance used by the addon.

getListenerRegistry() - Method in class de.craftsblock.craftsnet.CraftsNet

Retrieves the listener registry instance for managing event listeners.

getLoader() - Method in class de.craftsblock.craftsnet.autoregister.meta.AutoRegisterInfo

Returns the class loader used to load this class.

getLogger() - Method in class de.craftsblock.craftsnet.addon.Addon

Get the logger instance used by the addon.

getLogger() - Method in class de.craftsblock.craftsnet.api.session.SessionInfo

Retrieves the Logger instance associated with this session, if available.

getLogger() - Method in class de.craftsblock.craftsnet.CraftsNet

Retrieves the logger instance for logging messages.

getLogRotate() - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Retrieves the log rotation size threshold.

getLogStream() - Method in class de.craftsblock.craftsnet.addon.Addon

Get the LogStream instance used by the addon.

getLogStream() - Method in class de.craftsblock.craftsnet.CraftsNet

Retrieves the LogStream instance for advanced log creation.

getLogStreamMutators() - Method in class de.craftsblock.craftsnet.logging.mutate.LogStream

Returns an unmodifiable list of all currently registered LogStreamMutators.

getMapping() - Method in class de.craftsblock.craftsnet.events.requests.shares.ShareRequestEvent

Gets the share mapping, which includes some basic information about the share.

getMappings() - Method in class de.craftsblock.craftsnet.events.requests.routes.RouteRequestEvent

Get a list of RouteRegistry.EndpointMapping associated with the request event.

getMappings() - Method in class de.craftsblock.craftsnet.events.sockets.ClientConnectEvent

Gets a EnumMap of all RouteRegistry.EndpointMapping associated with the client connection event.

getMappings() - Method in class de.craftsblock.craftsnet.events.sockets.ClientDisconnectEvent

Gets a EnumMap of all RouteRegistry.EndpointMapping associated with the client disconnect event.

getMaxAge() - Method in class de.craftsblock.craftsnet.api.http.cookies.Cookie

Returns the maximum age of the cookie.

getMaxDataLength() - Static method in class de.craftsblock.craftsnet.api.websocket.extensions.builtin.PerMessageDeflateExtension

Gets the maximum allowed data length for decompressed data.

getMessage() - Method in class de.craftsblock.craftsnet.events.ConsoleMessageEvent

Gets the console message associated with the event.

getMessage() - Method in class de.craftsblock.craftsnet.events.sockets.message.ReceivedPingMessageEvent

Deprecated, for removal: This API element is subject to removal in a future version.

Use GenericSocketMessageEventBase.getData() instead.

getMessage() - Method in class de.craftsblock.craftsnet.events.sockets.message.ReceivedPongMessageEvent

Deprecated, for removal: This API element is subject to removal in a future version.

Use GenericSocketMessageEventBase.getData() instead.

getMeta() - Method in class de.craftsblock.craftsnet.addon.Addon

Get the metadata of the addon.

getMethods() - Method in enum class de.craftsblock.craftsnet.api.http.HttpMethod

Get the array of strings containing the request methods for this enum value.

getMiddlewareRegistry() - Method in class de.craftsblock.craftsnet.addon.Addon

Get the MiddlewareRegistry instance used by the addon.

getMiddlewareRegistry() - Method in class de.craftsblock.craftsnet.CraftsNet

Retrieves the middleware registry instance for manging middlewares

getMiddlewares() - Method in class de.craftsblock.craftsnet.api.middlewares.MiddlewareRegistry

Get all global applied middlewares.

getMiddlewares(BaseExchange) - Method in class de.craftsblock.craftsnet.api.middlewares.MiddlewareRegistry

Get all, for the exchange applicable, global applied middlewares.

getMiddlewares(Class<? extends Server>) - Method in class de.craftsblock.craftsnet.api.middlewares.MiddlewareRegistry

Get all, for the server type applicable, global applied middlewares.

getName() - Method in class de.craftsblock.craftsnet.addon.Addon

Get the name of the addon.

getName() - Method in class de.craftsblock.craftsnet.api.http.cookies.Cookie

Returns the name of the cookie.

getName() - Method in enum class de.craftsblock.craftsnet.api.utils.Scheme

Gets the name of the scheme.

getName() - Method in class de.craftsblock.craftsnet.command.Command

Retrieves the name of the command.

getNewInstance(Class<T>, Object...) - Static method in class de.craftsblock.craftsnet.utils.reflection.ReflectionUtils

Creates a new instance of a class.

getOpcode() - Method in class de.craftsblock.craftsnet.api.websocket.Frame

Gets the opcode of this frame which indicates the type of the frame.

getOpcode() - Method in interface de.craftsblock.craftsnet.events.sockets.message.GenericSocketMessageEventBase

Gets the opcode used when sending the data.

getOrNew(String) - Method in class de.craftsblock.craftsnet.api.session.SessionCache

Retrieves a Session from the cache by its key.

getParent() - Method in interface de.craftsblock.craftsnet.api.transformers.Transformable

Gets the parent transformer which is invoked before invoking Transformable.transform(Object) on this transformer.

getParentTypes() - Method in class de.craftsblock.craftsnet.autoregister.meta.AutoRegisterInfo

Returns a list of parent types (superclasses and interfaces) of the class.

getParser(Class<T>) - Method in class de.craftsblock.craftsnet.api.http.body.BodyRegistry

Retrieves the body parser associated with the specified body type.

getPath() - Method in class de.craftsblock.craftsnet.api.http.cookies.Cookie

Returns the path of the cookie.

getPath() - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Returns the requested path from the client's headers.

getPath() - Method in class de.craftsblock.craftsnet.events.requests.shares.ShareFileLoadedEvent

Gets the loaded file path associated with this event.

getPort() - Method in class de.craftsblock.craftsnet.api.Server

Retrieves the port number the server is bound to.

getPrefix() - Method in enum class de.craftsblock.craftsnet.logging.LogLevel

Returns the color-coded prefix for this log level.

getProtocolName() - Method in class de.craftsblock.craftsnet.api.websocket.extensions.WebSocketExtension

Returns the protocol name of this extension.

getQueryParams() - Method in class de.craftsblock.craftsnet.api.http.Request

Gets all query parameters stored in a map of the request.

getRawBody() - Method in class de.craftsblock.craftsnet.api.http.Request

Retrieves a new instance of an input stream containing the request body.

getRawCloseCode() - Method in class de.craftsblock.craftsnet.events.sockets.ClientDisconnectEvent

Gets the raw close code why the connection was closed.

getRawContentType() - Method in class de.craftsblock.craftsnet.api.http.body.Body

Returns this content type of the underlying request.

getRawContentType() - Method in class de.craftsblock.craftsnet.events.requests.shares.ShareFileLoadedEvent

Determines the content type of the current file.

getRawUrl() - Method in class de.craftsblock.craftsnet.api.http.Request

Gets the raw url which is not trimmed and therefore contains anything except the domain

getRequest() - Method in interface de.craftsblock.craftsnet.events.requests.GenericRequestEventBase

Gets the Request which is involved in this event.

getRequestMethod() - Method in class de.craftsblock.craftsnet.api.http.Request

Retrieves the RequestMethod of the request (e.g., GET, POST, PUT, etc.).

getRequirementRegistry() - Method in class de.craftsblock.craftsnet.addon.Addon

Get the RequirementRegistry instance used by the addon.

getRequirementRegistry() - Method in class de.craftsblock.craftsnet.CraftsNet

Retrieves the route registry instance for managing web and web requirements.

getRequirements() - Method in class de.craftsblock.craftsnet.api.requirements.RequirementRegistry

Get all registered requirement processors.

getRequirements(Class<A>) - Method in interface de.craftsblock.craftsnet.api.RouteRegistry.Mapping

Retrieves a value associated with a specific annotation's default key ("value").

getRequirements(Class<A>, String) - Method in record class de.craftsblock.craftsnet.api.RouteRegistry.EndpointMapping

Retrieves a specific value from the requirements of the given annotation.

getRequirements(Class<A>, String) - Method in interface de.craftsblock.craftsnet.api.RouteRegistry.Mapping

Retrieves a value associated with a specific annotation's requirements key.

getRequirements(Class<? extends Server>) - Method in class de.craftsblock.craftsnet.api.requirements.RequirementRegistry

Get all registered requirement processors for a specific server system.

getResponse() - Method in interface de.craftsblock.craftsnet.events.requests.GenericRequestEventBase

Gets the Response which is involved in this event.

getRoute(Request) - Method in class de.craftsblock.craftsnet.api.RouteRegistry

Gets the route mappings associated with a specific request information.

getRouteRegistry() - Method in class de.craftsblock.craftsnet.addon.Addon

Get the RouteRegistry instance used by the addon.

getRouteRegistry() - Method in class de.craftsblock.craftsnet.CraftsNet

Retrieves the route registry instance for managing web and web socket routes.

getRoutes() - Method in class de.craftsblock.craftsnet.api.http.Request

Retrieves the matched routes mapping for the request.

getRoutes() - Method in class de.craftsblock.craftsnet.api.RouteRegistry

Gets an immutable copy of the registered routes in the registry.

getSameSite() - Method in class de.craftsblock.craftsnet.api.http.cookies.Cookie

Returns the SameSite policy of the cookie.

getServer() - Method in interface de.craftsblock.craftsnet.events.sockets.GenericSocketEventBase

Gets the WebSocketServer which is involved in this event.

getServer(CraftsNet) - Method in enum class de.craftsblock.craftsnet.api.utils.Scheme

Retrieves the appropriate server instance for the current scheme.

getServerMappings() - Method in class de.craftsblock.craftsnet.api.RouteRegistry

Retrieves all registered server mappings.

getServerRaw() - Method in enum class de.craftsblock.craftsnet.api.utils.Scheme

Gets the raw server class type associated with the current scheme.

getServiceManager() - Method in class de.craftsblock.craftsnet.addon.Addon

Get the ServiceManager instance used by the addon.

getServiceManager() - Method in class de.craftsblock.craftsnet.CraftsNet

Retrieves the service manager instance for managing services.

getSession() - Method in class de.craftsblock.craftsnet.api.session.SessionInfo

Retrieves the Session instance associated with this metadata.

getSession() - Method in class de.craftsblock.craftsnet.api.session.SessionStorage

Retrieves the Session instance associated with this session file.

getSession() - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Returns the storage of this websocket client for storing specific data.

getSessionCache() - Method in class de.craftsblock.craftsnet.CraftsNet

Retrieves the session cache instance which is in charge of caching session.

getSessionCacheSize() - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Retrieves the session cache size configured.

getSessionID() - Method in class de.craftsblock.craftsnet.api.session.SessionInfo

Retrieves the session ID associated with this session, if available.

getSessionInfo() - Method in class de.craftsblock.craftsnet.api.session.Session

Retrieves the SessionInfo associated with this session.

getSessionStorage() - Method in class de.craftsblock.craftsnet.api.session.Session

Retrieves the SessionStorage associated with this session.

getShare(String) - Method in class de.craftsblock.craftsnet.api.RouteRegistry

Gets the mapping for the share associated with the given URL.

getShareFolder(String) - Method in class de.craftsblock.craftsnet.api.RouteRegistry

Gets the shared folder associated with the given URL.

getSharePattern(String) - Method in class de.craftsblock.craftsnet.api.RouteRegistry

Gets the pattern associated with the shared folder that matches the given URL.

getShares() - Method in class de.craftsblock.craftsnet.api.RouteRegistry

Returns an immutable copy of the shared folders and patterns.

getSocket(WebSocketClient) - Method in class de.craftsblock.craftsnet.api.RouteRegistry

Gets the socket mapping associated with a specific URL and domain.

getSockets() - Method in class de.craftsblock.craftsnet.api.RouteRegistry

Gets an immutable copy of the registered socket handlers in the registry.

getSource() - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Returns the underlying byte array used by the buffer.

getSsl(boolean) - Method in enum class de.craftsblock.craftsnet.api.utils.Scheme

Returns the scheme with or without SSL support.

getStreamEncoder() - Method in class de.craftsblock.craftsnet.api.http.Request

Retrieves the StreamEncoder that was determined during the request body loading.

getStreamEncoder() - Method in class de.craftsblock.craftsnet.api.http.Response

Retrieves the StreamEncoder that is used to encode the response body.

getStreamEncoderRegistry() - Method in class de.craftsblock.craftsnet.addon.Addon

Get the StreamEncoderRegistry instance used by the addon.

getStreamEncoderRegistry() - Method in class de.craftsblock.craftsnet.CraftsNet

Retrieves the stream encoder registry instance for managing stream encoders.

getStreamEncoders() - Method in class de.craftsblock.craftsnet.api.http.encoding.StreamEncoderRegistry

Retrieves a list of all registered StreamEncoder.

getTarget() - Method in class de.craftsblock.craftsnet.api.codec.CodecPair

Returns the target type of this codec pair.

getThreadByName(String) - Static method in class de.craftsblock.craftsnet.utils.Utils

Retrieves a thread by its name from the currently running threads.

getType() - Method in class de.craftsblock.craftsnet.api.http.body.bodies.typed.TypedBody

Retrieves the body data type.

getTypeEncoderRegistry() - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketServer

Retrieves the TypeEncoderRegistry instance managing the registration and lookup of WebSocketSafeTypeEncoder codecs.

getUrl() - Method in class de.craftsblock.craftsnet.addon.loaders.DependencyClassLoader

Retrieves the URL which this DependencyClassLoader loads classes from.

getUrl() - Method in class de.craftsblock.craftsnet.api.http.Request

Gets the trimmed url which only includes the location of the resource.

getUtf8() - Method in class de.craftsblock.craftsnet.api.websocket.Frame

Gets the payload data of this frame as a UTF-8 encoded string.

getUtf8() - Method in interface de.craftsblock.craftsnet.events.sockets.message.GenericSocketMessageEventBase

Gets the incoming message as an utf8 encoded string.

getValue() - Method in class de.craftsblock.craftsnet.api.http.cookies.Cookie

Retrieves the value of the cookie, cast to the specified type.

getValue(String) - Method in record class de.craftsblock.craftsnet.api.requirements.meta.RequirementInfo

Retrieves the value associated with a given key from the annotation's values.

getWebServer() - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Retrieves the activation type configured for the web server.

getWebServer() - Method in class de.craftsblock.craftsnet.CraftsNet

Retrieves the web server instance for handling HTTP requests.

getWebServerPort() - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Retrieves the port number configured for the web server.

getWebSocketEncoderRegistry() - Method in class de.craftsblock.craftsnet.addon.Addon

Retrieves the TypeEncoderRegistry dedicated to managing WebSocketSafeTypeEncoder instances used by the WebSocketServer.

getWebSocketEncoderRegistry() - Method in class de.craftsblock.craftsnet.CraftsNet

Retrieves the TypeEncoderRegistry dedicated to managing WebSocketSafeTypeEncoder instances used by the WebSocketServer.

getWebsocketExtensionRegistry() - Method in class de.craftsblock.craftsnet.addon.Addon

Retrieves the WebSocketExtensionRegistry instance used by the addon.

getWebSocketExtensionRegistry() - Method in class de.craftsblock.craftsnet.CraftsNet

Retrieves the extension registry for the websocket protocol.

getWebSocketServer() - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Retrieves the activation type configured for the WebSocket server.

getWebSocketServer() - Method in class de.craftsblock.craftsnet.CraftsNet

Retrieves the WebSocket server instance for handling WebSocket connections.

getWebSocketServerPort() - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Retrieves the port number configured for the WebSocket server.

GOING_AWAY - Enum constant in enum class de.craftsblock.craftsnet.api.websocket.ClosureCode

Indicates that an endpoint is "going away", such as a server going down or a browser having navigated away from a page.

GZIPStreamEncoder - Class in de.craftsblock.craftsnet.api.http.encoding.builtin

A concrete implementation of StreamEncoder that performs compression and decompression using the GZIP algorithm.

GZIPStreamEncoder() - Constructor for class de.craftsblock.craftsnet.api.http.encoding.builtin.GZIPStreamEncoder

Constructs a new GZIPStreamEncoder.

H

handle(HttpExchange) - Method in class de.craftsblock.craftsnet.api.http.WebHandler

Handles incoming HTTP requests and delegates them to the appropriate handlers.

handle(ListenerAdapter, AutoRegisterInfo, Object...) - Method in class de.craftsblock.craftsnet.autoregister.builtin.events.ListenerAutoRegisterHandler

Handles the registration of the provided ListenerAdapter.

handle(ServiceLoader<?>, AutoRegisterInfo, Object...) - Method in class de.craftsblock.craftsnet.autoregister.builtin.addons.ServiceLoaderAutoRegisterHandler

Handles the registration of the provided ServiceLoader.

handle(Handler, AutoRegisterInfo, Object...) - Method in class de.craftsblock.craftsnet.autoregister.builtin.http.HandlerAutoRegisterHandler

Handles the registration of the provided Handler.

handle(BodyParser<? extends Body>, AutoRegisterInfo, Object...) - Method in class de.craftsblock.craftsnet.autoregister.builtin.http.BodyAutoRegisterHandler

Handles the registration of the provided BodyParser.

handle(StreamEncoder, AutoRegisterInfo, Object...) - Method in class de.craftsblock.craftsnet.autoregister.builtin.http.StreamEncoderAutoRegisterHandler

Handles the registration of the provided StreamEncoder.

handle(MiddlewareCallbackInfo, BaseExchange) - Method in interface de.craftsblock.craftsnet.api.middlewares.HttpMiddleware

Defines the logic of the middleware.

handle(MiddlewareCallbackInfo, BaseExchange) - Method in interface de.craftsblock.craftsnet.api.middlewares.Middleware

Defines the logic of the middleware.

handle(MiddlewareCallbackInfo, BaseExchange) - Method in interface de.craftsblock.craftsnet.api.middlewares.WebsocketMiddleware

Defines the logic of the middleware.

handle(MiddlewareCallbackInfo, Exchange) - Method in interface de.craftsblock.craftsnet.api.middlewares.HttpMiddleware

Defines the logic this middleware applies to the exchange.

handle(Middleware, AutoRegisterInfo, Object...) - Method in class de.craftsblock.craftsnet.autoregister.builtin.MiddlewareAutoRegisterHandler

Handles the registration of the provided Middleware.

handle(WebRequirement, AutoRegisterInfo, Object...) - Method in class de.craftsblock.craftsnet.autoregister.builtin.http.WebRequirementAutoRegisterHandler

Handles the registration of the provided WebRequirement.

handle(WebSocketRequirement<? extends RequireAble>, AutoRegisterInfo, Object...) - Method in class de.craftsblock.craftsnet.autoregister.builtin.sockets.WebSocketRequirementAutoRegisterHandler

Handles the registration of the provided WebSocketRequirement.

handle(WebSocketSafeTypeDecoder<?>, AutoRegisterInfo, Object...) - Method in class de.craftsblock.craftsnet.autoregister.builtin.sockets.codec.WebSocketTypeDecoderAutoRegisterHandler

Handles the registration of the provided WebSocketSafeTypeDecoder.

handle(WebSocketSafeTypeEncoder<?, ?>, AutoRegisterInfo, Object...) - Method in class de.craftsblock.craftsnet.autoregister.builtin.sockets.codec.WebSocketTypeEncoderAutoRegisterHandler

Handles the registration of the provided WebSocketSafeTypeEncoder.

handle(WebSocketExtension, AutoRegisterInfo, Object...) - Method in class de.craftsblock.craftsnet.autoregister.builtin.sockets.WebSocketExtensionAutoRegisterHandler

Handles the registration of the provided WebSocketExtension.

handle(AutoRegisterInfo, Object...) - Method in class de.craftsblock.craftsnet.autoregister.AutoRegisterRegistry

Handles a single AutoRegisterInfo by invoking the appropriate handler(s) based on its parent types.

handle(LogStreamMutator, AutoRegisterInfo, Object...) - Method in class de.craftsblock.craftsnet.autoregister.builtin.cli.LogStreamMutatorAutoRegisterHandler

Handles the registration of the provided LogStreamMutator.

handle(T, AutoRegisterInfo, Object...) - Method in class de.craftsblock.craftsnet.autoregister.AutoRegisterHandler

Handles the provided object AutoRegisterHandler during the auto registration process.

handleAll(List<AutoRegisterInfo>, Object...) - Method in class de.craftsblock.craftsnet.autoregister.AutoRegisterRegistry

Handles a list of AutoRegisterInfo by delegating to the appropriate handlers.

handleConnect(MiddlewareCallbackInfo, SocketExchange) - Method in interface de.craftsblock.craftsnet.api.middlewares.WebsocketMiddleware

Defines middleware logic when a new websocket client connects to the server.

handleConsoleMessage(ConsoleMessageEvent) - Method in class de.craftsblock.craftsnet.listeners.ConsoleListener

Event handler for console messages.

handleDefault(Exchange) - Method in class de.craftsblock.craftsnet.api.http.builtin.DefaultRoute

Handles the default GET request.

handleDisconnect(MiddlewareCallbackInfo, SocketExchange) - Method in interface de.craftsblock.craftsnet.api.middlewares.WebsocketMiddleware

Defines middleware logic when a new websocket client disconnects from the server.

handleError(TransformerException) - Method in interface de.craftsblock.craftsnet.api.transformers.TransformerErrorCallback

Handles transformer errors by implementing custom error-handling logic.

handleMessageReceived(MiddlewareCallbackInfo, SocketExchange, Frame) - Method in interface de.craftsblock.craftsnet.api.middlewares.WebsocketMiddleware

Defines middleware logic when the server received a new message from the websocket client.

handleMessageSent(MiddlewareCallbackInfo, SocketExchange, Frame) - Method in interface de.craftsblock.craftsnet.api.middlewares.WebsocketMiddleware

Defines middleware logic when the server sends a new message to the websocket client.

handlePing(ReceivedPingMessageEvent) - Method in class de.craftsblock.craftsnet.api.websocket.DefaultPingResponder

Handles the received ping message event by sending a pong message back to the client.

handler() - Method in record class de.craftsblock.craftsnet.api.RouteRegistry.EndpointMapping

Returns the value of the handler record component.

Handler - Interface in de.craftsblock.craftsnet.api

Represents a contract for classes that handle any type of connections in a server application.

HandlerAutoRegisterHandler - Class in de.craftsblock.craftsnet.autoregister.builtin.http

A handler for automatically registering Handler implementations.

HandlerAutoRegisterHandler(CraftsNet) - Constructor for class de.craftsblock.craftsnet.autoregister.builtin.http.HandlerAutoRegisterHandler

Constructs a new HandlerAutoRegisterHandler.

hasBody() - Method in class de.craftsblock.craftsnet.api.http.Request

Checks if the HTTP request has a request body.

hasBounding() - Method in class de.craftsblock.craftsnet.autoregister.meta.AutoRegisterInfo

Checks whether this class is associated with an Addon.

hasCancelReason() - Method in class de.craftsblock.craftsnet.api.middlewares.MiddlewareCallbackInfo

Checks and returns whether a custom cancel reason was set by one of the listeners.

hasCancelReason() - Method in class de.craftsblock.craftsnet.events.EventWithCancelReason

Checks and returns whether a custom cancel reason was set by one of the listeners.

hasCodec(Class<?>) - Method in class de.craftsblock.craftsnet.api.codec.registry.TypeCodecRegistry

Checks whether a codec exists for the given class type.

hasCommand(String) - Method in class de.craftsblock.craftsnet.command.CommandRegistry

Checks if a command with the given name exists.

hasCookie(String) - Method in class de.craftsblock.craftsnet.api.http.Request

Checks if the request contains the specified cookie.

hasExecutor() - Method in class de.craftsblock.craftsnet.command.Command

Checks if the command has an associated executor.

hasExtension(WebSocketExtension) - Method in class de.craftsblock.craftsnet.api.websocket.extensions.WebSocketExtensionRegistry

Checks if a WebSocket extension is registered by its instance.

hasExtension(String) - Method in class de.craftsblock.craftsnet.api.websocket.extensions.WebSocketExtensionRegistry

Checks if a WebSocket extension is registered by its protocol name.

hasField(String) - Method in class de.craftsblock.craftsnet.api.http.body.bodies.FormBody

Checks if a specific field exists in the form data.

hasField(String) - Method in class de.craftsblock.craftsnet.api.http.body.bodies.MultipartFormBody

Checks if a specific field exists in the multipart data.

hasField(String) - Method in class de.craftsblock.craftsnet.api.http.body.bodies.StandardFormBody

Checks if a specific field exists in the form data.

hashCode() - Method in record class de.craftsblock.craftsnet.addon.meta.AddonConfiguration

Returns a hash code value for this object.

hashCode() - Method in record class de.craftsblock.craftsnet.addon.meta.AddonMeta

Returns a hash code value for this object.

hashCode() - Method in record class de.craftsblock.craftsnet.addon.meta.RegisteredService

Returns a hash code value for this object.

hashCode() - Method in record class de.craftsblock.craftsnet.api.http.body.bodies.MultipartFormBody.MultipartData

Returns a hash code value for this object.

hashCode() - Method in record class de.craftsblock.craftsnet.api.http.body.bodies.MultipartFormBody.MultipartItem

Returns a hash code value for this object.

hashCode() - Method in class de.craftsblock.craftsnet.api.http.cookies.Cookie

Returns the hash code value for this cookie.

hashCode() - Method in class de.craftsblock.craftsnet.api.http.encoding.StreamEncoder

Computes a hash code for this encoder based on its encoding name.

hashCode() - Method in record class de.craftsblock.craftsnet.api.http.Exchange

Returns a hash code value for this object.

hashCode() - Method in record class de.craftsblock.craftsnet.api.requirements.meta.RequirementInfo

Returns a hash code value for this object.

hashCode() - Method in record class de.craftsblock.craftsnet.api.RouteRegistry.EndpointMapping

Returns a hash code value for this object.

hashCode() - Method in record class de.craftsblock.craftsnet.api.RouteRegistry.ShareMapping

Returns a hash code value for this object.

hashCode() - Method in record class de.craftsblock.craftsnet.api.utils.ProtocolVersion

Generates a hash code for this protocol version.

hashCode() - Method in record class de.craftsblock.craftsnet.api.websocket.SocketExchange

Returns a hash code value for this object.

hashCode() - Method in class de.craftsblock.craftsnet.autoregister.meta.AutoRegisterInfo

hashCode() - Method in record class de.craftsblock.craftsnet.logging.impl.NoOpLogger

Returns a hash code value for this object.

hashCode() - Method in record class de.craftsblock.craftsnet.logging.impl.PlainLogger

Returns a hash code value for this object.

hasHeader(String) - Method in class de.craftsblock.craftsnet.api.http.Request

Checks if the request contains the specified header.

hasHeader(String) - Method in class de.craftsblock.craftsnet.api.http.Response

Checks if a response header with the specified key exists.

hasHeader(String) - Method in class de.craftsblock.craftsnet.events.requests.shares.ShareRequestEvent

Deprecated, for removal: This API element is subject to removal in a future version.

Use Response.hasHeader(String) instead.

hasMappings() - Method in class de.craftsblock.craftsnet.events.requests.routes.RouteRequestEvent

Checks if the request event has at least one valid RouteRegistry.EndpointMapping associated with it.

hasMappings() - Method in class de.craftsblock.craftsnet.events.sockets.ClientConnectEvent

Checks if the client connection event has at least one valid SocketMapping associated with it.

hasMappings() - Method in class de.craftsblock.craftsnet.events.sockets.ClientDisconnectEvent

Checks if the client disconnection event has at least one valid SocketMapping associated with it.

hasParam(String) - Method in class de.craftsblock.craftsnet.api.http.Request

Checks if the request contains the specified query parameter.

hasRouteMappings(Request) - Method in class de.craftsblock.craftsnet.api.RouteRegistry

Checks if there are any registered route mappings for a given Request.

hasRoutes() - Method in class de.craftsblock.craftsnet.api.RouteRegistry

Checks if the registry has any registered route handlers or shares.

hasShares() - Method in class de.craftsblock.craftsnet.api.RouteRegistry

Checks if the registry has any registered shares.

hasSocketMappings(WebSocketClient) - Method in class de.craftsblock.craftsnet.api.RouteRegistry

Checks if there are any registered websocket mappings for a given WebSocketClient.

hasTransformers(Object) - Method in class de.craftsblock.craftsnet.api.transformers.TransformerPerformer

Checks whether transformers are present in a method or class.

hasValue(String) - Method in record class de.craftsblock.craftsnet.api.requirements.meta.RequirementInfo

Checks whether the given key exists in the annotation's values.

hasWebsockets() - Method in class de.craftsblock.craftsnet.api.RouteRegistry

Checks if the registry has any registered socket handlers.

HEAD - Enum constant in enum class de.craftsblock.craftsnet.api.http.HttpMethod

Represents the HEAD request method

HeadersRequirement - Class in de.craftsblock.craftsnet.api.requirements.web

A specific web requirement that checks if the headers of an HTTP request matches certain criteria.

HeadersRequirement() - Constructor for class de.craftsblock.craftsnet.api.requirements.web.HeadersRequirement

Constructs a new headers requirement.

headersSent() - Method in class de.craftsblock.craftsnet.api.http.Response

Returns whether the response headers have already been sent or not.

HIGH - Enum constant in enum class de.craftsblock.craftsnet.api.annotations.ProcessPriority.Priority

Indicates a high priority.

HIGHEST - Enum constant in enum class de.craftsblock.craftsnet.api.annotations.ProcessPriority.Priority

Indicates the highest priority.

HollowAddon - Class in de.craftsblock.craftsnet.addon

An instance of Addon which is only capable of holding dummy data of an addon that did not specify a valid main class.

HollowAddon() - Constructor for class de.craftsblock.craftsnet.addon.HollowAddon

Constructor which checks the caller class to prevent direct initialization.

HTTP - Enum constant in enum class de.craftsblock.craftsnet.api.utils.Scheme

HTTP protocol scheme, associated with a WebServer.

HTTPDomainRequirement - Class in de.craftsblock.craftsnet.api.requirements.web

A specific web requirement that checks if the domain of an HTTP request matches certain criteria.

HTTPDomainRequirement() - Constructor for class de.craftsblock.craftsnet.api.requirements.web.HTTPDomainRequirement

Constructs a new HTTP domain requirement.

HttpMethod - Enum Class in de.craftsblock.craftsnet.api.http

The RequestMethod enum represents the different HTTP request methods, such as POST, GET, PUT, DELETE, PATCH, and HEAD.

HttpMiddleware - Interface in de.craftsblock.craftsnet.api.middlewares

A specific middleware for manipulating http requests.

HTTPS - Enum constant in enum class de.craftsblock.craftsnet.api.utils.Scheme

HTTPS protocol scheme, associated with a WebServer.

I

IdentityStreamEncoder - Class in de.craftsblock.craftsnet.api.http.encoding.builtin

A concrete implementation of StreamEncoder that performs no encoding and returns the input and output streams as they are.

IdentityStreamEncoder() - Constructor for class de.craftsblock.craftsnet.api.http.encoding.builtin.IdentityStreamEncoder

Constructs a new IdentityStreamEncoder.

IgnoreConstructor - Annotation Interface in de.craftsblock.craftsnet.autoregister.meta.constructors

This annotation is used to mark a constructor that should be ignored.

IGNORED - Enum constant in enum class de.craftsblock.craftsnet.autoregister.meta.constructors.ConstructorType

A constructor marked with IgnoreConstructor, meaning it should be ignored.

IIOServiceLoader - Class in de.craftsblock.craftsnet.addon.services.builtin

A concrete implementation of the ServiceLoader interface for managing instances of IIOServiceProvider.

IIOServiceLoader() - Constructor for class de.craftsblock.craftsnet.addon.services.builtin.IIOServiceLoader

IncomingSocketMessageEvent - Class in de.craftsblock.craftsnet.events.sockets.message

The IncomingSocketMessageEvent class represents an event related to an incoming message on a websocket connection.

IncomingSocketMessageEvent(SocketExchange, Frame) - Constructor for class de.craftsblock.craftsnet.events.sockets.message.IncomingSocketMessageEvent

Constructs a new IncomingSocketMessageEvent with the specified SocketExchange and incoming message data.

info(String, Object...) - Method in interface de.craftsblock.craftsnet.logging.Logger

Logs a formatted informational message.

info(String) - Method in class de.craftsblock.craftsnet.logging.impl.LoggerImpl

Logs an informational message.

info(String) - Method in record class de.craftsblock.craftsnet.logging.impl.NoOpLogger

Logs an informational message.

info(String) - Method in record class de.craftsblock.craftsnet.logging.impl.PlainLogger

Logs an informational message.

info(String) - Method in interface de.craftsblock.craftsnet.logging.Logger

Logs an informational message.

INFO - Enum constant in enum class de.craftsblock.craftsnet.logging.LogLevel

Informational level for general information messages.

instantiate() - Element in annotation interface de.craftsblock.craftsnet.autoregister.meta.AutoRegister

The Instantiate value that determines which instance type logic should be applied when a new instance of the object is created.

Instantiate - Enum Class in de.craftsblock.craftsnet.autoregister.meta

The Instantiate enum defines the different ways an instance of a class can be managed during the auto registration process.

INTERNAL_CODES - Static variable in enum class de.craftsblock.craftsnet.api.websocket.ClosureCode

List of ClosureCode values that are considered internal.

IntTransformer - Class in de.craftsblock.craftsnet.api.transformers.builtin

A transformer class for converting a string representation of an integer value to an Integer object.

IntTransformer() - Constructor for class de.craftsblock.craftsnet.api.transformers.builtin.IntTransformer

intValue() - Method in enum class de.craftsblock.craftsnet.api.websocket.ClosureCode

Retrieves the integer value of the ClosureCode.

intValue() - Method in enum class de.craftsblock.craftsnet.api.websocket.Opcode

Retrieves the integer value of the opcode.

invokeMethod(Object, Method, Object...) - Static method in class de.craftsblock.craftsnet.utils.reflection.ReflectionUtils

Invokes a specific method with the given arguments on the specified owner object.

invokeMethod(Object, String, Object...) - Static method in class de.craftsblock.craftsnet.utils.reflection.ReflectionUtils

Invokes a method with the given name and arguments on the specified owner object.

IP_SEARCHER - Static variable in class de.craftsblock.craftsnet.utils.Utils

A Pattern instance which searches for ip addresses.

IPv4_SEARCH - Static variable in class de.craftsblock.craftsnet.utils.Utils

A pattern to search for ipv4 addresses.

IPv6_SEARCH - Static variable in class de.craftsblock.craftsnet.utils.Utils

A pattern to search for ipv6 addresses.

isActive() - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Returns whether the websocket runnable has been started.

isAddonSystem(ActivateType) - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Checks if the addon system is configured with the specified activation type.

isAlias(String) - Method in class de.craftsblock.craftsnet.command.Command

Checks if an alias is already present.

isAllowAllHeaders() - Method in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Checks if all http headers are allowed for cross-origin requests.

isAllowAllMethods() - Method in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Checks if all http methods are allowed for cross-origin requests.

isAllowAllOrigins() - Method in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Checks if all origins are allowed for cross-origin requests.

isAllowCredentials() - Method in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Checks if credentials (such as cookies) are allowed in cross-origin requests.

isAllowedWithoutMapping() - Method in class de.craftsblock.craftsnet.events.sockets.ClientConnectEvent

Retrieves whether the websocket client is allowed to connect without a valid endpoint or not.

isAnnotationPresent(Object, Class<A>) - Static method in class de.craftsblock.craftsnet.utils.reflection.ReflectionUtils

Checks if a given annotation is present on the object.

isApplicable(BaseExchange) - Method in interface de.craftsblock.craftsnet.api.middlewares.Middleware

Checks if the middleware is applicable of handling the specific exchange.

isApplicable(Class<? extends Server>) - Method in interface de.craftsblock.craftsnet.api.middlewares.HttpMiddleware

Checks if the middleware is applicable of handling the specific servers exchange.

isApplicable(Class<? extends Server>) - Method in interface de.craftsblock.craftsnet.api.middlewares.Middleware

Checks if the middleware is applicable of handling the specific servers exchange.

isApplicable(Class<? extends Server>) - Method in interface de.craftsblock.craftsnet.api.middlewares.WebsocketMiddleware

Checks if the middleware is applicable of handling the specific servers exchange.

isAssignable(Class<?>, Class<?>) - Static method in class de.craftsblock.craftsnet.utils.reflection.TypeUtils

Determines if the sourceType can be assigned to the targetType, considering both primitive types and their corresponding wrapper classes.

isAvailable() - Method in class de.craftsblock.craftsnet.api.http.encoding.StreamEncoder

Checks whether the encoding method is available.

isAvailable(String) - Method in class de.craftsblock.craftsnet.api.http.encoding.StreamEncoderRegistry

Checks if an StreamEncoder with the given encoding name is available.

isBodyAble() - Method in class de.craftsblock.craftsnet.api.http.Response

Returns whether the response can have a response body.

isBodyFromType(Class<? extends Body>) - Method in class de.craftsblock.craftsnet.api.http.body.Body

Checks if this request body is a specific type of request body.

isBusy() - Method in class de.craftsblock.craftsnet.api.session.SessionStorage

Checks whether the session file is currently busy with an operation.

isCacheable() - Method in interface de.craftsblock.craftsnet.api.transformers.Transformable

Gets whether the result of Transformable.transform(Object) should be cached or not.

isCancelled() - Method in class de.craftsblock.craftsnet.api.middlewares.MiddlewareCallbackInfo

Checks if the callback has been cancelled.

isClosed() - Method in class de.craftsblock.craftsnet.api.http.body.Body

Checks if this request body is already closed.

isClosed() - Method in class de.craftsblock.craftsnet.api.http.Request

Gets if the request has been closed.

isCommandSystem(ActivateType) - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Checks if the command system is configured with the specified activation type.

isConnected() - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Returns whether the web socket is still connected or the connection has been closed / failed.

isConstructorPresent(Class<?>, Class<?>...) - Static method in class de.craftsblock.craftsnet.utils.reflection.ReflectionUtils

Checks if a constructor is present in the specified class with the provided argument types.

isControlCode() - Method in enum class de.craftsblock.craftsnet.api.websocket.Opcode

Checks if the opcode is a code which should contain control instruction

isCraftsNetLoaded() - Static method in class de.craftsblock.craftsnet.addon.loaders.CraftsNetClassLoader

Checks whether the calling class was loaded by a CraftsNetClassLoader.

isCraftsNetLoaded(Class<?>) - Static method in class de.craftsblock.craftsnet.addon.loaders.CraftsNetClassLoader

Checks whether the given class was loaded by a CraftsNetClassLoader.

isDataCode() - Method in enum class de.craftsblock.craftsnet.api.websocket.Opcode

Checks if the opcode is a code which should contain data

isDebug() - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Checks if debug mode is enabled.

isEmpty() - Method in record class de.craftsblock.craftsnet.api.http.body.bodies.MultipartFormBody.MultipartData

Checks if the multipart data for the field is empty.

isEnabled() - Method in class de.craftsblock.craftsnet.api.http.WebServer

Checks if the server is enabled.

isEnabled() - Method in class de.craftsblock.craftsnet.api.Server

Checks if the server is enabled.

isEnabled() - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketServer

Checks if the server is enabled.

isFile() - Method in record class de.craftsblock.craftsnet.api.http.body.bodies.MultipartFormBody.MultipartItem

Checks if the multipart item represents a file.

isFileLogger(ActivateType) - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Checks if the file logger is configured with the specified activation type.

isFinalFrame() - Method in class de.craftsblock.craftsnet.api.websocket.Frame

Checks if this frame is the final frame in a sequence of fragmented frames.

isFixedSize() - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Checks if the buffer has a fixed size.

isHttpOnly() - Method in class de.craftsblock.craftsnet.api.http.cookies.Cookie

Returns whether the cookie is HttpOnly.

isInternal() - Method in enum class de.craftsblock.craftsnet.api.websocket.ClosureCode

Checks whether the ClosureCode is considered internal.

isJsonBody() - Method in class de.craftsblock.craftsnet.api.http.body.Body

Checks if this request body is a JSON request body.

isLogRotate() - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Checks if log rotation is disabled.

isLogStreamMutatorRegistered(LogStreamMutator) - Method in class de.craftsblock.craftsnet.logging.mutate.LogStream

Checks whether the given LogStreamMutator is already registered or not.

isMasked() - Method in class de.craftsblock.craftsnet.api.websocket.Frame

Returns if the frame was masked (when received), or schuld be masked (when send)!

isMultipartFormBody() - Method in class de.craftsblock.craftsnet.api.http.body.Body

Checks if this request body is a multipart form request body.

isParseable(String) - Method in class de.craftsblock.craftsnet.api.http.body.BodyParser

Checks if this parser can parse the given content type.

isParserPresent(Class<T>) - Method in class de.craftsblock.craftsnet.api.http.body.BodyRegistry

Checks if a parser is registered for the specified body type.

isPersistent() - Method in class de.craftsblock.craftsnet.api.session.SessionInfo

Checks whether the session is persistent.

isPresent(Class<A>) - Method in record class de.craftsblock.craftsnet.api.RouteRegistry.EndpointMapping

Checks whether the given annotation is present in the requirements.

isPresent(Class<A>) - Method in interface de.craftsblock.craftsnet.api.RouteRegistry.Mapping

Checks whether a specific annotation is present in the mapping's requirements.

isPresent(Class<A>, String) - Method in record class de.craftsblock.craftsnet.api.RouteRegistry.EndpointMapping

Checks whether a specific key within the given annotation's requirements is present.

isPresent(Class<A>, String) - Method in interface de.craftsblock.craftsnet.api.RouteRegistry.Mapping

Checks whether a specific key within an annotation's requirements is present.

isPrimitive(Class<?>) - Static method in class de.craftsblock.craftsnet.utils.reflection.TypeUtils

Checks if the given type represents a primitive type.

isReadable() - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Checks if there are any readable bytes remaining in the buffer.

isReadable(int) - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Checks if the buffer has enough readable bytes for a specified length.

isReadOnly() - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Checks if the buffer is read-only.

isRegistered(StreamEncoder) - Method in class de.craftsblock.craftsnet.api.http.encoding.StreamEncoderRegistry

Checks if the given StreamEncoder is already registered.

isRegistered(Class<? extends Addon>) - Method in class de.craftsblock.craftsnet.addon.AddonManager

Checks whether an Addon class is registered or not.

isRegistered(String) - Method in class de.craftsblock.craftsnet.addon.AddonManager

Checks whether an Addon is registered using its name.

isRegistered(String) - Method in class de.craftsblock.craftsnet.api.http.encoding.StreamEncoderRegistry

Checks if an StreamEncoder with the given encoding name is registered.

isRegistered(C) - Method in class de.craftsblock.craftsnet.api.codec.registry.TypeCodecRegistry

Checks if the given codec is already registered.

isRegistered(ServiceLoader<?>) - Method in class de.craftsblock.craftsnet.addon.services.ServiceManager

Checks if the given ServiceLoader is registered.

isRegistered(Handler) - Method in class de.craftsblock.craftsnet.api.RouteRegistry

Checks if the given Handler is registered.

isRegistered(BodyParser<? extends Body>) - Method in class de.craftsblock.craftsnet.api.http.body.BodyRegistry

Checks if the given BodyParser is registered.

isRegistered(Middleware) - Method in class de.craftsblock.craftsnet.api.middlewares.MiddlewareRegistry

Checks if a specific middleware is registered for global appliance.

isRegistered(WebRequirement) - Method in class de.craftsblock.craftsnet.api.requirements.RequirementRegistry

Checks if the given WebRequirement is registered.

isRegistered(WebSocketRequirement<? extends RequireAble>) - Method in class de.craftsblock.craftsnet.api.requirements.RequirementRegistry

Checks if the given WebSocketRequirement is registered.

isRegistered(Class<? extends ServiceLoader<?>>) - Method in class de.craftsblock.craftsnet.addon.services.ServiceManager

Checks if the given class representation of the ServiceLoader is registered.

isRegistered(Class<? extends Handler>) - Method in class de.craftsblock.craftsnet.api.RouteRegistry

Checks if the given class representation of the Handler is registered.

isRegistered(Class<? extends BodyParser<? extends Body>>) - Method in class de.craftsblock.craftsnet.api.http.body.BodyRegistry

Checks if the given class representation of the BodyParser is registered.

isRegistered(Class<? extends Requirement<? extends RequireAble, RouteRegistry.EndpointMapping>>) - Method in class de.craftsblock.craftsnet.api.requirements.RequirementRegistry

Checks if the given class representation of the Requirement is registered.

isRequestBodyAble() - Method in enum class de.craftsblock.craftsnet.api.http.HttpMethod

Check if the HTTP method allows a request body.

isResponseBodyAble() - Method in enum class de.craftsblock.craftsnet.api.http.HttpMethod

Check if the HTTP method allows a response body.

isRsv1() - Method in class de.craftsblock.craftsnet.api.websocket.Frame

Checks if the RSV1 bit is set in the frame header.

isRsv2() - Method in class de.craftsblock.craftsnet.api.websocket.Frame

Checks if the RSV2 bit is set in the frame header.

isRsv3() - Method in class de.craftsblock.craftsnet.api.websocket.Frame

Checks if the RSV3 bit is set in the frame header.

isRunning() - Method in class de.craftsblock.craftsnet.api.Server

Checks if the server is running.

isSameFamily(Scheme) - Method in enum class de.craftsblock.craftsnet.api.utils.Scheme

Checks if the specified scheme is from the same scheme family as this scheme.

isSecure() - Method in class de.craftsblock.craftsnet.api.http.cookies.Cookie

Returns whether the cookie is secure.

isSessionStarted() - Method in class de.craftsblock.craftsnet.api.session.Session

Checks whether a session has been started.

isShare(String) - Method in class de.craftsblock.craftsnet.api.RouteRegistry

Checks if a URL corresponds to a shared folder by verifying if both a shared folder and its pattern exist for the URL.

isSSL() - Method in class de.craftsblock.craftsnet.api.http.WebServer

Checks if SSL is enabled for the server.

isSSL() - Method in class de.craftsblock.craftsnet.api.Server

Checks if SSL is enabled for the server.

isSSL() - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketServer

Checks if SSL is enabled for the server.

isSSL() - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Checks if SSL is enabled.

isStandardFormBody() - Method in class de.craftsblock.craftsnet.api.http.body.Body

Checks if this request body is a standard form request body.

isType(String, Class<T>) - Method in class de.craftsblock.craftsnet.api.session.Session

Checks if the value associated with the specified key is of the specified type.

isUnknown() - Method in enum class de.craftsblock.craftsnet.api.websocket.Opcode

Checks if the opcode is not a valid opcode as defined in RFC 6455

isWebServer(ActivateType) - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Checks if the web server is configured with the specified activation type.

isWebSocketServer(ActivateType) - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Checks if the WebSocket server is configured with the specified activation type.

isWrapper(Class<?>) - Static method in class de.craftsblock.craftsnet.utils.reflection.TypeUtils

Checks if the given type represents a wrapper class of a primitive type.

isWriteable() - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Checks if the buffer is writable (i.e., there is space to write).

isWriteable(int) - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Checks if the buffer has enough space to write the specified number of bytes.

items() - Method in record class de.craftsblock.craftsnet.api.http.body.bodies.MultipartFormBody.MultipartData

Returns the value of the items record component.

J

join(CharSequence, HttpMethod...) - Static method in enum class de.craftsblock.craftsnet.api.http.HttpMethod

Joins the names of the provided HttpMethod values into a single string using the specified delimiter.

join(HttpMethod...) - Static method in enum class de.craftsblock.craftsnet.api.http.HttpMethod

Joins the names of the provided HttpMethod values using the default delimiter "|".

json() - Method in record class de.craftsblock.craftsnet.addon.meta.AddonConfiguration

Returns the value of the json record component.

JsonBody - Class in de.craftsblock.craftsnet.api.http.body.bodies

The JsonBody class represents an http request body which contains Json data.

JsonBody(Request, Json) - Constructor for class de.craftsblock.craftsnet.api.http.body.bodies.JsonBody

Constructs a new JsonBody object.

JsonBodyParser - Class in de.craftsblock.craftsnet.api.http.body.parser.typed

This class is a body parser specifically designed to parse json request bodies.

JsonBodyParser() - Constructor for class de.craftsblock.craftsnet.api.http.body.parser.typed.JsonBodyParser

Constructs a new JsonBodyParser object with the content type set to "application/json".

L

LAX - Enum constant in enum class de.craftsblock.craftsnet.api.http.cookies.SameSite

The "Lax" value allows the cookie to be sent with same-site requests and with top-level cross-site navigation.

ListenerAdapterLoader - Class in de.craftsblock.craftsnet.addon.services.builtin.listeners

A concrete implementation of the ServiceLoader interface for managing instances of ListenerAdapter.

ListenerAdapterLoader(CraftsNet) - Constructor for class de.craftsblock.craftsnet.addon.services.builtin.listeners.ListenerAdapterLoader

Creates a new instance of ListenerAdapterLoader.

ListenerAutoRegisterHandler - Class in de.craftsblock.craftsnet.autoregister.builtin.events

A handler for automatically registering ListenerAdapter implementations.

ListenerAutoRegisterHandler(CraftsNet) - Constructor for class de.craftsblock.craftsnet.autoregister.builtin.events.ListenerAutoRegisterHandler

Constructs a new ListenerAutoRegisterHandler.

listenerRegistry() - Method in class de.craftsblock.craftsnet.addon.Addon

Deprecated, for removal: This API element is subject to removal in a future version.

Use Addon.getListenerRegistry() instead. This will be removed in the future.

listenerRegistry() - Method in class de.craftsblock.craftsnet.CraftsNet

Deprecated, for removal: This API element is subject to removal in a future version.

Use CraftsNet.getListenerRegistry() instead. This will be removed in the future.

load() - Method in class de.craftsblock.craftsnet.addon.loaders.AddonLoader

Loads all the addons from the provided addon files.

load() - Method in class de.craftsblock.craftsnet.api.session.SessionInfo

Loads session metadata from the exchange and integrates it into the session system.

load() - Method in class de.craftsblock.craftsnet.api.session.SessionStorage

Loads the sessions data using the currently set driver.

load(ListenerAdapter) - Method in class de.craftsblock.craftsnet.addon.services.builtin.listeners.ListenerAdapterLoader

Loads an ListenerAdapter into the ListenerRegistry for further processing.

load(Handler) - Method in class de.craftsblock.craftsnet.addon.services.builtin.handlers.GenericHandlerLoader

Loads an Handler into the RouteRegistry for further processing.

load(RequestHandler) - Method in class de.craftsblock.craftsnet.addon.services.builtin.handlers.RequestHandlerLoader

Loads an RequestHandler into the RouteRegistry for further processing.

load(Middleware) - Method in class de.craftsblock.craftsnet.addon.services.builtin.handlers.MiddlewareHandlerLoader

Loads an Middleware into the MiddlewareRegistry for further processing.

load(Session, String) - Method in class de.craftsblock.craftsnet.api.session.drivers.builtin.FileSessionDriver

Loads the session data from a file corresponding to the sessions ID.

load(Session, String) - Method in interface de.craftsblock.craftsnet.api.session.drivers.SessionDriver

Loads session data from the underlying storage into the provided session instance.

load(SocketHandler) - Method in class de.craftsblock.craftsnet.addon.services.builtin.handlers.SocketHandlerLoader

Loads an SocketHandler into the RouteRegistry for further processing.

load(CraftsNet) - Static method in class de.craftsblock.craftsnet.api.ssl.SSL

This method loads SSL context using default paths for the certificate chain and private key files.

load(CraftsNet, String, String) - Static method in class de.craftsblock.craftsnet.api.ssl.SSL

This method loads an SSL context using the provided full chain and private key files.

load(Class<T>, Class<?>) - Method in class de.craftsblock.craftsnet.addon.services.ServiceManager

Loads a service provider for a specific service type using the provided service loader class.

load(Driver) - Method in class de.craftsblock.craftsnet.addon.services.builtin.SQLDriverLoader

Loads an Driver into the DriverManager for further processing.

load(List<AddonConfiguration>) - Method in class de.craftsblock.craftsnet.addon.loaders.AddonLoader

Loads all the addons from the provided list of AddonConfiguration.

load(IIOServiceProvider) - Method in class de.craftsblock.craftsnet.addon.services.builtin.IIOServiceLoader

Loads an IIOServiceProvider into the default IIORegistry for further processing.

load(T) - Method in interface de.craftsblock.craftsnet.addon.services.ServiceLoader

Loads a service provider and performs necessary operations.

LOAD - Enum constant in enum class de.craftsblock.craftsnet.addon.meta.Startup

Represents the loading stage of the addon load process.

LOAD - Enum constant in enum class de.craftsblock.craftsnet.api.session.SessionStorage.JobType

Indicating a load process.

loadAddons(CraftsNet) - Method in class de.craftsblock.craftsnet.builder.AddonContainingBuilder

Load all the addons that have been registered in the builder.

loadClass(String, boolean) - Method in class de.craftsblock.craftsnet.addon.loaders.AddonClassLoader

Loads the class with the specified name, optionally linking it after loading.

loadClass(String, boolean) - Method in class de.craftsblock.craftsnet.addon.loaders.DependencyClassLoader

Loads the class with the specified name, optionally linking it after loading.

loadFrom(ClassLoader, Collection<Addon>, JarFile) - Method in class de.craftsblock.craftsnet.autoregister.loaders.AutoRegisterLoader

Loads and processes all classes annotated with AutoRegister from the provided JarFile using the provided class loader.

loadFrom(ClassLoader, Collection<Addon>, JarFile, Class<? extends Annotation>) - Method in class de.craftsblock.craftsnet.autoregister.loaders.AutoRegisterLoader

Loads and processes all classes annotated with the specified annotation from the provided JarFile.

loadLibraries(CraftsNet, AddonLoader, Collection<RegisteredService>, String, String...) - Method in class de.craftsblock.craftsnet.addon.artifacts.ArtifactLoader

Loads libraries for a specific addon based on the provided library coordinates.

loadRequirements(ConcurrentHashMap<Class<? extends Annotation>, RequirementInfo>, Collection<Class<? extends Annotation>>, Method, Object) - Method in class de.craftsblock.craftsnet.api.requirements.RequirementRegistry

Load all the requirements from a specific list of annotations for a method and its handler.

logger - Variable in class de.craftsblock.craftsnet.api.Server

logger() - Method in class de.craftsblock.craftsnet.addon.Addon

Deprecated, for removal: This API element is subject to removal in a future version.

Use Addon.getLogger() instead. This will be removed in the future.

logger() - Method in class de.craftsblock.craftsnet.CraftsNet

Deprecated, for removal: This API element is subject to removal in a future version.

Use CraftsNet.getLogger() instead. This will be removed in the future.

Logger - Interface in de.craftsblock.craftsnet.logging

A logger interface for logging messages at different severity levels.

LoggerImpl - Class in de.craftsblock.craftsnet.logging.impl

The LoggerImpl class provides a simple logging mechanism for displaying log messages in the console with different log levels.

LoggerImpl(boolean) - Constructor for class de.craftsblock.craftsnet.logging.impl.LoggerImpl

Constructs a Logger with the specified debug mode.

LogLevel - Enum Class in de.craftsblock.craftsnet.logging

An enumeration of log levels used for categorizing log messages.

logStream() - Method in class de.craftsblock.craftsnet.CraftsNet

Deprecated, for removal: This API element is subject to removal in a future version.

Use CraftsNet.getLogStream() instead. This will be removed in the future.

LogStream - Class in de.craftsblock.craftsnet.logging.mutate

A utility class for logging to files.

LogStream(CraftsNet, boolean, long) - Constructor for class de.craftsblock.craftsnet.logging.mutate.LogStream

Constructs a new LogStream instance with a specified maximum number of log files.

LogStreamMutator - Interface in de.craftsblock.craftsnet.logging.mutate

Functional interface for mutating log output lines before they are written to the output stream.

LogStreamMutatorAutoRegisterHandler - Class in de.craftsblock.craftsnet.autoregister.builtin.cli

A handler for automatically registering LogStreamMutator implementations.

LogStreamMutatorAutoRegisterHandler(CraftsNet) - Constructor for class de.craftsblock.craftsnet.autoregister.builtin.cli.LogStreamMutatorAutoRegisterHandler

Constructs a new LogStreamMutatorAutoRegisterHandler.

LongTransformer - Class in de.craftsblock.craftsnet.api.transformers.builtin

A transformer class for converting a string representation of a long value to a Long object.

LongTransformer() - Constructor for class de.craftsblock.craftsnet.api.transformers.builtin.LongTransformer

LOW - Enum constant in enum class de.craftsblock.craftsnet.api.annotations.ProcessPriority.Priority

Indicates a low priority.

LOWEST - Enum constant in enum class de.craftsblock.craftsnet.api.annotations.ProcessPriority.Priority

Indicates the lowest priority.

M

main(String[]) - Static method in class de.craftsblock.craftsnet.CraftsNet

The main method is the entry point of the application.

mainClass() - Method in record class de.craftsblock.craftsnet.addon.meta.AddonMeta

Returns the value of the mainClass record component.

major() - Method in record class de.craftsblock.craftsnet.api.utils.ProtocolVersion

Returns the major version number.

makePersistent() - Method in class de.craftsblock.craftsnet.api.session.SessionInfo

Makes the session persistent by generating a unique session ID and updating the HTTP response with a session cookie.

map(Class<? extends Addon>, String) - Static method in record class de.craftsblock.craftsnet.addon.meta.AddonConfiguration

Maps an addon class to a custom name.

map(Class<? extends Addon>, String) - Method in class de.craftsblock.craftsnet.builder.AddonContainingBuilder

Maps an addon class to a custom name.

markDeleted() - Method in class de.craftsblock.craftsnet.api.http.cookies.Cookie

Marks the cookie as deleted by setting its expiry date to a date in the past.

markReaderIndex() - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Marks the current reader index, so it can be restored later.

markWriterIndex() - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Marks the current writer index, so it can be restored later.

MAX_AGE_HEADER - Static variable in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

The http header that indicates how long the results of a preflight request can be cached.

merge(RequirementInfo, RequirementInfo) - Static method in record class de.craftsblock.craftsnet.api.requirements.meta.RequirementInfo

Merges two RequirementInfo instances into a single one.

MessageTypeRequirement - Class in de.craftsblock.craftsnet.api.requirements.websocket

A specific websocket requirement that checks if the domain of a websocket connection matches certain criteria.

MessageTypeRequirement() - Constructor for class de.craftsblock.craftsnet.api.requirements.websocket.MessageTypeRequirement

Constructs a new websocket message type requirement.

meta() - Method in record class de.craftsblock.craftsnet.addon.meta.AddonConfiguration

Returns the value of the meta record component.

meta() - Method in record class de.craftsblock.craftsnet.api.requirements.meta.RequirementInfo

Returns the value of the meta record component.

Meta - Annotation Interface in de.craftsblock.craftsnet.addon.meta.annotations

Provides basic metadata for Addon.

method() - Method in record class de.craftsblock.craftsnet.api.RouteRegistry.EndpointMapping

Returns the value of the method record component.

MethodRequirement - Class in de.craftsblock.craftsnet.api.requirements.web

A specific web requirement that checks if the request method of an HTTP request matches certain criteria.

MethodRequirement() - Constructor for class de.craftsblock.craftsnet.api.requirements.web.MethodRequirement

Constructs a new method requirement.

methods() - Element in annotation interface de.craftsblock.craftsnet.api.requirements.meta.RequirementMeta

Specifies the method(s) to be used when extracting values from the annotated requirement.

Middleware - Interface in de.craftsblock.craftsnet.api.middlewares

Represents a basic middleware that can be used in context with exchanges to manipulate the behaviour of the application without interacting with the built-in listener system.

MiddlewareAutoRegisterHandler - Class in de.craftsblock.craftsnet.autoregister.builtin

A handler for automatically registering Middleware implementations.

MiddlewareAutoRegisterHandler(CraftsNet) - Constructor for class de.craftsblock.craftsnet.autoregister.builtin.MiddlewareAutoRegisterHandler

Constructs a new MiddlewareAutoRegisterHandler.

MiddlewareCallbackInfo - Class in de.craftsblock.craftsnet.api.middlewares

The MiddlewareCallbackInfo is used to pass information between the different middlewares.

MiddlewareCallbackInfo() - Constructor for class de.craftsblock.craftsnet.api.middlewares.MiddlewareCallbackInfo

MiddlewareHandlerLoader - Class in de.craftsblock.craftsnet.addon.services.builtin.handlers

A concrete implementation of the ServiceLoader interface for managing instances of Middleware.

MiddlewareHandlerLoader(CraftsNet) - Constructor for class de.craftsblock.craftsnet.addon.services.builtin.handlers.MiddlewareHandlerLoader

Creates a new instance of MiddlewareHandlerLoader.

middlewareRegistry() - Method in class de.craftsblock.craftsnet.addon.Addon

Deprecated, for removal: This API element is subject to removal in a future version.

Use Addon.getMiddlewareRegistry() instead. This will be removed in the future.

middlewareRegistry() - Method in class de.craftsblock.craftsnet.CraftsNet

Deprecated, for removal: This API element is subject to removal in a future version.

Use CraftsNet.getMiddlewareRegistry() instead. This will be removed in the future.

MiddlewareRegistry - Class in de.craftsblock.craftsnet.api.middlewares

A registry for resolving and storing middlewares.

MiddlewareRegistry() - Constructor for class de.craftsblock.craftsnet.api.middlewares.MiddlewareRegistry

middlewares() - Method in record class de.craftsblock.craftsnet.api.RouteRegistry.EndpointMapping

Returns the value of the middlewares record component.

migrate(SessionDriver) - Method in class de.craftsblock.craftsnet.api.session.SessionStorage

Migrates this session from the currently set driver to another driver.

migrate(Session, String, SessionDriver) - Method in interface de.craftsblock.craftsnet.api.session.drivers.SessionDriver

Migrates the session data from one SessionDriver to another.

MIGRATE - Enum constant in enum class de.craftsblock.craftsnet.api.session.SessionStorage.JobType

Indicating a migrate process.

minor() - Method in record class de.craftsblock.craftsnet.api.utils.ProtocolVersion

Returns the minor version number.

MONITOR - Enum constant in enum class de.craftsblock.craftsnet.api.annotations.ProcessPriority.Priority

Indicates a monitoring priority.

MULTIPART_FORM_DATA - Static variable in interface de.craftsblock.craftsnet.api.http.body.ContentType

MultipartData(String, List<MultipartFormBody.MultipartItem>) - Constructor for record class de.craftsblock.craftsnet.api.http.body.bodies.MultipartFormBody.MultipartData

Creates an instance of a MultipartData record class.

MultipartFormBody - Class in de.craftsblock.craftsnet.api.http.body.bodies

The MultipartFormBody class represents an HTTP request body that contains data in the multipart/form-data format.

MultipartFormBody(Request, String, InputStream) - Constructor for class de.craftsblock.craftsnet.api.http.body.bodies.MultipartFormBody

Constructs a new MultipartFormBody by specifying the boundary and providing an input stream containing the multipart/form-data.

MultipartFormBody.MultipartData - Record Class in de.craftsblock.craftsnet.api.http.body.bodies

The MultipartData class represents the multipart data for a single field in the multipart/form-data.

MultipartFormBody.MultipartItem - Record Class in de.craftsblock.craftsnet.api.http.body.bodies

The MultipartItem class represents an individual part of the multipart data, which can be a file or a form field.

MultipartFormBodyParser - Class in de.craftsblock.craftsnet.api.http.body.parser

This class is a body parser specifically designed to parse multipart form data request bodies.

MultipartFormBodyParser() - Constructor for class de.craftsblock.craftsnet.api.http.body.parser.MultipartFormBodyParser

Constructs a new MultipartFormBodyParser object with the content type set to "multipart/form-data".

MultipartItem(List<byte[]>, String) - Constructor for record class de.craftsblock.craftsnet.api.http.body.bodies.MultipartFormBody.MultipartItem

Creates an instance of a MultipartItem record class.

mutate(LogStream, String) - Method in class de.craftsblock.craftsnet.logging.mutate.builtin.BlurIPsMutator

Mutates the log line blurring the line if it is enabled.

mutate(LogStream, String) - Method in interface de.craftsblock.craftsnet.logging.mutate.LogStreamMutator

Mutates the given log line based on the state or configuration of the associated LogStream.

N

name() - Method in record class de.craftsblock.craftsnet.addon.meta.AddonMeta

Returns the value of the name record component.

name() - Element in annotation interface de.craftsblock.craftsnet.addon.meta.annotations.Meta

The name of the addon.

name() - Method in record class de.craftsblock.craftsnet.api.http.body.bodies.MultipartFormBody.MultipartData

Returns the value of the name record component.

NAME_VALIDATOR - Static variable in record class de.craftsblock.craftsnet.addon.meta.AddonConfiguration

Pattern for validating addon names.

needsAnnotation() - Method in enum class de.craftsblock.craftsnet.autoregister.meta.constructors.ConstructorType

Determines whether this constructor type requires an annotation.

NEW - Enum constant in enum class de.craftsblock.craftsnet.autoregister.meta.Instantiate

Indicates that a new instance of the class should be created each time it is accessed.

newInstance(Class<T>, Object...) - Method in interface de.craftsblock.craftsnet.addon.services.ServiceLoader

Creates a new instance of the specified class using its default constructor.

NO_STATUS - Enum constant in enum class de.craftsblock.craftsnet.api.websocket.ClosureCode

Indicates that no status code was actually present.

NONE - Enum constant in enum class de.craftsblock.craftsnet.api.http.cookies.SameSite

The "None" value allows the cookie to be sent with both cross-site and same-site requests.

NoOpLogger - Record Class in de.craftsblock.craftsnet.logging.impl

An implementation of the Logger interface that performs no operations.

NoOpLogger(Logger) - Constructor for record class de.craftsblock.craftsnet.logging.impl.NoOpLogger

Constructs an NoOpLogger with a reference to a previous Logger.

NORMAL - Enum constant in enum class de.craftsblock.craftsnet.api.annotations.ProcessPriority.Priority

Indicates a normal priority.

NORMAL - Enum constant in enum class de.craftsblock.craftsnet.api.websocket.ClosureCode

Indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled.

NORMAL - Enum constant in enum class de.craftsblock.craftsnet.autoregister.meta.constructors.ConstructorType

A normal constructor without any special annotation.

normalize(HttpMethod...) - Static method in enum class de.craftsblock.craftsnet.api.http.HttpMethod

Normalizes the provided array of HttpMethod values by: Removing null values Excluding UNKNOWN methods Flattening ALL and ALL_RAW into their actual method components Removing duplicates

NotTransformableException - Exception in de.craftsblock.craftsnet.api.transformers.exceptions

This exception is thrown when a parameter cannot be transformed to a specified target type.

NotTransformableException(String, Class<?>) - Constructor for exception de.craftsblock.craftsnet.api.transformers.exceptions.NotTransformableException

Construct a new NotTransformableException which indicates that something bad happened while transforming the value.

O

of(AddonConfiguration) - Static method in record class de.craftsblock.craftsnet.addon.meta.AddonMeta

Creates an AddonMeta instance from the configuration provided by the AddonConfiguration.

of(String, Collection<Addon>, Annotation, ClassLoader, List<String>) - Static method in class de.craftsblock.craftsnet.autoregister.meta.AutoRegisterInfo

Creates a new instance of AutoRegisterInfo.

of(CraftsNet, AddonLoader, Class<? extends Addon>) - Static method in record class de.craftsblock.craftsnet.addon.meta.AddonConfiguration

Creates a list of AddonConfiguration instances from the provided Addon class, including its dependencies.

of(Path, Json, URL[], DependencyClassLoader[], Collection<RegisteredService>) - Static method in record class de.craftsblock.craftsnet.addon.meta.AddonConfiguration

Creates an AddonConfiguration instance from the provided params.

onCommand(Command, String, String[], Logger) - Method in class de.craftsblock.craftsnet.command.commands.PluginCommand

Executes the plugin command.

onCommand(Command, String, String[], Logger) - Method in class de.craftsblock.craftsnet.command.commands.ReloadCommand

Executes the reload command.

onCommand(Command, String, String[], Logger) - Method in class de.craftsblock.craftsnet.command.commands.ShutdownCommand

Executes the "shutdown" command, initiating the shutdown process for CraftsNet.

onCommand(Command, String, String[], Logger) - Method in class de.craftsblock.craftsnet.command.commands.VersionCommand

Executes the version command.

onCommand(Command, String, String[], Logger) - Method in interface de.craftsblock.craftsnet.command.CommandExecutor

Executes a command with the provided arguments and logger.

onDisable() - Method in class de.craftsblock.craftsnet.addon.Addon

Called when the addon is being disabled.

onEnable() - Method in class de.craftsblock.craftsnet.addon.Addon

Called when the addon is being enabled.

onLoad() - Method in class de.craftsblock.craftsnet.addon.Addon

Called when the addon is being loaded.

onlyGet() - Method in record class de.craftsblock.craftsnet.api.RouteRegistry.ShareMapping

Returns the value of the onlyGet record component.

Opcode - Enum Class in de.craftsblock.craftsnet.api.websocket

Enumeration representing WebSocket opcodes along with their integer values.

OPTIONS - Enum constant in enum class de.craftsblock.craftsnet.api.http.HttpMethod

Represents the OPTIONS request method

OutgoingSocketMessageEvent - Class in de.craftsblock.craftsnet.events.sockets.message

The OutgoingSocketMessageEvent class represents an event related to an outgoing message on a websocket connection.

OutgoingSocketMessageEvent(SocketExchange, Frame) - Constructor for class de.craftsblock.craftsnet.events.sockets.message.OutgoingSocketMessageEvent

Constructs a new OutgoingSocketMessageEvent with the specified SocketExchange and message data.

override(Cookie) - Method in class de.craftsblock.craftsnet.api.http.cookies.Cookie

Overrides the current cookie's attributes with those of another cookie.

P

parameter() - Element in annotation interface de.craftsblock.craftsnet.api.transformers.annotations.Transformer

Specifies the name of the parameter to be transformed.

parse(Scheme, String) - Static method in record class de.craftsblock.craftsnet.api.utils.ProtocolVersion

Parses a protocol version string using the default dot separator (".").

parse(Scheme, String, String) - Static method in record class de.craftsblock.craftsnet.api.utils.ProtocolVersion

Parses a protocol version string using a custom separator.

parse(Request, InputStream) - Method in class de.craftsblock.craftsnet.api.http.body.BodyParser

Parses the body from the provided input stream.

parse(Request, InputStream) - Method in class de.craftsblock.craftsnet.api.http.body.parser.MultipartFormBodyParser

Parses the multipart form data body from the provided input stream.

parse(Request, InputStream) - Method in class de.craftsblock.craftsnet.api.http.body.parser.StandardFormBodyParser

Parses the standard form body from the provided input stream.

parse(Request, InputStream) - Method in class de.craftsblock.craftsnet.api.http.body.parser.typed.TypedBodyParser

Parses the body from the provided input stream.

parse(String) - Static method in enum class de.craftsblock.craftsnet.api.http.HttpMethod

Parse the given HTTP request method string and return the corresponding RequestMethod enum value.

parseCookies(Headers) - Static method in class de.craftsblock.craftsnet.api.http.Request

Parses the "Cookie" header from the given HTTP headers and returns a collection of Cookie objects.

parseHeader(String) - Static method in class de.craftsblock.craftsnet.api.http.encoding.AcceptEncodingHelper

Parses an Accept-Encoding header and extracts encoding types with their quality values.

PassphraseUtils - Class in de.craftsblock.craftsnet.utils

This utility class provides helper methods for generating passphrases.

PATCH - Enum constant in enum class de.craftsblock.craftsnet.api.http.HttpMethod

Represents the PATCH request method

path() - Method in record class de.craftsblock.craftsnet.addon.meta.AddonConfiguration

Returns the value of the path record component.

path() - Method in record class de.craftsblock.craftsnet.api.http.Exchange

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of Request.getRawUrl().

patternGroupNameExtractPattern - Static variable in class de.craftsblock.craftsnet.utils.Utils

A regular expression pattern used to extract group names from a regular expression pattern string.

perform(Handler, Method, Object[]) - Method in class de.craftsblock.craftsnet.api.transformers.TransformerPerformer

Performs transformations on method arguments.

perform(String, String[]) - Method in class de.craftsblock.craftsnet.command.CommandRegistry

Performs the execution of a command with the provided name and arguments.

PerMessageDeflateExtension - Class in de.craftsblock.craftsnet.api.websocket.extensions.builtin

WebSocket extension that implements per-message deflate compression as described in RFC 7692.

PerMessageDeflateExtension() - Constructor for class de.craftsblock.craftsnet.api.websocket.extensions.builtin.PerMessageDeflateExtension

Constructs a new PerMessageDeflateExtension with the protocol name "permessage-deflate".

PING - Enum constant in enum class de.craftsblock.craftsnet.api.websocket.Opcode

Indicates a Ping frame.

PlainLogger - Record Class in de.craftsblock.craftsnet.logging.impl

An implementation of the Logger interface that prints the result in the System.out or the System.err stream, without any further formating.

PlainLogger(Logger) - Constructor for record class de.craftsblock.craftsnet.logging.impl.PlainLogger

Constructs an PlainLogger with a reference to a previous Logger.

PluginCommand - Class in de.craftsblock.craftsnet.command.commands

Command executor for the plugin command.

PluginCommand(CraftsNet) - Constructor for class de.craftsblock.craftsnet.command.commands.PluginCommand

Constructs a new instance of the plugin command

POLICY_VIOLATION - Enum constant in enum class de.craftsblock.craftsnet.api.websocket.ClosureCode

Indicates a violation of the WebSocket protocol's policy.

PONG - Enum constant in enum class de.craftsblock.craftsnet.api.websocket.Opcode

Indicates a Pong frame.

port - Variable in class de.craftsblock.craftsnet.api.Server

POST - Enum constant in enum class de.craftsblock.craftsnet.api.http.HttpMethod

Represents the POST request method

PostRequestEvent - Class in de.craftsblock.craftsnet.events.requests

This event is triggered after an HTTP request has been processed.

PostRequestEvent(Exchange, boolean, boolean) - Constructor for class de.craftsblock.craftsnet.events.requests.PostRequestEvent

Constructs a new PostRequestEvent.

PreferConstructor - Annotation Interface in de.craftsblock.craftsnet.autoregister.meta.constructors

This annotation is used to mark a constructor as the preferred constructor.

PREFERRED - Enum constant in enum class de.craftsblock.craftsnet.autoregister.meta.constructors.ConstructorType

A constructor marked with PreferConstructor, indicating that it should be preferred.

PreRequestEvent - Class in de.craftsblock.craftsnet.events.requests

This event is triggered before a http request is processed as route or share.

PreRequestEvent(Exchange) - Constructor for class de.craftsblock.craftsnet.events.requests.PreRequestEvent

Constructs a new PreRequestEvent with the provided Exchange object.

previous() - Method in record class de.craftsblock.craftsnet.logging.impl.NoOpLogger

Returns the value of the previous record component.

previous() - Method in record class de.craftsblock.craftsnet.logging.impl.PlainLogger

Returns the previous Logger in the chain.

print(byte[]) - Method in class de.craftsblock.craftsnet.api.http.Response

Sends the provided bytes as the response body.

print(Json, boolean) - Method in class de.craftsblock.craftsnet.api.http.Response

Sends the string representation of the provided json object as the response body while setting the pretty printing flag.

print(File) - Method in class de.craftsblock.craftsnet.api.http.Response

Sends the provided file as the response body.

print(InputStream) - Method in class de.craftsblock.craftsnet.api.http.Response

Sends the content of the provided input stream as the response body.

print(Object) - Method in class de.craftsblock.craftsnet.api.http.Response

Sends the string representation of the provided object as the response body.

print(String) - Method in class de.craftsblock.craftsnet.api.http.Response

Sends the provided text as the response body in UTF-8 encoding.

print(Path) - Method in class de.craftsblock.craftsnet.api.http.Response

Sends the provided file behind the Path as the response body.

println(String) - Method in class de.craftsblock.craftsnet.api.http.Response

Sends the provided text as the response body followed by a new line in UTF-8 encoding.

priority() - Method in record class de.craftsblock.craftsnet.api.RouteRegistry.EndpointMapping

Returns the value of the priority record component.

ProcessPriority - Annotation Interface in de.craftsblock.craftsnet.api.annotations

Annotation to define the processing priority of a method.

ProcessPriority.Priority - Enum Class in de.craftsblock.craftsnet.api.annotations

Enumeration representing different priority levels.

PROTOCOL_ERROR - Enum constant in enum class de.craftsblock.craftsnet.api.websocket.ClosureCode

Indicates a protocol error, meaning that the endpoint received a message that violates its protocol.

protocolVersion() - Method in interface de.craftsblock.craftsnet.api.BaseExchange

Gets the ProtocolVersion of the exchange.

protocolVersion() - Method in record class de.craftsblock.craftsnet.api.http.Exchange

Returns the value of the protocolVersion record component.

protocolVersion() - Method in record class de.craftsblock.craftsnet.api.websocket.SocketExchange

Returns the value of the protocolVersion record component.

ProtocolVersion - Record Class in de.craftsblock.craftsnet.api.utils

Represents a specific version of a protocol, including its scheme, major version, and minor version.

ProtocolVersion(Scheme, int, int) - Constructor for record class de.craftsblock.craftsnet.api.utils.ProtocolVersion

Constructs a new ProtocolVersion instance.

provider() - Method in record class de.craftsblock.craftsnet.addon.meta.RegisteredService

Returns the value of the provider record component.

PUT - Enum constant in enum class de.craftsblock.craftsnet.api.http.HttpMethod

Represents the PUT request method

Q

QueryParameterRequirement - Class in de.craftsblock.craftsnet.api.requirements.web

A specific web requirement that checks if the url parameter list of an HTTP request matches certain criteria.

QueryParameterRequirement() - Constructor for class de.craftsblock.craftsnet.api.requirements.web.QueryParameterRequirement

Constructs a new query parameter requirement.

R

RAW_INTERNAL_CODES - Static variable in enum class de.craftsblock.craftsnet.api.websocket.ClosureCode

List of integer values corresponding to ClosureCode values that are considered internal.

read(InputStream) - Static method in class de.craftsblock.craftsnet.api.websocket.Frame

Reads a WebSocket frame from the given input stream.

readableBytes() - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Returns the number of readable bytes left in the buffer.

readBoolean() - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Reads a boolean value from the buffer.

readByte() - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Reads a single byte from the buffer.

readChar() - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Reads a single character from the buffer.

readCharSequence(int, Charset) - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Reads a sequence of characters from the buffer using the specified Charset.

readDouble() - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Reads a double value (8 bytes) from the buffer.

readEnum(Class<T>) - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Reads an enum constant from the buffer by ordinal value.

readerIndex() - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Returns the current reader index of the buffer.

readerIndex(int) - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Sets the reader index to the specified value.

readFloat() - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Reads a floating-point value (4 bytes) from the buffer.

readInt() - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Reads an integer (4 bytes) from the buffer.

readLong() - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Reads a long (8 bytes) from the buffer.

readNBytes(int) - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Reads the specified number of bytes from the buffer and advances the reader index.

readRemaining() - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Reads all remaining bytes from the current reader index.

readShifted(int, int) - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Reads a shifted integer from the buffer by combining bytes.

readShort() - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Reads a short (2 bytes) from the buffer.

readUnsignedShort() - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Reads an unsigned short (2 bytes) from the buffer.

readUTF() - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Reads a UTF-8 encoded string from the buffer.

readUTF(int) - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Reads a UTF-8 encoded string of the given length from the buffer.

readUUID() - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Reads a UUID from the buffer, which consists of two long values (most significant bits and least significant bits).

readVarInt() - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Reads a variable-length integer from the buffer.

readVarLong() - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Reads a variable-length long from the buffer.

ReceivedPingMessageEvent - Class in de.craftsblock.craftsnet.events.sockets.message

An event indicating that a Ping message has been received.

ReceivedPingMessageEvent(SocketExchange, Frame) - Constructor for class de.craftsblock.craftsnet.events.sockets.message.ReceivedPingMessageEvent

Constructs a ReceivedPingMessageEvent with the specified SocketExchange.

ReceivedPongMessageEvent - Class in de.craftsblock.craftsnet.events.sockets.message

An event indicating that a Pong message has been received.

ReceivedPongMessageEvent(SocketExchange, Frame) - Constructor for class de.craftsblock.craftsnet.events.sockets.message.ReceivedPongMessageEvent

Constructs a ReceivedPongMessageEvent with the specified SocketExchange.

REFERENCE_COOKIE - Static variable in class de.craftsblock.craftsnet.api.session.SessionInfo

The reference Cookie

ReflectionUtils - Class in de.craftsblock.craftsnet.utils.reflection

Some reflection utilities.

register(Addon) - Method in class de.craftsblock.craftsnet.addon.AddonManager

Registers an addon in the AddonManager.

register(BodyParser<T>) - Method in class de.craftsblock.craftsnet.api.http.body.BodyRegistry

Registers a body parser for a specific body type.

register(StreamEncoder) - Method in class de.craftsblock.craftsnet.api.http.encoding.StreamEncoderRegistry

Registers a new StreamEncoder if it is not already registered.

register(C) - Method in class de.craftsblock.craftsnet.api.codec.registry.TypeCodecRegistry

Registers a new codec into the registry.

register(ServiceLoader<T>) - Method in class de.craftsblock.craftsnet.addon.services.ServiceManager

Registers a service loader with the ServiceManager.

register(Handler) - Method in class de.craftsblock.craftsnet.api.RouteRegistry

Registers an endpoint handler (RequestHandler and or SocketHandler) by inspecting its annotated methods and adding it to the registry.

register(Middleware) - Method in class de.craftsblock.craftsnet.api.middlewares.MiddlewareRegistry

Registers a middleware that should be applied globally.

register(WebRequirement) - Method in class de.craftsblock.craftsnet.api.requirements.RequirementRegistry

Registers and applies a new requirement to the web system.

register(WebRequirement, boolean) - Method in class de.craftsblock.craftsnet.api.requirements.RequirementRegistry

Registers a new requirement to the web system.

register(WebSocketRequirement<? extends RequireAble>) - Method in class de.craftsblock.craftsnet.api.requirements.RequirementRegistry

Registers and applies a new requirement to the websocket system.

register(WebSocketRequirement<? extends RequireAble>, boolean) - Method in class de.craftsblock.craftsnet.api.requirements.RequirementRegistry

Registers a new requirement to the websocket system.

register(WebSocketExtension) - Method in class de.craftsblock.craftsnet.api.websocket.extensions.WebSocketExtensionRegistry

Registers a new WebSocket extension.

register(AutoRegisterHandler<? extends T>) - Method in class de.craftsblock.craftsnet.autoregister.AutoRegisterRegistry

Registers a custom AutoRegisterHandler.

register(CraftsNet) - Static method in class de.craftsblock.craftsnet.api.websocket.DefaultPingResponder

Registers the DefaultPingResponder with the specified CraftsNet instance.

RegisteredService - Record Class in de.craftsblock.craftsnet.addon.meta

Represents a registered service, encapsulating the service provider interface (SPI) and the provider information in a concise record.

RegisteredService(String, String) - Constructor for record class de.craftsblock.craftsnet.addon.meta.RegisteredService

Creates an instance of a RegisteredService record class.

registerLogStreamMutator(LogStreamMutator) - Method in class de.craftsblock.craftsnet.logging.mutate.LogStream

Registers a new LogStreamMutator that will be applied to each line written to the log stream.

ReloadCommand - Class in de.craftsblock.craftsnet.command.commands

Command executor for the reload command.

ReloadCommand(CraftsNet) - Constructor for class de.craftsblock.craftsnet.command.commands.ReloadCommand

Constructs a new instance of the reload command.

remove(WebSocketClient) - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketServer

Removes a WebSocket client from the server and the associated path.

removeAllowedHeader(String...) - Method in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Removes one or more http headers from the list of allowed headers.

removeAllowedOrigin(HttpMethod...) - Method in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Removes one or more http methods from the list of allowed methods.

removeAllowedOrigin(String...) - Method in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Removes one or more origins from the list of allowed origins.

removeCodeSource(CodeSource) - Method in class de.craftsblock.craftsnet.builder.AddonContainingBuilder

Removes a CodeSource from the code sources list.

removeCodeSource(CodeSource) - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Removes a CodeSource from the code sources list.

removeExposedHeader(String...) - Method in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Removes one or more headers from the list of exposed headers.

repositories() - Method in record class de.craftsblock.craftsnet.addon.meta.AddonMeta

Returns the value of the repositories record component.

REPOSITORY - Enum constant in enum class de.craftsblock.craftsnet.addon.meta.ShadowType

Represents a repository reference for resolving dependencies.

request() - Method in record class de.craftsblock.craftsnet.api.http.Exchange

Gets the Request object associated with this exchange holding information about the request.

Request - Class in de.craftsblock.craftsnet.api.http

The Request class represents an incoming HTTP request received by the web server.

Request(CraftsNet, HttpExchange, Headers, String, String, String, HttpMethod) - Constructor for class de.craftsblock.craftsnet.api.http.Request

Constructs a new Request object.

REQUEST_HEADERS_HEADER - Static variable in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

The http header sent by browsers in preflight requests to indicate which custom headers will be included in the actual request.

RequestHandler - Interface in de.craftsblock.craftsnet.api.http

The RequestHandler interface serves as a marker interface for classes that are intended to handle incoming HTTP requests.

RequestHandlerLoader - Class in de.craftsblock.craftsnet.addon.services.builtin.handlers

A concrete implementation of the ServiceLoader interface for managing instances of RequestHandler.

RequestHandlerLoader(CraftsNet) - Constructor for class de.craftsblock.craftsnet.addon.services.builtin.handlers.RequestHandlerLoader

Creates a new instance of RequestHandlerLoader.

RequestMethod - Annotation Interface in de.craftsblock.craftsnet.api.http.annotations

Specifies the HTTP request methods that are supported by the service method.

RequireAble - Interface in de.craftsblock.craftsnet.api.requirements

Marker interface representing a class that contains information which can be used to feed the requirement system.

RequireBody - Annotation Interface in de.craftsblock.craftsnet.api.http.annotations

Annotation used to indicate that a request handler method requires specific types of request bodies.

RequireContentType - Annotation Interface in de.craftsblock.craftsnet.api.http.annotations

This annotation can be applied to methods or types to indicate that certain content types are required for processing the request.

RequireCookie - Annotation Interface in de.craftsblock.craftsnet.api.http.annotations

Annotation to specify required cookies for methods or types.

RequireHeaders - Annotation Interface in de.craftsblock.craftsnet.api.http.annotations

Annotation to specify required HTTP headers for methods or types.

Requirement<T extends RequireAble,R extends RouteRegistry.EndpointMapping> - Class in de.craftsblock.craftsnet.api.requirements

Represents an abstract requirement that can be used in the requirement system.

Requirement(Class<? extends Annotation>) - Constructor for class de.craftsblock.craftsnet.api.requirements.Requirement

Constructs a new requirement with the specified annotation class.

RequirementInfo - Record Class in de.craftsblock.craftsnet.api.requirements.meta

Represents detailed information about a specific requirement annotation.

RequirementInfo(Annotation) - Constructor for record class de.craftsblock.craftsnet.api.requirements.meta.RequirementInfo

Constructs a RequirementInfo from a given annotation.

RequirementInfo(Class<? extends Annotation>, RequirementMeta, Map<String, Object>) - Constructor for record class de.craftsblock.craftsnet.api.requirements.meta.RequirementInfo

Creates an instance of a RequirementInfo record class.

RequirementMeta - Annotation Interface in de.craftsblock.craftsnet.api.requirements.meta

Annotation to define metadata for custom requirement annotations.

requirementRegistry() - Method in class de.craftsblock.craftsnet.addon.Addon

Deprecated, for removal: This API element is subject to removal in a future version.

Use Addon.getRequirementRegistry() instead. This will be removed in the future.

requirementRegistry() - Method in class de.craftsblock.craftsnet.CraftsNet

Deprecated, for removal: This API element is subject to removal in a future version.

Use CraftsNet.getRequirementRegistry() instead. This will be removed in the future.

RequirementRegistry - Class in de.craftsblock.craftsnet.api.requirements

The RequirementRegistry class manages the registration and unregistration of Requirement.

RequirementRegistry(CraftsNet) - Constructor for class de.craftsblock.craftsnet.api.requirements.RequirementRegistry

Constructs a new instance of the RequirementRegistry

requirements() - Method in record class de.craftsblock.craftsnet.api.RouteRegistry.EndpointMapping

Returns the value of the requirements record component.

RequirementStore - Annotation Interface in de.craftsblock.craftsnet.api.requirements.meta

Annotation to mark methods within a requirement annotation for value storage.

RequirementType - Enum Class in de.craftsblock.craftsnet.api.requirements.meta

Represents the different types of requirements that can be defined for annotations.

RequireMessageType - Annotation Interface in de.craftsblock.craftsnet.api.websocket.annotations

Specifies the message type that should be received.

RequireParameter - Annotation Interface in de.craftsblock.craftsnet.api.http.annotations

Annotation to specify required url parameters for methods or types.

reset() - Method in class de.craftsblock.craftsnet.addon.loaders.AddonLoader

Clears all addon paths from the stack.

resetReaderIndex() - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Resets the reader index to the previously marked index.

resetWriterIndex() - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Resets the writer index to the previously marked index.

resolveMiddlewares(Handler, Method) - Method in class de.craftsblock.craftsnet.api.middlewares.MiddlewareRegistry

Retrieves a stack of middlewares from a specific endpoint handler nd its child method.

response() - Method in record class de.craftsblock.craftsnet.api.http.Exchange

Gets the Response object associated with this exchange used for managing the response to the request.

Response - Class in de.craftsblock.craftsnet.api.http

The Response class represents an HTTP response sent by the web server to the client.

Response(CraftsNet, StreamEncoder, HttpExchange, HttpMethod) - Constructor for class de.craftsblock.craftsnet.api.http.Response

Constructor for creating a new Response object.

responseEncodingAllowed() - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Determines whether from the client requested response encoding should be applied or not.

restart() - Method in class de.craftsblock.craftsnet.CraftsNet

Restarts the CraftsNet framework.

restart(Runnable) - Method in class de.craftsblock.craftsnet.CraftsNet

Restarts the CraftsNet framework.

restrictToCallers(Class<?>...) - Static method in class de.craftsblock.craftsnet.utils.reflection.ReflectionUtils

Ensures that the caller's caller is of one of the specified allowed types.

retrieveCookie(String) - Method in class de.craftsblock.craftsnet.api.http.Request

Retrieves the specified cookie from the request.

retrieveCookie(String, Cookie) - Method in class de.craftsblock.craftsnet.api.http.Request

Retrieves the specified cookie from the request or return a fallback cookie if it is not present on this request.

retrieveCraftsNet() - Static method in class de.craftsblock.craftsnet.addon.loaders.CraftsNetClassLoader

Attempts to retrieve the CraftsNet instance associated with the class loader of the calling class.

retrieveCraftsNet(Class<?>) - Static method in class de.craftsblock.craftsnet.addon.loaders.CraftsNetClassLoader

Attempts to retrieve the CraftsNet instance associated with the class loader of the given class.

retrieveEncoder(Class<? extends StreamEncoder>) - Method in class de.craftsblock.craftsnet.api.http.encoding.StreamEncoderRegistry

Retrieves a StreamEncoder by its type.

retrieveEncoder(String) - Method in class de.craftsblock.craftsnet.api.http.encoding.StreamEncoderRegistry

Retrieves a StreamEncoder by its encoding name.

retrieveParam(String) - Method in class de.craftsblock.craftsnet.api.http.Request

Retrieves the value of the specified query parameter from the request.

retrieveParam(String, String) - Method in class de.craftsblock.craftsnet.api.http.Request

Retrieves the value of the specified query parameter from the request or return a fallback value if it is not present on this request.

retrieveRawAnnotation(AnnotatedElement, Class<A>) - Static method in class de.craftsblock.craftsnet.utils.reflection.ReflectionUtils

This method searches for an annotation of the specified type in an object.

retrieveServices(JarFile) - Method in class de.craftsblock.craftsnet.addon.loaders.AddonLoader

Utility method for loading RegistrableService instances from a jar file.

retrieveValueOfAnnotation(AnnotatedElement, Class<A>, Class<T>, boolean) - Static method in class de.craftsblock.craftsnet.utils.reflection.ReflectionUtils

Retrieves the value of a specified annotation attribute from an object.

Route - Annotation Interface in de.craftsblock.craftsnet.api.http.annotations

Specifies the path associated with a service method or defines the parent path.

routeRegistry() - Method in class de.craftsblock.craftsnet.addon.Addon

Deprecated, for removal: This API element is subject to removal in a future version.

Use Addon.getRouteRegistry() instead. This will be removed in the future.

routeRegistry() - Method in class de.craftsblock.craftsnet.CraftsNet

Deprecated, for removal: This API element is subject to removal in a future version.

Use CraftsNet.getRouteRegistry() instead. This will be removed in the future.

RouteRegistry - Class in de.craftsblock.craftsnet.api

The RouteRegistry class manages the registration and unregistration of RequestHandler (routes) and SocketHandler (websockets).

RouteRegistry(CraftsNet) - Constructor for class de.craftsblock.craftsnet.api.RouteRegistry

Constructs a new instance of the RouteRegistry

RouteRegistry.EndpointMapping - Record Class in de.craftsblock.craftsnet.api

Represents the mapping of a registered endpoint handler.

RouteRegistry.Mapping - Interface in de.craftsblock.craftsnet.api

A universal interface for mappings.

RouteRegistry.ShareMapping - Record Class in de.craftsblock.craftsnet.api

The ShareMapping class represents the mapping of a registered shared endpoint.

RouteRequestEvent - Class in de.craftsblock.craftsnet.events.requests.routes

The RouteRequestEvent class represents an event related to a route request.

RouteRequestEvent(Exchange) - Constructor for class de.craftsblock.craftsnet.events.requests.routes.RouteRequestEvent

Constructs a new RouteRequestEvent with the specified Exchange and RouteRegistry.EndpointMapping.

run() - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Runs the WebSocket client to handle incoming messages and manage connections.

running - Variable in class de.craftsblock.craftsnet.api.Server

S

safelyNew(CraftsNet, URL) - Static method in class de.craftsblock.craftsnet.addon.loaders.DependencyClassLoader

Creates a new DependencyClassLoader for a specific URL.

SAME - Enum constant in enum class de.craftsblock.craftsnet.autoregister.meta.Instantiate

Indicates that the same instance of the class should be reused.

SameSite - Enum Class in de.craftsblock.craftsnet.api.http.cookies

Enumeration representing the SameSite attribute of a cookie.

save() - Method in class de.craftsblock.craftsnet.api.session.SessionStorage

Saves the sessions data using the currently set driver.

save(Session, String) - Method in class de.craftsblock.craftsnet.api.session.drivers.builtin.FileSessionDriver

Saves the session data to a file corresponding to the sessions ID.

save(Session, String) - Method in interface de.craftsblock.craftsnet.api.session.drivers.SessionDriver

Persists the provided session data to the underlying storage.

SAVE - Enum constant in enum class de.craftsblock.craftsnet.api.session.SessionStorage.JobType

Indicating a save process.

scheme() - Method in interface de.craftsblock.craftsnet.api.BaseExchange

Gets the Scheme of the exchange.

scheme() - Method in record class de.craftsblock.craftsnet.api.utils.ProtocolVersion

Returns the scheme associated with this protocol version.

Scheme - Enum Class in de.craftsblock.craftsnet.api.utils

Enum representing different schemes (protocols) supported by the system.

SecureEncodingUtils - Class in de.craftsblock.craftsnet.utils

Utility class for secure encoding and decoding of character arrays to byte arrays and vice versa.

secureRandomLength(int, int) - Static method in class de.craftsblock.craftsnet.utils.PassphraseUtils

Generates a secure random passphrase length within a specified range.

secureSession() - Method in class de.craftsblock.craftsnet.api.session.SessionInfo

Performs a quick session check against the session storage to validate that the current session is a real session.

sendingFile() - Method in class de.craftsblock.craftsnet.api.http.Response

Returns whether the response was used to send a file to the client.

sendMessage(byte[]) - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Sends a message to the connected WebSocket client.

sendMessage(Json) - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Sends a message to the connected WebSocket client.

sendMessage(ByteBuffer) - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Sends a message to the connected WebSocket client.

sendMessage(Object) - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Sends a message to the connected WebSocket client.

sendMessage(String) - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Sends a message to the connected WebSocket client.

sendPing() - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Sends a ping to the connected WebSocket client.

sendPing(byte[]) - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Sends a ping with the provided payload to the connected WebSocket client.

sendPing(String) - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Sends a ping with the provided payload to the connected WebSocket client.

sendPong() - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Sends a pong to the connected WebSocket client.

sendPong(byte[]) - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Sends a pong with the provided payload to the connected WebSocket client.

sendPong(String) - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Sends a pong with the provided payload to the connected WebSocket client.

server() - Method in record class de.craftsblock.craftsnet.api.websocket.SocketExchange

Gets the WebSocketServer object associated with this exchange the websocket client connected to.

Server - Class in de.craftsblock.craftsnet.api

Abstract class representing a server in the CraftsNet framework.

Server(CraftsNet, int, boolean) - Constructor for class de.craftsblock.craftsnet.api.Server

Constructs a server with the specified port and SSL configuration.

Server(CraftsNet, int, int, boolean) - Constructor for class de.craftsblock.craftsnet.api.Server

Constructs a server with the specified port, backlog, and SSL configuration.

SERVER_ERROR - Enum constant in enum class de.craftsblock.craftsnet.api.websocket.ClosureCode

Indicates that the server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.

SERVICE_ERROR - Enum constant in enum class de.craftsblock.craftsnet.api.websocket.ClosureCode

Indicates that the service is terminating the connection because it is restarting.

ServiceLoader<T> - Interface in de.craftsblock.craftsnet.addon.services

A simple service loader interface for managing instances of a specified type.

ServiceLoaderAutoRegisterHandler - Class in de.craftsblock.craftsnet.autoregister.builtin.addons

A handler for automatically registering ServiceLoader implementations.

ServiceLoaderAutoRegisterHandler(CraftsNet) - Constructor for class de.craftsblock.craftsnet.autoregister.builtin.addons.ServiceLoaderAutoRegisterHandler

Constructs a new ServiceLoaderAutoRegisterHandler.

serviceManager() - Method in class de.craftsblock.craftsnet.addon.Addon

Deprecated, for removal: This API element is subject to removal in a future version.

Use Addon.getServiceManager() instead. This will be removed in the future.

serviceManager() - Method in class de.craftsblock.craftsnet.CraftsNet

Deprecated, for removal: This API element is subject to removal in a future version.

Use CraftsNet.getServiceManager() instead. This will be removed in the future.

ServiceManager - Class in de.craftsblock.craftsnet.addon.services

The ServiceManager class represents a manager responsible for handling various service loaders in a system.

ServiceManager(CraftsNet) - Constructor for class de.craftsblock.craftsnet.addon.services.ServiceManager

Constructs a new ServiceManager and registers default service loaders.

services() - Method in record class de.craftsblock.craftsnet.addon.meta.AddonConfiguration

Returns the value of the services record component.

session() - Method in record class de.craftsblock.craftsnet.api.http.Exchange

Get the Session object associated with this exchange holding information from the session.

Session - Class in de.craftsblock.craftsnet.api.session

Manages session data, allowing the storage and retrieval of serialized objects within a json file.

Session() - Constructor for class de.craftsblock.craftsnet.api.session.Session

Creates a new instance of Session without an active session.

sessionCache() - Method in class de.craftsblock.craftsnet.CraftsNet

Deprecated, for removal: This API element is subject to removal in a future version.

Use CraftsNet.getSessionCache() ()} instead. This will be removed in the future.

SessionCache - Class in de.craftsblock.craftsnet.api.session

A specialized cache for managing Session objects, allowing efficient storage and retrieval of session instances using unique string keys.

SessionCache(int) - Constructor for class de.craftsblock.craftsnet.api.session.SessionCache

Constructs a new SessionCache with a specified maximum capacity.

SessionDriver - Interface in de.craftsblock.craftsnet.api.session.drivers

Interface representing a driver responsible for session persistence operations.

SessionInfo - Class in de.craftsblock.craftsnet.api.session

Manages session metadata and handles the persistence and lifecycle of sessions.

SessionInfo(Session) - Constructor for class de.craftsblock.craftsnet.api.session.SessionInfo

Creates a new SessionInfo instance associated with the specified session.

SessionStorage - Class in de.craftsblock.craftsnet.api.session

Handles the persistence of session data by providing functionality for loading, saving, and destroying session files.

SessionStorage(Session) - Constructor for class de.craftsblock.craftsnet.api.session.SessionStorage

Constructs a new SessionStorage instance for managing the specified session.

SessionStorage.JobType - Enum Class in de.craftsblock.craftsnet.api.session

Indicating the type of job the SessionStorage is performing.

setArg(String, String) - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Applies a single argument and its value to the builder.

setCancelled(boolean) - Method in class de.craftsblock.craftsnet.api.middlewares.MiddlewareCallbackInfo

Sets the cancelled flag for the callback, indicating whether the callback is cancelled or not.

setCancelReason(String) - Method in class de.craftsblock.craftsnet.api.middlewares.MiddlewareCallbackInfo

Sets a custom cancel reason which is printed to the console

setCancelReason(String) - Method in class de.craftsblock.craftsnet.events.EventWithCancelReason

Sets a custom cancel reason which is printed to the console

setCode(int) - Method in class de.craftsblock.craftsnet.api.http.Response

Sets the HTTP status code for the response.

setCompressWhenHigher(int) - Static method in class de.craftsblock.craftsnet.api.websocket.extensions.builtin.PerMessageDeflateExtension

Sets the threshold for compression.

setContentType(String) - Method in class de.craftsblock.craftsnet.api.http.Response

Sets the content type for the response.

setContentType(String) - Method in class de.craftsblock.craftsnet.events.requests.shares.ShareFileLoadedEvent

Forces the sending of a specific content type.

setContentType(String, String) - Method in class de.craftsblock.craftsnet.api.http.Response

Sets the content type for the response or use the fallback value if the contentType is null.

setControlMaxAge(int) - Method in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Sets the maximum age (in seconds) for how long the results of a preflight request can be cached by the client.

setCookie(String) - Method in class de.craftsblock.craftsnet.api.http.Response

Sets a cookie with the specified name and no value.

setCookie(String, Object) - Method in class de.craftsblock.craftsnet.api.http.Response

Sets a cookie with the specified name and value.

setCookie(Cookie) - Method in class de.craftsblock.craftsnet.api.http.Response

Adds a cookie to the response, overriding any existing cookie with the same name.

setCorsPolicy(CorsPolicy) - Method in class de.craftsblock.craftsnet.api.http.Response

Updates the cors policy added to the header of the response.

setData(byte[]) - Method in class de.craftsblock.craftsnet.api.websocket.Frame

Sets the payload data for this frame.

setData(byte[]) - Method in class de.craftsblock.craftsnet.events.sockets.message.OutgoingSocketMessageEvent

Sets the outgoing message data for the event.

setDefaultDriver(SessionDriver) - Static method in class de.craftsblock.craftsnet.api.session.SessionStorage

Changes the default SessionDriver that will be used when creating sessions.

setDeflateFlush(int) - Static method in class de.craftsblock.craftsnet.api.websocket.extensions.builtin.PerMessageDeflateExtension

Sets the deflate flush mode.

setDeflateLevel(int) - Static method in class de.craftsblock.craftsnet.api.websocket.extensions.builtin.PerMessageDeflateExtension

Sets the deflate compression level.

setDeflateStrategy(int) - Static method in class de.craftsblock.craftsnet.api.websocket.extensions.builtin.PerMessageDeflateExtension

Sets the deflate compression strategy.

setDomain(String) - Method in class de.craftsblock.craftsnet.api.http.cookies.Cookie

Sets the domain of the cookie.

setExchange(BaseExchange) - Method in class de.craftsblock.craftsnet.api.session.Session

Sets the BaseExchange instance for this session storage.

setExchange(Exchange) - Method in class de.craftsblock.craftsnet.api.http.Request

Sets the Exchange managing this request.

setExchange(Exchange) - Method in class de.craftsblock.craftsnet.api.http.Response

Sets the Exchange managing this response.

setExecutor(CommandExecutor) - Method in class de.craftsblock.craftsnet.command.Command

Sets the executor for this command.

setExpiresAt(String) - Method in class de.craftsblock.craftsnet.api.http.cookies.Cookie

Sets the expiry date of the cookie using a string representation.

setExpiresAt(OffsetDateTime) - Method in class de.craftsblock.craftsnet.api.http.cookies.Cookie

Sets the expiry date of the cookie using a TemporalAccessor.

setField(String, Object, Object) - Static method in class de.craftsblock.craftsnet.utils.reflection.ReflectionUtils

Sets a field in the given object using reflection.

setFile(File) - Method in class de.craftsblock.craftsnet.events.requests.shares.ShareFileLoadedEvent

Sets the loaded file associated with this event.

setFilePath(String) - Method in class de.craftsblock.craftsnet.events.requests.shares.ShareRequestEvent

Sets the relativ path on the file system associated with the share request.

setFlag(String, String) - Method in class de.craftsblock.craftsnet.api.http.cookies.Cookie

Sets a specified attribute of the cookie based on the flag provided.

setFragmentationEnabled(boolean) - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Enable or disable fragmentation of messages send by the server.

setFragmentationEnabled(boolean) - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketServer

Enable or disable fragmentation of messages send by the server.

setFragmentSize(int) - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Sets the maximum size of each fragment of a frame.

setFragmentSize(int) - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketServer

Sets the maximum size of each fragment of a frame.

setFrame(Frame) - Method in class de.craftsblock.craftsnet.events.sockets.message.OutgoingSocketMessageEvent

Sets the outgoing message frame.

setHeader(String, String) - Method in class de.craftsblock.craftsnet.api.http.Response

Sets a response header with the specified key and value.

setHeader(String, String) - Method in class de.craftsblock.craftsnet.events.requests.shares.ShareRequestEvent

Deprecated, for removal: This API element is subject to removal in a future version.

Use Response.setHeader(String, String) instead.

setHttpOnly(boolean) - Method in class de.craftsblock.craftsnet.api.http.cookies.Cookie

Sets whether the cookie is HttpOnly.

setMasked(boolean) - Method in class de.craftsblock.craftsnet.api.websocket.Frame

Sets whether the frame should be masked when sent to the client.

setMaskingOutgoing(boolean) - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Sets whether the outgoing message should be masked or not.

setMaxAge(long) - Method in class de.craftsblock.craftsnet.api.http.cookies.Cookie

Sets the maximum age of this cookie.

setMaxDataLength(int) - Static method in class de.craftsblock.craftsnet.api.websocket.extensions.builtin.PerMessageDeflateExtension

Sets the maximum allowed data length for decompressed data.

setOpcode(Opcode) - Method in class de.craftsblock.craftsnet.api.websocket.Frame

Sets the Opcode for the frame.

setOpcode(Opcode) - Method in class de.craftsblock.craftsnet.events.sockets.message.OutgoingSocketMessageEvent

Sets the opcode used to send the data.

setPath(Path) - Method in class de.craftsblock.craftsnet.events.requests.shares.ShareFileLoadedEvent

Sets the loaded file path associated with this event.

setPath(String) - Method in class de.craftsblock.craftsnet.api.http.cookies.Cookie

Sets the path of the cookie.

setReferenceCookie(Cookie) - Static method in class de.craftsblock.craftsnet.api.session.SessionInfo

Setting the reference cookie whose parameters are used when session cookies are created or deleted.

setRoutes(Collection<RouteRegistry.EndpointMapping>) - Method in class de.craftsblock.craftsnet.api.http.Request

Sets the matched routes mapping for the request.

setSameSite(SameSite) - Method in class de.craftsblock.craftsnet.api.http.cookies.Cookie

Sets the SameSite policy of the cookie.

setSameSite(String) - Method in class de.craftsblock.craftsnet.api.http.cookies.Cookie

Sets the SameSite policy of the cookie using a string representation.

setSecure(boolean) - Method in class de.craftsblock.craftsnet.api.http.cookies.Cookie

Sets whether the cookie is secure.

setStreamEncoder(StreamEncoder) - Method in class de.craftsblock.craftsnet.api.http.Response

Sets the StreamEncoder that is used to encode the response body.

setStreamEncoder(String) - Method in class de.craftsblock.craftsnet.api.http.Response

Sets the StreamEncoder by its name that is used to encode the response body.

setValidator(Pattern) - Method in class de.craftsblock.craftsnet.api.transformers.TransformerPerformer

Updates the validator which is used to load the group names from.

setValue(Object) - Method in class de.craftsblock.craftsnet.api.http.cookies.Cookie

Sets the value of the cookie.

Shadow - Annotation Interface in de.craftsblock.craftsnet.addon.meta.annotations

Indicates that the annotated Addon requires a dependency or repository.

ShadowCollection - Annotation Interface in de.craftsblock.craftsnet.addon.meta.annotations

Container annotation for grouping multiple Shadow annotations.

ShadowType - Enum Class in de.craftsblock.craftsnet.addon.meta

Enum representing the types of resources in an addon context.

share(String, File) - Method in class de.craftsblock.craftsnet.api.RouteRegistry

Shares a folder for a specified path.

share(String, File, boolean) - Method in class de.craftsblock.craftsnet.api.RouteRegistry

Shares a folder for a specified path.

share(String, Path) - Method in class de.craftsblock.craftsnet.api.RouteRegistry

Shares a folder for a specified path.

share(String, Path, boolean) - Method in class de.craftsblock.craftsnet.api.RouteRegistry

Shares a folder for a specified path.

ShareFileLoadedEvent - Class in de.craftsblock.craftsnet.events.requests.shares

Represents an event that is triggered when a share file has been loaded.

ShareFileLoadedEvent(Exchange, Path) - Constructor for class de.craftsblock.craftsnet.events.requests.shares.ShareFileLoadedEvent

Creates a new ShareFileLoadedEvent with the specified loaded file.

ShareMapping(String, boolean) - Constructor for record class de.craftsblock.craftsnet.api.RouteRegistry.ShareMapping

Creates an instance of a ShareMapping record class.

ShareRequestEvent - Class in de.craftsblock.craftsnet.events.requests.shares

Represents an event that is triggered when a share request is made.

ShareRequestEvent(String, String, Exchange, RouteRegistry.ShareMapping) - Constructor for class de.craftsblock.craftsnet.events.requests.shares.ShareRequestEvent

Creates a new ShareRequestEvent with the specified path.

ShortTransformer - Class in de.craftsblock.craftsnet.api.transformers.builtin

A transformer class for converting a string representation of a short value to a Short object.

ShortTransformer() - Constructor for class de.craftsblock.craftsnet.api.transformers.builtin.ShortTransformer

shouldFragment() - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Returns whether fragmentation is enabled or not.

shouldFragment() - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketServer

Returns whether fragmentation is enabled or not.

shouldHideIps() - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Checks if ips should be hidden in the log output.

shouldMaskOutgoing() - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Returns whether the outgoing messages should be masked or not.

shouldPlaceTempFilesOnNormalFileSystem() - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Determines whether temporary files should be placed in the normal file system.

shouldSkipDefaultRoute() - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Determines whether the registration of the default route (if no other route was registered) should be skipped on startup.

shouldSkipVersionCheck() - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Determines whether the version check should be skipped on startup.

shouldUseSSL() - Method in class de.craftsblock.craftsnet.api.http.WebServer

Checks if SSL should be enabled for the server.

shouldUseSSL() - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketServer

Checks if SSL should be enabled for the server.

shouldUseSSL(boolean) - Method in class de.craftsblock.craftsnet.api.Server

Sets whether SSL should be used for the server.

ShutdownCommand - Class in de.craftsblock.craftsnet.command.commands

The ShutdownCommand class implements the CommandExecutor interface and defines the behavior of the "shutdown" command.

ShutdownCommand(CraftsNet) - Constructor for class de.craftsblock.craftsnet.command.commands.ShutdownCommand

Constructs a new instance shutdown command.

SID_COOKIE_NAME - Static variable in class de.craftsblock.craftsnet.api.session.SessionInfo

The name of the cookie used to store session identifiers.

size() - Method in record class de.craftsblock.craftsnet.api.http.body.bodies.MultipartFormBody.MultipartData

Gets the number of items in the multipart data for the field.

size() - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Returns the size of the buffer.

SKIP_PACKAGES - Static variable in class de.craftsblock.craftsnet.autoregister.loaders.AutoRegisterLoader

List of package names to skip when processing class files in the JAR.

skipNext() - Method in class de.craftsblock.craftsnet.logging.mutate.LogStream

Skips the next input on the System.out stream, if it is a file log stream.

skipNext(int) - Method in class de.craftsblock.craftsnet.logging.mutate.LogStream

Skips the next n inputs on the System.out stream, if it is a file log stream.

sleepIfNotNeeded() - Method in class de.craftsblock.craftsnet.api.http.WebServer

Puts the server to sleep if it is not needed.

sleepIfNotNeeded() - Method in class de.craftsblock.craftsnet.api.Server

Puts the server to sleep if it is not needed.

sleepIfNotNeeded() - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketServer

Puts the server to sleep if it is not needed.

Socket - Annotation Interface in de.craftsblock.craftsnet.api.websocket.annotations

Custom annotation used to mark classes as WebSocket handlers.

SocketExchange - Record Class in de.craftsblock.craftsnet.api.websocket

The SocketExchange record represents an exchange object that provides a way to interact with the WebSocket server and client within the context of a WebSocket connection.

SocketExchange(ProtocolVersion, WebSocketServer, WebSocketClient) - Constructor for record class de.craftsblock.craftsnet.api.websocket.SocketExchange

Creates an instance of a SocketExchange record class.

SocketHandler - Interface in de.craftsblock.craftsnet.api.websocket

Represents a contract for classes that handle WebSocket connections in a server application.

SocketHandlerLoader - Class in de.craftsblock.craftsnet.addon.services.builtin.handlers

A concrete implementation of the ServiceLoader interface for managing instances of SocketHandler.

SocketHandlerLoader(CraftsNet) - Constructor for class de.craftsblock.craftsnet.addon.services.builtin.handlers.SocketHandlerLoader

Creates a new instance of SocketHandlerLoader.

soft() - Element in annotation interface de.craftsblock.craftsnet.addon.meta.annotations.Depends

Specifies whether this dependency should be treated as optional or not.

softDepends() - Method in record class de.craftsblock.craftsnet.addon.meta.AddonMeta

Returns the value of the softDepends record component.

SPECIAL_CHARS - Static variable in class de.craftsblock.craftsnet.utils.PassphraseUtils

The special chars used to created passphrases when special chars are required.

SPECIFIED_CODES - Static variable in enum class de.craftsblock.craftsnet.api.websocket.ClosureCode

List of all closure codes that are specified in RFC 6455.

spi() - Method in record class de.craftsblock.craftsnet.addon.meta.RegisteredService

Returns the value of the spi record component.

SQLDriverLoader - Class in de.craftsblock.craftsnet.addon.services.builtin

A concrete implementation of the ServiceLoader interface for managing instances of Driver.

SQLDriverLoader() - Constructor for class de.craftsblock.craftsnet.addon.services.builtin.SQLDriverLoader

ssl - Variable in class de.craftsblock.craftsnet.api.Server

SSL - Class in de.craftsblock.craftsnet.api.ssl

The SSL class encapsulates a collection of utility methods aimed at facilitating SSL/TLS functionality within an application.

SSL() - Constructor for class de.craftsblock.craftsnet.api.ssl.SSL

StandardFormBody - Class in de.craftsblock.craftsnet.api.http.body.bodies

The StandardFormBody class represents an HTTP request body that contains form data encoded in the standard application/x-www-form-urlencoded format.

StandardFormBody(Request, InputStream) - Constructor for class de.craftsblock.craftsnet.api.http.body.bodies.StandardFormBody

Constructs a new StandardFormBody by reading and parsing form data from an input stream.

StandardFormBodyParser - Class in de.craftsblock.craftsnet.api.http.body.parser

This class is a body parser specifically designed to parse standard form request bodies.

StandardFormBodyParser() - Constructor for class de.craftsblock.craftsnet.api.http.body.parser.StandardFormBodyParser

Constructs a new StandardFormBodyParser object with the content type set to "application/x-www-form-urlencoded".

start() - Method in class de.craftsblock.craftsnet.api.http.WebServer

Starts the server.

start() - Method in class de.craftsblock.craftsnet.api.Server

Starts the server.

start() - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketServer

Starts the server.

start() - Method in class de.craftsblock.craftsnet.logging.mutate.LogStream

Starts logging to files.

start(CraftsNetBuilder) - Method in class de.craftsblock.craftsnet.CraftsNet

Starts the CraftsNet framework with the provided builder configuration.

startSession() - Method in class de.craftsblock.craftsnet.api.session.Session

Starts a new session and generates a session identifier.

startup() - Method in class de.craftsblock.craftsnet.addon.AddonManager

Performs the startup of the addon system and loads all present addon configurations.

startup() - Element in annotation interface de.craftsblock.craftsnet.autoregister.meta.AutoRegister

The Startup value that determines when the auto registration should be performed.

Startup - Enum Class in de.craftsblock.craftsnet.addon.meta

Enum representing the different stages of the loading process of addons.

stop() - Method in class de.craftsblock.craftsnet.addon.AddonManager

Method to stop the AddonManager.

stop() - Method in class de.craftsblock.craftsnet.addon.artifacts.ArtifactLoader

Cleanup and shutdown of the internal repository resolver

stop() - Method in class de.craftsblock.craftsnet.api.http.WebServer

Stops the server.

stop() - Method in class de.craftsblock.craftsnet.api.Server

Stops the server.

stop() - Method in class de.craftsblock.craftsnet.api.websocket.WebSocketServer

Stops the server.

stop() - Method in class de.craftsblock.craftsnet.CraftsNet

Stops the CraftsNet framework.

stop() - Method in class de.craftsblock.craftsnet.logging.mutate.LogStream

Stops the logging to files

stopSession() - Method in class de.craftsblock.craftsnet.api.session.Session

Stops the current session and deletes the associated session file.

STORAGE_EXTENSION - Static variable in class de.craftsblock.craftsnet.api.session.drivers.builtin.FileSessionDriver

The file extension used for session files.

STORAGE_LOCATION - Static variable in class de.craftsblock.craftsnet.api.session.drivers.builtin.FileSessionDriver

The default directory where session files are stored.

STORING - Enum constant in enum class de.craftsblock.craftsnet.api.requirements.meta.RequirementType

A requirement type indicating that the annotation holds specific data that must be extracted and stored.

StreamEncoder - Class in de.craftsblock.craftsnet.api.http.encoding

Abstract class representing a stream encoder, which can be used to encode and decode input and output streams.

StreamEncoder(String) - Constructor for class de.craftsblock.craftsnet.api.http.encoding.StreamEncoder

Constructs a new StreamEncoder with the specified encoding name.

StreamEncoderAutoRegisterHandler - Class in de.craftsblock.craftsnet.autoregister.builtin.http

A handler for automatically registering StreamEncoder implementations.

StreamEncoderAutoRegisterHandler(CraftsNet) - Constructor for class de.craftsblock.craftsnet.autoregister.builtin.http.StreamEncoderAutoRegisterHandler

Constructs a new StreamEncoderAutoRegisterHandler.

streamEncoderRegistry() - Method in class de.craftsblock.craftsnet.addon.Addon

Deprecated, for removal: This API element is subject to removal in a future version.

Use Addon.getStreamEncoderRegistry() instead. This will be removed in the future.

streamEncoderRegistry() - Method in class de.craftsblock.craftsnet.CraftsNet

Deprecated, for removal: This API element is subject to removal in a future version.

Use CraftsNet.getStreamEncoderRegistry() ()} instead. This will be removed in the future.

StreamEncoderRegistry - Class in de.craftsblock.craftsnet.api.http.encoding

A registry for managing and retrieving StreamEncoder instances.

StreamEncoderRegistry() - Constructor for class de.craftsblock.craftsnet.api.http.encoding.StreamEncoderRegistry

Constructs a new StreamEncoderRegistry and registers the built-in stream encoders.

STRICT - Enum constant in enum class de.craftsblock.craftsnet.api.http.cookies.SameSite

The "Strict" value ensures that the cookie is sent only in a first-party context (same-site requests).

StringBody - Class in de.craftsblock.craftsnet.api.http.body.bodies.typed

The StringBody class represents an http request body which contains String data.

StringBody(Request, String) - Constructor for class de.craftsblock.craftsnet.api.http.body.bodies.typed.StringBody

Constructs a new instance of a TypedBody.

StringBodyParser - Class in de.craftsblock.craftsnet.api.http.body.parser.typed

This class is a body parser specifically designed to parse StringBody request bodies.

StringBodyParser() - Constructor for class de.craftsblock.craftsnet.api.http.body.parser.typed.StringBodyParser

Constructs a new StringBodyParser.

stringify(byte[]) - Static method in class de.craftsblock.craftsnet.utils.PassphraseUtils

Converts the given UTF-8 encoded byte array into a String.

suitable(String, String) - Static method in class de.craftsblock.craftsnet.utils.versions.Versions

Determines whether the given current version is suitable in comparison to the expected version.

T

TEXT - Enum constant in enum class de.craftsblock.craftsnet.api.websocket.Opcode

Indicates a text frame.

TLS_HANDSHAKE_FAIL - Enum constant in enum class de.craftsblock.craftsnet.api.websocket.ClosureCode

Indicates that the connection was closed due to a failure to perform a TLS handshake.

TOO_LARGE - Enum constant in enum class de.craftsblock.craftsnet.api.websocket.ClosureCode

Indicates that the message received was too large for the endpoint to process.

toPrimitive(Class<?>) - Static method in class de.craftsblock.craftsnet.utils.reflection.TypeUtils

Converts the given type to its corresponding primitive class if it is a wrapper type.

toString() - Method in record class de.craftsblock.craftsnet.addon.meta.AddonConfiguration

Returns a string representation of this record class.

toString() - Method in record class de.craftsblock.craftsnet.addon.meta.AddonMeta

Returns a string representation of this record class.

toString() - Method in record class de.craftsblock.craftsnet.addon.meta.RegisteredService

Returns a string representation of this record class.

toString() - Method in record class de.craftsblock.craftsnet.api.http.body.bodies.MultipartFormBody.MultipartData

Returns a string representation of this record class.

toString() - Method in record class de.craftsblock.craftsnet.api.http.body.bodies.MultipartFormBody.MultipartItem

Returns a string representation of this record class.

toString() - Method in class de.craftsblock.craftsnet.api.http.cookies.Cookie

Returns a string representation of the cookie.

toString() - Method in record class de.craftsblock.craftsnet.api.http.Exchange

Returns a string representation of this record class.

toString() - Method in enum class de.craftsblock.craftsnet.api.http.HttpMethod

Get the string representation of the enum value.

toString() - Method in record class de.craftsblock.craftsnet.api.requirements.meta.RequirementInfo

Returns a string representation of this record class.

toString() - Method in record class de.craftsblock.craftsnet.api.RouteRegistry.EndpointMapping

Returns a string representation of this record class.

toString() - Method in record class de.craftsblock.craftsnet.api.RouteRegistry.ShareMapping

Returns a string representation of this record class.

toString() - Method in record class de.craftsblock.craftsnet.api.utils.ProtocolVersion

Returns a string representation of this record class.

toString() - Method in record class de.craftsblock.craftsnet.api.websocket.SocketExchange

Returns a string representation of this record class.

toString() - Method in record class de.craftsblock.craftsnet.logging.impl.NoOpLogger

Returns a string representation of this record class.

toString() - Method in record class de.craftsblock.craftsnet.logging.impl.PlainLogger

Returns a string representation of this record class.

toWrapper(Class<?>) - Static method in class de.craftsblock.craftsnet.utils.reflection.TypeUtils

Converts the given type to its corresponding wrapper class if it is a primitive type.

TRACE - Enum constant in enum class de.craftsblock.craftsnet.api.http.HttpMethod

Represents the TRACE request method

transform(String) - Method in class de.craftsblock.craftsnet.api.transformers.builtin.BooleanTransformer

Transforms the provided string parameter into a Boolean object.

transform(String) - Method in class de.craftsblock.craftsnet.api.transformers.builtin.ByteTransformer

Transforms the provided string parameter into a Byte object.

transform(String) - Method in class de.craftsblock.craftsnet.api.transformers.builtin.DoubleTransformer

Transforms the provided string parameter into a Double object.

transform(String) - Method in class de.craftsblock.craftsnet.api.transformers.builtin.FloatTransformer

Transforms the provided string parameter into a Float object.

transform(String) - Method in class de.craftsblock.craftsnet.api.transformers.builtin.IntTransformer

Transforms the provided string parameter into an Integer object.

transform(String) - Method in class de.craftsblock.craftsnet.api.transformers.builtin.LongTransformer

Transforms the provided string parameter into a Long object.

transform(String) - Method in class de.craftsblock.craftsnet.api.transformers.builtin.ShortTransformer

Transforms the provided string parameter into a Short object.

transform(T) - Method in interface de.craftsblock.craftsnet.api.transformers.Transformable

Transforms the provided parameter into a specific type.

Transformable<R,T> - Interface in de.craftsblock.craftsnet.api.transformers

Interface representing a transformation operation.

transformer() - Element in annotation interface de.craftsblock.craftsnet.api.transformers.annotations.Transformer

Specifies the class of the transformer that performs the transformation.

Transformer - Annotation Interface in de.craftsblock.craftsnet.api.transformers.annotations

Annotation to mark methods or types that provide transformation functionality.

TransformerCollection - Annotation Interface in de.craftsblock.craftsnet.api.transformers.annotations

Annotation to mark a collection of transformer annotations.

TransformerErrorCallback - Interface in de.craftsblock.craftsnet.api.transformers

The TransformerErrorCallback interface defines a contract for handling transformer errors within the CraftsNet API.

TransformerException - Exception in de.craftsblock.craftsnet.api.transformers.exceptions

This class represents an exception that occurs during data transformation operations.

TransformerException(String) - Constructor for exception de.craftsblock.craftsnet.api.transformers.exceptions.TransformerException

Constructs a new TransformerException with the specified detail message.

TransformerPerformer - Class in de.craftsblock.craftsnet.api.transformers

The TransformerPerformer class is responsible for performing transformations on method arguments based on provided annotations.

TransformerPerformer(CraftsNet, Pattern, int) - Constructor for class de.craftsblock.craftsnet.api.transformers.TransformerPerformer

Constructor for TransformerPerformer.

TransformerPerformer(CraftsNet, Pattern, int, TransformerErrorCallback) - Constructor for class de.craftsblock.craftsnet.api.transformers.TransformerPerformer

Constructor for TransformerPerformer.

TRY_AGAIN_LATER - Enum constant in enum class de.craftsblock.craftsnet.api.websocket.ClosureCode

Indicates that the service is terminating the connection because it encountered an error during the transmission of the response.

type() - Element in annotation interface de.craftsblock.craftsnet.addon.meta.annotations.Shadow

Specifies the type of the shadow dependency.

type() - Element in annotation interface de.craftsblock.craftsnet.api.requirements.meta.RequirementMeta

Defines the type of requirement.

TypeCodecRegistry<C extends Codec<?,?>,P extends CodecPair<?,?>> - Class in de.craftsblock.craftsnet.api.codec.registry

A base registry class for managing codecs that handle conversion between types.

TypedBody<T> - Class in de.craftsblock.craftsnet.api.http.body.bodies.typed

The TypedBody class represents an http request body containing specific typed data.

TypedBody(Request, T) - Constructor for class de.craftsblock.craftsnet.api.http.body.bodies.typed.TypedBody

Constructs a new instance of a TypedBody.

TypedBodyParser<T extends TypedBody<?>> - Class in de.craftsblock.craftsnet.api.http.body.parser.typed

This class is a body parser specifically designed to parse TypedBody request bodies.

TypedBodyParser(BiFunction<Request, InputStream, T>) - Constructor for class de.craftsblock.craftsnet.api.http.body.parser.typed.TypedBodyParser

Constructs a new TypedBodyParser.

TypedBodyParser(BiFunction<Request, InputStream, T>, String, String...) - Constructor for class de.craftsblock.craftsnet.api.http.body.parser.typed.TypedBodyParser

Constructs a new TypedBodyParser with the given content types.

TypeDecoderRegistry<D extends Decoder<?,?>> - Class in de.craftsblock.craftsnet.api.codec.registry

A concrete implementation of TypeCodecRegistry for managing Decoder instances.

TypeDecoderRegistry() - Constructor for class de.craftsblock.craftsnet.api.codec.registry.TypeDecoderRegistry

Constructs a new TypeDecoderRegistry instance.

TypeEncoderRegistry<E extends Encoder<?,?>> - Class in de.craftsblock.craftsnet.api.codec.registry

A specialized implementation of TypeCodecRegistry for managing Encoder instances.

TypeEncoderRegistry() - Constructor for class de.craftsblock.craftsnet.api.codec.registry.TypeEncoderRegistry

Constructs a new TypeEncoderRegistry instance.

TypeUtils - Class in de.craftsblock.craftsnet.utils.reflection

Utility class for handling Java primitive types and their wrapper classes.

U

UNKNOWN - Enum constant in enum class de.craftsblock.craftsnet.api.http.HttpMethod

Represents an unrecognized request method

UNKNOWN - Enum constant in enum class de.craftsblock.craftsnet.api.websocket.Opcode

Indicates that an opcode is unknown.

UnknownSchemeException - Exception in de.craftsblock.craftsnet.api.exceptions

Exception thrown when an unknown or unsupported scheme is encountered.

UnknownSchemeException(Scheme) - Constructor for exception de.craftsblock.craftsnet.api.exceptions.UnknownSchemeException

Constructs a new UnknownSchemeException with a message derived from the provided scheme.

UnknownSchemeException(String) - Constructor for exception de.craftsblock.craftsnet.api.exceptions.UnknownSchemeException

Constructs a new UnknownSchemeException with the specified detail message.

unregister(Addon) - Method in class de.craftsblock.craftsnet.addon.AddonManager

Unregisters an addon from the AddonManager.

unregister(StreamEncoder) - Method in class de.craftsblock.craftsnet.api.http.encoding.StreamEncoderRegistry

Unregisters the given StreamEncoder.

unregister(String) - Method in class de.craftsblock.craftsnet.api.http.encoding.StreamEncoderRegistry

Unregisters the StreamEncoder associated with the given encoding name.

unregister(C) - Method in class de.craftsblock.craftsnet.api.codec.registry.TypeCodecRegistry

Unregisters the given codec from the registry.

unregister(ServiceLoader<T>) - Method in class de.craftsblock.craftsnet.addon.services.ServiceManager

Unregisters a service loader from the ServiceManager.

unregister(Handler) - Method in class de.craftsblock.craftsnet.api.RouteRegistry

Unregisters an endpoint handler (route or websocket) from the registry.

unregister(Middleware) - Method in class de.craftsblock.craftsnet.api.middlewares.MiddlewareRegistry

Unregisters a middleware that should no longer be applied globally.

unregister(WebSocketExtension) - Method in class de.craftsblock.craftsnet.api.websocket.extensions.WebSocketExtensionRegistry

Unregisters a WebSocket extension by its instance.

unregister(AutoRegisterHandler<T>) - Method in class de.craftsblock.craftsnet.autoregister.AutoRegisterRegistry

Unregisters the specified AutoRegisterHandler.

unregister(CraftsNet) - Static method in class de.craftsblock.craftsnet.api.websocket.DefaultPingResponder

Unregisters the DefaultPingResponder from the specified CraftsNet instance.

unregister(Class<T>) - Method in class de.craftsblock.craftsnet.autoregister.AutoRegisterRegistry

Unregisters an AutoRegisterHandler by its type.

unregister(String) - Method in class de.craftsblock.craftsnet.api.websocket.extensions.WebSocketExtensionRegistry

Unregisters a WebSocket extension by its protocol name.

unregisterLogStreamMutator(LogStreamMutator) - Method in class de.craftsblock.craftsnet.logging.mutate.LogStream

Unregisters a previously registered LogStreamMutator.

unsafe() - Method in class de.craftsblock.craftsnet.api.http.Request

Retrieves the HttpExchange object representing the incoming HTTP request.

unsafe() - Method in class de.craftsblock.craftsnet.api.http.Response

Retrieves the underlying HttpExchange object associated with this Response.

UNSUPPORTED - Enum constant in enum class de.craftsblock.craftsnet.api.websocket.ClosureCode

Indicates that the received message type is unsupported or not expected.

UNSUPPORTED_PAYLOAD - Enum constant in enum class de.craftsblock.craftsnet.api.websocket.ClosureCode

Indicates that the endpoint received a message with a payload that it cannot accept.

update(CorsPolicy) - Method in class de.craftsblock.craftsnet.api.http.cors.CorsPolicy

Updates the current CORS policy by copying the settings from another policy.

update(String) - Method in class de.craftsblock.craftsnet.addon.loaders.AddonLoader

Adds a new addon file to the loader using the file name.

update(Path) - Method in class de.craftsblock.craftsnet.addon.loaders.AddonLoader

Adds a new addon to the loader using the path to the file.

Utils - Class in de.craftsblock.craftsnet.utils

This utility class provides helper methods for general operations.

V

validateContentType() - Method in record class de.craftsblock.craftsnet.api.http.body.bodies.MultipartFormBody.MultipartItem

Validates the content type of the multipart item by comparing it to the actual data.

validator() - Method in record class de.craftsblock.craftsnet.api.RouteRegistry.EndpointMapping

Returns the value of the validator record component.

value() - Element in annotation interface de.craftsblock.craftsnet.addon.meta.annotations.Depends

Specifies the class of the required addon.

value() - Element in annotation interface de.craftsblock.craftsnet.addon.meta.annotations.DependsCollection

An array of Depends annotations.

value() - Element in annotation interface de.craftsblock.craftsnet.addon.meta.annotations.Shadow

Specifies the dependency or repository.

value() - Element in annotation interface de.craftsblock.craftsnet.addon.meta.annotations.ShadowCollection

An array of Shadow annotations.

value() - Element in annotation interface de.craftsblock.craftsnet.api.annotations.Domain

Defines the domain associated with the annotated method or class.

value() - Element in annotation interface de.craftsblock.craftsnet.api.annotations.ProcessPriority

Specifies the priority level for the annotated method.

value() - Element in annotation interface de.craftsblock.craftsnet.api.http.annotations.RequestMethod

Defines the HTTP request methods that are supported.

value() - Element in annotation interface de.craftsblock.craftsnet.api.http.annotations.RequireBody

The classes representing the types of bodies that are required for the annotated method or class.

value() - Element in annotation interface de.craftsblock.craftsnet.api.http.annotations.RequireContentType

Specifies the required content types.

value() - Element in annotation interface de.craftsblock.craftsnet.api.http.annotations.RequireCookie

Specifies the required cookies.

value() - Element in annotation interface de.craftsblock.craftsnet.api.http.annotations.RequireHeaders

Specifies the required HTTP headers.

value() - Element in annotation interface de.craftsblock.craftsnet.api.http.annotations.RequireParameter

Specifies the required url parameter.

value() - Element in annotation interface de.craftsblock.craftsnet.api.http.annotations.Route

Defines the path associated with the annotated method or class.

value() - Element in annotation interface de.craftsblock.craftsnet.api.middlewares.annotation.ApplyMiddleware.List

Specifies an array of ApplyMiddleware annotations.

value() - Element in annotation interface de.craftsblock.craftsnet.api.middlewares.annotation.ApplyMiddleware

Gets the type of the Middleware that should be applied before running the endpoint.

value() - Element in annotation interface de.craftsblock.craftsnet.api.transformers.annotations.TransformerCollection

Specifies an array of Transformer annotations.

value() - Element in annotation interface de.craftsblock.craftsnet.api.websocket.annotations.ApplyDecoder

The WebSocketSafeTypeDecoder class used to decode the second parameter.

value() - Element in annotation interface de.craftsblock.craftsnet.api.websocket.annotations.RequireMessageType

Defines the message types associated with the annotated method or class.

value() - Element in annotation interface de.craftsblock.craftsnet.api.websocket.annotations.Socket

Specifies the WebSocket path to which this handler is associated.

valueOf(String) - Static method in enum class de.craftsblock.craftsnet.addon.meta.ShadowType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class de.craftsblock.craftsnet.addon.meta.Startup

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class de.craftsblock.craftsnet.api.annotations.ProcessPriority.Priority

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class de.craftsblock.craftsnet.api.http.cookies.SameSite

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class de.craftsblock.craftsnet.api.http.HttpMethod

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class de.craftsblock.craftsnet.api.requirements.meta.RequirementType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class de.craftsblock.craftsnet.api.session.SessionStorage.JobType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class de.craftsblock.craftsnet.api.utils.Scheme

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class de.craftsblock.craftsnet.api.websocket.ClosureCode

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class de.craftsblock.craftsnet.api.websocket.Opcode

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class de.craftsblock.craftsnet.autoregister.meta.constructors.ConstructorType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class de.craftsblock.craftsnet.autoregister.meta.Instantiate

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class de.craftsblock.craftsnet.builder.ActivateType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class de.craftsblock.craftsnet.logging.LogLevel

Returns the enum constant of this class with the specified name.

values() - Static method in enum class de.craftsblock.craftsnet.addon.meta.ShadowType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class de.craftsblock.craftsnet.addon.meta.Startup

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class de.craftsblock.craftsnet.api.annotations.ProcessPriority.Priority

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class de.craftsblock.craftsnet.api.http.cookies.SameSite

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class de.craftsblock.craftsnet.api.http.HttpMethod

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Method in record class de.craftsblock.craftsnet.api.requirements.meta.RequirementInfo

Returns the value of the values record component.

values() - Static method in enum class de.craftsblock.craftsnet.api.requirements.meta.RequirementType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class de.craftsblock.craftsnet.api.session.SessionStorage.JobType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class de.craftsblock.craftsnet.api.utils.Scheme

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class de.craftsblock.craftsnet.api.websocket.ClosureCode

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class de.craftsblock.craftsnet.api.websocket.Opcode

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class de.craftsblock.craftsnet.autoregister.meta.constructors.ConstructorType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class de.craftsblock.craftsnet.autoregister.meta.Instantiate

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class de.craftsblock.craftsnet.builder.ActivateType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class de.craftsblock.craftsnet.logging.LogLevel

Returns an array containing the constants of this enum class, in the order they are declared.

verbalCheck(CraftsNet) - Static method in class de.craftsblock.craftsnet.utils.versions.Versions

Checks the version of CraftsNet using the repo server and displays the result in the console.

version - Static variable in class de.craftsblock.craftsnet.CraftsNet

version() - Method in record class de.craftsblock.craftsnet.addon.meta.AddonMeta

Returns the value of the version record component.

VersionCommand - Class in de.craftsblock.craftsnet.command.commands

Command executor for the version command.

VersionCommand() - Constructor for class de.craftsblock.craftsnet.command.commands.VersionCommand

Versions - Class in de.craftsblock.craftsnet.utils.versions

Utility class for handling version comparison logic in the CNet system.

W

warning(String, Object...) - Method in interface de.craftsblock.craftsnet.logging.Logger

Logs a formatted warning message.

warning(String) - Method in class de.craftsblock.craftsnet.logging.impl.LoggerImpl

Logs a warning message.

warning(String) - Method in record class de.craftsblock.craftsnet.logging.impl.NoOpLogger

Logs a warning message.

warning(String) - Method in record class de.craftsblock.craftsnet.logging.impl.PlainLogger

Logs a warning message.

warning(String) - Method in interface de.craftsblock.craftsnet.logging.Logger

Logs a warning message.

WARNING - Enum constant in enum class de.craftsblock.craftsnet.logging.LogLevel

Warning level for potential issues or important notices.

wasClosedByServer() - Method in class de.craftsblock.craftsnet.events.sockets.ClientDisconnectEvent

Gets whether the server disconnected the client or the client disconnected.

wasFound() - Method in class de.craftsblock.craftsnet.events.requests.PostRequestEvent

Checks whether the requested resource was found.

wasShared() - Method in class de.craftsblock.craftsnet.events.requests.PostRequestEvent

Checks whether the requested resource was shared successfully.

WebHandler - Class in de.craftsblock.craftsnet.api.http

Handles HTTP requests and routes them to the appropriate handlers based on the registered routes.

WebHandler(CraftsNet) - Constructor for class de.craftsblock.craftsnet.api.http.WebHandler

Constructs a new instance of the WebHandler

WebRequirement - Class in de.craftsblock.craftsnet.api.requirements.web

Abstract class representing a web specific requirement.

WebRequirement(Class<? extends Annotation>) - Constructor for class de.craftsblock.craftsnet.api.requirements.web.WebRequirement

Constructs a new web requirement with the specified annotation class.

WebRequirementAutoRegisterHandler - Class in de.craftsblock.craftsnet.autoregister.builtin.http

A handler for automatically registering WebRequirement implementations.

WebRequirementAutoRegisterHandler(CraftsNet) - Constructor for class de.craftsblock.craftsnet.autoregister.builtin.http.WebRequirementAutoRegisterHandler

Constructs a new WebRequirement.

webServer() - Method in class de.craftsblock.craftsnet.CraftsNet

Deprecated, for removal: This API element is subject to removal in a future version.

Use CraftsNet.getWebServer() instead. This will be removed in the future.

WebServer - Class in de.craftsblock.craftsnet.api.http

The WebServer class represents a simple HTTP or HTTPS server that listens for incoming requests and handles them based on registered API endpoints using the provided RouteRegistry.

WebServer(CraftsNet, int, boolean) - Constructor for class de.craftsblock.craftsnet.api.http.WebServer

Constructs a WebServer with the specified port and SSL settings.

website() - Method in record class de.craftsblock.craftsnet.addon.meta.AddonMeta

Returns the value of the website record component.

WebSocketClient - Class in de.craftsblock.craftsnet.api.websocket

The WebSocketClient class represents a WebSocket client that connects to the WebSocketServer.

WebSocketClient(CraftsNet, Socket, WebSocketServer) - Constructor for class de.craftsblock.craftsnet.api.websocket.WebSocketClient

Creates a new WebSocketClient with the provided socket and server.

WebSocketExtension - Class in de.craftsblock.craftsnet.api.websocket.extensions

Abstract base class for WebSocket extensions.

WebSocketExtension(String) - Constructor for class de.craftsblock.craftsnet.api.websocket.extensions.WebSocketExtension

Constructs a new WebSocket extension with the specified protocol name.

WebSocketExtensionAutoRegisterHandler - Class in de.craftsblock.craftsnet.autoregister.builtin.sockets

A handler for automatically registering WebSocketExtension implementations.

WebSocketExtensionAutoRegisterHandler(CraftsNet) - Constructor for class de.craftsblock.craftsnet.autoregister.builtin.sockets.WebSocketExtensionAutoRegisterHandler

Constructs a new WebSocketExtensionAutoRegisterHandler.

webSocketExtensionRegistry() - Method in class de.craftsblock.craftsnet.CraftsNet

Deprecated, for removal: This API element is subject to removal in a future version.

Use CraftsNet.getFileHelper() instead. This will be removed in the future.

WebSocketExtensionRegistry - Class in de.craftsblock.craftsnet.api.websocket.extensions

Registry for managing WebSocket extensions.

WebSocketExtensionRegistry() - Constructor for class de.craftsblock.craftsnet.api.websocket.extensions.WebSocketExtensionRegistry

Constructs a new WebSocket extension registry and registers the default extensions.

WebsocketMiddleware - Interface in de.craftsblock.craftsnet.api.middlewares

A specific middleware for manipulating websocket clients connections.

WebSocketRequirement<T extends RequireAble> - Class in de.craftsblock.craftsnet.api.requirements.websocket

Abstract class representing a websocket specific requirement.

WebSocketRequirement(Class<? extends Annotation>) - Constructor for class de.craftsblock.craftsnet.api.requirements.websocket.WebSocketRequirement

Constructs a new websocket requirement with the specified annotation class.

WebSocketRequirementAutoRegisterHandler - Class in de.craftsblock.craftsnet.autoregister.builtin.sockets

A handler for automatically registering WebSocketRequirement implementations.

WebSocketRequirementAutoRegisterHandler(CraftsNet) - Constructor for class de.craftsblock.craftsnet.autoregister.builtin.sockets.WebSocketRequirementAutoRegisterHandler

Constructs a new WebSocketExtensionAutoRegisterHandler.

WebSocketSafeTypeDecoder<R> - Interface in de.craftsblock.craftsnet.api.websocket.codec

A specialized Decoder for safely decoding Frame objects into a target type.

WebSocketSafeTypeEncoder<R,T> - Interface in de.craftsblock.craftsnet.api.websocket.codec

A sealed Encoder for safely encoding types for WebSocket communication.

WebSocketSafeTypeEncoder.TypeToByteArrayEncoder<T> - Interface in de.craftsblock.craftsnet.api.websocket.codec

An encoder that transforms a specific input type into a byte[] representation suitable for binary WebSocket frames.

WebSocketSafeTypeEncoder.TypeToByteBufferEncoder<T> - Interface in de.craftsblock.craftsnet.api.websocket.codec

An encoder that transforms a specific input type into a ByteBuffer representation.

WebSocketSafeTypeEncoder.TypeToJsonEncoder<T> - Interface in de.craftsblock.craftsnet.api.websocket.codec

An encoder that transforms a specific input type into a Json representation, typically for use with text-based WebSocket frames.

WebSocketSafeTypeEncoder.TypeToStringEncoder<T> - Interface in de.craftsblock.craftsnet.api.websocket.codec

An encoder that transforms a specific input type into a String representation, typically for use with text-based WebSocket frames.

webSocketServer() - Method in class de.craftsblock.craftsnet.CraftsNet

Deprecated, for removal: This API element is subject to removal in a future version.

Use CraftsNet.getWebSocketServer() instead. This will be removed in the future.

WebSocketServer - Class in de.craftsblock.craftsnet.api.websocket

The WebSocketServer class represents a simple WebSocket server implementation.

WebSocketServer(CraftsNet, int, boolean) - Constructor for class de.craftsblock.craftsnet.api.websocket.WebSocketServer

Constructs a WebSocketServer instance with the specified port number.

WebSocketServer(CraftsNet, int, int, boolean) - Constructor for class de.craftsblock.craftsnet.api.websocket.WebSocketServer

Constructs a WebSocketServer instance with the specified port number and backlog size.

WebSocketTypeDecoderAutoRegisterHandler - Class in de.craftsblock.craftsnet.autoregister.builtin.sockets.codec

A handler for automatically registering WebSocketSafeTypeDecoder implementations.

WebSocketTypeDecoderAutoRegisterHandler(CraftsNet) - Constructor for class de.craftsblock.craftsnet.autoregister.builtin.sockets.codec.WebSocketTypeDecoderAutoRegisterHandler

Constructs an WebSocketTypeDecoderAutoRegisterHandler with the specified CraftsNet instance.

WebSocketTypeEncoderAutoRegisterHandler - Class in de.craftsblock.craftsnet.autoregister.builtin.sockets.codec

A handler for automatically registering WebSocketSafeTypeEncoder implementations.

WebSocketTypeEncoderAutoRegisterHandler(CraftsNet) - Constructor for class de.craftsblock.craftsnet.autoregister.builtin.sockets.codec.WebSocketTypeEncoderAutoRegisterHandler

Constructs an WebSocketTypeEncoderAutoRegisterHandler with the specified CraftsNet instance.

withAddonSystem(ActivateType) - Method in class de.craftsblock.craftsnet.builder.AddonContainingBuilder

Specifies the activation type for the addon system.

withAddonSystem(ActivateType) - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Specifies the activation type for the addon system.

withApplyResponseEncoding(boolean) - Method in class de.craftsblock.craftsnet.builder.AddonContainingBuilder

Specifies whether from the client requested response encodings should be applied or not.

withApplyResponseEncoding(boolean) - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Specifies whether from the client requested response encodings should be applied or not.

withArgs(String[]) - Method in class de.craftsblock.craftsnet.builder.AddonContainingBuilder

Configures the builder using a set of command-line arguments.

withArgs(String[]) - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Configures the builder using a set of command-line arguments.

withCommandSystem(ActivateType) - Method in class de.craftsblock.craftsnet.builder.AddonContainingBuilder

Specifies the activation type for the command system.

withCommandSystem(ActivateType) - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Specifies the activation type for the command system.

withCustomLogger(Logger) - Method in class de.craftsblock.craftsnet.builder.AddonContainingBuilder

Sets a custom logger which will be used by CraftsNet.

withCustomLogger(Logger) - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Sets a custom logger which will be used by CraftsNet.

withDebug(boolean) - Method in class de.craftsblock.craftsnet.builder.AddonContainingBuilder

Specifies whether debug mode should be enabled.

withDebug(boolean) - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Specifies whether debug mode should be enabled.

withFileLogger(ActivateType) - Method in class de.craftsblock.craftsnet.builder.AddonContainingBuilder

Specifies the activation type for the file logger.

withFileLogger(ActivateType) - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Specifies the activation type for the file logger.

withIpsInLog(boolean) - Method in class de.craftsblock.craftsnet.builder.AddonContainingBuilder

Specifies whether ips should be blurred in the log output.

withIpsInLog(boolean) - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Specifies whether ips should be blurred in the log output.

withLogger(ActivateType) - Method in class de.craftsblock.craftsnet.builder.AddonContainingBuilder

Specifies the activation type for the logger.

withLogger(ActivateType) - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Specifies the activation type for the logger.

withLogRotate(long) - Method in class de.craftsblock.craftsnet.builder.AddonContainingBuilder

Sets the log rotation size threshold for this builder.

withLogRotate(long) - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Sets the log rotation size threshold for this builder.

withoutLogRotate() - Method in class de.craftsblock.craftsnet.builder.AddonContainingBuilder

Disables log rotation by setting the log rotation size threshold to 0.

withoutLogRotate() - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Disables log rotation by setting the log rotation size threshold to 0.

withSessionCache(int) - Method in class de.craftsblock.craftsnet.builder.AddonContainingBuilder

Specifies the size of the session cache.

withSessionCache(int) - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Specifies the size of the session cache.

withSkipDefaultRoute(boolean) - Method in class de.craftsblock.craftsnet.builder.AddonContainingBuilder

Specifies whether the registration of the default route (if no other route was registered) should be skipped on startup.

withSkipDefaultRoute(boolean) - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Specifies whether the registration of the default route (if no other route was registered) should be skipped on startup.

withSkipVersionCheck(boolean) - Method in class de.craftsblock.craftsnet.builder.AddonContainingBuilder

Specifies whether the version check should be skipped on startup.

withSkipVersionCheck(boolean) - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Specifies whether the version check should be skipped on startup.

withSSL(boolean) - Method in class de.craftsblock.craftsnet.builder.AddonContainingBuilder

Specifies whether SSL should be enabled.

withSSL(boolean) - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Specifies whether SSL should be enabled.

withTempFilesOnNormalFileSystem(boolean) - Method in class de.craftsblock.craftsnet.builder.AddonContainingBuilder

Configures whether temporary files should be placed on the normal file system.

withTempFilesOnNormalFileSystem(boolean) - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Configures whether temporary files should be placed on the normal file system.

withWebServer(int) - Method in class de.craftsblock.craftsnet.builder.AddonContainingBuilder

Specifies the port for the web server.

withWebServer(int) - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Specifies the port for the web server.

withWebServer(ActivateType) - Method in class de.craftsblock.craftsnet.builder.AddonContainingBuilder

Specifies the port for the web server.

withWebServer(ActivateType) - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Specifies the port for the web server.

withWebServer(ActivateType, int) - Method in class de.craftsblock.craftsnet.builder.AddonContainingBuilder

Specifies the activation type and port for the web server.

withWebServer(ActivateType, int) - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Specifies the activation type and port for the web server.

withWebSocketServer(int) - Method in class de.craftsblock.craftsnet.builder.AddonContainingBuilder

Specifies the port for the WebSocket server.

withWebSocketServer(int) - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Specifies the port for the WebSocket server.

withWebSocketServer(ActivateType) - Method in class de.craftsblock.craftsnet.builder.AddonContainingBuilder

Specifies the activation type and port for the WebSocket server.

withWebSocketServer(ActivateType) - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Specifies the activation type and port for the WebSocket server.

withWebSocketServer(ActivateType, int) - Method in class de.craftsblock.craftsnet.builder.AddonContainingBuilder

Specifies the activation type and port for the WebSocket server.

withWebSocketServer(ActivateType, int) - Method in class de.craftsblock.craftsnet.builder.CraftsNetBuilder

Specifies the activation type and port for the WebSocket server.

write(byte[]) - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Writes the specified byte array to the buffer at the current writer index.

write(OutputStream) - Method in class de.craftsblock.craftsnet.api.websocket.Frame

Writes the current frame to the specified output stream.

writeableBytes() - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Returns the number of writable bytes remaining in the buffer.

writeBoolean(boolean) - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Writes a boolean value to the buffer.

writeByte(byte) - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Writes a single byte to the buffer.

writeByte(int) - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Writes a single byte (represented as an integer) to the buffer.

writeChar(char) - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Writes a single character to the buffer.

writeCharSequence(CharSequence, Charset) - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Writes a CharSequence to the buffer using the specified Charset.

writeDouble(double) - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Writes a double value (8 bytes) to the buffer.

writeEnum(T) - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Writes an enum constant to the buffer by its ordinal value.

writeFloat(float) - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Writes a floating-point value (4 bytes) to the buffer.

writeInt(int) - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Writes an integer (4 bytes) to the buffer.

writeLong(long) - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Writes a long (8 bytes) to the buffer.

writerIndex() - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Returns the current writer index of the buffer.

writerIndex(int) - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Sets the writer index to the specified value.

writeShort(short) - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Writes a short (2 bytes) to the buffer.

writeUnsignedShort(int) - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Writes an unsigned short (2 bytes) to the buffer.

writeUTF(String) - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Writes a UTF-8 encoded string to the buffer.

writeUUID(UUID) - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Writes a UUID to the buffer.

writeVarInt(int) - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Writes a variable-length integer to the buffer using the VarInt format.

writeVarLong(long) - Method in class de.craftsblock.craftsnet.utils.ByteBuffer

Writes a variable-length long to the buffer using the VarLong format.

WS - Enum constant in enum class de.craftsblock.craftsnet.api.utils.Scheme

WebSocket protocol scheme, associated with a WebSocketServer.

WSDomainRequirement - Class in de.craftsblock.craftsnet.api.requirements.websocket

A specific websocket requirement that checks if the domain of a websocket connection matches certain criteria.

WSDomainRequirement() - Constructor for class de.craftsblock.craftsnet.api.requirements.websocket.WSDomainRequirement

Constructs a new websocket domain requirement.

WSS - Enum constant in enum class de.craftsblock.craftsnet.api.utils.Scheme

Secure WebSocket protocol scheme, associated with a WebSocketServer.

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