程序包 org.ssssssss.magicapi.core.web

类 MagicWorkbenchController

java.lang.Object

org.ssssssss.magicapi.core.web.MagicController

org.ssssssss.magicapi.core.web.MagicWorkbenchController

所有已实现的接口:

JsonCodeConstants, MagicExceptionHandler

public class MagicWorkbenchController
extends MagicController
implements MagicExceptionHandler

字段概要

字段

修饰符和类型	字段	说明
private String	allClassTxt
private static final org.slf4j.Logger	logger
private static final Pattern	MULTI_LINE_COMMENT_TODO
private final List<Plugin>	plugins
private final MagicAPIProperties	properties
private final String	secretKey
private static final Pattern	SINGLE_LINE_COMMENT_TODO

从类继承的字段 org.ssssssss.magicapi.core.web.MagicController

configuration, magicAPIService, magicBackupService

从接口继承的字段 org.ssssssss.magicapi.core.config.JsonCodeConstants

API_NOT_FOUND, BACKUP_NOT_ENABLED, BODY_INVALID, CRON_ID_REQUIRED, DATASOURCE_KEY_INVALID, DS_KEY_CONFLICT, DS_KEY_REQUIRED, DS_URL_REQUIRED, FILE_IS_REQUIRED, FILE_NOT_FOUND, FILE_PATH_NOT_EXISTS, FILE_SAVE_FAILURE, FUNCTION_PATH_REQUIRED, GROUP_ID_REQUIRED, GROUP_NOT_FOUND, HEADER_INVALID, IS_READ_ONLY, MOVE_NAME_CONFLICT, MOVE_PATH_CONFLICT, NAME_INVALID, NAME_REQUIRED, NOT_SUPPORTED_GROUP_TYPE, PARAMETER_INVALID, PATH_CONFLICT, PATH_REQUIRED, PATH_VARIABLE_INVALID, PERMISSION_INVALID, REQUEST_METHOD_REQUIRED, REQUEST_PATH_CONFLICT, REQUEST_PATH_REQUIRED, RESOURCE_LOCKED, RESOURCE_PATH_CONFLICT, SAVE_GROUP_PATH_CONFLICT, SCRIPT_REQUIRED, SECRET_KEY_IS_REQUIRED, SIGN_IS_INVALID, SRC_GROUP_CONFLICT, SUCCESS, TARGET_IS_REQUIRED, TOPIC_ID_REQUIRED, TOPIC_TAG_REPEAT

构造器概要

构造器

构造器	说明
MagicWorkbenchController(MagicConfiguration configuration, MagicAPIProperties properties, List<Plugin> plugins)

方法概要

修饰符和类型	方法	说明
JsonBean<Map<String,Object>>	classes()	获取所有class
JsonBean<Set<org.ssssssss.script.ScriptClass>>	clazz(String className)	获取单个class
void	configJs(MagicHttpServletResponse response)
void	download(String groupId, List<SelectedResource> resources, MagicHttpServletRequest request, MagicHttpServletResponse response)
JsonBean<Boolean>	login(String username, String password, MagicHttpServletRequest request, MagicHttpServletResponse response)	登录
JsonBean<Void>	logout(MagicHttpServletRequest request)
JsonBean<List<List<String>>>	options()
JsonBean<List<Plugin>>	plugins()
JsonBean<?>	push(String target, String secretKey, String mode, List<SelectedResource> resources, MagicHttpServletRequest request)
private String	readClass()
MagicAPIProperties	readConfig()
JsonBean<Void>	receivePush(org.springframework.web.multipart.MultipartFile file, String mode, Long timestamp, String sign)
String	redirectIndex(MagicHttpServletRequest request)
JsonBean<Boolean>	reload(MagicHttpServletRequest request)
JsonBean<List<Map<String,Object>>>	search(String keyword, MagicHttpServletRequest request)
JsonBean<List<Map<String,Object>>>	todo(MagicHttpServletRequest request)
JsonBean<Boolean>	upload(org.springframework.web.multipart.MultipartFile file, String mode, MagicHttpServletRequest request)
JsonBean<MagicUser>	user(MagicHttpServletRequest request)

从类继承的方法 org.ssssssss.magicapi.core.web.MagicController

allowVisit, allowVisit, allowVisit, doValid, entities, invalidLogin

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.ssssssss.magicapi.core.config.JsonCodeConstants

isTrue, notBlank, notNull

从接口继承的方法 org.ssssssss.magicapi.core.web.MagicExceptionHandler

exceptionHandler, exceptionHandler

字段详细资料

logger

private static final org.slf4j.Logger logger

SINGLE_LINE_COMMENT_TODO

private static final Pattern SINGLE_LINE_COMMENT_TODO

MULTI_LINE_COMMENT_TODO

private static final Pattern MULTI_LINE_COMMENT_TODO

secretKey

private final String secretKey

plugins

private final List<Plugin> plugins

properties

private final MagicAPIProperties properties

allClassTxt

private String allClassTxt

构造器详细资料

MagicWorkbenchController

public MagicWorkbenchController(MagicConfiguration configuration,
 MagicAPIProperties properties,
 List<Plugin> plugins)

方法详细资料

redirectIndex

@GetMapping({"","/"})
@Valid(requireLogin=false)
public String redirectIndex(MagicHttpServletRequest request)

readConfig

@GetMapping("/config.json")
@Valid(requireLogin=false)
@ResponseBody
public MagicAPIProperties readConfig()

readClass

@GetMapping(value="/classes.txt",
            produces="text/plain")
@ResponseBody
@Valid(requireLogin=false)
private String readClass()

classes

@PostMapping("/classes")
@ResponseBody
@Valid(requireLogin=false)
public JsonBean<Map<String,Object>> classes()

获取所有class

clazz

@PostMapping("/class")
@ResponseBody
public JsonBean<Set<org.ssssssss.script.ScriptClass>> clazz(String className)

获取单个class

参数:

className - 类名

login

@PostMapping("/login")
@ResponseBody
@Valid(requireLogin=false)
public JsonBean<Boolean> login(String username,
 String password,
 MagicHttpServletRequest request,
 MagicHttpServletResponse response)
                        throws MagicLoginException

登录

抛出:

MagicLoginException

user

@PostMapping("/user")
@ResponseBody
public JsonBean<MagicUser> user(MagicHttpServletRequest request)

logout

@PostMapping("/logout")
@ResponseBody
@Valid(requireLogin=false)
public JsonBean<Void> logout(MagicHttpServletRequest request)

plugins

@GetMapping("/plugins")
@Valid(requireLogin=false)
@ResponseBody
public JsonBean<List<Plugin>> plugins()

options

@RequestMapping("/options")
@ResponseBody
@Valid(requireLogin=false)
public JsonBean<List<List<String>>> options()

reload

@GetMapping("/reload")
@ResponseBody
public JsonBean<Boolean> reload(MagicHttpServletRequest request)

search

@GetMapping("/search")
@ResponseBody
public JsonBean<List<Map<String,Object>>> search(String keyword,
 MagicHttpServletRequest request)

todo

@GetMapping("/todo")
@ResponseBody
@Valid
public JsonBean<List<Map<String,Object>>> todo(MagicHttpServletRequest request)

configJs

@RequestMapping("/config-js")
@Valid(requireLogin=false)
public void configJs(MagicHttpServletResponse response)
              throws IOException

抛出:

IOException

download

@RequestMapping("/download")
@Valid(authorization=DOWNLOAD)
public void download(String groupId,
 @RequestBody(required=false)
 List<SelectedResource> resources,
 MagicHttpServletRequest request,
 MagicHttpServletResponse response)
              throws IOException

抛出:

IOException

upload

@RequestMapping("/upload")
@Valid(readonly=false,
       authorization=UPLOAD)
@ResponseBody
public JsonBean<Boolean> upload(org.springframework.web.multipart.MultipartFile file,
 String mode,
 MagicHttpServletRequest request)
                         throws IOException

抛出:

IOException

push

@RequestMapping("/push")
@ResponseBody
@Valid(authorization=PUSH)
public JsonBean<?> push(@RequestHeader("magic-push-target")
 String target,
 @RequestHeader("magic-push-secret-key")
 String secretKey,
 @RequestHeader("magic-push-mode")
 String mode,
 @RequestBody
 List<SelectedResource> resources,
 MagicHttpServletRequest request)

receivePush

@ResponseBody
@Valid(requireLogin=false)
public JsonBean<Void> receivePush(org.springframework.web.multipart.MultipartFile file,
 String mode,
 Long timestamp,
 String sign)
                           throws IOException

抛出:

IOException