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.client; 017 018 019 020import org.forgerock.opendj.config.ManagedObjectDefinition; 021import org.forgerock.opendj.config.PropertyException; 022import org.forgerock.opendj.server.config.server.HTTPOauth2TokenIntrospectionAuthorizationMechanismCfg; 023 024 025 026/** 027 * A client-side interface for reading and modifying HTTP Oauth2 Token 028 * Introspection Authorization Mechanism settings. 029 * <p> 030 * The HTTP Oauth2 Token Introspection Authorization Mechanism is used 031 * to define OAuth2 authorization using an introspection (RFC7662) 032 * compliant authorization server. 033 */ 034public interface HTTPOauth2TokenIntrospectionAuthorizationMechanismCfgClient extends HTTPOauth2AuthorizationMechanismCfgClient { 035 036 /** 037 * Get the configuration definition associated with this HTTP Oauth2 Token Introspection Authorization Mechanism. 038 * 039 * @return Returns the configuration definition associated with this HTTP Oauth2 Token Introspection Authorization Mechanism. 040 */ 041 ManagedObjectDefinition<? extends HTTPOauth2TokenIntrospectionAuthorizationMechanismCfgClient, ? extends HTTPOauth2TokenIntrospectionAuthorizationMechanismCfg> definition(); 042 043 044 045 /** 046 * Gets the "authzid-json-pointer" property. 047 * <p> 048 * Specifies the JSON pointer to the value to use as Authorization 049 * ID. The JSON pointer is applied to the resolved access token JSON 050 * document. (example: /uid) 051 * 052 * @return Returns the value of the "authzid-json-pointer" property. 053 */ 054 String getAuthzidJsonPointer(); 055 056 057 058 /** 059 * Sets the "authzid-json-pointer" property. 060 * <p> 061 * Specifies the JSON pointer to the value to use as Authorization 062 * ID. The JSON pointer is applied to the resolved access token JSON 063 * document. (example: /uid) 064 * 065 * @param value The value of the "authzid-json-pointer" property. 066 * @throws PropertyException 067 * If the new value is invalid. 068 */ 069 void setAuthzidJsonPointer(String value) throws PropertyException; 070 071 072 073 /** 074 * Gets the "client-id" property. 075 * <p> 076 * Client's ID to use during the HTTP basic authentication against 077 * the authorization server. 078 * 079 * @return Returns the value of the "client-id" property. 080 */ 081 String getClientId(); 082 083 084 085 /** 086 * Sets the "client-id" property. 087 * <p> 088 * Client's ID to use during the HTTP basic authentication against 089 * the authorization server. 090 * 091 * @param value The value of the "client-id" property. 092 * @throws PropertyException 093 * If the new value is invalid. 094 */ 095 void setClientId(String value) throws PropertyException; 096 097 098 099 /** 100 * Gets the "client-secret" property. 101 * <p> 102 * Client's secret to use during the HTTP basic authentication 103 * against the authorization server. 104 * 105 * @return Returns the value of the "client-secret" property. 106 */ 107 String getClientSecret(); 108 109 110 111 /** 112 * Sets the "client-secret" property. 113 * <p> 114 * Client's secret to use during the HTTP basic authentication 115 * against the authorization server. 116 * 117 * @param value The value of the "client-secret" property. 118 * @throws PropertyException 119 * If the new value is invalid. 120 */ 121 void setClientSecret(String value) throws PropertyException; 122 123 124 125 /** 126 * Gets the "java-class" property. 127 * <p> 128 * Specifies the fully-qualified name of the Java class that 129 * provides the HTTP Oauth2 Token Introspection Authorization 130 * Mechanism implementation. 131 * 132 * @return Returns the value of the "java-class" property. 133 */ 134 String getJavaClass(); 135 136 137 138 /** 139 * Sets the "java-class" property. 140 * <p> 141 * Specifies the fully-qualified name of the Java class that 142 * provides the HTTP Oauth2 Token Introspection Authorization 143 * Mechanism implementation. 144 * 145 * @param value The value of the "java-class" property. 146 * @throws PropertyException 147 * If the new value is invalid. 148 */ 149 void setJavaClass(String value) throws PropertyException; 150 151 152 153 /** 154 * Gets the "key-manager-provider" property. 155 * <p> 156 * Specifies the name of the key manager that should be used with 157 * this HTTP Oauth2 Token Introspection Authorization Mechanism . 158 * 159 * @return Returns the value of the "key-manager-provider" property. 160 */ 161 String getKeyManagerProvider(); 162 163 164 165 /** 166 * Sets the "key-manager-provider" property. 167 * <p> 168 * Specifies the name of the key manager that should be used with 169 * this HTTP Oauth2 Token Introspection Authorization Mechanism . 170 * 171 * @param value The value of the "key-manager-provider" property. 172 * @throws PropertyException 173 * If the new value is invalid. 174 */ 175 void setKeyManagerProvider(String value) throws PropertyException; 176 177 178 179 /** 180 * Gets the "token-introspection-url" property. 181 * <p> 182 * Defines the token introspection endpoint URL where the 183 * access-token resolution request should be sent. (example: 184 * http://example.com/introspect) 185 * 186 * @return Returns the value of the "token-introspection-url" property. 187 */ 188 String getTokenIntrospectionUrl(); 189 190 191 192 /** 193 * Sets the "token-introspection-url" property. 194 * <p> 195 * Defines the token introspection endpoint URL where the 196 * access-token resolution request should be sent. (example: 197 * http://example.com/introspect) 198 * 199 * @param value The value of the "token-introspection-url" property. 200 * @throws PropertyException 201 * If the new value is invalid. 202 */ 203 void setTokenIntrospectionUrl(String value) throws PropertyException; 204 205 206 207 /** 208 * Gets the "trust-manager-provider" property. 209 * <p> 210 * Specifies the name of the trust manager that should be used when 211 * negotiating SSL connections with the remote authorization server. 212 * 213 * @return Returns the value of the "trust-manager-provider" property. 214 */ 215 String getTrustManagerProvider(); 216 217 218 219 /** 220 * Sets the "trust-manager-provider" property. 221 * <p> 222 * Specifies the name of the trust manager that should be used when 223 * negotiating SSL connections with the remote authorization server. 224 * 225 * @param value The value of the "trust-manager-provider" property. 226 * @throws PropertyException 227 * If the new value is invalid. 228 */ 229 void setTrustManagerProvider(String value) throws PropertyException; 230 231}