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 2013-2014 UnboundID Corp. 026 */ 027 package com.unboundid.directory.sdk.common.config; 028 029 030 import com.unboundid.util.NotExtensible; 031 import com.unboundid.util.ThreadSafety; 032 import com.unboundid.util.ThreadSafetyLevel; 033 034 035 /** 036 * This interface defines a set of methods that may be used to obtain 037 * information about the general configuration for a Velocity context 038 * provider. 039 */ 040 @NotExtensible() 041 @ThreadSafety(level= ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE) 042 public interface VelocityContextProviderConfig extends GenericConfig 043 { 044 045 static enum ObjectScope { 046 047 /** 048 * Objects added to the context should be scoped for the lifetime of 049 * the application. 050 */ 051 APPLICATION, 052 053 054 055 /** 056 * Objects added to the context should be scoped to the client's 057 * session. 058 */ 059 SESSION, 060 061 062 063 /** 064 * Objects added to the context should be scoped to the client's 065 * request. 066 */ 067 REQUEST; 068 } 069 070 071 072 /** 073 * Indicates the expected scope for objects added to the Velocity 074 * context by this provider. 075 * 076 * @return scope for objects added to the context. 077 */ 078 ObjectScope getObjectScope(); 079 080 }