com.magicapi.gitsync

Class GitSyncResource

java.lang.Object

org.ssssssss.magicapi.core.resource.FileResource

com.magicapi.gitsync.GitSyncResource

All Implemented Interfaces:

org.ssssssss.magicapi.core.resource.Resource

public class GitSyncResource
extends org.ssssssss.magicapi.core.resource.FileResource

增强版 Git 存储资源，顶替官方 magic-api-plugin-git 的 GitResource （官方 magicGitResource Bean 带 @ConditionalOnMissingBean，本插件先注册即自动替换）。

与官方行为的差异：

1. 保存/删除/重命名后是否自动提交推送由 magic-api.git-sync.auto-commit 控制（官方固定每次保存都提交推送）
2. 提交与推送使用触发操作的编辑器登录用户对应的个人凭证（官方固定用全局账号）

Field Summary

Fields inherited from class org.ssssssss.magicapi.core.resource.FileResource

file, rootPath

Constructor Summary

Constructors

Constructor and Description
GitSyncResource(boolean readonly, File file, String rootPath, GitRepoHelper helper, MagicGitSyncProperties syncProperties)

Method Summary

Modifier and Type	Method and Description
boolean	delete()
List<org.ssssssss.magicapi.core.resource.Resource>	dirs()
List<org.ssssssss.magicapi.core.resource.Resource>	files(String suffix)
org.ssssssss.magicapi.core.resource.Resource	getDirectory(String name)
org.ssssssss.magicapi.core.resource.Resource	getResource(String name)
boolean	mkdir()
static GitSyncResource	of(boolean readonly, GitRepoHelper helper, MagicGitSyncProperties syncProperties) 构建工作区资源：确保本地仓库已克隆，并在启动时拉取一次远程最新代码
org.ssssssss.magicapi.core.resource.Resource	parent()
boolean	renameTo(org.ssssssss.magicapi.core.resource.Resource resource)
List<org.ssssssss.magicapi.core.resource.Resource>	resources()
boolean	write(byte[] content)
boolean	write(String content)

Methods inherited from class org.ssssssss.magicapi.core.resource.FileResource

exists, getAbsolutePath, getFilePath, isDirectory, name, processExport, read, readonly, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ssssssss.magicapi.core.resource.Resource

export, readAll, separator

Constructor Detail

GitSyncResource

public GitSyncResource(boolean readonly,
                       File file,
                       String rootPath,
                       GitRepoHelper helper,
                       MagicGitSyncProperties syncProperties)

Method Detail

of

public static GitSyncResource of(boolean readonly,
                                 GitRepoHelper helper,
                                 MagicGitSyncProperties syncProperties)
                          throws Exception

构建工作区资源：确保本地仓库已克隆，并在启动时拉取一次远程最新代码

Throws:

Exception

write

public boolean write(byte[] content)

Specified by:

write in interface org.ssssssss.magicapi.core.resource.Resource

Overrides:

write in class org.ssssssss.magicapi.core.resource.FileResource

write

public boolean write(String content)

Specified by:

write in interface org.ssssssss.magicapi.core.resource.Resource

Overrides:

write in class org.ssssssss.magicapi.core.resource.FileResource

delete

public boolean delete()

Specified by:

delete in interface org.ssssssss.magicapi.core.resource.Resource

Overrides:

delete in class org.ssssssss.magicapi.core.resource.FileResource

mkdir

public boolean mkdir()

Specified by:

mkdir in interface org.ssssssss.magicapi.core.resource.Resource

Overrides:

mkdir in class org.ssssssss.magicapi.core.resource.FileResource

renameTo

public boolean renameTo(org.ssssssss.magicapi.core.resource.Resource resource)

Specified by:

renameTo in interface org.ssssssss.magicapi.core.resource.Resource

Overrides:

renameTo in class org.ssssssss.magicapi.core.resource.FileResource

getResource

public org.ssssssss.magicapi.core.resource.Resource getResource(String name)

Specified by:

getResource in interface org.ssssssss.magicapi.core.resource.Resource

Overrides:

getResource in class org.ssssssss.magicapi.core.resource.FileResource

getDirectory

public org.ssssssss.magicapi.core.resource.Resource getDirectory(String name)

parent

public org.ssssssss.magicapi.core.resource.Resource parent()

Specified by:

parent in interface org.ssssssss.magicapi.core.resource.Resource

Overrides:

parent in class org.ssssssss.magicapi.core.resource.FileResource

resources

public List<org.ssssssss.magicapi.core.resource.Resource> resources()

Specified by:

resources in interface org.ssssssss.magicapi.core.resource.Resource

Overrides:

resources in class org.ssssssss.magicapi.core.resource.FileResource

dirs

public List<org.ssssssss.magicapi.core.resource.Resource> dirs()

Specified by:

dirs in interface org.ssssssss.magicapi.core.resource.Resource

Overrides:

dirs in class org.ssssssss.magicapi.core.resource.FileResource

files

public List<org.ssssssss.magicapi.core.resource.Resource> files(String suffix)

Specified by:

files in interface org.ssssssss.magicapi.core.resource.Resource

Overrides:

files in class org.ssssssss.magicapi.core.resource.FileResource