AS AgentScopeAPI 手册 / API Reference

JpaUserStore

@Transactional public class JpaUserStore implements UserStore
源码Source io/agentscope/builder/web/persistence/jpa/JpaUserStore.java:43–186

JPA 用户存储,负责持久化与读取数据。位于 io.agentscope.builder.web.persistence.jpa 包,实现 UserStore。核心成员包括 passwordEncoder、findById、findByUsername、listAll、createUser、verifyPassword。

JPA-backed UserStore. This is the only UserStore implementation shipped with the builder; it is always wired in by JpaPersistenceConfig.

On first start, if the builder_user table is empty, a default admin/admin user is seeded so an operator can sign in immediately after pointing the builder at a fresh database. The seeded password is logged with a "change immediately" warning, matching the file-mode behavior.

Wired through io.agentscope.builder.web.persistence.jpa.JpaPersistenceConfig; declared as a plain @Service-flavored Spring bean (annotated via the configuration class rather than @Component so the JPA backend stays inert when the configuration does not load).

构造器摘要Constructor Summary

构造器Constructor说明Description
public JpaUserStore(UserEntityRepository repository)
初始化 `JpaUserStore` 实例。
Creates a new instance.
public JpaUserStore(UserEntityRepository repository, boolean seedUsers)
初始化 `JpaUserStore` 实例。
Creates a new instance.

方法摘要Method Summary

方法Method说明Description
public PasswordEncoder passwordEncoder()
返回 `passwordEncoder` 结果。
Returns the password encoder.
public Optional<UserRecord> findById(String userId)
查找通过标识。
Finds the by id.
public Optional<UserRecord> findByUsername(String username)
查找 `findByUsername`。
Finds the by username.
public List<UserRecord> listAll()
列出所有。
Lists the all.
public UserRecord createUser(String userId, String username, String password, List<String> roles)
创建用户。
Creates the user.
public boolean verifyPassword(UserRecord user, String rawPassword)
执行 `verifyPassword` 方法。
Performs the verify password operation.
public Optional<UserRecord> updatePassword(String userId, String newPassword)
更新密码。
Updates the password.
public Optional<UserRecord> updateRoles(String userId, List<String> newRoles)
更新 `updateRoles`。
Updates the roles.
public boolean deleteUser(String userId)
删除用户。
Deletes the user.

构造器详情Constructor Detail

JpaUserStore

public JpaUserStore(UserEntityRepository repository)

初始化 JpaUserStore 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
repositoryUserEntityRepository仓库(类型 `UserEntityRepository`)。The repository.
源码Source io/agentscope/builder/web/persistence/jpa/JpaUserStore.java:52–54

JpaUserStore

public JpaUserStore(UserEntityRepository repository, boolean seedUsers)

初始化 JpaUserStore 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
repositoryUserEntityRepository仓库(类型 `UserEntityRepository`)。The repository.
seedUsersboolean预置用户(类型 `boolean`)。The seed users.
源码Source io/agentscope/builder/web/persistence/jpa/JpaUserStore.java:56–59

方法详情Method Detail

passwordEncoder

public PasswordEncoder passwordEncoder()

返回 passwordEncoder 结果。

Returns the password encoder.

返回Returns PasswordEncoder
返回PasswordEncoder。Returns password encoder.
源码Source io/agentscope/builder/web/persistence/jpa/JpaUserStore.java:79–82

findById

public Optional<UserRecord> findById(String userId)

查找通过标识。

Finds the by id.

参数Parameters
名称Name类型Type说明Description
userIdString用户标识(类型 `String`)。The user id.
返回Returns Optional<UserRecord>
返回可选。Returns optional.
源码Source io/agentscope/builder/web/persistence/jpa/JpaUserStore.java:84–88

findByUsername

public Optional<UserRecord> findByUsername(String username)

查找 findByUsername。

Finds the by username.

参数Parameters
名称Name类型Type说明Description
usernameStringusername(类型 `String`)。The username.
返回Returns Optional<UserRecord>
返回可选。Returns optional.
源码Source io/agentscope/builder/web/persistence/jpa/JpaUserStore.java:90–95

listAll

public List<UserRecord> listAll()

列出所有。

Lists the all.

返回Returns List<UserRecord>
返回列出。Returns list.
源码Source io/agentscope/builder/web/persistence/jpa/JpaUserStore.java:97–101

createUser

public UserRecord createUser(String userId, String username, String password, List<String> roles)

创建用户。

Creates the user.

参数Parameters
名称Name类型Type说明Description
userIdString用户标识(类型 `String`)。The user id.
usernameStringusername(类型 `String`)。The username.
passwordString密码(类型 `String`)。The password.
rolesList<String>roles(类型 `List`)。The roles.
返回Returns UserRecord
返回UserRecord。Returns user record.
源码Source io/agentscope/builder/web/persistence/jpa/JpaUserStore.java:103–118

verifyPassword

public boolean verifyPassword(UserRecord user, String rawPassword)

执行 verifyPassword 方法。

Performs the verify password operation.

参数Parameters
名称Name类型Type说明Description
userUserRecord用户(类型 `UserRecord`)。The user.
rawPasswordString原始密码(类型 `String`)。The raw password.
返回Returns boolean
返回布尔值,表示判断结果。Returns a boolean result.
源码Source io/agentscope/builder/web/persistence/jpa/JpaUserStore.java:120–123

updatePassword

public Optional<UserRecord> updatePassword(String userId, String newPassword)

更新密码。

Updates the password.

参数Parameters
名称Name类型Type说明Description
userIdString用户标识(类型 `String`)。The user id.
newPasswordString新建密码(类型 `String`)。The new password.
返回Returns Optional<UserRecord>
返回可选。Returns optional.
源码Source io/agentscope/builder/web/persistence/jpa/JpaUserStore.java:125–136

updateRoles

public Optional<UserRecord> updateRoles(String userId, List<String> newRoles)

更新 updateRoles。

Updates the roles.

参数Parameters
名称Name类型Type说明Description
userIdString用户标识(类型 `String`)。The user id.
newRolesList<String>新建 Roles(类型 `List`)。The new roles.
返回Returns Optional<UserRecord>
返回可选。Returns optional.
源码Source io/agentscope/builder/web/persistence/jpa/JpaUserStore.java:138–147

deleteUser

public boolean deleteUser(String userId)

删除用户。

Deletes the user.

参数Parameters
名称Name类型Type说明Description
userIdString用户标识(类型 `String`)。The user id.
返回Returns boolean
返回布尔值,表示判断结果。Returns a boolean result.
源码Source io/agentscope/builder/web/persistence/jpa/JpaUserStore.java:149–162
基于官方固定版本源码静态生成Generated from pinned official sources · Python 2.0.11 · Java 2.0.4
签名与文档为静态抽取;如有疑问请以源码为准。Signatures and docs are extracted statically; verify against the source when in doubt.