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.HTTPOauth2CtsAuthorizationMechanismCfg; 023 024 025 026/** 027 * A client-side interface for reading and modifying HTTP Oauth2 Cts 028 * Authorization Mechanism settings. 029 * <p> 030 * The HTTP Oauth2 Cts Authorization Mechanism is used to define 031 * OAuth2 authorization through a direct access to the CTS (Core Token 032 * Service). 033 */ 034public interface HTTPOauth2CtsAuthorizationMechanismCfgClient extends HTTPOauth2AuthorizationMechanismCfgClient { 035 036 /** 037 * Get the configuration definition associated with this HTTP Oauth2 Cts Authorization Mechanism. 038 * 039 * @return Returns the configuration definition associated with this HTTP Oauth2 Cts Authorization Mechanism. 040 */ 041 ManagedObjectDefinition<? extends HTTPOauth2CtsAuthorizationMechanismCfgClient, ? extends HTTPOauth2CtsAuthorizationMechanismCfg> 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 "base-dn" property. 075 * <p> 076 * The base DN of the Core Token Service where access token are 077 * stored. (example: 078 * ou=famrecords,ou=openam-session,ou=tokens,dc=example,dc=com) 079 * 080 * @return Returns the value of the "base-dn" property. 081 */ 082 String getBaseDN(); 083 084 085 086 /** 087 * Sets the "base-dn" property. 088 * <p> 089 * The base DN of the Core Token Service where access token are 090 * stored. (example: 091 * ou=famrecords,ou=openam-session,ou=tokens,dc=example,dc=com) 092 * 093 * @param value The value of the "base-dn" property. 094 * @throws PropertyException 095 * If the new value is invalid. 096 */ 097 void setBaseDN(String value) throws PropertyException; 098 099 100 101 /** 102 * Gets the "java-class" property. 103 * <p> 104 * Specifies the fully-qualified name of the Java class that 105 * provides the HTTP Oauth2 Cts Authorization Mechanism 106 * implementation. 107 * 108 * @return Returns the value of the "java-class" property. 109 */ 110 String getJavaClass(); 111 112 113 114 /** 115 * Sets the "java-class" property. 116 * <p> 117 * Specifies the fully-qualified name of the Java class that 118 * provides the HTTP Oauth2 Cts Authorization Mechanism 119 * implementation. 120 * 121 * @param value The value of the "java-class" property. 122 * @throws PropertyException 123 * If the new value is invalid. 124 */ 125 void setJavaClass(String value) throws PropertyException; 126 127}