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 org.forgerock.opendj.config.server.ConfigurationChangeListener; 021 022 023 024/** 025 * A server-side interface for querying HTTP Oauth2 Cts Authorization 026 * Mechanism settings. 027 * <p> 028 * The HTTP Oauth2 Cts Authorization Mechanism is used to define 029 * OAuth2 authorization through a direct access to the CTS (Core Token 030 * Service). 031 */ 032public interface HTTPOauth2CtsAuthorizationMechanismCfg extends HTTPOauth2AuthorizationMechanismCfg { 033 034 /** 035 * Gets the configuration class associated with this HTTP Oauth2 Cts Authorization Mechanism. 036 * 037 * @return Returns the configuration class associated with this HTTP Oauth2 Cts Authorization Mechanism. 038 */ 039 Class<? extends HTTPOauth2CtsAuthorizationMechanismCfg> configurationClass(); 040 041 042 043 /** 044 * Register to be notified when this HTTP Oauth2 Cts Authorization Mechanism is changed. 045 * 046 * @param listener 047 * The HTTP Oauth2 Cts Authorization Mechanism configuration change listener. 048 */ 049 void addHTTPOauth2CtsAuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPOauth2CtsAuthorizationMechanismCfg> listener); 050 051 052 053 /** 054 * Deregister an existing HTTP Oauth2 Cts Authorization Mechanism configuration change listener. 055 * 056 * @param listener 057 * The HTTP Oauth2 Cts Authorization Mechanism configuration change listener. 058 */ 059 void removeHTTPOauth2CtsAuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPOauth2CtsAuthorizationMechanismCfg> listener); 060 061 062 063 /** 064 * Gets the "authzid-json-pointer" property. 065 * <p> 066 * Specifies the JSON pointer to the value to use as Authorization 067 * ID. The JSON pointer is applied to the resolved access token JSON 068 * document. (example: /uid) 069 * 070 * @return Returns the value of the "authzid-json-pointer" property. 071 */ 072 String getAuthzidJsonPointer(); 073 074 075 076 /** 077 * Gets the "base-dn" property. 078 * <p> 079 * The base DN of the Core Token Service where access token are 080 * stored. (example: 081 * ou=famrecords,ou=openam-session,ou=tokens,dc=example,dc=com) 082 * 083 * @return Returns the value of the "base-dn" property. 084 */ 085 String getBaseDN(); 086 087 088 089 /** 090 * Gets the "java-class" property. 091 * <p> 092 * Specifies the fully-qualified name of the Java class that 093 * provides the HTTP Oauth2 Cts Authorization Mechanism 094 * implementation. 095 * 096 * @return Returns the value of the "java-class" property. 097 */ 098 String getJavaClass(); 099 100}