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 File Authorization
026 * Mechanism settings.
027 * <p>
028 * The HTTP Oauth2 File Authorization Mechanism is used to define
029 * OAuth2 authorization through a file based access-token resolution.
030 * For test purpose only, this mechanism is looking up for JSON
031 * access-token files under the specified path.
032 */
033public interface HTTPOauth2FileAuthorizationMechanismCfg extends HTTPOauth2AuthorizationMechanismCfg {
034
035  /**
036   * Gets the configuration class associated with this HTTP Oauth2 File Authorization Mechanism.
037   *
038   * @return Returns the configuration class associated with this HTTP Oauth2 File Authorization Mechanism.
039   */
040  Class<? extends HTTPOauth2FileAuthorizationMechanismCfg> configurationClass();
041
042
043
044  /**
045   * Register to be notified when this HTTP Oauth2 File Authorization Mechanism is changed.
046   *
047   * @param listener
048   *          The HTTP Oauth2 File Authorization Mechanism configuration change listener.
049   */
050  void addHTTPOauth2FileAuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPOauth2FileAuthorizationMechanismCfg> listener);
051
052
053
054  /**
055   * Deregister an existing HTTP Oauth2 File Authorization Mechanism configuration change listener.
056   *
057   * @param listener
058   *          The HTTP Oauth2 File Authorization Mechanism configuration change listener.
059   */
060  void removeHTTPOauth2FileAuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPOauth2FileAuthorizationMechanismCfg> listener);
061
062
063
064  /**
065   * Gets the "access-token-directory" property.
066   * <p>
067   * Directory containing token files. File names must be equal to the
068   * token strings. The file content must a JSON object with the
069   * following attributes: 'scope', 'expireTime' and all the field(s)
070   * needed to resolve the authzIdTemplate.
071   *
072   * @return Returns the value of the "access-token-directory" property.
073   */
074  String getAccessTokenDirectory();
075
076
077
078  /**
079   * Gets the "java-class" property.
080   * <p>
081   * Specifies the fully-qualified name of the Java class that
082   * provides the HTTP Oauth2 File Authorization Mechanism
083   * implementation.
084   *
085   * @return Returns the value of the "java-class" property.
086   */
087  String getJavaClass();
088
089}