com.semanticcms.core.servlet.Headers Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of semanticcms-core-servlet Show documentation

Java API for modeling web page content and relationships in a Servlet environment.

There is a newer version: 1.20.0

Show newest version

/*
 * semanticcms-core-servlet - Java API for modeling web page content and relationships in a Servlet environment.
 * Copyright (C) 2015, 2016, 2017, 2021, 2022  AO Industries, Inc.
 *     [email protected]
 *     7262 Bull Pen Cir
 *     Mobile, AL 36695
 *
 * This file is part of semanticcms-core-servlet.
 *
 * semanticcms-core-servlet is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * semanticcms-core-servlet 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
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with semanticcms-core-servlet.  If not, see .
 */

package com.semanticcms.core.servlet;

import javax.servlet.http.HttpServletRequest;

/**
 * Provides static access to the client-provided headers.
 */
public final class Headers {

  /** Make no instances. */
  private Headers() {
    throw new AssertionError();
  }

  /**
   * A client may include this header to indicate it is in export mode.
   */
  private static final String EXPORTING_HEADER = "X-com-semanticcms-core-exporting";

  /**
   * The value to pass in the header.
   */
  private static final String EXPORTING_HEADER_VALUE = "true";

  /**
   * Checks if the request is for an export.
   */
  public static boolean isExporting(HttpServletRequest request) {
    return EXPORTING_HEADER_VALUE.equalsIgnoreCase(request.getHeader(EXPORTING_HEADER));
  }
}