com.novartis.opensource.yada.plugin.ContentPolicy Maven / Gradle / Ivy

Go to download
/**
 * Copyright 2016 Novartis Institutes for BioMedical Research Inc.
 * 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 com.novartis.opensource.yada.plugin;

/**
 * @author Dave Varon
 * @since 0.7.0.0
 *
 */
public interface ContentPolicy extends SecurityPolicy {

  /**
   * An implementation of row-level security, this enables amendment of SQL query 
   * prior to execution, to restrict content dynamically per request.
   * @throws YADASecurityException
   */
  public void applyContentPolicy() throws YADASecurityException;

  /**
   * Provides route to inject HTTP header value into content policy.
   * @param header the name of the header from which to retrieve the value
   * @return the value of the request header, or {@code null} if the header was not included
   * @since 0.7.0.0
   */
  public String getHeader(String header);

  /**
   * Provides route to inject HTTP cookie value into the content policy.
   * @param cookie the name of the cookie for which to retrieve the value
   * @return the value of the desired cookie or {@code null} if the cookie was not included in the request
   * @since 0.7.0.0
   */
  public String getCookie(String cookie);
}