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; 021import org.forgerock.opendj.ldap.DN; 022 023 024 025/** 026 * A server-side interface for querying HTTP Oauth2 Openam 027 * Authorization Mechanism settings. 028 * <p> 029 * The HTTP Oauth2 Openam Authorization Mechanism is used to define 030 * OAuth2 authorization using an OpenAM server as authorization server 031 * . 032 */ 033public interface HTTPOauth2OpenamAuthorizationMechanismCfg extends HTTPOauth2AuthorizationMechanismCfg { 034 035 /** 036 * Gets the configuration class associated with this HTTP Oauth2 Openam Authorization Mechanism. 037 * 038 * @return Returns the configuration class associated with this HTTP Oauth2 Openam Authorization Mechanism. 039 */ 040 Class<? extends HTTPOauth2OpenamAuthorizationMechanismCfg> configurationClass(); 041 042 043 044 /** 045 * Register to be notified when this HTTP Oauth2 Openam Authorization Mechanism is changed. 046 * 047 * @param listener 048 * The HTTP Oauth2 Openam Authorization Mechanism configuration change listener. 049 */ 050 void addHTTPOauth2OpenamAuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPOauth2OpenamAuthorizationMechanismCfg> listener); 051 052 053 054 /** 055 * Deregister an existing HTTP Oauth2 Openam Authorization Mechanism configuration change listener. 056 * 057 * @param listener 058 * The HTTP Oauth2 Openam Authorization Mechanism configuration change listener. 059 */ 060 void removeHTTPOauth2OpenamAuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPOauth2OpenamAuthorizationMechanismCfg> listener); 061 062 063 064 /** 065 * Gets the "authzid-json-pointer" property. 066 * <p> 067 * Specifies the JSON pointer to the value to use as Authorization 068 * ID. The JSON pointer is applied to the resolved access token JSON 069 * document. (example: /uid) 070 * 071 * @return Returns the value of the "authzid-json-pointer" property. 072 */ 073 String getAuthzidJsonPointer(); 074 075 076 077 /** 078 * Gets the "java-class" property. 079 * <p> 080 * Specifies the fully-qualified name of the Java class that 081 * provides the HTTP Oauth2 Openam Authorization Mechanism 082 * implementation. 083 * 084 * @return Returns the value of the "java-class" property. 085 */ 086 String getJavaClass(); 087 088 089 090 /** 091 * Gets the "key-manager-provider" property. 092 * <p> 093 * Specifies the name of the key manager that should be used with 094 * this HTTP Oauth2 Openam Authorization Mechanism . 095 * 096 * @return Returns the value of the "key-manager-provider" property. 097 */ 098 String getKeyManagerProvider(); 099 100 101 102 /** 103 * Gets the "key-manager-provider" property as a DN. 104 * <p> 105 * Specifies the name of the key manager that should be used with 106 * this HTTP Oauth2 Openam Authorization Mechanism . 107 * 108 * @return Returns the DN value of the "key-manager-provider" 109 * property. 110 */ 111 DN getKeyManagerProviderDN(); 112 113 114 115 /** 116 * Gets the "token-info-url" property. 117 * <p> 118 * Defines the OpenAM endpoint URL where the access-token resolution 119 * request should be sent. 120 * 121 * @return Returns the value of the "token-info-url" property. 122 */ 123 String getTokenInfoUrl(); 124 125 126 127 /** 128 * Gets the "trust-manager-provider" property. 129 * <p> 130 * Specifies the name of the trust manager that should be used when 131 * negotiating SSL connections with the remote authorization server. 132 * 133 * @return Returns the value of the "trust-manager-provider" property. 134 */ 135 String getTrustManagerProvider(); 136 137 138 139 /** 140 * Gets the "trust-manager-provider" property as a DN. 141 * <p> 142 * Specifies the name of the trust manager that should be used when 143 * negotiating SSL connections with the remote authorization server. 144 * 145 * @return Returns the DN value of the "trust-manager-provider" 146 * property. 147 */ 148 DN getTrustManagerProviderDN(); 149 150}