org.graylog.events.processor.systemnotification.SystemNotificationRenderResource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of graylog2-server Show documentation
Graylog
There is a newer version: 6.1.4
/*
 * Copyright (C) 2020 Graylog, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Server Side Public License, version 1,
 * as published by MongoDB, Inc.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * Server Side Public License for more details.
 *
 * You should have received a copy of the Server Side Public License
 * along with this program. If not, see
 * .
 */
package org.graylog.events.processor.systemnotification;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.apache.shiro.authz.annotation.RequiresAuthentication;
import org.graylog2.audit.jersey.NoAuditEvent;
import org.graylog2.notifications.Notification;
import org.graylog2.shared.rest.resources.RestResource;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.annotation.Nullable;
import javax.inject.Inject;
import javax.ws.rs.Consumes;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import java.util.HashMap;
import java.util.Map;

@Api(value = "System/Notification/Message", description = "Render system notification messages")
@Path("/system/notification/message")
@Consumes(MediaType.APPLICATION_JSON)
@Produces({MediaType.TEXT_HTML, MediaType.TEXT_PLAIN})
@RequiresAuthentication
public class SystemNotificationRenderResource extends RestResource {
    private static final Logger LOG = LoggerFactory.getLogger(SystemNotificationRenderResource.class);

    private final SystemNotificationRenderService systemNotificationRenderService;

    @Inject
    public SystemNotificationRenderResource(SystemNotificationRenderService systemNotificationRenderService) {
        this.systemNotificationRenderService = systemNotificationRenderService;
    }

    @POST
    @NoAuditEvent("Doesn't change any data, only renders a notification message")
    @Path("/html/{type}")
    @Produces(MediaType.APPLICATION_JSON)
    @ApiOperation(value = "Get HTML formatted message")
    public TemplateRenderResponse renderHtml(@ApiParam(name = "type", required = true)
                                             @PathParam("type") Notification.Type type,
                                             @ApiParam(name = "JSON body", required = false)
                                             TemplateRenderRequest request) {
        return render(type, null, SystemNotificationRenderService.Format.HTML, request);
    }

    @POST
    @NoAuditEvent("Doesn't change any data, only renders a notification message")
    @Path("/html/{type}/{key}")
    @Produces(MediaType.APPLICATION_JSON)
    @ApiOperation(value = "Get HTML formatted message")
    public TemplateRenderResponse renderHtmlWithKey(@ApiParam(name = "type", required = true) @PathParam("type") Notification.Type type,
                                                    @ApiParam(name = "key", required = true) @PathParam("key") String key,
                                                    @ApiParam(name = "JSON body", required = false)
                                                    TemplateRenderRequest request) {
        return render(type, key, SystemNotificationRenderService.Format.HTML, request);
    }

    @POST
    @NoAuditEvent("Doesn't change any data, only renders a notification message")
    @Path("/plaintext/{type}")
    @Produces(MediaType.APPLICATION_JSON)
    @ApiOperation(value = "Get plaintext formatted message")
    public TemplateRenderResponse renderPlainText(@ApiParam(name = "type", required = true)
                                                  @PathParam("type") Notification.Type type,
                                                  @ApiParam(name = "JSON body", required = false)
                                                  TemplateRenderRequest request) {
        return render(type, null, SystemNotificationRenderService.Format.PLAINTEXT, request);
    }

    @POST
    @NoAuditEvent("Doesn't change any data, only renders a notification message")
    @Path("/plaintext/{type}/{key}")
    @Produces(MediaType.APPLICATION_JSON)
    @ApiOperation(value = "Get plaintext formatted message")
    public TemplateRenderResponse renderPlainTextWithKey(@ApiParam(name = "type", required = true) @PathParam("type") Notification.Type type,
                                                         @ApiParam(name = "key", required = true) @PathParam("key") String key,
                                                         @ApiParam(name = "JSON body", required = false)
                                                         TemplateRenderRequest request) {
        return render(type, key, SystemNotificationRenderService.Format.PLAINTEXT, request);
    }

    private TemplateRenderResponse render(
            Notification.Type type,
            @Nullable String key,
            SystemNotificationRenderService.Format format,
            TemplateRenderRequest request) {
        Map values = (request != null) ? request.values() : new HashMap<>();
        SystemNotificationRenderService.RenderResponse renderResponse =
                systemNotificationRenderService.render(type, key, format, values);

        return TemplateRenderResponse.create(renderResponse.title, renderResponse.description);
    }
}