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.HTTPOauth2OpenamAuthorizationMechanismCfg; 023 024 025 026/** 027 * A client-side interface for reading and modifying HTTP Oauth2 028 * Openam Authorization Mechanism settings. 029 * <p> 030 * The HTTP Oauth2 Openam Authorization Mechanism is used to define 031 * OAuth2 authorization using an OpenAM server as authorization server 032 * . 033 */ 034public interface HTTPOauth2OpenamAuthorizationMechanismCfgClient extends HTTPOauth2AuthorizationMechanismCfgClient { 035 036 /** 037 * Get the configuration definition associated with this HTTP Oauth2 Openam Authorization Mechanism. 038 * 039 * @return Returns the configuration definition associated with this HTTP Oauth2 Openam Authorization Mechanism. 040 */ 041 ManagedObjectDefinition<? extends HTTPOauth2OpenamAuthorizationMechanismCfgClient, ? extends HTTPOauth2OpenamAuthorizationMechanismCfg> 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 "java-class" property. 075 * <p> 076 * Specifies the fully-qualified name of the Java class that 077 * provides the HTTP Oauth2 Openam Authorization Mechanism 078 * implementation. 079 * 080 * @return Returns the value of the "java-class" property. 081 */ 082 String getJavaClass(); 083 084 085 086 /** 087 * Sets the "java-class" property. 088 * <p> 089 * Specifies the fully-qualified name of the Java class that 090 * provides the HTTP Oauth2 Openam Authorization Mechanism 091 * implementation. 092 * 093 * @param value The value of the "java-class" property. 094 * @throws PropertyException 095 * If the new value is invalid. 096 */ 097 void setJavaClass(String value) throws PropertyException; 098 099 100 101 /** 102 * Gets the "key-manager-provider" property. 103 * <p> 104 * Specifies the name of the key manager that should be used with 105 * this HTTP Oauth2 Openam Authorization Mechanism . 106 * 107 * @return Returns the value of the "key-manager-provider" property. 108 */ 109 String getKeyManagerProvider(); 110 111 112 113 /** 114 * Sets the "key-manager-provider" property. 115 * <p> 116 * Specifies the name of the key manager that should be used with 117 * this HTTP Oauth2 Openam Authorization Mechanism . 118 * 119 * @param value The value of the "key-manager-provider" property. 120 * @throws PropertyException 121 * If the new value is invalid. 122 */ 123 void setKeyManagerProvider(String value) throws PropertyException; 124 125 126 127 /** 128 * Gets the "token-info-url" property. 129 * <p> 130 * Defines the OpenAM endpoint URL where the access-token resolution 131 * request should be sent. 132 * 133 * @return Returns the value of the "token-info-url" property. 134 */ 135 String getTokenInfoUrl(); 136 137 138 139 /** 140 * Sets the "token-info-url" property. 141 * <p> 142 * Defines the OpenAM endpoint URL where the access-token resolution 143 * request should be sent. 144 * 145 * @param value The value of the "token-info-url" property. 146 * @throws PropertyException 147 * If the new value is invalid. 148 */ 149 void setTokenInfoUrl(String value) throws PropertyException; 150 151 152 153 /** 154 * Gets the "trust-manager-provider" property. 155 * <p> 156 * Specifies the name of the trust manager that should be used when 157 * negotiating SSL connections with the remote authorization server. 158 * 159 * @return Returns the value of the "trust-manager-provider" property. 160 */ 161 String getTrustManagerProvider(); 162 163 164 165 /** 166 * Sets the "trust-manager-provider" property. 167 * <p> 168 * Specifies the name of the trust manager that should be used when 169 * negotiating SSL connections with the remote authorization server. 170 * 171 * @param value The value of the "trust-manager-provider" property. 172 * @throws PropertyException 173 * If the new value is invalid. 174 */ 175 void setTrustManagerProvider(String value) throws PropertyException; 176 177}