Liandian Marketplace

https://ldn-backend.pages.dev
Admin
Liandian Marketplace is an API for a battery marketplace, providing functionalities for...
Tokens:112,230
Snippets:899
Trust Score:7.2
Update:8 months ago
Show doc for...
Tokens:
Raw
### Java get() Method Implementation Example

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/common/service/SystemOperationService.SupplierWithException

Illustrates how to implement the `get()` method of the `SupplierWithException` interface. This example shows a lambda expression that performs an operation, returns a result, and handles potential exceptions.

```java
SystemOperationService.SupplierWithException<String> operation = () -> {
    // Simulate an operation that might throw an exception
    if (System.currentTimeMillis() % 2 == 0) {
        throw new Exception("Operation failed due to time.");
    }
    return "Operation successful";
};

try {
    String result = operation.get();
    System.out.println(result);
} catch (Exception e) {
    System.err.println(e.getMessage());
}
```

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

### GET /

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/user/controller/UserController

Retrieves a paginated list of all users. Requires `users:read_all` permission.

```APIDOC
## GET /

### Description
Retrieves a paginated list of all users. Requires `users:read_all` permission.

### Method
GET

### Endpoint
/

### Parameters
#### Query Parameters
- **page** (long) - Optional - The page number (1-indexed), defaults to 1.
- **size** (long) - Optional - The page size, defaults to 10.

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **pageResponse** (PageResponse<UserResponse>) - A response containing paginated users.

#### Response Example
```json
{
  "status": "SUCCESS",
  "data": {
    "content": [
      {
        "id": 1,
        "username": "user1",
        "email": "user1@example.com",
        "mobile": "1111111111",
        "createdAt": "2023-01-01T10:00:00Z",
        "updatedAt": "2023-01-01T10:00:00Z"
      },
      {
        "id": 2,
        "username": "user2",
        "email": "user2@example.com",
        "mobile": "2222222222",
        "createdAt": "2023-01-02T11:00:00Z",
        "updatedAt": "2023-01-02T11:00:00Z"
      }
    ],
    "page": 1,
    "size": 10,
    "totalElements": 2,
    "totalPages": 1
  }
}
```
```

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

### Get All Roles

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/rbac/entity/class-use/Role

Retrieves a list of all roles available in the system.

```APIDOC
## GET /api/roles

### Description
Retrieves a list of all roles available in the system.

### Method
GET

### Endpoint
/api/roles

### Response
#### Success Response (200)
- **roles** (array) - A list of role objects.
  - **roleName** (string) - The name of the role.
  - **permissions** (array) - A list of permissions associated with the role.

#### Response Example
```json
{
  "roles": [
    {
      "roleName": "admin",
      "permissions": ["read", "write", "delete"]
    },
    {
      "roleName": "user",
      "permissions": ["read"]
    }
  ]
}
```
```

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

### GET /me

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/user/controller/UserController

Retrieves the currently authenticated user's information.

```APIDOC
## GET /me

### Description
Retrieves the currently authenticated user's information.

### Method
GET

### Endpoint
/me

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **userResponse** (UserResponse) - The authenticated user's information.

#### Response Example
```json
{
  "status": "SUCCESS",
  "data": {
    "id": 1,
    "username": "testuser",
    "email": "test@example.com",
    "mobile": "1234567890",
    "createdAt": "2023-01-01T10:00:00Z",
    "updatedAt": "2023-01-01T10:00:00Z"
  }
}
```
```

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

### GET /users

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/common/class-use/PageResponse

Retrieves a paginated list of all users. Supports pagination via page and size parameters.

```APIDOC
## GET /users

### Description
Retrieves a paginated list of all users.

### Method
GET

### Endpoint
/users

### Parameters
#### Query Parameters
- **page** (long) - Required - The page number to retrieve.
- **size** (long) - Required - The number of items per page.

### Response
#### Success Response (200)
- **ApiResponse<PageResponse<UserResponse>>** - Contains the paginated list of users and metadata.

#### Response Example
```json
{
  "code": 200,
  "message": "Success",
  "data": {
    "content": [
      {
        "userId": 1,
        "username": "john_doe",
        "email": "john.doe@example.com"
      }
    ],
    "pageable": {
      "pageNumber": 0,
      "pageSize": 10,
      "sort": {
        "empty": false,
        "sorted": true,
        "unsorted": false
      },
      "offset": 0,
      "paged": true,
      "unpaged": false
    },
    "totalPages": 5,
    "totalElements": 50,
    "last": false,
    "size": 10,
    "number": 0,
    "sort": {
      "empty": false,
      "sorted": true,
      "unsorted": false
    },
    "numberOfElements": 10,
    "first": true,
    "empty": false
  }
}
```
```

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

### Spring Web MVC Configuration in Java

Source: https://ldn-backend.pages.dev/overview-tree

Configures the web layer of a Spring Boot application using WebMvcConfigurer. This example shows how to add interceptors to the application's request handling pipeline.

```java
package tech.liandian.batterymarketplace.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new TraceIdInterceptor());
    }
}
```

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

### Verify Registration SMS (Java)

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/auth/controller/MobileAuthController

Verifies the SMS code provided during registration and completes the user account setup. Upon successful verification, it creates a new user, marks the mobile number as verified, enables the account, and assigns the default 'USER' role. It takes the registration request and HTTP request as parameters.

```java
@PostMapping("/register/verify")
public org.springframework.http.ResponseEntity<ApiResponse<MobileRegistrationResponse>> verifyRegistration(@Valid @RequestBody @Valid MobileRegistrationRequest request, jakarta.servlet.http.HttpServletRequest httpRequest)
{
    // Method implementation details would be here
}
```

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

### Get All Users (Paginated) - Java

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/user/controller/UserController

Fetches a paginated list of all users. This endpoint requires the 'users:read_all' permission and allows specifying page number and size. It returns a PageResponse containing user data.

```java
@PreAuthorize("hasPermission(null, 'users:read_all')") @GetMapping public org.springframework.http.ResponseEntity<ApiResponse<PageResponse<UserResponse>>> getUsers(@RequestParam(defaultValue="1") long page, @RequestParam(defaultValue="10") long size)
Retrieves a paginated list of all users. 
Requires `users:read_all` permission. 

Parameters:
    `page` - the page number (1-indexed), defaults to 1     `size` - the page size, defaults to 10 

Returns:
    a response containing paginated users 

See Also:
    
      * `PageResponse`
```

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

### Create UserDetailsImpl Instance

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/user/entity/class-use/User

Factory methods for creating UserDetailsImpl instances. These methods abstract the instantiation logic and can optionally include role assignment.

```java
public static UserDetailsImpl create(User user) {
    // Implementation details...
    return null;
}

public static UserDetailsImpl create(User user, UserRoleAssignmentMapper userRoleAssignmentMapper) {
    // Implementation details...
    return null;
}
```

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

### Get Current User - Java

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/user/controller/UserController

Retrieves the details of the currently authenticated user. This endpoint uses Spring Security's @AuthenticationPrincipal to get user details from the security context.

```java
@GetMapping("/me") public org.springframework.http.ResponseEntity<ApiResponse<UserResponse>> getCurrentUser(@AuthenticationPrincipal UserDetailsImpl userDetails)
Retrieves the currently authenticated user's information. 

Parameters:
    `userDetails` - the authenticated user from security context 

Returns:
    the current user's information
```

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

### POST /

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/user/controller/UserController

Creates a new user. Requires `users:create` permission.

```APIDOC
## POST /

### Description
Creates a new user. Requires `users:create` permission.

### Method
POST

### Endpoint
/

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **command** (CreateUserCommand) - Required - The user creation request containing username, email, password, mobile, and verification flag.

### Request Example
```json
{
  "username": "newuser",
  "email": "newuser@example.com",
  "password": "securepassword",
  "mobile": "9876543210",
  "verified": false
}
```

### Response
#### Success Response (201)
- **userResponse** (UserResponse) - The created user.

#### Response Example
```json
{
  "status": "SUCCESS",
  "data": {
    "id": 3,
    "username": "newuser",
    "email": "newuser@example.com",
    "mobile": "9876543210",
    "createdAt": "2023-01-03T12:00:00Z",
    "updatedAt": "2023-01-03T12:00:00Z"
  }
}
```
```

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

### RbacController: Get User Roles (Java)

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/rbac/controller/RbacController

Retrieves all roles assigned to a specific user using the `/api/v1/rbac/users/{id}/roles` GET endpoint. Requires `roles:read_all` permission. Returns a ResponseEntity with a list of RoleResponse objects.

```java
@GetMapping("/users/{id}/roles")
@PreAuthorize("hasPermission(null, 'roles:read_all')")
public org.springframework.http.ResponseEntity<ApiResponse<List<RoleResponse>>> getUserRoles(@PathVariable Long id)
Retrieves all roles assigned to a specific user. 

Parameters:
    `id` - The unique identifier of the user whose roles are to be retrieved. 

Returns:
    A `ResponseEntity` containing a list of `RoleResponse` objects, detailing each role assigned to the user.
```

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

### UserResponse Instance Methods (Java)

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/user/dto/UserResponse

Lists the concrete instance methods available for the UserResponse record. These methods include accessors for each record component (e.g., `id()`, `username()`), as well as standard methods like `equals()`, `hashCode()`, and `toString()`. These methods allow for interaction with and representation of the user data.

```java
`Instant`
`createdAt()`
Returns the value of the `createdAt` record component.
`String`
`email()`
Returns the value of the `email` record component.
`Boolean`
`emailVerified()`
Returns the value of the `emailVerified` record component.
`final boolean`
`equals(Object o)`
Indicates whether some other object is "equal to" this one.
`final int`
`hashCode()`
Returns a hash code value for this object.
`Long`
`id()`
Returns the value of the `id` record component.
`String`
`mobile()`
Returns the value of the `mobile` record component.
`Boolean`
`mobileVerified()`
Returns the value of the `mobileVerified` record component.
`final String`
`toString()`
Returns a string representation of this record class.
`Instant`
`updatedAt()`
Returns the value of the `updatedAt` record component.
`String`
`username()`
Returns the value of the `username` record component.
```

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

### Constructor for UserDetailsImpl with Role Mapper

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/auth/service/UserDetailsImpl

Initializes a new UserDetailsImpl instance, associating a User entity with role assignment logic via a UserRoleAssignmentMapper. This is crucial for setting up user authentication and authorization.

```java
public UserDetailsImpl(User user, UserRoleAssignmentMapper userRoleAssignmentMapper)
Constructs a new UserDetailsImpl instance. 

Parameters:
    `user` - The core `User` entity from the application's domain.     `userRoleAssignmentMapper` - The mapper to retrieve roles assigned to the user. 

Throws:
    `org.springframework.security.core.userdetails.UsernameNotFoundException` - if the provided user is null.
```

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

### Get Role by Name

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/rbac/entity/class-use/Role

Retrieves a specific role by its unique name.

```APIDOC
## GET /api/roles/{roleName}

### Description
Retrieves a specific role by its unique name.

### Method
GET

### Endpoint
/api/roles/{roleName}

### Parameters
#### Path Parameters
- **roleName** (string) - Required - The unique name of the role to retrieve.

### Response
#### Success Response (200)
- **roleName** (string) - The name of the role.
- **permissions** (array) - A list of permissions associated with the role.

#### Response Example
```json
{
  "roleName": "admin",
  "permissions": ["read", "write", "delete"]
}
```
```

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

### Authentication Service - Send Welcome Email

Source: https://ldn-backend.pages.dev/index-all

Sends a welcome email to a user after successful verification.

```APIDOC
## POST /api/auth/send-welcome-email

### Description
Sends a welcome email to a user after their account has been successfully verified.

### Method
POST

### Endpoint
/api/auth/send-welcome-email

### Parameters
#### Request Body
- **user** (User) - Required - The user object for whom to send the welcome email.

### Request Example
```json
{
  "user": {
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "email": "user@example.com",
    "username": "johndoe"
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the welcome email has been sent.

#### Response Example
```json
{
  "message": "Welcome email sent successfully."
}
```
```

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

### SmsPurpose Enum Methods

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/notification/sms/class-use/SmsPurpose

Details on how to get and use SmsPurpose enum constants.

```APIDOC
## SmsPurpose Enum

### Description
Represents the purpose of an SMS message, used for various operations like verification and notifications.

### Methods

#### `static SmsPurpose valueOf(String name)`

##### Description
Returns the enum constant of this class with the specified name.

##### Method
`static SmsPurpose`

##### Parameters
- **name** (String) - Required - The name of the enum constant to return.

#### `static SmsPurpose[] values()`

##### Description
Returns an array containing the constants of this enum class, in the order they are declared.

##### Method
`static SmsPurpose[]`

##### Parameters
None
```

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

### Factory Method to Create UserDetailsImpl (With Roles)

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/auth/service/UserDetailsImpl

A static factory method to create a UserDetailsImpl instance with role assignment logic. This is the primary method for creating instances when full authentication and authorization are required, as it fetches user roles.

```java
public static UserDetailsImpl create(User user, UserRoleAssignmentMapper userRoleAssignmentMapper)
Factory method to create a UserDetailsImpl instance with role assignment logic. 
This is the primary way to create `UserDetailsImpl` when full authentication and authorization capabilities are required, as it fetches and assigns the user's roles. 

Parameters:
    `user` - The core `User` entity.     `userRoleAssignmentMapper` - The mapper to retrieve roles assigned to the user. 

Returns:
    A new `UserDetailsImpl` instance. 

Throws:
    `org.springframework.security.core.userdetails.UsernameNotFoundException` - if the provided user is null.
```

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

### Get Roles by User ID

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/rbac/entity/class-use/Role

Retrieves a list of roles assigned to a specific user.

```APIDOC
## GET /api/users/{userId}/roles

### Description
Retrieves a list of roles assigned to a specific user.

### Method
GET

### Endpoint
/api/users/{userId}/roles

### Parameters
#### Path Parameters
- **userId** (long) - Required - The ID of the user whose roles are to be retrieved.

### Response
#### Success Response (200)
- **roles** (array) - A list of role objects assigned to the user.
  - **roleName** (string) - The name of the role.
  - **permissions** (array) - A list of permissions associated with the role.

#### Response Example
```json
{
  "roles": [
    {
      "roleName": "editor",
      "permissions": ["read", "update"]
    }
  ]
}
```
```

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

### Constructor for RefreshTokenService

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/auth/service/RefreshTokenService

Initializes the RefreshTokenService with necessary dependencies. It requires a RefreshTokenMapper for data access and a UserService for user validation.

```java
public RefreshTokenService(RefreshTokenMapper refreshTokenMapper, UserService userService)
Constructs RefreshTokenService with required dependencies. 

Parameters:
    `refreshTokenMapper` - The `RefreshTokenMapper` data access mapper.     `userService` - The `UserService` for user-related operations, particularly for validating user existence.
```

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

### Create System Authentication Token (Java)

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/config/SecurityConfig

Creates a system authentication token for internal operations, such as event listeners and scheduled tasks. This allows background processes to execute actions with elevated privileges without requiring a user context.

```java
@Bean public org.springframework.security.core.Authentication systemAuthentication()
Creates a system authentication token for internal operations. This allows event listeners and scheduled tasks to perform actions that would normally require user authentication. 

Returns:
    Authentication token with system privileges
```

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

### Get User Email - UserDetailsImpl

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/auth/service/UserDetailsImpl

Retrieves the email address of the user. This method is a convenience getter within UserDetailsImpl.

```java
public String getEmail()
Returns the email address of the user. 

Returns:
    The user's email address.
```

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

### Create User Endpoint (Java)

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/user/controller/UserController

Endpoint for creating a new user. It accepts a CreateUserCommand and UserDetailsImpl (admin details) as input. This method supports creating pre-verified users by setting 'isVerified=true'. User creation is logged via UserAuditLogService.

```java
org.springframework.http.ResponseEntity<ApiResponse<UserResponse>> createUser(@Valid CreateUserCommand command, UserDetailsImpl adminDetails) {
    // Implementation to create user
}
```

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

### Initialize JwtService

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/auth/service/JwtService

Initializes the JWT service with configured secret key and properties. Requires JwtProperties for configuration.

```java
public JwtService(JwtProperties jwtProperties)
Initializes the JWT service with configured secret key and properties. 

Parameters:
    `jwtProperties` - The `JwtProperties` containing JWT configuration.
```

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

### Get Password - UserDetailsImpl

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/auth/service/UserDetailsImpl

Retrieves the hashed password for user authentication. This method implements the getPassword method from the UserDetails interface.

```java
public String getPassword()
Returns the password used to authenticate the user. 

Specified by:
    `getPassword` in interface `org.springframework.security.core.userdetails.UserDetails` 

Returns:
    The hashed password.
```

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

### Factory Method to Create UserDetailsImpl (No Roles)

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/auth/service/UserDetailsImpl

A static factory method to create a UserDetailsImpl instance without immediate role assignment. Useful for scenarios where roles are not needed initially or for testing purposes.

```java
public static UserDetailsImpl create(User user)
Factory method to create a UserDetailsImpl instance without role assignment logic. 
This variant is typically used in scenarios where roles are not immediately needed or for testing purposes. 

Parameters:
    `user` - The core `User` entity. 

Returns:
    A new `UserDetailsImpl` instance. 

Throws:
    `org.springframework.security.core.userdetails.UsernameNotFoundException` - if the provided user is null.
```

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

### POST /api/v1/auth/mobile/send-registration-sms

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/auth/controller/MobileAuthController

Sends an SMS verification code for mobile registration. This endpoint is used to start the mobile registration process.

```APIDOC
## POST /api/v1/auth/mobile/send-registration-sms

### Description
Sends an SMS verification code for mobile registration. This endpoint is used to start the mobile registration process.

### Method
POST

### Endpoint
/api/v1/auth/mobile/send-registration-sms

### Parameters
#### Query Parameters
None

#### Request Body
- **request** (SendCodeRequest) - Required - The request object containing the mobile number.

### Request Example
```json
{
  "mobileNumber": "+1234567890"
}
```

### Response
#### Success Response (200)
- **VerificationResponse** (object) - Contains information about the sent SMS code.
  - **message** (string) - A confirmation message.

#### Response Example
```json
{
  "status": "SUCCESS",
  "data": {
    "message": "Verification code sent successfully."
  }
}
```
```

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

### GET /api/users/{id}/roles

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/rbac/dto/class-use/RoleResponse

Retrieves all roles assigned to a specific user by their ID. This endpoint is available in both the controller and service layers.

```APIDOC
## GET /api/users/{id}/roles

### Description
Retrieves all roles assigned to a specific user.

### Method
GET

### Endpoint
/api/users/{id}/roles

### Parameters
#### Path Parameters
- **id** (Long) - Required - The unique identifier of the user.

### Request Example
(No request body for GET request)

### Response
#### Success Response (200)
- **ApiResponse<List<RoleResponse>>** - An object containing a list of RoleResponse objects representing the user's roles.

#### Response Example
```json
{
  "status": "success",
  "data": [
    {
      "roleId": 1,
      "roleName": "Admin"
    },
    {
      "roleId": 2,
      "roleName": "Editor"
    }
  ]
}
```
```

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

### UserResponse Constructor

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/user/dto/UserResponse

Creates an instance of the UserResponse record class. It takes all record components as parameters to initialize a new UserResponse object.

```java
public UserResponse(Long id, String username, String email, String mobile, Boolean emailVerified, Boolean mobileVerified, Instant createdAt, Instant updatedAt)
```

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

### Get User Identifier for JWT

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/user/entity/class-use/User

Determines the appropriate identifier for a user, which is typically used in token generation and validation.

```java
public String getIdentifier(User user) {
    // Implementation details...
    return null;
}
```

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

### User Details Factory Methods

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/auth/service/class-use/UserDetailsImpl

Factory methods for creating UserDetailsImpl instances, with and without role assignment logic.

```APIDOC
## UserDetailsImpl Factory Methods

### Description
Factory methods to create UserDetailsImpl instances. One method includes role assignment logic, while the other does not.

### Method
`static UserDetailsImpl`

### Endpoint
N/A (Factory methods)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "No direct request body for factory methods"
}
```

### Response
#### Success Response (200)
- **UserDetailsImpl** (object) - An instance of UserDetailsImpl.

#### Response Example
```json
{
  "example": "UserDetailsImpl object"
}
```
```

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

### Get RoleAuditLogs by User ID

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/rbac/entity/class-use/RoleAuditLog

Retrieves a list of RoleAuditLog entries associated with a specific user ID. Supports pagination through limit and offset parameters.

```APIDOC
## GET /websites/ldn-backend_pages_dev/tech.liandian.batterymarketplace.rbac.mapper/findByTargetUserId

### Description
Retrieves a list of RoleAuditLog entries associated with a specific user ID. Supports pagination through limit and offset parameters.

### Method
GET

### Endpoint
/websites/ldn-backend_pages_dev/tech.liandian.batterymarketplace.rbac.mapper/findByTargetUserId

### Parameters
#### Query Parameters
- **userId** (Long) - Required - The ID of the user to retrieve audit logs for.
- **limit** (int) - Optional - The maximum number of audit log entries to return.
- **offset** (int) - Optional - The number of audit log entries to skip before returning results.

### Request Example
```json
{
  "userId": 123,
  "limit": 10,
  "offset": 0
}
```

### Response
#### Success Response (200)
- **List<RoleAuditLog>** (List) - A list of RoleAuditLog objects.

#### Response Example
```json
{
  "auditLogs": [
    {
      "id": 1,
      "userId": 123,
      "action": "CREATE_USER",
      "timestamp": "2023-10-27T10:00:00Z"
    },
    {
      "id": 2,
      "userId": 123,
      "action": "UPDATE_PROFILE",
      "timestamp": "2023-10-27T10:05:00Z"
    }
  ]
}
```
```

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

### MyBatis-Plus Service Implementation in Java

Source: https://ldn-backend.pages.dev/overview-tree

Demonstrates the use of MyBatis-Plus's ServiceImpl for common CRUD operations. It extends ServiceImpl and implements a custom service interface, providing a base for data access logic.

```java
package tech.liandian.batterymarketplace.auth.service.impl;

import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import tech.liandian.batterymarketplace.auth.entity.RefreshToken;
import tech.liandian.batterymarketplace.auth.mapper.RefreshTokenMapper;
import tech.liandian.batterymarketplace.auth.service.RefreshTokenService;
import org.springframework.stereotype.Service;

@Service
public class RefreshTokenServiceImpl extends ServiceImpl<RefreshTokenMapper, RefreshToken> implements RefreshTokenService {
    // Service methods implementation
}

@Service
public class UserAuditLogServiceImpl extends ServiceImpl<UserAuditLogMapper, UserAuditLog> implements UserAuditLogService {
    // Service methods implementation
}

@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {
    // Service methods implementation
}
```

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

### Get User Identifier

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/auth/service/JwtService

Determines the appropriate identifier (mobile or email) for a user, prioritizing verified mobile numbers.

```java
public String getIdentifier(User user)
Determines the appropriate identifier for a user. 
The identifier is used in JWT tokens for user lookup during authentication. This method selects: 
      * Mobile number if the user has a verified mobile
      * Email otherwise (default for email-registered users)

Parameters:
    `user` - The `User` entity.

Returns:
    The identifier string (email or mobile number).
```

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

### AccountController Constructor

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/user/controller/AccountController

Constructs the AccountController with necessary service dependencies and configuration.

```java
public AccountController(UserService userService, SmsVerificationService smsVerificationService, EmailService emailService, org.springframework.security.crypto.password.PasswordEncoder passwordEncoder, @Value("${app.base-url:http://localhost:8088}") String baseUrl)
{
    // Constructor implementation details
}
```

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

### UserController Constructor - Java

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/user/controller/UserController

Initializes the UserController with necessary service dependencies. It requires instances of UserService for user-related operations and UserAuditLogService for logging administrative actions.

```java
public UserController(UserService userService, UserAuditLogService userAuditLogService)
Constructs UserController with required dependencies. 

Parameters:
    `userService` - the user service for user operations     `userAuditLogService` - the audit log service for tracking admin actions
```

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

### Get Username - UserDetailsImpl

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/auth/service/UserDetailsImpl

Retrieves the username used for authentication, typically an email address in this application. This method implements the getUsername method from the UserDetails interface.

```java
public String getUsername()
Returns the username used to authenticate the user. 

Specified by:
    `getUsername` in interface `org.springframework.security.core.userdetails.UserDetails` 

Returns:
    The username (email in this application).
```

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

### User Constructor (Java)

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/user/entity/User

Provides the default constructor for the User entity. This constructor initializes a new User object without any specific parameters.

```java
public User() {
}
```

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

### GET /{id}

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/user/controller/UserController

Retrieves a specific user by ID. Uses scope-based permissions: `users:read_own`, `users:read_all`.

```APIDOC
## GET /{id}

### Description
Retrieves a specific user by ID. Uses scope-based permissions: `users:read_own` - Allows reading own profile, `users:read_all` - Allows reading any profile.

### Method
GET

### Endpoint
`/{id}`

### Parameters
#### Path Parameters
- **id** (Long) - Required - The user ID.

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **userResponse** (UserResponse) - The user if found.

#### Response Example
```json
{
  "status": "SUCCESS",
  "data": {
    "id": 1,
    "username": "testuser",
    "email": "test@example.com",
    "mobile": "1234567890",
    "createdAt": "2023-01-01T10:00:00Z",
    "updatedAt": "2023-01-01T10:00:00Z"
  }
}
```
```

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

### Create User - Java

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/user/controller/UserController

Creates a new user with the provided details. This endpoint requires 'users:create' permission and validates the input command. It returns a 201 Created response on success or 400 Bad Request on failure.

```java
@PreAuthorize("hasPermission(null, 'users:create')") @PostMapping public org.springframework.http.ResponseEntity<ApiResponse<UserResponse>> createUser(@Valid @RequestBody @Valid CreateUserCommand command, @AuthenticationPrincipal UserDetailsImpl adminDetails)
Creates a new user. 
Requires `users:create` permission. 

Parameters:
    `command` - the user creation request containing username, email, password, mobile, and verification flag     `adminDetails` - the authenticated admin performing the action 

Returns:
    a 201 Created response with the created user if successful, or 400 Bad Request if creation fails
```

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

### GET /api/v1/rbac/users/{id}/roles

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/rbac/controller/RbacController

Retrieves all roles assigned to a specific user. Requires 'roles:read_all' permission.

```APIDOC
## GET /api/v1/rbac/users/{id}/roles

### Description
Retrieves all roles assigned to a specific user.

### Method
GET

### Endpoint
/api/v1/rbac/users/{id}/roles

### Parameters
#### Path Parameters
- **id** (Long) - Required - The unique identifier of the user whose roles are to be retrieved.

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **data** (List<RoleResponse>) - A list of RoleResponse objects, detailing each role assigned to the user.

#### Response Example
{
  "data": [
    {
      "roleName": "admin",
      "description": "Administrator role"
    },
    {
      "roleName": "editor",
      "description": "Content editor role"
    }
  ]
}
```

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

### Get Underlying User Entity - UserDetailsImpl

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/auth/service/UserDetailsImpl

Retrieves the core User entity associated with this UserDetailsImpl instance. This method provides access to the domain-specific User object.

```java
public User getUser()
Returns the underlying `User` entity. 

Returns:
    The `User` entity.
```

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

### Logging User Creation (Java)

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/user/service/impl/UserAuditLogServiceImpl

The logUserCreation method is responsible for recording events related to user account creation. It takes the user object and the admin who performed the action as parameters.

```java
public void logUserCreation(User user, User admin) {
  // Logs a user creation event.
  // Parameters: user - the newly created user (email/mobile captured for audit)
  //             admin - the admin who created the user (null if system-created)
}
```

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

### Get Authorities - UserDetailsImpl

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/auth/service/UserDetailsImpl

Retrieves the collection of authorities (roles) granted to the user. This method implements the getAuthorities method from the UserDetails interface and returns GrantedAuthority objects.

```java
public Collection<? extends org.springframework.security.core.GrantedAuthority> getAuthorities()
Returns the authorities granted to the user. 

Specified by:
    `getAuthorities` in interface `org.springframework.security.core.userdetails.UserDetails` 

Returns:
    A collection of `GrantedAuthority` objects representing the user's roles.
```

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

### User Controller Constructor (Java)

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/user/controller/UserController

The constructor for UserController. It initializes the controller with its required dependencies: UserService for business logic related to users and UserAuditLogService for logging user-related audit events.

```java
UserController(UserService userService, UserAuditLogService userAuditLogService) {
    // Initialization logic
}
```

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

### UserResponse Constructor (Java)

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/user/dto/UserResponse

Provides the constructor signature for the UserResponse record. This constructor is used to create new instances of the UserResponse record, initializing all its components with the provided values. It ensures that all necessary user data is present upon instantiation.

```java
UserResponse(Long id, String username, String email, String mobile, Boolean emailVerified, Boolean mobileVerified, Instant createdAt, Instant updatedAt)
```

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

### Get User ID - UserDetailsImpl

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/auth/service/UserDetailsImpl

Retrieves the unique identifier for the user. This method is part of the UserDetailsImpl class and returns a Long representing the user's ID.

```java
public Long getId()
Returns the unique ID of the user. 

Returns:
    The user's ID.
```

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

### Get All Permissions

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/rbac/service/PermissionService

Retrieves a list of all available permissions in the system. This method provides a complete overview of all possible access rights.

```java
public List<Permission> getAllPermissions()
```

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

### Register New User Account

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/user/entity/class-use/User

Provides functionality to register a new user account. This method takes a registration request object as input and returns the newly created User entity.

```java
public User registerUser(RegisterRequest request) {
    // Implementation details...
    return null;
}
```

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

### Get Client Identifier (Java)

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/auth/filter/RateLimiter

Extracts the client identifier from an incoming HttpServletRequest. This is crucial for identifying unique clients for rate limiting.

```java
String getClientId(jakarta.servlet.http.HttpServletRequest request)
```

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

### Get Token String from RefreshToken (Java)

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/auth/entity/RefreshToken

Retrieves the refresh token string itself. This method returns the token as a String, which can be used for authentication purposes.

```java
public String getToken() {
    return token;
}
```

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

### SecurityConfig Constructor

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/config/SecurityConfig

Constructs the SecurityConfig with required dependencies for user details, JWT authentication, and permission evaluation.

```APIDOC
## SecurityConfig Constructor

### Description
Constructs the SecurityConfig with required dependencies.

### Method
CONSTRUCTOR

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
None

### Constructor Details
* **SecurityConfig** (`userDetailsService`, `jwtAuthenticationFilter`, `permissionEvaluator`)
  * `userDetailsService` (CustomUserDetailsService) - Custom implementation of `CustomUserDetailsService` for loading user-specific data.
  * `jwtAuthenticationFilter` (JwtAuthenticationFilter) - The `JwtAuthenticationFilter` for processing JWT tokens from requests.
  * `permissionEvaluator` (CustomPermissionEvaluator) - The `CustomPermissionEvaluator` for handling fine-grained permission checks.
```

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

### Register User - Java

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/auth/service/AuthService

Registers a new user by validating input, generating a verification token, saving user data (delegating password encoding), assigning a default role, and sending a verification email. Throws exceptions for existing emails or missing roles.

```java
@Transactional public User registerUser(RegisterRequest request)
Registers a new user account based on the provided registration request. 
This method performs several steps: 
      * Validates the uniqueness of the username and email.
      * Generates a unique email verification token with a 24-hour validity period.
      * Saves the new user entity (password encoding is handled by `UserService`).
      * Assigns the default 'USER' role to the new user.
      * Sends an email verification link to the user. 

Parameters:
    `request` - The `RegisterRequest` containing the user's email and password. 

Returns:
    The newly created `User` entity (with email not yet verified). 

Throws:
    `EmailVerificationException` - if the email already exists.     `IllegalStateException` - if the default 'USER' role is not found.
```

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

### Get Expiry Date from RefreshToken (Java)

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/auth/entity/RefreshToken

Retrieves the expiry date and time of the refresh token. This method returns an Instant object representing when the token will expire.

```java
public Instant getExpiryDate() {
    return expiryDate;
}
```

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

### Get Role by Name

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/rbac/service/PermissionService

Finds and returns a specific role entity based on its unique name. Returns null if no role matches the provided name.

```java
public Role getRoleByName(String roleName)
```

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

### POST /email/verify

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/user/controller/AccountController

Completes adding an email address by verifying the provided email verification token.

```APIDOC
## POST /email/verify

### Description
Completes adding an email address by verifying the email token. This endpoint verifies the token and marks the email as verified. After verification, the user can login with either mobile/SMS or email/password.

### Method
POST

### Endpoint
/email/verify

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **request** (VerifyEmailRequest) - Required - The request containing the verification token.
- **userDetails** (UserDetailsImpl) - Required - The authenticated user.

### Request Example
```json
{
  "verificationToken": "a1b2c3d4e5f6"
}
```

### Response
#### Success Response (200)
- **ApiResponse<EmailVerificationResponse>** - Response with verification status.

#### Response Example
```json
{
  "status": "SUCCESS",
  "data": {
    "isVerified": true,
    "message": "Email verified successfully."
  }
}
```
```

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

### Get All Roles

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/rbac/service/PermissionService

Retrieves a comprehensive list of all roles defined within the system. This method is useful for administrative tasks and understanding the available role structures.

```java
public List<Role> getAllRoles()
```

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

### MyBatisConfig.sqlSessionFactory

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/config/class-use/MyBatisMetaObjectHandler

This method configures and initializes the SqlSessionFactory for MyBatis-Plus, incorporating the MyBatisMetaObjectHandler and MybatisPlusInterceptor.

```APIDOC
## POST /websites/ldn-backend_pages_dev/MyBatisConfig

### Description
Configures and creates the `SqlSessionFactory` for MyBatis-Plus, integrating the `MyBatisMetaObjectHandler` and `MybatisPlusInterceptor`.

### Method
POST

### Endpoint
/websites/ldn-backend_pages_dev/MyBatisConfig

### Parameters
#### Query Parameters
- **dataSource** (DataSource) - Required - The data source to be used by MyBatis.
- **metaObjectHandler** (MyBatisMetaObjectHandler) - Required - The MyBatisMetaObjectHandler instance for custom field population.
- **mybatisPlusInterceptor** (com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor) - Required - The MybatisPlusInterceptor for MyBatis-Plus features.

### Request Example
```json
{
  "dataSource": "<DataSource Object>",
  "metaObjectHandler": "<MyBatisMetaObjectHandler Object>",
  "mybatisPlusInterceptor": "<MybatisPlusInterceptor Object>"
}
```

### Response
#### Success Response (200)
- **sqlSessionFactory** (org.apache.ibatis.session.SqlSessionFactory) - The configured SqlSessionFactory instance.

#### Response Example
```json
{
  "sqlSessionFactory": "<SqlSessionFactory Object>"
}
```
```

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

### Spring Security Configuration in Java

Source: https://ldn-backend.pages.dev/overview-tree

Configures security aspects of the application, likely involving authentication and authorization. This snippet shows a typical SecurityConfig class setup.

```java
package tech.liandian.batterymarketplace.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.authentication.AuthenticationManager;
import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
import tech.liandian.batterymarketplace.auth.service.UserDetailsServiceImpl;

@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {

    private final UserDetailsServiceImpl userDetailsService;

    public SecurityConfig(UserDetailsServiceImpl userDetailsService) {
        this.userDetailsService = userDetailsService;
    }

    @Override
    protected void configure(AuthenticationManagerBuilder auth) throws Exception {
        auth.userDetailsService(userDetailsService);
    }

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http.authorizeRequests()
            .antMatchers("/api/auth/**").permitAll()
            .anyRequest().authenticated()
            .and()
            .formLogin()
            .and()
            .csrf().disable();
    }

    @Bean
    @Override
    public AuthenticationManager authenticationManagerBean() throws Exception {
        return super.authenticationManagerBean();
    }
}
```

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

### Construct UserDetailsImpl Object

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/user/entity/class-use/User

Constructor for the UserDetailsImpl class, allowing for the creation of instances with or without role assignment logic.

```java
public UserDetailsImpl(User user, UserRoleAssignmentMapper userRoleAssignmentMapper) {
    // Implementation details...
}
```

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

### Initialize MailgunEmailService (Java)

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/notification/email/MailgunEmailService

Initializes the Mailgun email service with provided API key, domain, and sender email address. These values are typically injected from application properties.

```java
public MailgunEmailService(@Value("${mailgun.api-key}") String apiKey, @Value("${mailgun.domain}") String domain, @Value("${mailgun.from-email}") String fromEmail) {
    // Initialization logic here
}
```

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

### AssignRoleRequest Java Class Definition

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/rbac/dto/AssignRoleRequest

Defines the AssignRoleRequest DTO, used for requesting role assignments. It includes methods to get and set the role name, with validation for the role name.

```java
public class AssignRoleRequest extends Object {
    public AssignRoleRequest() {
    }

    public String getRoleName() {
        return null;
    }

    public void setRoleName(String roleName) {
    }
}
```

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

### SystemOperationService.SupplierWithException<T> Interface

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/common/service/SystemOperationService

Documentation for the SupplierWithException functional interface, detailing its purpose, type parameters, and methods.

```APIDOC
## SystemOperationService.SupplierWithException<T>

### Description
Functional interface for operations that return a value and may throw exceptions. This interface is intended to be used as the assignment target for lambda expressions or method references.

### Type Parameters
* `T` - The type of result returned by the operation.

### Methods
#### get
* **Method:** `get()`
* **Description:** Executes the operation and returns a result.
* **Returns:** The result of the operation.
* **Throws:** `Exception` - if the operation fails.

### Request Example
```java
// Example usage with a lambda expression
SystemOperationService.SupplierWithException<String> stringSupplier = () -> {
    // Operation that returns a String and might throw an exception
    if (Math.random() > 0.5) {
        return "Success!";
    } else {
        throw new Exception("Operation failed randomly.");
    }
};

try {
    String result = stringSupplier.get();
    System.out.println("Result: " + result);
} catch (Exception e) {
    System.err.println("Error: " + e.getMessage());
}
```

### Response Example
```json
{
  "example": "Success!"
}
```

### Error Handling
* **Exception:** `Exception` - Thrown if the operation fails during execution.
```

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

### Get Reset Time (Java)

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/auth/filter/RateLimiter

Calculates the remaining time until the current rate limit window resets for a specific client. Supports custom actions and window durations.

```java
long getResetTime(String clientId)
long getResetTime(String clientId, String action, Duration window)
long getResetTime(String clientId, Duration window)
```

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

### Get Current User Endpoint (Java)

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/user/controller/UserController

Retrieves the information of the currently authenticated user. It uses UserDetailsImpl to identify the current user and returns their details wrapped in ApiResponse.

```java
org.springframework.http.ResponseEntity<ApiResponse<UserResponse>> getCurrentUser(UserDetailsImpl userDetails) {
    // Implementation to get current user
}
```

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

### Send Email Notifications to User

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/user/entity/class-use/User

Handles sending verification and welcome emails to users. These methods require the User object and relevant tokens or information.

```java
public void sendVerificationEmail(User user, String verificationToken) {
    // Implementation details...
}

public void sendWelcomeEmail(User user) {
    // Implementation details...
}
```

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

### Get Reset Time (Client and Action)

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/auth/filter/RateLimiter

Retrieves the remaining time until the current rate limit window resets for a specific client and action. This is useful for informing clients when they can retry.

```java
public long getResetTime(String clientId, String action, Duration window)
```

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

### AuthService Constructor - Java

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/auth/service/AuthService

Initializes the AuthService with necessary dependencies: UserService for user data management, EmailAuthService for sending emails, and RoleService for assigning roles.

```java
public AuthService(UserService userService, EmailAuthService emailAuthService, RoleService roleService)
Initializes the authentication service with its required dependencies.
```

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

### Get Current Request Count (Java)

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/auth/filter/RateLimiter

Retrieves the current request count for a client within the current rate limiting window. Supports custom actions and window durations.

```java
long getCurrentCount(String clientId)
long getCurrentCount(String clientId, String action, Duration window)
long getCurrentCount(String clientId, Duration window)
```

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

### Send SMS Verification Code (Java)

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/notification/sms/SmsService

Example of sending an SMS verification code using the SmsService interface. It demonstrates dependency injection of the SmsService and calling the sendVerificationCode method with necessary parameters.

```java
@Autowired
private SmsService smsService;

public void sendCode(String mobile, String code) {
    smsService.sendVerificationCode(mobile, code, SmsTemplate.LOGIN);
}

```

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

### Email Management (Java)

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/user/entity/User

Methods for retrieving and setting the email address of a User. getEmail() returns the current email, while setEmail(String email) updates it.

```java
public String getEmail() {
    // ... implementation
}

public void setEmail(String email) {
    // ... implementation
}
```

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

### Get Permissions for a Role

Source: https://ldn-backend.pages.dev/tech/liandian/batterymarketplace/rbac/service/PermissionService

Fetches all permission names associated with a specific role ID. It employs a batch query strategy to optimize performance and prevent the N+1 query problem.

```java
public Set<String> getPermissionsForRole(Long roleId)
```
Tokens:
Raw