Search in sources :

Example 71 with Operation

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

the class StatisticsEndpoint method handle.

/**
 * Gets availability times of the server.
 *
 * @return the availability
 */
@ReadOperation
@Operation(summary = "Get a report of CAS statistics")
public Map<String, Object> handle() {
    val model = new HashMap<String, Object>();
    val diff = Duration.between(this.upTimeStartDate, ZonedDateTime.now(ZoneOffset.UTC));
    model.put("upTime", diff.getSeconds());
    val runtime = Runtime.getRuntime();
    model.put("totalMemory", FileUtils.byteCountToDisplaySize(runtime.totalMemory()));
    model.put("maxMemory", FileUtils.byteCountToDisplaySize(runtime.maxMemory()));
    model.put("freeMemory", FileUtils.byteCountToDisplaySize(runtime.freeMemory()));
    val unexpiredTgts = new AtomicInteger();
    val unexpiredSts = new AtomicInteger();
    val expiredTgts = new AtomicInteger();
    val expiredSts = new AtomicInteger();
    val tickets = this.centralAuthenticationService.getObject().getTickets(ticket -> true);
    tickets.forEach(Unchecked.consumer(ticket -> {
        if (ticket instanceof ServiceTicket) {
            if (ticket.isExpired()) {
                this.centralAuthenticationService.getObject().deleteTicket(ticket.getId());
                expiredSts.incrementAndGet();
            } else {
                unexpiredSts.incrementAndGet();
            }
        } else {
            if (ticket.isExpired()) {
                this.centralAuthenticationService.getObject().deleteTicket(ticket.getId());
                expiredTgts.incrementAndGet();
            } else {
                unexpiredTgts.incrementAndGet();
            }
        }
    }));
    model.put("unexpiredTgts", unexpiredTgts);
    model.put("unexpiredSts", unexpiredSts);
    model.put("expiredTgts", expiredTgts);
    model.put("expiredSts", expiredSts);
    return model;
}
Also used : lombok.val(lombok.val) CasConfigurationProperties(org.apereo.cas.configuration.CasConfigurationProperties) Unchecked(org.jooq.lambda.Unchecked) ReadOperation(org.springframework.boot.actuate.endpoint.annotation.ReadOperation) Endpoint(org.springframework.boot.actuate.endpoint.annotation.Endpoint) ZonedDateTime(java.time.ZonedDateTime) lombok.val(lombok.val) CentralAuthenticationService(org.apereo.cas.CentralAuthenticationService) FileUtils(org.apache.commons.io.FileUtils) HashMap(java.util.HashMap) BaseCasActuatorEndpoint(org.apereo.cas.web.BaseCasActuatorEndpoint) Operation(io.swagger.v3.oas.annotations.Operation) ObjectProvider(org.springframework.beans.factory.ObjectProvider) AtomicInteger(java.util.concurrent.atomic.AtomicInteger) Duration(java.time.Duration) Map(java.util.Map) ZoneOffset(java.time.ZoneOffset) ServiceTicket(org.apereo.cas.ticket.ServiceTicket) HashMap(java.util.HashMap) AtomicInteger(java.util.concurrent.atomic.AtomicInteger) ServiceTicket(org.apereo.cas.ticket.ServiceTicket) ReadOperation(org.springframework.boot.actuate.endpoint.annotation.ReadOperation) ReadOperation(org.springframework.boot.actuate.endpoint.annotation.ReadOperation) Operation(io.swagger.v3.oas.annotations.Operation)

Example 72 with Operation

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

the class AuditLogEndpoint method getAuditLog.

/**
 * Gets Audit log for passed interval.
 *
 * @param interval - Interval subtracted from current time
 * @return the auditlog
 */
@ReadOperation
@SuppressWarnings("JavaUtilDate")
@Operation(summary = "Provide a report of the audit log using a given interval", parameters = { @Parameter(name = "interval", description = "Accepts the duration syntax, such as PT1H") })
public Set<AuditActionContext> getAuditLog(@Selector final String interval) {
    if (StringUtils.isBlank(interval)) {
        val sinceDate = LocalDate.now(ZoneId.systemDefault()).minusDays(casProperties.getAudit().getEngine().getNumberOfDaysInHistory());
        return auditTrailManager.getObject().getAuditRecordsSince(sinceDate);
    }
    val duration = Beans.newDuration(interval);
    val sinceTime = new Date(new Date().getTime() - duration.toMillis());
    val days = duration.toDays();
    val sinceDate = LocalDate.now(ZoneId.systemDefault()).minusDays(days + 1);
    return auditTrailManager.getObject().getAuditRecordsSince(sinceDate).stream().filter(a -> a.getWhenActionWasPerformed().after(sinceTime)).collect(Collectors.toSet());
}
Also used : lombok.val(lombok.val) CasConfigurationProperties(org.apereo.cas.configuration.CasConfigurationProperties) ReadOperation(org.springframework.boot.actuate.endpoint.annotation.ReadOperation) AuditTrailExecutionPlan(org.apereo.cas.audit.AuditTrailExecutionPlan) Date(java.util.Date) Endpoint(org.springframework.boot.actuate.endpoint.annotation.Endpoint) MediaType(org.springframework.http.MediaType) lombok.val(lombok.val) Set(java.util.Set) Beans(org.apereo.cas.configuration.support.Beans) AuditActionContext(org.apereo.inspektr.audit.AuditActionContext) WriteOperation(org.springframework.boot.actuate.endpoint.annotation.WriteOperation) StringUtils(org.apache.commons.lang3.StringUtils) Collectors(java.util.stream.Collectors) ZoneId(java.time.ZoneId) BaseCasActuatorEndpoint(org.apereo.cas.web.BaseCasActuatorEndpoint) Parameter(io.swagger.v3.oas.annotations.Parameter) Operation(io.swagger.v3.oas.annotations.Operation) ObjectProvider(org.springframework.beans.factory.ObjectProvider) LocalDate(java.time.LocalDate) Nullable(org.springframework.lang.Nullable) Selector(org.springframework.boot.actuate.endpoint.annotation.Selector) Date(java.util.Date) LocalDate(java.time.LocalDate) ReadOperation(org.springframework.boot.actuate.endpoint.annotation.ReadOperation) ReadOperation(org.springframework.boot.actuate.endpoint.annotation.ReadOperation) WriteOperation(org.springframework.boot.actuate.endpoint.annotation.WriteOperation) Operation(io.swagger.v3.oas.annotations.Operation)

Example 73 with Operation

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

the class CasReleaseAttributesReportEndpoint method releaseAttributes.

/**
 * Method that accepts a JSON body through a POST method to receive user credentials and only returns a
 * map of attributes released for the authenticated user.
 *
 * @param username - the username
 * @param password - the password
 * @param service  - the service id
 * @return - the map
 */
@WriteOperation
@Operation(summary = "Get collection of released attributes for the user and application", parameters = { @Parameter(name = "username", required = true), @Parameter(name = "password", required = true), @Parameter(name = "service", required = true) })
public Map<String, Object> releaseAttributes(final String username, final String password, final String service) {
    val map = releasePrincipalAttributes(username, password, service);
    val assertion = (ImmutableAssertion) map.get("assertion");
    return Map.of("uid", username, "attributes", assertion.getPrimaryAuthentication().getPrincipal().getAttributes());
}
Also used : lombok.val(lombok.val) ImmutableAssertion(org.apereo.cas.validation.ImmutableAssertion) WriteOperation(org.springframework.boot.actuate.endpoint.annotation.WriteOperation) ReadOperation(org.springframework.boot.actuate.endpoint.annotation.ReadOperation) WriteOperation(org.springframework.boot.actuate.endpoint.annotation.WriteOperation) Operation(io.swagger.v3.oas.annotations.Operation)

Example 74 with Operation

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

the class SingleSignOnSessionStatusEndpoint method ssoStatus.

/**
 * Sso status response entity.
 *
 * @param tgc     the tgc
 * @param request the request
 * @return the response entity
 */
@GetMapping(produces = MediaType.APPLICATION_JSON_VALUE)
@Operation(summary = "Get current status of single sign-on", parameters = { @Parameter(name = "tgc", required = false), @Parameter(name = "request", required = false) })
public ResponseEntity<Map<?, ?>> ssoStatus(@RequestParam(name = "tgc", required = false, defaultValue = StringUtils.EMPTY) final String tgc, final HttpServletRequest request) {
    val tgtId = StringUtils.isNotBlank(tgc) ? ticketGrantingTicketCookieGenerator.getCasCookieValueManager().obtainCookieValue(tgc, request) : ticketGrantingTicketCookieGenerator.retrieveCookieValue(request);
    if (StringUtils.isBlank(tgtId)) {
        return ResponseEntity.badRequest().build();
    }
    val auth = this.ticketRegistrySupport.getAuthenticationFrom(tgtId);
    if (auth == null) {
        return ResponseEntity.badRequest().build();
    }
    val ticketState = this.ticketRegistrySupport.getTicket(tgtId);
    val body = CollectionUtils.wrap("principal", auth.getPrincipal().getId(), "authenticationDate", auth.getAuthenticationDate(), "ticketGrantingTicketCreationTime", ticketState.getCreationTime(), "ticketGrantingTicketPreviousTimeUsed", ticketState.getPreviousTimeUsed(), "ticketGrantingTicketLastTimeUsed", ticketState.getLastTimeUsed());
    return ResponseEntity.ok(body);
}
Also used : lombok.val(lombok.val) GetMapping(org.springframework.web.bind.annotation.GetMapping) Operation(io.swagger.v3.oas.annotations.Operation)

Example 75 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)

Aggregations

Operation (io.swagger.v3.oas.annotations.Operation)177 Operation (io.swagger.v3.oas.models.Operation)174 OpenAPI (io.swagger.v3.oas.models.OpenAPI)141 Test (org.testng.annotations.Test)129 PathItem (io.swagger.v3.oas.models.PathItem)108 ApiResponses (io.swagger.v3.oas.annotations.responses.ApiResponses)99 Schema (io.swagger.v3.oas.models.media.Schema)68 ApiResponse (io.swagger.v3.oas.models.responses.ApiResponse)62 IntegerSchema (io.swagger.v3.oas.models.media.IntegerSchema)59 ArraySchema (io.swagger.v3.oas.models.media.ArraySchema)55 ObjectSchema (io.swagger.v3.oas.models.media.ObjectSchema)51 ArrayList (java.util.ArrayList)51 ProtectedApi (org.gluu.oxtrust.service.filter.ProtectedApi)50 StringSchema (io.swagger.v3.oas.models.media.StringSchema)48 MediaType (io.swagger.v3.oas.models.media.MediaType)44 Path (javax.ws.rs.Path)44 ApiResponses (io.swagger.v3.oas.models.responses.ApiResponses)43 Content (io.swagger.v3.oas.models.media.Content)42 lombok.val (lombok.val)42 Parameter (io.swagger.v3.oas.models.parameters.Parameter)39