Wicketstuff Rest Annotations

https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0
Admin
Wicketstuff Rest Annotations is a Java library that provides annotation-based REST resource support...
Tokens:24,214
Snippets:167
Trust Score:9.5
Update:6 months ago
Show doc for...
Tokens:
Raw
### Get Method Information

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/resource/urlsegments/visitor/ScoreMethodAndExtractPathVars.html

Returns the MethodMappingInfo associated with this visitor, which contains details about the target method for the route.

```java
public MethodMappingInfo getMethodInfo()
```

--------------------------------

### Get Serializer/Deserializer

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/contenthandling/class-use/IWebSerialDeserial.html

Retrieves the IWebSerialDeserial instance from the current method parameter context.

```APIDOC
## GET /MethodParameterContext/getSerialDeserial

### Description
Retrieves the IWebSerialDeserial instance associated with the current method parameter context.

### Method
GET

### Response
#### Success Response (200)
- **IWebSerialDeserial** (Object) - The configured serializer/deserializer instance.
```

--------------------------------

### Get Path Variables

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/resource/urlsegments/visitor/ScoreMethodAndExtractPathVars.html

Retrieves a map of extracted path variables from the URL. Keys are variable names and values are their corresponding string values.

```java
public Map<String,String> getPathVariables()
```

--------------------------------

### Retrieve sub-segments

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/resource/urlsegments/class-use/AbstractURLSegment.html

Get the list of sub-segments from a MultiParamSegment.

```java
List<AbstractURLSegment> MultiParamSegment.getSubSegments()
```

--------------------------------

### ReflectionUtils Constructor

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/utils/reflection/ReflectionUtils.html

Initializes a new instance of the ReflectionUtils class.

```APIDOC
## Constructor Details
### ReflectionUtils
public ReflectionUtils()
Initializes a new instance of the ReflectionUtils class.
```

--------------------------------

### MethodMappingInfo Constructor

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/annotations/class-use/MethodMapping.html

Details about the constructor for MethodMappingInfo, which is used in conjunction with MethodMapping.

```APIDOC
## MethodMappingInfo Constructor

### Description
Constructs a new MethodMappingInfo object.

### Method
`MethodMappingInfo(MethodMapping methodMapped, Method method, Supplier<Locale> localeSupplier)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### Method Mapping Configuration

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/index-all.html

Configuration options for mapping HTTP methods to resource methods.

```APIDOC
## MethodMapping Annotation

### Description
Annotation used to map HTTP methods to specific resource methods.

### Elements
- **consumes()** (string[]): Specifies the MIME types the method can consume.
```

--------------------------------

### Get Total Score

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/resource/urlsegments/visitor/ScoreMethodAndExtractPathVars.html

Retrieves the total calculated score for the URL segment. A higher score indicates a better match.

```java
public int getScore()
```

--------------------------------

### MultiParamSegment Visitor Methods

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/resource/urlsegments/class-use/MultiParamSegment.html

Documentation of methods that accept MultiParamSegment as a parameter within the visitor pattern.

```APIDOC
## Visitor Methods for MultiParamSegment

### Description
These methods are part of the visitor pattern implementation for processing URL segments in WicketStuff RestAnnotations.

### Methods
- **ISegmentVisitor.visit(MultiParamSegment segment)**: Visits a MultiParamSegment instance.
- **ScoreMethodAndExtractPathVars.visit(MultiParamSegment segment)**: Visits a MultiParamSegment instance to score methods and extract path variables.

### Parameters
- **segment** (MultiParamSegment) - Required - The segment object to be visited.
```

--------------------------------

### MethodParameterContext Constructor

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/utils/wicket/MethodParameterContext.html

Initializes a new context for a method parameter with the provided attributes, path parameters, and serialization handler.

```APIDOC
## Constructor: MethodParameterContext

### Description
Constructs a new MethodParameterContext instance to manage the execution context for a method parameter.

### Parameters
- **attributesWrapper** (AttributesWrapper) - Required - The current attribute wrapper.
- **pathParameters** (Map<String,String>) - Required - The map of path parameters.
- **serialDeserial** (IWebSerialDeserial) - Required - The object serial/deserial to use.
```

--------------------------------

### FixedURLSegment Visitor Pattern

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/resource/urlsegments/class-use/FixedURLSegment.html

Documentation for methods that accept FixedURLSegment as a parameter within the visitor pattern.

```APIDOC
## Visitor Pattern for FixedURLSegment

### Description
This section details the methods used to visit FixedURLSegment objects within the WicketStuff RestAnnotations framework.

### Methods
- **ISegmentVisitor.visit(FixedURLSegment segment)**: A method to visit a fixed URL segment.
- **ScoreMethodAndExtractPathVars.visit(FixedURLSegment segment)**: A method to visit a fixed URL segment for scoring and path variable extraction.
```

--------------------------------

### DefaultBundleResolver Methods

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/utils/wicket/bundle/DefaultBundleResolver.html

Details the instance methods of the DefaultBundleResolver class.

```APIDOC
## Method Summary

All Methods
Instance Methods
Concrete Methods

### getMessage

`String getMessage(String key, Map<String,Object> vars)`

**Description:** Retrieves a message based on a key and optional variables. This method is specified by the `IErrorMessageSource` interface.

**Parameters:**
- **key** (String) - Required - The key to look up the message.
- **vars** (Map<String,Object>) - Optional - Variables to be substituted in the message.

**Returns:**
- String - The resolved message.
```

--------------------------------

### ReflectionUtils Methods

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/utils/reflection/ReflectionUtils.html

This section details the static methods available in the ReflectionUtils class for performing various reflection-based operations.

```APIDOC
## ReflectionUtils Utility Methods

### Description
Utility methods to work with reflection entities.

### Methods

#### `findAnnotation`

##### Description
Utility method to find if an annotation type is present in an array of annotations.

##### Signature
`static <T extends Annotation> T findAnnotation(Annotation[] parameterAnnotations, Class<T> targetAnnotation)`

#### `findMethod`

##### Description
Safely search for a method with a given signature (name + parameter types) on a given class.

##### Signature
`static Method findMethod(Class<?> clazz, String name, Class<?>... parameterTypes)`

#### `findMethodParameterAnnotation`

##### Description
Return the specified annotation for the method parameter at a given position (see `paramIndex`).

##### Signature
`static <T extends Annotation> T findMethodParameterAnnotation(Method ownerMethod, int paramIndex, Class<T> targetAnnotation)`

#### `getAnnotationField`

##### Description
Get the value of an annotation field.

##### Signature
`static <T> T getAnnotationField(Annotation annotation, String fieldName, T defaultValue)`

#### `getAnnotationParam`

##### Description
Return the annotation (annotated with an `AnnotatedParam`) used with a given method parameter.

##### Signature
`static Annotation getAnnotationParam(int i, Method method)`

#### `getElementsClasses`

##### Description
Extract the list of types of every element of a given collection.

##### Signature
`static List<Class<?>> getElementsClasses(Collection<?> collection)`

#### `invokeMethod`

##### Description
Safely invoke a method with the given signature (name + parameter types) on the given target object.

##### Signature
`static <T> T invokeMethod(Object target, String name, Class<?>... parameterTypes)`

#### `isParameterAnnotatedWith`

##### Description
Check if a parameter is annotated with a given annotation.

##### Signature
`static boolean isParameterAnnotatedWith(int i, Method method, Class<? extends Annotation> targetAnnotation)`
```

--------------------------------

### ISegmentVisitor Interface Methods

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/resource/urlsegments/visitor/ISegmentVisitor.html

Details on the visitor methods for processing URL segments.

```APIDOC
## ISegmentVisitor Methods

### Description
Interface for implementing the Visitor pattern to traverse and process URL segments.

### Methods
- **visit(FixedURLSegment segment)**: Processes a fixed URL segment.
- **visit(MultiParamSegment segment)**: Processes a multi-parameter URL segment.
- **visit(ParamSegment segment)**: Processes a standard parameter URL segment.
```

--------------------------------

### MethodMappingInfo API

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/utils/reflection/class-use/MethodParameter.html

Methods for retrieving method parameters and annotated parameters from MethodMappingInfo.

```APIDOC
## GET MethodMappingInfo.getAnnotatedMethodParameters()

### Description
Retrieves the method parameters stored by annotation.

### Response
- **Return Type** (Map<Class<? extends Annotation>,List<MethodParameter<?>>>) - A map where keys are annotation classes and values are lists of associated method parameters.

## GET MethodMappingInfo.getMethodParameters()

### Description
Retrieves the list of all method parameters.

### Response
- **Return Type** (List<MethodParameter<?>>) - A list containing all method parameters.
```

--------------------------------

### PackageScanner Utility

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/index-all.html

Provides static methods to scan packages for REST resources within a Wicket application.

```APIDOC
## PackageScanner Utility

### Description
Utility class for scanning packages to discover REST resources.

### Methods

#### `scanPackage(String...)`
- **Description**: Scans specified packages for REST resources.
- **Static method in**: `org.wicketstuff.rest.utils.mounting.PackageScanner`

#### `scanPackage(WebApplication, String)`
- **Description**: Scans a specific package within a Wicket application for REST resources.
- **Static method in**: `org.wicketstuff.rest.utils.mounting.PackageScanner`

#### `scanPackage(WebApplication, String...)`
- **Description**: Scans multiple specified packages within a Wicket application for REST resources.
- **Static method in**: `org.wicketstuff.rest.utils.mounting.PackageScanner`
```

--------------------------------

### MethodMappingInfo Class Overview

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/resource/MethodMappingInfo.html

This class encapsulates metadata for methods mapped to REST resources, allowing the framework to select the appropriate method for a given request.

```APIDOC
## MethodMappingInfo Class

### Description
Contains information about a resource-mapped method (annotated with @MethodMapping) used at runtime to select the most suited method to serve a request.

### Methods
- **getSegments()**: Returns the segments of the mapped URL.
- **getSegmentsCount()**: Returns the count of URL segments.
- **getHttpMethod()**: Returns the HTTP method (e.g., GET, POST).
- **getMethod()**: Returns the underlying Java class method.
- **getRoles()**: Returns optional authorization roles for the method.
- **getInputFormat()**: Returns the MIME input format.
- **getOutputFormat()**: Returns the MIME output format.
- **getMethodParameters()**: Returns the list of method parameters.
- **getAnnotatedMethodParameters()**: Returns method parameters grouped by annotation.
- **getLocaleSupplier()**: Returns the Supplier used to retrieve the Locale.
```

--------------------------------

### String Conversion Utility

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/index-all.html

Utility class for converting strings to values and vice-versa.

```APIDOC
## String Conversion Utility

### Description
Provides utility methods for converting strings to various data types and vice-versa, often used for parameter binding and data formatting.

### Classes

#### `StringConverterInterpolator`
- **Description**: Utility class to convert strings to values and vice-versa.

#### Constructor
- **`StringConverterInterpolator(String, Map<?, ?>, boolean, Locale)`**: Constructor for `StringConverterInterpolator`.
```

--------------------------------

### AbstractRestResource Methods

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/resource/AbstractRestResource.html

Documentation for the core methods of the AbstractRestResource class, responsible for handling REST requests, managing responses, and processing exceptions.

```APIDOC
## AbstractRestResource Methods

### respond(IResource.Attributes attributes)

Handles a REST request invoking one of the methods annotated with `MethodMapping`. If the annotated method returns a value, this latter is automatically serialized to a given string format (like JSON, XML, etc...) and written to the web response. If no method is found to serve the current request, a 400 HTTP code is returned to the client. Similarly, a 401 HTTP code is returned if the user doesn't own one of the roles required to execute an annotated method (See `AuthorizeInvocation`).

Specified by:
`respond` in interface `IResource`

**Parameters**:
- `attributes` (IResource.Attributes) - the Attribute object of the current request

### unauthorizedMethodAccess(WebResponse response, MethodMappingInfo methodInfo)

Handle unauthorized user access. Default: set response Status to 401. Override this method to implement customized handling.

**Parameters**:
- `response` (WebResponse) - Response-Object
- `methodInfo` (MethodMappingInfo) - The mapped method

### noSuitableMethodFound(WebResponse response, org.wicketstuff.restutils.http.HttpMethod httpMethod)

This method can be used to write a standard error message to the current response object when no mapped method has been found for the current request.

**Parameters**:
- `response` (WebResponse) - the current response object
- `httpMethod` (org.wicketstuff.restutils.http.HttpMethod) - the HTTP method of the current request

### onBeforeMethodInvoked(MethodMappingInfo mappedMethod, IResource.Attributes attributes)

Invoked just before a mapped method is invoked to serve the current request.

**Parameters**:
- `mappedMethod` (MethodMappingInfo) - the mapped method.
- `attributes` (IResource.Attributes) - the current Attributes object.

### onAfterMethodInvoked(MethodMappingInfo mappedMethod, IResource.Attributes attributes, Object result)

Invoked just after a mapped method has been invoked to serve the current request.

**Parameters**:
- `mappedMethod` (MethodMappingInfo) - the mapped method.
- `attributes` (IResource.Attributes) - the current Attributes object.
- `result` (Object) - the value returned by the invoked method.

### objectToResponse(Object result, WebResponse response, String mimeType)

Method invoked to serialize the result of the invoked method and write this value to the response.

**Parameters**:
- `result` (Object) - The object to write to response.
- `response` (WebResponse) - The current response object.
- `mimeType` (String) - The MIME type to use to serialize data

### onInitialize(T objSerialDeserial)

Method called to initialize and configure the resource.

**Parameters**:
- `objSerialDeserial` (T) - the object serializer/deserializer

### handleException(WebResponse response, Exception exception)

Handle Exception. Default: responds with a generic error message "General server error." and logging the exception. Override this method to implement customized error handling.

**Parameters**:
- `exception` (Exception) - The Exception
- `response` (WebResponse) - Response-Object

### resolveExceptionStatusCode(Exception e, int defaultStatusCode)

Resolve `WebResponse` status code for Exception. Override this method to implement customized status code resolution for exceptions.

**Parameters**:
- `e` (Exception) - The Exception
- `defaultStatusCode` (int) - The default status code to use if resolution fails.
```

--------------------------------

### Reflection and Annotation Utilities

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/index-all.html

Utility methods for working with Java reflection, annotations, and method parameters.

```APIDOC
## GET /api/reflection/annotation/field

### Description
Retrieves the value of a specific field from an annotation.

### Method
GET

### Endpoint
/api/reflection/annotation/field

### Query Parameters
- **annotationType** (String) - Required - The fully qualified name of the annotation type.
- **fieldName** (String) - Required - The name of the field within the annotation.
- **targetObject** (Object) - Required - The object from which to extract the annotation (serialized).

### Response
#### Success Response (200)
- **fieldValue** (Object) - The value of the annotation field.

#### Response Example
{
  "fieldValue": "exampleValue"
}

## GET /api/reflection/annotation/param

### Description
Retrieves the annotation associated with a specific method parameter.

### Method
GET

### Endpoint
/api/reflection/annotation/param

### Query Parameters
- **methodName** (String) - Required - The name of the method.
- **parameterIndex** (Integer) - Required - The index of the parameter within the method.

### Response
#### Success Response (200)
- **annotation** (Object) - The annotation object.

#### Response Example
{
  "annotation": {
    "@type": "org.wicketstuff.rest.annotations.MethodParam",
    "value": "userId"
  }
}

## GET /api/reflection/elements/classes

### Description
Extracts the list of types for all elements within a given collection.

### Method
GET

### Endpoint
/api/reflection/elements/classes

### Query Parameters
- **collection** (Collection) - Required - The collection from which to extract element types (serialized).

### Response
#### Success Response (200)
- **elementClasses** (List<String>) - A list of fully qualified class names for each element.

#### Response Example
{
  "elementClasses": ["java.lang.String", "java.lang.Integer"]
}
```

--------------------------------

### Reflection Utilities

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/index-all.html

Utility methods for performing reflection-based operations on methods and parameters.

```APIDOC
## invokeMethod

### Description
Safely invokes a method with a specific signature on a target object.

### Parameters
- **target** (Object) - The object instance.
- **methodName** (String) - The name of the method.
- **parameterTypes** (Class<?>...) - The parameter types of the method.

## isParameterAnnotatedWith

### Description
Checks if a specific method parameter is annotated with a given annotation.

### Parameters
- **index** (int) - The parameter index.
- **method** (Method) - The method to inspect.
- **annotationClass** (Class<? extends Annotation>) - The annotation to check for.
```

--------------------------------

### MethodMappingInfo Class

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/resource/package-use.html

Information about a resource mapped method annotated with @MethodMapping.

```APIDOC
## Class MethodMappingInfo

### Description
This class contains the informations of a resource mapped method (i.e. a method annotated with `MethodMapping`).

### Package
org.wicketstuff.rest.resource
org.wicketstuff.rest.resource.urlsegments.visitor
org.wicketstuff.rest.utils.reflection
```

--------------------------------

### AbstractRestResource Constructors

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/resource/AbstractRestResource.html

Details the constructors available for the AbstractRestResource class, used for initializing the resource with different configurations.

```APIDOC
## AbstractRestResource Constructors

### Description
Constructors for initializing the AbstractRestResource with various dependencies like serializers, deserializers, and role-checking strategies.

### Constructors

- **AbstractRestResource(T serialDeserial)**: Constructor with no role-checker (i.e., we don't use annotation `AuthorizeInvocation`).
- **AbstractRestResource(T serialDeserial, IRoleCheckingStrategy roleCheckingStrategy)**: Constructor that takes in input the object serializer/deserializer and the role-checking strategy to use.
- **AbstractRestResource(T serialDeserial, IRoleCheckingStrategy roleCheckingStrategy, Supplier<Locale> localeSupplier)**: Main constructor that takes in input the object serializer/deserializer, the role-checking strategy to use, and a locale supplier.
```

--------------------------------

### MethodMappingInfo Class

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/resource/package-summary.html

Contains metadata information for a resource method annotated with @MethodMapping.

```APIDOC
## MethodMappingInfo

### Description
This class contains the information of a resource mapped method (i.e., a method annotated with @MethodMapping). It is used by the framework to route requests to the appropriate handler method.
```

--------------------------------

### Object Conversion and Locale

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/resource/AbstractRestResource.html

Methods for converting string values to objects and retrieving locale information.

```APIDOC
## toObject

### Description
Utility method to convert string values to the corresponding objects.

### Method
`public static Object`

### Parameters
- **clazz** (Class<?>) - the type of the object we want to obtain.
- **value** (String) - the string value we want to convert.
- **localeSupplier** (Supplier<Locale>)

### Returns
the object corresponding to the converted string value, or null if value parameter is null.

### Throws
`RuntimeException`

## getLocaleSupplier

### Description
Gets the Supplier used to retrieve the Locale.

### Method
`public Supplier<Locale>`

### Returns
the Supplier used to retrieve the Locale
```

--------------------------------

### PackageScanner.scanPackage

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/utils/mounting/PackageScanner.html

Utility methods to scan specified packages for REST annotations, optionally associated with a Wicket WebApplication instance.

```APIDOC
## static void scanPackage(String... packageNames)

### Description
Scans the provided packages for REST annotations.

### Parameters
- **packageNames** (String...) - Required - Variable number of package names to scan.

---

## static void scanPackage(WebApplication application, String... packageNames)

### Description
Scans the provided packages for REST annotations within the context of a Wicket WebApplication.

### Parameters
- **application** (WebApplication) - Required - The Wicket WebApplication instance.
- **packageNames** (String...) - Required - Variable number of package names to scan.

---

## static void scanPackage(WebApplication application, String packageName)

### Description
Scans a single package for REST annotations within the context of a Wicket WebApplication.

### Parameters
- **application** (WebApplication) - Required - The Wicket WebApplication instance.
- **packageName** (String) - Required - The name of the package to scan.
```

--------------------------------

### AbstractRestResource Method Mapping API

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/resource/class-use/MethodMappingInfo.html

Methods for retrieving and managing method mappings within the AbstractRestResource class.

```APIDOC
## GET /AbstractRestResource/mappedMethods

### Description
Retrieves the mapped methods grouped by the number of segments and the HTTP method.

### Method
GET

### Response
#### Success Response (200)
- **Map<String,List<MethodMappingInfo>>** - A map containing the grouped method mapping information.

## GET /AbstractRestResource/mappedMethodsInfo

### Description
Retrieves a map of all methods and their corresponding MethodMappingInfo.

### Method
GET

### Response
#### Success Response (200)
- **Map<Method,MethodMappingInfo>** - A map linking Java methods to their mapping info.
```

--------------------------------

### Utility Classes

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/index-all.html

Utility classes for common tasks such as collection manipulation and bundle resolution.

```APIDOC
## Utility Classes

### CollectionUtils

#### Description
Provides utility methods for collection manipulation.

#### Constructor
- **CollectionUtils()**: Default constructor.

### DefaultBundleResolver

#### Description
Wicket bundle resolver that relies on the default `IStringResourceLoader`s.

#### Constructors
- **DefaultBundleResolver(Class<?>... classes)**: Constructor taking variable arguments of classes.
- **DefaultBundleResolver(List<Class<?>> classes)**: Constructor taking a list of classes.
```

--------------------------------

### AbstractRestResource Lifecycle Methods

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/index-all.html

Methods provided by AbstractRestResource to manage the lifecycle of a REST request, including initialization and pre/post-invocation hooks.

```APIDOC
## Lifecycle Methods in AbstractRestResource

### Description
These methods are part of the AbstractRestResource class and are used to hook into the request processing lifecycle.

### Methods
- **onInitialize(T)**: Called to initialize and configure the resource.
- **onBeforeMethodInvoked(MethodMappingInfo, IResource.Attributes)**: Invoked just before a mapped method is invoked to serve the current request.
- **onAfterMethodInvoked(MethodMappingInfo, IResource.Attributes, Object)**: Invoked just after a mapped method has been invoked to serve the current request.
```

--------------------------------

### FixedURLSegment Methods

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/resource/urlsegments/FixedURLSegment.html

Documentation for the methods available in the FixedURLSegment class.

```APIDOC
## Methods

### accept
```java
public void accept(ISegmentVisitor visitor)
```

### loadMetaPattern
```java
protected MetaPattern loadMetaPattern()
```
**Description:** Method invoked to load the MetaPattern for the current segment.

**Specified by:** `loadMetaPattern` in class `AbstractURLSegment`

**Returns:** the MetaPattern for the current segment.
```

--------------------------------

### AbstractRestResource Methods

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/resource/AbstractRestResource.html

This section details the methods available in the AbstractRestResource class, which forms the basis for creating RESTful resources in Wicket.

```APIDOC
## AbstractRestResource Methods

### Description
Provides methods for handling REST requests, including extracting URLs, managing web requests and responses, serializing/deserialerializing objects, and managing validators.

### Methods

#### Static Methods
- **extractUrlFromRequest()** (static Url): Utility method to extract the client URL from the current request.
- **getCurrentWebRequest()** (static final WebRequest): Utility method to retrieve the current web request.
- **getCurrentWebResponse()** (static final WebResponse): Utility method to retrieve the current web response.
- **toObject(Class<?> clazz, String value, Supplier<Locale> localeSupplier)** (static Object): Utility method to convert string values to the corresponding objects.

#### Instance Methods
- **getLocaleSupplier()** (Supplier<Locale>): Gets the Supplier used to retrieve the Locale.
- **getMappedMethods()** (protected Map<String,List<MethodMappingInfo>>): Return mapped methods grouped by number of segments and HTTP method.
- **getMappedMethodsInfo()** (Map<Method,MethodMappingInfo>): Returns information about mapped methods.
- **getMethodInfo(Method method)** (MethodMappingInfo): Retrieves information about a specific method.
- **getValidator(String key, E validatorType)** (protected final <E> IValidator<E>): Retrieve a registered validator.
- **handleException(WebResponse response, Exception exception)** (protected void): Handle Exception.
- **handleValidationError(WebResponse response, String outputFormat, IValidationError error)** (protected void): Handle Validation exception.
- **noSuitableMethodFound(WebResponse response, org.wicketstuff.restutils.http.HttpMethod httpMethod)** (void): This method can be used to write a standard error message to the current response object when no mapped method has been found for the current request.
- **objectToResponse(Object result, WebResponse response, String mimeType)** (void): Method invoked to serialize the result of the invoked method and write this value to the response.
- **onAfterMethodInvoked(MethodMappingInfo mappedMethod, IResource.Attributes attributes, Object result)** (protected void): Invoked just after a mapped method has been invoked to serve the current request.
- **onBeforeMethodInvoked(MethodMappingInfo mappedMethod, IResource.Attributes attributes)** (protected void): Invoked just before a mapped method is invoked to serve the current request.
- **onInitialize(T objSerialDeserial)** (protected void): Method called to initialize and configure the resource.
- **registerValidator(String key, IValidator<?> validator)** (protected final void): Register a Wicket validator for the current resource.
- **requestToObject(WebRequest request, Class<E> argClass, String mimeType)** (<E> E): Internal method that tries to extract an instance of the given class from the request body.
- **resolveExceptionStatusCode(Exception e, int defaultStatusCode)** (protected int): Resolve `WebResponse` status code for Exception.
- **resolveValidationErrorStatusCode(IValidationError error, int defaultStatusCode)** (protected int): Resolve `WebResponse` status code for `IValidationError`.
- **respond(IResource.Attributes attributes)** (final void): Handles a REST request invoking one of the methods annotated with `MethodMapping`.
- **setResponseStatusCode(int statusCode)** (protected final void): Set the status code for the current response.
- **unauthorizedMethodAccess(WebResponse response, MethodMappingInfo methodInfo)** (protected void): Handle unauthorized user access.
- **unregisterValidator(String key)** (protected final void): Unregister a Wicket validator.
```

--------------------------------

### DefaultBundleResolver Constructors

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/utils/wicket/bundle/DefaultBundleResolver.html

Details the constructors available for the DefaultBundleResolver class.

```APIDOC
## Constructor Summary

Constructors

### DefaultBundleResolver

`DefaultBundleResolver(Class<?>... targetClasses)`

### DefaultBundleResolver

`DefaultBundleResolver(List<Class<?>> targetClasses)`
```

--------------------------------

### AbstractRestResource Class

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/resource/AbstractRestResource.html

The base class for building resources that serve REST requests. It implements IResource and IClusterable, and is Serializable.

```APIDOC
## Class AbstractRestResource<T extends IWebSerialDeserial>

### Description
Base class to build a resource that serves REST requests.

### Implements
`Serializable`, `IResource`, `IClusterable`

### Author
andrea del bene
```

--------------------------------

### ScoreMethodAndExtractPathVars Constructor

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/resource/urlsegments/visitor/ScoreMethodAndExtractPathVars.html

Initializes a new instance of the ScoreMethodAndExtractPathVars class with the provided MethodMappingInfo and PageParameters.

```java
public ScoreMethodAndExtractPathVars(MethodMappingInfo methodInfo, PageParameters pageParameters)
```

--------------------------------

### Content Handling and Serialization

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/index-all.html

Utilities for handling content types, serialization, and deserialization in REST requests and responses.

```APIDOC
## GET /api/content/input/format

### Description
Gets the MIME type to use for input content.

### Method
GET

### Endpoint
/api/content/input/format

### Response
#### Success Response (200)
- **inputFormat** (String) - The MIME type for input.

#### Response Example
{
  "inputFormat": "application/json"
}

## GET /api/content/output/format

### Description
Gets the MIME type to use for output content.

### Method
GET

### Endpoint
/api/content/output/format

### Response
#### Success Response (200)
- **outputFormat** (String) - The MIME type for output.

#### Response Example
{
  "outputFormat": "application/json"
}

## GET /api/content/serialization/deserialization

### Description
Retrieves the object responsible for serializing and deserializing content.

### Method
GET

### Endpoint
/api/content/serialization/deserialization

### Response
#### Success Response (200)
- **objectSerialDeserial** (Object) - The serializer/deserializer object.

#### Response Example
{
  "objectSerialDeserial": {
    "@type": "org.wicketstuff.rest.contenthandling.webserialdeserial.TextualWebSerialDeserial"
  }
}
```

--------------------------------

### AbstractRestResource.noSuitableMethodFound

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/index-all.html

Handles error reporting when no mapped method matches the incoming request.

```APIDOC
## Method: noSuitableMethodFound

### Description
This method can be used to write a standard error message to the current response object when no mapped method has been found for the current request.

### Parameters
- **response** (WebResponse) - Required - The current web response object.
- **method** (HttpMethod) - Required - The HTTP method that failed to find a match.
```

--------------------------------

### Mapped Methods Info Field

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/serialized-form.html

Stores mapped methods with the Method object as the key.

```java
Map<Method,MethodMappingInfo> mappedMethodsInfo
```

--------------------------------

### Request and Response Utilities

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/resource/AbstractRestResource.html

Utility methods for accessing and processing web requests and responses.

```APIDOC
## extractUrlFromRequest

### Description
Utility method to extract the client URL from the current request.

### Method
`public static Url`

### Returns
the URL for the current request.

## requestToObject

### Description
Internal method that tries to extract an instance of the given class from the request body.

### Method
`public <E> E`

### Parameters
- **request** (WebRequest)
- **argClass** (Class<E>) - the type we want to extract from request body.
- **mimeType** (String)

### Returns
the extracted object.

## getCurrentWebRequest

### Description
Utility method to retrieve the current web request.

### Method
`public static final WebRequest`

### Returns
the current web request

## getCurrentWebResponse

### Description
Utility method to retrieve the current web response.

### Method
`public static final WebResponse`

### Returns
the current web response
```

--------------------------------

### AbstractRestResource Constructors

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/resource/AbstractRestResource.html

Details the constructors available for the AbstractRestResource class, which are used for initializing the resource with serialization/deserialization strategies and role-checking mechanisms.

```APIDOC
## AbstractRestResource Constructors

### AbstractRestResource(T serialDeserial)

Constructor with no role-checker (i.e we don't use annotation `AuthorizeInvocation`).

**Parameters**:
- `serialDeserial` (T) - General class that is used to serialize/desiarilze objects to string.

### AbstractRestResource(T serialDeserial, IRoleCheckingStrategy roleCheckingStrategy)

Constructor that takes in input the object serializer/deserializer and the role-checking strategy to use.

**Parameters**:
- `serialDeserial` (T) - General class that is used to serialize/desiarilze objects to string
- `roleCheckingStrategy` (IRoleCheckingStrategy) - the role-checking strategy.

### AbstractRestResource(T serialDeserial, IRoleCheckingStrategy roleCheckingStrategy, Supplier<Locale> localeSupplier)

Main constructor that takes in input the object serializer/deserializer and the role-checking strategy to use.

**Parameters**:
- `serialDeserial` (T) - General class that is used to serialize/desiarilze objects to string
- `roleCheckingStrategy` (IRoleCheckingStrategy) - the role-checking strategy.
- `localeSupplier` (Supplier<Locale>) - the Supplier used to retrieve the Locale.
```

--------------------------------

### IWebSerialDeserial Methods

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/contenthandling/IWebSerialDeserial.html

Methods for handling object serialization, deserialization, and MIME type support checks.

```APIDOC
## isMimeTypeSupported

### Description
Check if a given MIME type is handled by the implementation.

### Parameters
#### Query Parameters
- **mimeType** (String) - Required - The MIME type to check.

### Response
#### Success Response (200)
- **boolean** - Returns true if the MIME type is supported, false otherwise.

---

## objectToResponse

### Description
Write the target object to the response by converting it to the specified MIME type.

### Parameters
#### Request Body
- **targetObject** (Object) - Required - The object instance to serialize.
- **response** (WebResponse) - Required - The response object.
- **mimeType** (String) - Required - The MIME type of the response.

---

## requestToObject

### Description
Extract an instance of a specific class from the request based on the provided MIME type.

### Parameters
#### Query Parameters
- **request** (WebRequest) - Required - The request object.
- **argClass** (Class<T>) - Required - The type of the object to extract.
- **mimeType** (String) - Required - The MIME type of the request.

### Response
#### Success Response (200)
- **T** - The object extracted from the request.
```

--------------------------------

### Serialization and Content Handling

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/index-all.html

Methods for serializing objects to the response based on MIME types.

```APIDOC
## objectToResponse

### Description
Serializes an object and writes it to the response using a specified MIME type.

### Parameters
- **object** (Object) - The object to serialize.
- **response** (WebResponse) - The web response object.
- **mimeType** (String) - The target MIME type for serialization.
```

--------------------------------

### MIME Type Handling

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/index-all.html

Interfaces and methods for resolving and checking supported MIME types.

```APIDOC
## isMimeTypeSupported

### Description
Checks if a given MIME type is supported by the serializer/deserializer.

### Parameters
- **mimeType** (String) - The MIME type string to check.

### Response
- **boolean** - Returns true if supported, false otherwise.
```

--------------------------------

### Content Handling and MIME Types

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/index-all.html

Constants and interfaces for handling request and response content types.

```APIDOC
## Content Handling and MIME Types

### RestMimeTypes

#### Description
Provides constants for common MIME types used in REST requests and responses.

#### Constants
- **APPLICATION_JSON** (string): Represents the `application/json` MIME type.
- **APPLICATION_RSS_XML** (string): Represents the `application/rss+xml` MIME type.
- **APPLICATION_XML** (string): Represents the `application/xml` MIME type.

### IObjectSerialDeserial

#### Description
Interface for objects responsible for serializing and deserializing data for REST requests and responses.

#### Methods
- **deserializeObject(T source, Class<E> targetClass, String mimeType)**: Extract an object instance from a given source object.
```

--------------------------------

### ISegmentVisitor Interface and ScoreMethodAndExtractPathVars Class

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/index-all.html

Documentation for the ISegmentVisitor interface and its implementation ScoreMethodAndExtractPathVars, used for visiting URL segments.

```APIDOC
## URL Segment Visitor

### Description
This section details the `ISegmentVisitor` interface and the `ScoreMethodAndExtractPathVars` class, which are used for traversing and processing URL segments, potentially extracting path variables.

### Interface
`ISegmentVisitor`
  - Methods:
    - `visit(FixedURLSegment)`
    - `visit(MultiParamSegment)`
    - `visit(ParamSegment)`

### Class
`ScoreMethodAndExtractPathVars` (implements `ISegmentVisitor`)
  - Methods:
    - `visit(FixedURLSegment)`
    - `visit(MultiParamSegment)`
    - `visit(ParamSegment)`

### Purpose
These components are involved in the process of matching incoming URL requests to specific methods and extracting any path parameters defined in the URL structure.
```

--------------------------------

### Visit MultiParamSegment

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/resource/urlsegments/visitor/ScoreMethodAndExtractPathVars.html

Visits a MultiParamSegment, implementing the ISegmentVisitor interface. Used for handling URL segments with multiple parameters.

```java
public void visit(MultiParamSegment segment)
```

--------------------------------

### Visit ParamSegment

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/resource/urlsegments/visitor/ScoreMethodAndExtractPathVars.html

Visits a ParamSegment, implementing the ISegmentVisitor interface. This method handles standard URL parameter segments.

```java
public void visit(ParamSegment segment)
```

--------------------------------

### ParamSegment Class

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/resource/urlsegments/ParamSegment.html

Details about the ParamSegment class, its inheritance, and methods.

```APIDOC
## Class: ParamSegment

### Description
`StringValue` subtype that represents a mounted segment containing a parameter's value (for example '/{id}/').

### Class Hierarchy
`java.lang.Object` -> `org.apache.wicket.util.string.StringValue` -> `org.wicketstuff.rest.resource.urlsegments.AbstractURLSegment` -> `ParamSegment`

### Implemented Interfaces
`Serializable`, `IClusterable`, `ISegementElement`

### Fields Inherited from `AbstractURLSegment`
- `REGEXP_BODY`
- `REGEXP_DECLARATION`
- `SEGMENT_PARAMETER`

### Methods
#### Instance Methods
- **`accept(ISegmentVisitor visitor)`** (void): Accepts a visitor for segment processing.
- **`getParamName()`** (String): Retrieves the name of the parameter represented by this segment.
- **`loadMetaPattern()`** (protected MetaPattern): Method invoked to load the MetaPattern for the current segment.

### Methods Inherited from `AbstractURLSegment`
- `getActualSegment`
- `getMetaPattern`
- `getSegmentMatrixParameters`
- `newSegment`

### Methods Inherited from `StringValue`
- `afterFirst`, `afterLast`, `beforeFirst`, `beforeLast`, `equals`, `hashCode`, `isEmpty`, `isNull`, `repeat`, `repeat`, `replaceAll`, `to`, `toBoolean`, `toBoolean`, `toBooleanObject`, `toChar`, `toChar`, `toCharacter`, `toDouble`, `toDouble`, `toDoubleObject`, `toDuration`, `toDuration`, `toEnum`, `toEnum`, `toEnum`, `toInstant`, `toInstant`, `toInt`, `toInt`, `toInteger`, `toLong`, `toLong`, `toLongObject`, `toOptional`, `toOptionalBoolean`, `toOptionalCharacter`, `toOptionalDouble`, `toOptionalDuration`, `toOptionalEnum`, `toOptionalInstant`, `toOptionalInteger`, `toOptionalLong`, `toOptionalString`, `toString`, `toString`, `valueOf`, `valueOf`, `valueOf`, `valueOf`, `valueOf`, `valueOf`, `valueOf`, `valueOf`

### Methods Inherited from `Object`
- `clone`, `finalize`, `getClass`, `notify`, `notifyAll`, `wait`, `wait`, `wait`

### Method Details
#### `loadMetaPattern`
protected MetaPattern loadMetaPattern()
Method invoked to load the MetaPattern for the current segment.

Specified by: `loadMetaPattern` in class `AbstractURLSegment`

Returns: the MetaPattern for the current segment.

#### `getParamName`
public String getParamName()

#### `accept`
public void accept(ISegmentVisitor visitor)
```

--------------------------------

### Create new URL segment

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/resource/urlsegments/class-use/AbstractURLSegment.html

Factory method to instantiate a new AbstractURLSegment from a string.

```java
static AbstractURLSegment AbstractURLSegment.newSegment(String segment)
```

--------------------------------

### ISegementElement.accept

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/resource/urlsegments/visitor/ISegementElement.html

Accepts an ISegmentVisitor to perform operations on the URL segment element.

```APIDOC
## void accept(ISegmentVisitor visitor)

### Description
Accepts an ISegmentVisitor to implement the Visitor pattern for URL segments.

### Parameters
- **visitor** (ISegmentVisitor) - Required - The visitor instance to be accepted by the segment element.
```

--------------------------------

### makeListMapImmutable

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/utils/collection/CollectionUtils.html

Converts a map of lists into an immutable version.

```APIDOC
## makeListMapImmutable

### Description
Make a list map immutable.

### Parameters
- **listMap** (Map<C,List<E>>) - Required - The list map in input.

### Response
- **Returns** (Map<C,List<E>>) - The immutable list map.
```

--------------------------------

### AbstractURLSegment Class

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/resource/urlsegments/AbstractURLSegment.html

Documentation for the AbstractURLSegment class, which serves as a base class for URL segments.

```APIDOC
## Class AbstractURLSegment

### Description
Base class to contain the informations of the segments that compose the URL used to map a method. It's used to use simple segments with no path parameters.

### Author
andrea del bene

### See Also
* Serialized Form

### Field Summary
#### Fields
- **REGEXP_BODY** (static final MetaPattern) - MetaPattern to identify the content of a regular expression.
- **REGEXP_DECLARATION** (static final MetaPattern) - MetaPattern to identify the declaration of a regular expression.
- **SEGMENT_PARAMETER** (static final MetaPattern) - MetaPattern to identify a path parameter inside a segment (i.e. "{paramName:regexp}")

### Method Summary
#### Static Methods
- **getActualSegment**(String fullSegment) - Get the segment value without optional matrix parameters.
- **getSegmentMatrixParameters**(String fullSegment) - Extract matrix parameters from the segment in input.
- **newSegment**(String segment) - Factory method to create new instances of AbstractURLSegment.

#### Instance Methods
- **getMetaPattern**() - Getter method for segment MetaPattern.

#### Abstract Methods
- **loadMetaPattern**() - Method invoked to load the MetaPattern for the current segment.

### Field Details
#### REGEXP_BODY
public static final MetaPattern REGEXP_BODY
MetaPattern to identify the content of a regular expression.

#### REGEXP_DECLARATION
public static final MetaPattern REGEXP_DECLARATION
MetaPattern to identify the declaration of a regular expression.

#### SEGMENT_PARAMETER
public static final MetaPattern SEGMENT_PARAMETER
MetaPattern to identify a path parameter inside a segment (i.e. "{paramName:regexp}")

### Method Details
#### loadMetaPattern
protected abstract MetaPattern loadMetaPattern()
Method invoked to load the MetaPattern for the current segment.

Returns:
the MetaPattern for the current segment.

#### newSegment
public static AbstractURLSegment newSegment(String segment)
Factory method to create new instances of AbstractURLSegment.

Parameters:
- `segment` (String) - The content of the new segment.

Returns:
the new instance of AbstractURLSegment.

#### getActualSegment
public static String getActualSegment(String fullSegment)
Get the segment value without optional matrix parameters. For example given the following value 'segment;parm=value', the function returns 'segment'.

Parameters:
- `fullSegment` (String) - 

Returns:
the value of the segment without matrix parameters.

#### getSegmentMatrixParameters
public static Map<String,String> getSegmentMatrixParameters(String fullSegment)
Extract matrix parameters from the segment in input.

Parameters:
- `fullSegment` (String) - the segment in input.

Returns:
a map containing matrix parameters.

#### getMetaPattern
public final MetaPattern getMetaPattern()
Getter method for segment MetaPattern.
```

--------------------------------

### Visit FixedURLSegment

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/resource/urlsegments/visitor/ScoreMethodAndExtractPathVars.html

Visits a FixedURLSegment, implementing the ISegmentVisitor interface. This method is part of the logic for scoring URL segments.

```java
public void visit(FixedURLSegment segment)
```

--------------------------------

### AbstractRestResource Exception Handling

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/index-all.html

Methods for handling exceptions and validation errors within the AbstractRestResource class.

```APIDOC
## handleException

### Description
Handles exceptions occurring during the request lifecycle.

### Method
Internal Method

### Parameters
- **WebResponse** (Object) - The current web response.
- **Exception** (Exception) - The exception to handle.

## handleValidationError

### Description
Handles validation errors encountered during request processing.

### Parameters
- **WebResponse** (Object) - The current web response.
- **String** (String) - The error message or context.
- **IValidationError** (Object) - The validation error details.
```

--------------------------------

### Parameter Annotations

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/org/wicketstuff/rest/annotations/parameters/class-use/AnnotatedParam.html

Annotations used to define how method parameters are populated from incoming HTTP requests.

```APIDOC
## Annotations for Parameter Extraction

This section details the annotations provided by `org.wicketstuff.rest.annotations.parameters` for mapping request data to method parameters.

### CookieParam

This annotation indicates that the value of a method parameter must be read from a cookie.

### HeaderParam

This annotation indicates that the value of a method parameter must be read from a header parameter.

### MatrixParam

This annotation indicates that the value of a method parameter must be read from a given segment as a matrix parameter.

### PathParam

This annotation indicates that the value of a method parameter must be extracted from a path parameter.

### RequestBody

Annotation used to indicate that a method parameter must be extracted from the request body.

### RequestParam

This annotation indicates that the value of a method parameter must be read from a request parameter.
```

--------------------------------

### REST Resource and Method Information

Source: https://javadoc.io/doc/org.wicketstuff/wicketstuff-restannotations/10.8.0/index-all.html

APIs related to retrieving information about REST resources, mapped methods, and HTTP request/response details.

```APIDOC
## GET /api/resource/current/request

### Description
Retrieves the current web request object.

### Method
GET

### Endpoint
/api/resource/current/request

### Response
#### Success Response (200)
- **webRequest** (Object) - The current web request object.

#### Response Example
{
  "webRequest": {
    "method": "GET",
    "url": "/api/users/123"
  }
}

## GET /api/resource/current/response

### Description
Retrieves the current web response object.

### Method
GET

### Endpoint
/api/resource/current/response

### Response
#### Success Response (200)
- **webResponse** (Object) - The current web response object.

#### Response Example
{
  "webResponse": {
    "statusCode": 200,
    "contentType": "application/json"
  }
}

## GET /api/resource/mapped/methods

### Description
Retrieves all mapped methods within a REST resource, grouped by HTTP method and number of segments.

### Method
GET

### Endpoint
/api/resource/mapped/methods

### Response
#### Success Response (200)
- **mappedMethods** (Map<String, Map<Integer, List<MethodMappingInfo>>>) - A map containing grouped method information.

#### Response Example
{
  "mappedMethods": {
    "GET": {
      "1": [
        {
          "httpMethod": "GET",
          "endpoint": "/users/{id}",
          "method": "getUserById"
        }
      ]
    }
  }
}

## GET /api/resource/method/info

### Description
Retrieves detailed information about a specific mapped method.

### Method
GET

### Endpoint
/api/resource/method/info

### Query Parameters
- **methodName** (String) - Required - The name of the method.

### Response
#### Success Response (200)
- **methodMappingInfo** (MethodMappingInfo) - Detailed information about the method.

#### Response Example
{
  "methodMappingInfo": {
    "httpMethod": "GET",
    "endpoint": "/users/{id}",
    "method": "getUserById",
    "annotatedMethodParameters": [],
    "methodParameters": [],
    "inputFormat": "application/json",
    "outputFormat": "application/json"
  }
}
```
Tokens:
Raw