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 org.mitre.oauth2.model.RegisteredClient;
026import org.mitre.openid.connect.config.ServerConfiguration;
027
028/**
029 * Builds a URL string to the IdP's authorization endpoint.
030 *
031 * @author jricher
032 *
033 */
034public interface AuthRequestUrlBuilder {
035
036        /**
037         * @param serverConfig
038         * @param clientConfig
039         * @param redirectUri
040         * @param nonce
041         * @param state
042         * @param loginHint
043         * @return
044         */
045        public String buildAuthRequestUrl(ServerConfiguration serverConfig, RegisteredClient clientConfig, String redirectUri, String nonce, String state, Map<String, String> options, String loginHint);
046
047}