Package com.evolveum.midpoint.rest.impl

Class ModelRestController

java.lang.Object

com.evolveum.midpoint.rest.impl.AbstractRestController

com.evolveum.midpoint.rest.impl.ModelRestController

@RestController
@RequestMapping({"/ws/rest","/rest/model","/api/model"})
public class ModelRestController
extends AbstractRestController

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GET_OBJECT_PATH

Fields inherited from class com.evolveum.midpoint.rest.impl.AbstractRestController

auditService, logger, prismContext, securityHelper, taskManager

Constructor Summary

Constructors

Constructor	Description
ModelRestController()

Method Summary

Modifier and Type	Method	Description
<T extends ObjectType> org.springframework.http.ResponseEntity<?>	addObject(String type, String id, List<String> options, @NotNull PrismObject<T> object)
<T extends ObjectType> org.springframework.http.ResponseEntity<?>	addObject(String type, List<String> options, @NotNull PrismObject<T> object)
<T extends ObjectType> org.springframework.http.ResponseEntity<?>	addObjectAlt(String type, List<String> options, @NotNull PrismObject<T> object)
<T extends ObjectType> org.springframework.http.ResponseEntity<?>	compare(List<String> restReadOptions, List<String> restCompareOptions, List<String> restIgnoreItems, PrismObject<T> clientObject)
org.springframework.http.ResponseEntity<?>	deleteObject(String type, String id, List<String> options)
org.springframework.http.ResponseEntity<?>	executeCredentialReset(String oid, ExecuteCredentialResetRequestType executeCredentialResetRequest)
org.springframework.http.ResponseEntity<?>	executeScript(Boolean asynchronous, ExecuteScriptType command)
org.springframework.http.ResponseEntity<?>	findShadowOwner(String shadowOid)
org.springframework.http.ResponseEntity<?>	generateValue(String type, String oid, PolicyItemsDefinitionType policyItemsDefinition)
org.springframework.http.ResponseEntity<?>	generateValueRpc(PolicyItemsDefinitionType policyItemsDefinition)
org.springframework.http.ResponseEntity<?>	getLog(Long fromPosition, Long maxSize)
org.springframework.http.ResponseEntity<?>	getLogFileSize()
org.springframework.http.ResponseEntity<?>	getObject(String type, String id, List<String> options, List<String> include, List<String> exclude, List<String> resolveNames)
org.springframework.http.ResponseEntity<?>	getRunningTasksThreadsDump()
org.springframework.http.ResponseEntity<?>	getSelf()
org.springframework.http.ResponseEntity<?>	getSelfAlt()
org.springframework.http.ResponseEntity<?>	getTaskThreadsDump(String oid)
org.springframework.http.ResponseEntity<?>	getThreadsDump()
org.springframework.http.ResponseEntity<?>	getValuePolicyForUser(String oid)
org.springframework.http.ResponseEntity<?>	importFromResource(String resourceOid, String objectClass)
org.springframework.http.ResponseEntity<?>	importShadow(String shadowOid)
org.springframework.http.ResponseEntity<?>	modifyObjectPatch(String type, String oid, List<String> options, ObjectModificationType modificationType)
org.springframework.http.ResponseEntity<?>	modifyObjectPost(String type, String oid, List<String> options, ObjectModificationType modificationType)
org.springframework.http.ResponseEntity<?>	notifyChange(ResourceObjectShadowChangeDescriptionType changeDescription)
org.springframework.http.ResponseEntity<?>	resumeTask(String taskOid)
org.springframework.http.ResponseEntity<?>	scheduleTaskNow(String taskOid)
org.springframework.http.ResponseEntity<?>	searchObjects(String type, List<String> options, List<String> include, List<String> exclude, List<String> resolveNames, QueryType queryType)
<T extends ObjectType> org.springframework.http.ResponseEntity<?>	searchObjectsByType(String type, List<String> options, List<String> include, List<String> exclude, List<String> resolveNames)
org.springframework.http.ResponseEntity<?>	suspendTask(String taskOid)
org.springframework.http.ResponseEntity<?>	testResource(String resourceOid)
@NotNull URI	uriGetObject(String type, String oid)
org.springframework.http.ResponseEntity<?>	validateValue(PolicyItemsDefinitionType policyItemsDefinition)
org.springframework.http.ResponseEntity<?>	validateValue(String type, String oid, PolicyItemsDefinitionType policyItemsDefinition)

Methods inherited from class com.evolveum.midpoint.rest.impl.AbstractRestController

controllerBasePath, createBody, createErrorResponseBuilder, createErrorResponseBuilder, createResponse, createResponse, createResponse, createResponseWithLocation, createSubresult, finishRequest, handleException, handleException, handleExceptionNoLog, initRequest

Methods inherited from class java.lang.Object

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

Field Details

GET_OBJECT_PATH

public static final String GET_OBJECT_PATH

See Also:

• Constant Field Values

Constructor Details

ModelRestController

public ModelRestController()

Method Details

generateValue

@PostMapping("/{type}/{oid}/generate")
public org.springframework.http.ResponseEntity<?> generateValue(@PathVariable("type")
 String type,
 @PathVariable("oid")
 String oid,
 @RequestBody
 PolicyItemsDefinitionType policyItemsDefinition)

generateValueRpc

@PostMapping("/rpc/generate")
public org.springframework.http.ResponseEntity<?> generateValueRpc(@RequestBody
 PolicyItemsDefinitionType policyItemsDefinition)

validateValue

@PostMapping("/{type}/{oid}/validate")
public org.springframework.http.ResponseEntity<?> validateValue(@PathVariable("type")
 String type,
 @PathVariable("oid")
 String oid,
 @RequestBody
 PolicyItemsDefinitionType policyItemsDefinition)

validateValue

@PostMapping("/rpc/validate")
public org.springframework.http.ResponseEntity<?> validateValue(@RequestBody
 PolicyItemsDefinitionType policyItemsDefinition)

getValuePolicyForUser

@GetMapping("/users/{id}/policy")
public org.springframework.http.ResponseEntity<?> getValuePolicyForUser(@PathVariable("id")
 String oid)

getObject

@GetMapping("/{type}/{id}")
public org.springframework.http.ResponseEntity<?> getObject(@PathVariable("type")
 String type,
 @PathVariable("id")
 String id,
 @RequestParam(value="options",required=false)
 List<String> options,
 @RequestParam(value="include",required=false)
 List<String> include,
 @RequestParam(value="exclude",required=false)
 List<String> exclude,
 @RequestParam(value="resolveNames",required=false)
 List<String> resolveNames)

getSelfAlt

@GetMapping("/self/")
public org.springframework.http.ResponseEntity<?> getSelfAlt()

getSelf

@GetMapping("/self")
public org.springframework.http.ResponseEntity<?> getSelf()

addObjectAlt

@PostMapping("/{type}/")
public <T extends ObjectType>
org.springframework.http.ResponseEntity<?> addObjectAlt(@PathVariable("type")
 String type,
 @RequestParam(value="options",required=false)
 List<String> options,
 @RequestBody @NotNull
 @NotNull PrismObject<T> object)

addObject

@PostMapping("/{type}")
public <T extends ObjectType>
org.springframework.http.ResponseEntity<?> addObject(@PathVariable("type")
 String type,
 @RequestParam(value="options",required=false)
 List<String> options,
 @RequestBody @NotNull
 @NotNull PrismObject<T> object)

uriGetObject

@NotNull
public @NotNull URI uriGetObject(@PathVariable("type")
 String type,
 String oid)

searchObjectsByType

@GetMapping("/{type}")
public <T extends ObjectType>
org.springframework.http.ResponseEntity<?> searchObjectsByType(@PathVariable("type")
 String type,
 @RequestParam(value="options",required=false)
 List<String> options,
 @RequestParam(value="include",required=false)
 List<String> include,
 @RequestParam(value="exclude",required=false)
 List<String> exclude,
 @RequestParam(value="resolveNames",required=false)
 List<String> resolveNames)

addObject

@PutMapping("/{type}/{id}")
public <T extends ObjectType>
org.springframework.http.ResponseEntity<?> addObject(@PathVariable("type")
 String type,
 @PathVariable("id")
 String id,
 @RequestParam(value="options",required=false)
 List<String> options,
 @RequestBody @NotNull
 @NotNull PrismObject<T> object)

deleteObject

@DeleteMapping("/{type}/{id}")
public org.springframework.http.ResponseEntity<?> deleteObject(@PathVariable("type")
 String type,
 @PathVariable("id")
 String id,
 @RequestParam(value="options",required=false)
 List<String> options)

modifyObjectPost

@PostMapping("/{type}/{oid}")
public org.springframework.http.ResponseEntity<?> modifyObjectPost(@PathVariable("type")
 String type,
 @PathVariable("oid")
 String oid,
 @RequestParam(value="options",required=false)
 List<String> options,
 @RequestBody
 ObjectModificationType modificationType)

modifyObjectPatch

@PatchMapping("/{type}/{oid}")
public org.springframework.http.ResponseEntity<?> modifyObjectPatch(@PathVariable("type")
 String type,
 @PathVariable("oid")
 String oid,
 @RequestParam(value="options",required=false)
 List<String> options,
 @RequestBody
 ObjectModificationType modificationType)

notifyChange

@PostMapping("/notifyChange")
public org.springframework.http.ResponseEntity<?> notifyChange(@RequestBody
 ResourceObjectShadowChangeDescriptionType changeDescription)

findShadowOwner

@GetMapping("/shadows/{oid}/owner")
public org.springframework.http.ResponseEntity<?> findShadowOwner(@PathVariable("oid")
 String shadowOid)

importShadow

@PostMapping("/shadows/{oid}/import")
public org.springframework.http.ResponseEntity<?> importShadow(@PathVariable("oid")
 String shadowOid)

searchObjects

@PostMapping("/{type}/search")
public org.springframework.http.ResponseEntity<?> searchObjects(@PathVariable("type")
 String type,
 @RequestParam(value="options",required=false)
 List<String> options,
 @RequestParam(value="include",required=false)
 List<String> include,
 @RequestParam(value="exclude",required=false)
 List<String> exclude,
 @RequestParam(value="resolveNames",required=false)
 List<String> resolveNames,
 @RequestBody
 QueryType queryType)

importFromResource

@PostMapping("/resources/{resourceOid}/import/{objectClass}")
public org.springframework.http.ResponseEntity<?> importFromResource(@PathVariable("resourceOid")
 String resourceOid,
 @PathVariable("objectClass")
 String objectClass)

testResource

@PostMapping("/resources/{resourceOid}/test")
public org.springframework.http.ResponseEntity<?> testResource(@PathVariable("resourceOid")
 String resourceOid)

suspendTask

@PostMapping("/tasks/{oid}/suspend")
public org.springframework.http.ResponseEntity<?> suspendTask(@PathVariable("oid")
 String taskOid)

resumeTask

@PostMapping("/tasks/{oid}/resume")
public org.springframework.http.ResponseEntity<?> resumeTask(@PathVariable("oid")
 String taskOid)

scheduleTaskNow

@PostMapping("tasks/{oid}/run")
public org.springframework.http.ResponseEntity<?> scheduleTaskNow(@PathVariable("oid")
 String taskOid)

executeScript

@PostMapping("/rpc/executeScript")
public org.springframework.http.ResponseEntity<?> executeScript(@RequestParam(value="asynchronous",required=false)
 Boolean asynchronous,
 @RequestBody
 ExecuteScriptType command)

compare

@PostMapping("/rpc/compare")
public <T extends ObjectType>
org.springframework.http.ResponseEntity<?> compare(@RequestParam(value="readOptions",required=false)
 List<String> restReadOptions,
 @RequestParam(value="compareOptions",required=false)
 List<String> restCompareOptions,
 @RequestParam(value="ignoreItems",required=false)
 List<String> restIgnoreItems,
 @RequestBody
 PrismObject<T> clientObject)

getLogFileSize

@GetMapping(value="/log/size",
            produces={"text/plain","*/*"})
public org.springframework.http.ResponseEntity<?> getLogFileSize()

getLog

@GetMapping(value="/log",
            produces={"text/plain","*/*"})
public org.springframework.http.ResponseEntity<?> getLog(@RequestParam(value="fromPosition",required=false)
 Long fromPosition,
 @RequestParam(value="maxSize",required=false)
 Long maxSize)

executeCredentialReset

@PostMapping("/users/{oid}/credential")
public org.springframework.http.ResponseEntity<?> executeCredentialReset(@PathVariable("oid")
 String oid,
 @RequestBody
 ExecuteCredentialResetRequestType executeCredentialResetRequest)

getThreadsDump

@GetMapping(value="/threads",
            produces={"text/plain","*/*"})
public org.springframework.http.ResponseEntity<?> getThreadsDump()

getRunningTasksThreadsDump

@GetMapping(value="/tasks/threads",
            produces={"text/plain","*/*"})
public org.springframework.http.ResponseEntity<?> getRunningTasksThreadsDump()

getTaskThreadsDump

@GetMapping(value="/tasks/{oid}/threads",
            produces={"text/plain","*/*"})
public org.springframework.http.ResponseEntity<?> getTaskThreadsDump(@PathVariable("oid")
 String oid)