001/*
002 * oauth2-oidc-sdk
003 *
004 * Copyright 2012-2016, Connect2id Ltd and contributors.
005 *
006 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use
007 * this file except in compliance with the License. You may obtain a copy of the
008 * 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 distributed
013 * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
014 * CONDITIONS OF ANY KIND, either express or implied. See the License for the
015 * specific language governing permissions and limitations under the License.
016 */
017
018package com.nimbusds.openid.connect.sdk;
019
020
021import java.net.URI;
022
023import com.nimbusds.oauth2.sdk.Response;
024import com.nimbusds.oauth2.sdk.id.State;
025
026
027/**
028 * OpenID Connect authentication response.
029 *
030 * <p>Related specifications:
031 *
032 * <ul>
033 *     <li>OpenID Connect Core 1.0, sections 3.1.2.5. and 3.1.2.6.
034 * </ul>
035 */
036public interface AuthenticationResponse extends Response {
037
038
039        /**
040         * Gets the base redirection URI.
041         *
042         * @return The base redirection URI (without the appended error
043         *         response parameters).
044         */
045        URI getRedirectionURI();
046
047
048        /**
049         * Gets the optional state.
050         *
051         * @return The state, {@code null} if not requested.
052         */
053        State getState();
054}