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 2011-2014 UnboundID Corp. 026 */ 027 package com.unboundid.directory.sdk.http.config; 028 029 030 031 import com.unboundid.util.InternalUseOnly; 032 import com.unboundid.util.NotExtensible; 033 import com.unboundid.util.ThreadSafety; 034 import com.unboundid.util.ThreadSafetyLevel; 035 036 037 038 /** 039 * This interface defines a set of methods that may be used to obtain 040 * information about the general configuration for an HTTP servlet extension. 041 */ 042 @NotExtensible() 043 @ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE) 044 public interface HTTPServletExtensionConfig 045 extends GenericHTTPConfig 046 { 047 /** 048 * Retrieves a handle to an object that may be used to interact with the HTTP 049 * server itself. This is provided for internal use only by 050 * UnboundID-developed extensions, and no guarantee is made about either the 051 * type of object, or the stability of the type of that object. 052 * 053 * @return A handle to an object that may be used by UnboundID-developed 054 * extensions to interact with the HTTP server itself. 055 */ 056 @InternalUseOnly() 057 Object getHTTPServerObject(); 058 059 060 061 /** 062 * Retrieves the DN of the configuration object for the HTTP connection 063 * handler that created the servlet extension. 064 * 065 * @return The DN of the configuration object for the HTTP connection handler 066 * that created the servlet extension. 067 */ 068 String getHTTPConnectionHandlerConfigDN(); 069 }