001/* 002 * CDDL HEADER START 003 * 004 * The contents of this file are subject to the terms of the 005 * Common Development and Distribution License, Version 1.0 only 006 * (the "License"). You may not use this file except in compliance 007 * with the License. 008 * 009 * You can obtain a copy of the license at 010 * docs/licenses/cddl.txt 011 * or http://www.opensource.org/licenses/cddl1.php. 012 * See the License for the specific language governing permissions 013 * and limitations under the License. 014 * 015 * When distributing Covered Code, include this CDDL HEADER in each 016 * file and include the License file at 017 * docs/licenses/cddl.txt. If applicable, 018 * add the following below this CDDL HEADER, with the fields enclosed 019 * by brackets "[]" replaced with your own identifying information: 020 * Portions Copyright [yyyy] [name of copyright owner] 021 * 022 * CDDL HEADER END 023 * 024 * 025 * Copyright 2016-2021 Ping Identity Corporation 026 */ 027package com.unboundid.directory.sdk.broker.types; 028 029import javax.servlet.http.HttpServletRequest; 030 031/** 032 * Common methods available to all Store Adapter Plugin request context 033 * interfaces. 034 */ 035public interface StoreRequestContext 036{ 037 /** 038 * Get the associated HTTP request, which may be {@code null} if there is no 039 * associated external HTTP request. The setAttribute and getAttribute methods 040 * on the HttpServletRequest may be used by a plugin extension to store 041 * some state in a pre-request method and reference it in the post-request 042 * method. 043 * 044 * @return The HTTP request, or {@code null} if there is none. 045 */ 046 HttpServletRequest getHttpServletRequest(); 047}