001/* 002 * The contents of this file are subject to the terms of the Common Development and 003 * Distribution License (the License). You may not use this file except in compliance with the 004 * License. 005 * 006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the 007 * specific language governing permission and limitations under the License. 008 * 009 * When distributing Covered Software, include this CDDL Header Notice in each file and include 010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL 011 * Header, with the fields enclosed by brackets [] replaced by your own identifying 012 * information: "Portions Copyright [year] [name of copyright owner]". 013 * 014 * Copyright 2008 Sun Microsystems, Inc. 015 */ 016package org.forgerock.opendj.server.config.server; 017 018 019 020import java.util.SortedSet; 021import org.forgerock.opendj.config.Configuration; 022import org.forgerock.opendj.config.server.ConfigurationChangeListener; 023import org.forgerock.opendj.ldap.DN; 024 025 026 027/** 028 * A server-side interface for querying HTTP Endpoint settings. 029 * <p> 030 * The HTTP Endpoint is used to define HTTP endpoint. 031 */ 032public interface HTTPEndpointCfg extends Configuration { 033 034 /** 035 * Gets the configuration class associated with this HTTP Endpoint. 036 * 037 * @return Returns the configuration class associated with this HTTP Endpoint. 038 */ 039 Class<? extends HTTPEndpointCfg> configurationClass(); 040 041 042 043 /** 044 * Register to be notified when this HTTP Endpoint is changed. 045 * 046 * @param listener 047 * The HTTP Endpoint configuration change listener. 048 */ 049 void addChangeListener(ConfigurationChangeListener<HTTPEndpointCfg> listener); 050 051 052 053 /** 054 * Deregister an existing HTTP Endpoint configuration change listener. 055 * 056 * @param listener 057 * The HTTP Endpoint configuration change listener. 058 */ 059 void removeChangeListener(ConfigurationChangeListener<HTTPEndpointCfg> listener); 060 061 062 063 /** 064 * Gets the "authorization-mechanism" property. 065 * <p> 066 * The HTTP authorization mechanisms supported by this HTTP 067 * Endpoint. 068 * 069 * @return Returns an unmodifiable set containing the values of the "authorization-mechanism" property. 070 */ 071 SortedSet<String> getAuthorizationMechanism(); 072 073 074 075 /** 076 * Gets the "authorization-mechanism" property as a set of DNs. 077 * <p> 078 * The HTTP authorization mechanisms supported by this HTTP 079 * Endpoint. 080 * 081 * @return Returns the DN values of the "authorization-mechanism" 082 * property. 083 */ 084 SortedSet<DN> getAuthorizationMechanismDNs(); 085 086 087 088 /** 089 * Gets the "base-path" property. 090 * <p> 091 * All HTTP requests matching the base path or subordinate to it 092 * will be routed to the HTTP endpoint unless a more specific HTTP 093 * endpoint is found. 094 * 095 * @return Returns the value of the "base-path" property. 096 */ 097 String getBasePath(); 098 099 100 101 /** 102 * Gets the "enabled" property. 103 * <p> 104 * Indicates whether the HTTP Endpoint is enabled. 105 * 106 * @return Returns the value of the "enabled" property. 107 */ 108 boolean isEnabled(); 109 110 111 112 /** 113 * Gets the "java-class" property. 114 * <p> 115 * Specifies the fully-qualified name of the Java class that 116 * provides the HTTP Endpoint implementation. 117 * 118 * @return Returns the value of the "java-class" property. 119 */ 120 String getJavaClass(); 121 122}