org.ssssssss.magicapi.controller

类 MagicWorkbenchController

java.lang.Object

org.ssssssss.magicapi.controller.MagicController

org.ssssssss.magicapi.controller.MagicWorkbenchController

所有已实现的接口:

MagicExceptionHandler, JsonCodeConstants

public class MagicWorkbenchController
extends MagicController
implements MagicExceptionHandler

UI上其它相关操作

作者:

mxd

字段概要

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

API_ALREADY_EXISTS, API_NAME_REQUIRED, API_NOT_FOUND, API_SAVE_FAILURE, BODY_INVALID, DATASOURCE_KEY_EXISTS, DATASOURCE_KEY_INVALID, DATASOURCE_KEY_REQUIRED, DATASOURCE_NOT_FOUND, DATASOURCE_TYPE_NOT_FOUND, DATASOURCE_TYPE_NOT_SET, FILE_IS_REQUIRED, FUNCTION_ALREADY_EXISTS, FUNCTION_NAME_REQUIRED, FUNCTION_NOT_FOUND, FUNCTION_PATH_CONFLICT, FUNCTION_PATH_REQUIRED, FUNCTION_SAVE_FAILURE, GROUP_CONFLICT, GROUP_NAME_REQUIRED, GROUP_NOT_FOUND, GROUP_SAVE_FAILURE, GROUP_TYPE_REQUIRED, HEADER_INVALID, IS_READ_ONLY, NAME_CONFLICT, NAME_INVALID, PARAMETER_INVALID, PATH_VARIABLE_INVALID, PERMISSION_INVALID, REQUEST_METHOD_REQUIRED, REQUEST_PATH_CONFLICT, REQUEST_PATH_REQUIRED, RESOURCE_LOCKED, SCRIPT_REQUIRED, SECRET_KEY_IS_REQUIRED, SIGN_IS_INVALID, SUCCESS, TARGET_IS_REQUIRED, UPLOAD_PATH_CONFLICT

构造器概要

构造器

构造器和说明
MagicWorkbenchController(MagicConfiguration configuration, String secretKey)

方法概要

限定符和类型	方法和说明
JsonBean<Map<String,Object>>	classes() 获取所有class
JsonBean<Set<org.ssssssss.script.ScriptClass>>	clazz(String className) 获取单个class
org.springframework.http.ResponseEntity<?>	configJs()
org.springframework.http.ResponseEntity<?>	download(String groupId, List<SelectedResource> resources)
JsonBean<Boolean>	login(String username, String password, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) 登录
JsonBean<Void>	logout(javax.servlet.http.HttpServletRequest request)
JsonBean<List<List<String>>>	options()
JsonBean<?>	push(String target, String secretKey, String mode, List<SelectedResource> resources)
JsonBean<Void>	receivePush(org.springframework.web.multipart.MultipartFile file, String mode, Long timestamp, String sign)
JsonBean<Void>	refresh()
JsonBean<List<Map<String,Object>>>	search(String keyword, String type)
JsonBean<List<Map<String,Object>>>	todo(javax.servlet.http.HttpServletRequest request)
JsonBean<Boolean>	upload(org.springframework.web.multipart.MultipartFile file, String mode)
JsonBean<MagicUser>	user(javax.servlet.http.HttpServletRequest request)

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

doValid, invalidLogin

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

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

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

exceptionHandler, exceptionHandler

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

isTrue, notBlank, notNull

构造器详细资料

MagicWorkbenchController

public MagicWorkbenchController(MagicConfiguration configuration,
                                String secretKey)

方法详细资料

classes

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

获取所有class

clazz

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

获取单个class

参数:

className - 类名

login

@RequestMapping(value="/login")
 @ResponseBody
 @Valid(requireLogin=false)
public JsonBean<Boolean> login(String username,
                                                                                                             String password,
                                                                                                             javax.servlet.http.HttpServletRequest request,
                                                                                                             javax.servlet.http.HttpServletResponse response)
                                                                                                      throws MagicLoginException

登录

抛出:

MagicLoginException

user

@RequestMapping(value="/user")
 @ResponseBody
public JsonBean<MagicUser> user(javax.servlet.http.HttpServletRequest request)

logout

@RequestMapping(value="/logout")
 @ResponseBody
 @Valid(requireLogin=false)
public JsonBean<Void> logout(javax.servlet.http.HttpServletRequest request)

refresh

@RequestMapping(value="/refresh")
 @ResponseBody
 @Valid
public JsonBean<Void> refresh()

options

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

search

@RequestMapping(value="/search")
 @ResponseBody
 @Valid
public JsonBean<List<Map<String,Object>>> search(String keyword,
                                                                                                            String type)

todo

@RequestMapping(value="/todo")
 @ResponseBody
 @Valid
public JsonBean<List<Map<String,Object>>> todo(javax.servlet.http.HttpServletRequest request)

configJs

@RequestMapping(value="/config-js")
 @ResponseBody
 @Valid(requireLogin=false)
public org.springframework.http.ResponseEntity<?> configJs()

download

@RequestMapping(value="/download")
 @Valid(authorization=DOWNLOAD)
 @ResponseBody
public org.springframework.http.ResponseEntity<?> download(String groupId,
                                                                                                                                                @RequestBody(required=false)
                                                                                                                                                List<SelectedResource> resources)
                                                                                                                                         throws IOException

抛出:

IOException

upload

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

抛出:

IOException

push

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

receivePush

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

抛出:

IOException