io.gravitee.management.rest.resource.param.AuditParam Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gravitee-management-api-rest Show documentation
There is a newer version: 1.30.31
Show newest version
/**
 * Copyright (C) 2015 The Gravitee team (http://gravitee.io)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.gravitee.management.rest.resource.param;

import io.swagger.annotations.ApiParam;
import io.swagger.annotations.Example;

import javax.ws.rs.DefaultValue;
import javax.ws.rs.QueryParam;

/**
 * @author Nicolas GERAUD (nicolas.geraud at graviteesource.com) 
 * @author GraviteeSource Team
 */
public class AuditParam {
    @QueryParam("mgmt")
    @ApiParam(value = "true if you only want logs from the management, false if you also want api and application audit logs")
    private boolean managementLogsOnly;

    @QueryParam("api")
    private String apiId;

    @QueryParam("application")
    private String applicationId;

    @QueryParam("event")
    @ApiParam(
            value = "filter by the name of an event.",
            example = "APPLICATION_UPDATED, API_CREATED, METADATA_DELETED, ..."
    )
    private String event;

    @QueryParam("from")
    @ApiParam(value = "Timestamp used to define the start date of the time window to query")
    private long from;

    @QueryParam("to")
    @ApiParam(value = "Timestamp used to define the end date of the time window to query")
    private long to;

    @QueryParam("size")
    @ApiParam(value = "Number of elements per page")
    @DefaultValue("20")
    private int size;

    @QueryParam("page")
    @DefaultValue("1")
    private int page;


    public boolean isManagementLogsOnly() {
        return managementLogsOnly;
    }

    public void setManagementLogsOnly(boolean managementLogsOnly) {
        this.managementLogsOnly = managementLogsOnly;
    }

    public String getApiId() {
        return apiId;
    }

    public void setApiId(String apiId) {
        this.apiId = apiId;
    }

    public String getApplicationId() {
        return applicationId;
    }

    public void setApplicationId(String applicationId) {
        this.applicationId = applicationId;
    }

    public String getEvent() {
        return event;
    }

    public void setEvent(String event) {
        this.event = event;
    }

    public long getFrom() {
        return from;
    }

    public void setFrom(long from) {
        this.from = from;
    }

    public long getTo() {
        return to;
    }

    public void setTo(long to) {
        this.to = to;
    }

    public int getSize() {
        return size;
    }

    public void setSize(int size) {
        this.size = size;
    }

    public int getPage() {
        return page;
    }

    public void setPage(int page) {
        this.page = page;
    }
}