org.opennms.web.utils.ResponseUtils Maven / Gradle / Ivy

Go to download
/*
 * Licensed to The OpenNMS Group, Inc (TOG) under one or more
 * contributor license agreements.  See the LICENSE.md file
 * distributed with this work for additional information
 * regarding copyright ownership.
 *
 * TOG licenses this file to You under the GNU Affero General
 * Public License Version 3 (the "License") or (at your option)
 * any later version.  You may not use this file except in
 * compliance with the License.  You may obtain a copy of the
 * License at:
 *
 *      https://www.gnu.org/licenses/agpl-3.0.txt
 *
 * 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 org.opennms.web.utils;

import java.util.List;

import javax.ws.rs.core.Response;

public abstract class ResponseUtils {
    private ResponseUtils() {}

    public static  Response createResponse(List entities, long offset, long totalCount) {
        if (entities == null || entities.isEmpty()) {
            return Response.noContent().build();
        }
        final String contentRangeHeader = getContentRange(entities.size(), offset, totalCount);
        return Response.ok(entities).header("Content-Range", contentRangeHeader).build();
    }

    public static String getContentRange(long itemCount, long offset, long totalCount) {
        return String.format("items %d-%d/%d", offset, offset + itemCount - 1, totalCount);
    }

}