Package io.fluxcapacitor.javaclient.web

Interface HttpRequestMethod

public interface HttpRequestMethod
Defines constants for standard and extended HTTP request methods used by Flux Capacitor's web handling system.

This interface provides:

  • String constants for standard HTTP verbs (e.g. GET, POST)
  • Custom pseudo-methods for WebSocket lifecycle events (e.g. WS_HANDSHAKE, WS_MESSAGE)
  • A wildcard constant (*) for method-agnostic routing
  • A helper method to detect whether a method is a WebSocket variant

Usage

These constants are used throughout the web routing and handler matching infrastructure:

The extended WebSocket methods are used internally to distinguish between phases of a WebSocket session, such as handshake negotiation, message delivery, or connection closure.

See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ANY
    Matches any HTTP method (wildcard).
    static final String
    DELETE
     
    static final String
    GET
     
    static final String
    HEAD
     
    static final String
    OPTIONS
     
    static final String
    PATCH
     
    static final String
    POST
     
    static final String
    PUT
     
    static final String
    TRACE
     
    static final String
    WS_CLOSE
    Represents an explicit closure of a WebSocket session.
    static final String
    WS_HANDSHAKE
    Synthetic method representing a WebSocket handshake (initial HTTP upgrade).
    static final String
    WS_MESSAGE
    Represents a message sent over an established WebSocket connection.
    static final String
    WS_OPEN
    Represents the WebSocket session being formally opened after handshake.
    static final String
    WS_PONG
    Represents a pong response received for a ping message.

  • Method Summary

    Static Methods
    Modifier and Type
    Method
    Description
    static boolean
    isWebsocket(String requestMethod)
    Determines whether the given method string represents a WebSocket-specific method.