001/*******************************************************************************
002 * Copyright 2017 The MIT Internet Trust Consortium
003 *
004 * Portions copyright 2011-2013 The MITRE Corporation
005 *
006 * Licensed under the Apache License, Version 2.0 (the "License");
007 * you may not use this file except in compliance with the License.
008 * You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 *******************************************************************************/
018/**
019 *
020 */
021package org.mitre.openid.connect.client.service;
022
023import java.util.Map;
024
025import javax.servlet.http.HttpServletRequest;
026
027import org.mitre.oauth2.model.RegisteredClient;
028import org.mitre.openid.connect.config.ServerConfiguration;
029
030/**
031 *
032 * This service provides any extra options that need to be passed to the authentication request,
033 * either through the authorization endpoint (getOptions) or the token endpoint (getTokenOptions).
034 * These options may depend on the server configuration, client configuration, or HTTP request.
035 *
036 * @author jricher
037 *
038 */
039public interface AuthRequestOptionsService {
040
041        /**
042         * The set of options needed at the authorization endpoint.
043         *
044         * @param server
045         * @param client
046         * @param request
047         * @return
048         */
049        public Map<String, String> getOptions(ServerConfiguration server, RegisteredClient client, HttpServletRequest request);
050
051        /**
052         * The set of options needed at the token endpoint.
053         *
054         * @param server
055         * @param client
056         * @param request
057         * @return
058         */
059        public Map<String, String> getTokenOptions(ServerConfiguration server, RegisteredClient client, HttpServletRequest request);
060
061}