Search in sources :

Example 36 with Operation

use of io.swagger.v3.oas.models.Operation in project cas by apereo.

the class SpringWebflowEndpoint method getReport.

/**
 * Get SWF report.
 *
 * @param flowId  the flow id
 * @param stateId the state id
 * @return JSON representing the current state of SWF.
 */
@ReadOperation
@Operation(summary = "Get Spring webflow report using an optional flow id", parameters = { @Parameter(name = "flowId"), @Parameter(name = "stateId") })
public Map<?, ?> getReport(@Nullable final String flowId, @Nullable final String stateId) {
    val jsonMap = new LinkedHashMap<String, Object>();
    val executionPlan = applicationContext.getBean(CasWebflowExecutionPlan.BEAN_NAME, CasWebflowExecutionPlan.class);
    executionPlan.execute();
    val map = applicationContext.getBeansOfType(FlowDefinitionRegistry.class);
    map.forEach((k, value) -> Arrays.stream(value.getFlowDefinitionIds()).filter(currentId -> StringUtils.isBlank(flowId) || flowId.equalsIgnoreCase(currentId)).forEach(id -> {
        val flowDefinition = (Flow) value.getFlowDefinition(id);
        val flowDetails = new LinkedHashMap<String, Object>();
        flowDetails.put("startState", flowDefinition.getStartState().getId());
        val startActions = StreamSupport.stream(flowDefinition.getStartActionList().spliterator(), false).map(SpringWebflowEndpoint::convertActionToString).collect(Collectors.toList());
        if (!startActions.isEmpty()) {
            flowDetails.put("startActions", startActions);
        }
        val states = new LinkedHashMap<String, Map>();
        Arrays.stream(flowDefinition.getStateIds()).filter(st -> StringUtils.isBlank(stateId) || RegexUtils.find(stateId, st)).forEach(st -> {
            val stateMap = getStateDetails(flowDefinition, st);
            states.put(st, stateMap);
        });
        flowDetails.put("states", states);
        flowDetails.put("possibleOutcomes", flowDefinition.getPossibleOutcomes());
        flowDetails.put("stateCount", flowDefinition.getStateCount());
        var acts = StreamSupport.stream(flowDefinition.getEndActionList().spliterator(), false).map(SpringWebflowEndpoint::convertActionToString).collect(Collectors.toList());
        if (!acts.isEmpty()) {
            flowDetails.put("endActions", acts);
        }
        acts = StreamSupport.stream(flowDefinition.getGlobalTransitionSet().spliterator(), false).map(tr -> tr.getId() + " -> " + tr.getTargetStateId() + " @ " + tr.getExecutionCriteria().toString()).collect(Collectors.toList());
        if (!acts.isEmpty()) {
            flowDetails.put("globalTransitions", acts);
        }
        acts = Arrays.stream(flowDefinition.getExceptionHandlerSet().toArray()).map(Object::toString).collect(Collectors.toList());
        if (!acts.isEmpty()) {
            flowDetails.put("exceptionHandlers", acts);
        }
        val vars = Arrays.stream(flowDefinition.getVariables()).map(FlowVariable::getName).collect(Collectors.joining(","));
        if (StringUtils.isNotBlank(vars)) {
            flowDetails.put("variables", vars);
        }
        jsonMap.put(id, flowDetails);
    }));
    return jsonMap;
}
Also used : lombok.val(lombok.val) CasConfigurationProperties(org.apereo.cas.configuration.CasConfigurationProperties) ActionState(org.springframework.webflow.engine.ActionState) Arrays(java.util.Arrays) ReadOperation(org.springframework.boot.actuate.endpoint.annotation.ReadOperation) SetAction(org.springframework.webflow.action.SetAction) ExternalRedirectAction(org.springframework.webflow.action.ExternalRedirectAction) AnnotatedAction(org.springframework.webflow.execution.AnnotatedAction) ActionExecutingViewFactory(org.springframework.webflow.engine.support.ActionExecutingViewFactory) CasWebflowExecutionPlan(org.apereo.cas.web.flow.CasWebflowExecutionPlan) StringUtils(org.apache.commons.lang3.StringUtils) TransitionableState(org.springframework.webflow.engine.TransitionableState) LinkedHashMap(java.util.LinkedHashMap) Operation(io.swagger.v3.oas.annotations.Operation) Map(java.util.Map) CollectionUtils(org.apereo.cas.util.CollectionUtils) Nullable(org.springframework.lang.Nullable) StreamSupport(java.util.stream.StreamSupport) FlowDefinitionRegistry(org.springframework.webflow.definition.registry.FlowDefinitionRegistry) FlowVariable(org.springframework.webflow.engine.FlowVariable) State(org.springframework.webflow.engine.State) Endpoint(org.springframework.boot.actuate.endpoint.annotation.Endpoint) lombok.val(lombok.val) Expression(org.springframework.binding.expression.Expression) EvaluateAction(org.springframework.webflow.action.EvaluateAction) Flow(org.springframework.webflow.engine.Flow) Action(org.springframework.webflow.execution.Action) Field(java.lang.reflect.Field) ApplicationContext(org.springframework.context.ApplicationContext) Collectors(java.util.stream.Collectors) RegexUtils(org.apereo.cas.util.RegexUtils) BaseCasActuatorEndpoint(org.apereo.cas.web.BaseCasActuatorEndpoint) Parameter(io.swagger.v3.oas.annotations.Parameter) Objects(java.util.Objects) Slf4j(lombok.extern.slf4j.Slf4j) EndState(org.springframework.webflow.engine.EndState) ViewState(org.springframework.webflow.engine.ViewState) ReflectionUtils(org.springframework.util.ReflectionUtils) LinkedHashMap(java.util.LinkedHashMap) Map(java.util.Map) LinkedHashMap(java.util.LinkedHashMap) FlowVariable(org.springframework.webflow.engine.FlowVariable) ReadOperation(org.springframework.boot.actuate.endpoint.annotation.ReadOperation) ReadOperation(org.springframework.boot.actuate.endpoint.annotation.ReadOperation) Operation(io.swagger.v3.oas.annotations.Operation)

Example 37 with Operation

use of io.swagger.v3.oas.models.Operation in project cas by apereo.

the class CasResolveAttributesReportEndpoint method resolvePrincipalAttributes.

/**
 * Resolve principal attributes map.
 *
 * @param uid the uid
 * @return the map
 */
@ReadOperation
@Operation(summary = "Resolve principal attributes for user", parameters = { @Parameter(name = "uid", required = true) })
public Map<String, Object> resolvePrincipalAttributes(@Selector final String uid) {
    val p = defaultPrincipalResolver.getObject().resolve(new BasicIdentifiableCredential(uid));
    val map = new HashMap<String, Object>();
    map.put("uid", p.getId());
    map.put("attributes", p.getAttributes());
    return map;
}
Also used : lombok.val(lombok.val) HashMap(java.util.HashMap) BasicIdentifiableCredential(org.apereo.cas.authentication.credential.BasicIdentifiableCredential) ReadOperation(org.springframework.boot.actuate.endpoint.annotation.ReadOperation) ReadOperation(org.springframework.boot.actuate.endpoint.annotation.ReadOperation) Operation(io.swagger.v3.oas.annotations.Operation)

Example 38 with Operation

use of io.swagger.v3.oas.models.Operation in project cas by apereo.

the class U2FRegisteredDevicesEndpoint method delete.

/**
 * Delete.
 *
 * @param username the username
 */
@DeleteOperation
@Operation(summary = "Delete all registered devices", parameters = { @Parameter(name = "username", required = true) })
public void delete(@Selector final String username) {
    val registeredDevices = new ArrayList<>(u2fDeviceRepository.getObject().getRegisteredDevices(username));
    registeredDevices.forEach(u2fDeviceRepository.getObject()::deleteRegisteredDevice);
}
Also used : lombok.val(lombok.val) ArrayList(java.util.ArrayList) DeleteOperation(org.springframework.boot.actuate.endpoint.annotation.DeleteOperation) ReadOperation(org.springframework.boot.actuate.endpoint.annotation.ReadOperation) DeleteOperation(org.springframework.boot.actuate.endpoint.annotation.DeleteOperation) Operation(io.swagger.v3.oas.annotations.Operation)

Example 39 with Operation

use of io.swagger.v3.oas.models.Operation in project cas by apereo.

the class SSOSamlIdPPostProfileHandlerEndpoint method produceGet.

/**
 * Produce response entity.
 *
 * @param request  the request
 * @param response the response
 * @return the response entity
 */
@GetMapping(produces = MediaType.APPLICATION_XML_VALUE)
@ResponseBody
@Operation(summary = "Produce SAML2 response entity", parameters = { @Parameter(name = "username", required = true), @Parameter(name = "password", required = true), @Parameter(name = SamlProtocolConstants.PARAMETER_ENTITY_ID, required = true), @Parameter(name = "encrypt") })
public ResponseEntity<Object> produceGet(final HttpServletRequest request, final HttpServletResponse response) {
    val username = request.getParameter("username");
    val password = request.getParameter("password");
    val entityId = request.getParameter(SamlProtocolConstants.PARAMETER_ENTITY_ID);
    val encrypt = Boolean.parseBoolean(request.getParameter("encrypt"));
    return produce(request, response, username, password, entityId, encrypt);
}
Also used : lombok.val(lombok.val) GetMapping(org.springframework.web.bind.annotation.GetMapping) Operation(io.swagger.v3.oas.annotations.Operation) ResponseBody(org.springframework.web.bind.annotation.ResponseBody)

Example 40 with Operation

use of io.swagger.v3.oas.models.Operation in project cas by apereo.

the class YubiKeyAccountRegistryEndpoint method export.

/**
 * Export.
 *
 * @return the response entity
 */
@GetMapping(path = "/export", produces = MediaType.APPLICATION_OCTET_STREAM_VALUE)
@ResponseBody
@Operation(summary = "Export all Yubikey accounts as a zip file")
public ResponseEntity<Resource> export() {
    val accounts = registry.getObject().getAccounts();
    val resource = CompressionUtils.toZipFile(accounts.stream(), Unchecked.function(entry -> {
        val acct = (YubiKeyAccount) entry;
        val fileName = String.format("%s-%s", acct.getUsername(), acct.getId());
        val sourceFile = File.createTempFile(fileName, ".json");
        MAPPER.writeValue(sourceFile, acct);
        return sourceFile;
    }), "yubikeybaccts");
    val headers = new HttpHeaders();
    headers.setContentDisposition(ContentDisposition.attachment().filename(Objects.requireNonNull(resource.getFilename())).build());
    return new ResponseEntity<>(resource, headers, HttpStatus.OK);
}
Also used : lombok.val(lombok.val) CasConfigurationProperties(org.apereo.cas.configuration.CasConfigurationProperties) PathVariable(org.springframework.web.bind.annotation.PathVariable) Operation(io.swagger.v3.oas.annotations.Operation) ObjectProvider(org.springframework.beans.factory.ObjectProvider) HttpServletRequest(javax.servlet.http.HttpServletRequest) ContentDisposition(org.springframework.http.ContentDisposition) GetMapping(org.springframework.web.bind.annotation.GetMapping) YubiKeyAccount(org.apereo.cas.adaptors.yubikey.YubiKeyAccount) TypeReference(com.fasterxml.jackson.core.type.TypeReference) DeleteMapping(org.springframework.web.bind.annotation.DeleteMapping) Resource(org.springframework.core.io.Resource) YubiKeyAccountRegistry(org.apereo.cas.adaptors.yubikey.YubiKeyAccountRegistry) PostMapping(org.springframework.web.bind.annotation.PostMapping) Unchecked(org.jooq.lambda.Unchecked) HttpHeaders(org.springframework.http.HttpHeaders) MediaType(org.springframework.http.MediaType) Collection(java.util.Collection) ObjectMapper(com.fasterxml.jackson.databind.ObjectMapper) lombok.val(lombok.val) CompressionUtils(org.apereo.cas.util.CompressionUtils) ResponseBody(org.springframework.web.bind.annotation.ResponseBody) File(java.io.File) StandardCharsets(java.nio.charset.StandardCharsets) BaseCasActuatorEndpoint(org.apereo.cas.web.BaseCasActuatorEndpoint) Parameter(io.swagger.v3.oas.annotations.Parameter) RestControllerEndpoint(org.springframework.boot.actuate.endpoint.web.annotation.RestControllerEndpoint) Objects(java.util.Objects) IOUtils(org.apache.commons.io.IOUtils) HttpStatus(org.springframework.http.HttpStatus) Slf4j(lombok.extern.slf4j.Slf4j) JacksonObjectMapperFactory(org.apereo.cas.util.serialization.JacksonObjectMapperFactory) ResponseEntity(org.springframework.http.ResponseEntity) HttpHeaders(org.springframework.http.HttpHeaders) ResponseEntity(org.springframework.http.ResponseEntity) GetMapping(org.springframework.web.bind.annotation.GetMapping) Operation(io.swagger.v3.oas.annotations.Operation) ResponseBody(org.springframework.web.bind.annotation.ResponseBody)

Aggregations

Operation (io.swagger.v3.oas.annotations.Operation)151 Operation (io.swagger.v3.oas.models.Operation)108 ApiResponses (io.swagger.v3.oas.annotations.responses.ApiResponses)99 OpenAPI (io.swagger.v3.oas.models.OpenAPI)79 Test (org.testng.annotations.Test)68 PathItem (io.swagger.v3.oas.models.PathItem)53 ProtectedApi (org.gluu.oxtrust.service.filter.ProtectedApi)50 ArrayList (java.util.ArrayList)45 lombok.val (lombok.val)42 ApiResponse (io.swagger.v3.oas.models.responses.ApiResponse)34 Map (java.util.Map)34 HashMap (java.util.HashMap)33 LinkedHashMap (java.util.LinkedHashMap)29 Test (org.junit.Test)29 OpenAPI3RequestValidationHandlerImpl (io.vertx.ext.web.api.contract.openapi3.impl.OpenAPI3RequestValidationHandlerImpl)28 Paths (io.swagger.v3.oas.models.Paths)27 Components (io.swagger.v3.oas.models.Components)26 Schema (io.swagger.v3.oas.models.media.Schema)24 Produces (javax.ws.rs.Produces)21 ApiResponses (io.swagger.v3.oas.models.responses.ApiResponses)20