001/*******************************************************************************
002 * Copyright 2014 The MITRE Corporation
003 *   and the MIT Kerberos and Internet Trust Consortium
004 * 
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 * 
009 *   http://www.apache.org/licenses/LICENSE-2.0
010 * 
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 ******************************************************************************/
017package org.mitre.oauth2.repository;
018
019import org.mitre.oauth2.model.AuthorizationCodeEntity;
020import org.springframework.security.oauth2.common.exceptions.InvalidGrantException;
021import org.springframework.security.oauth2.provider.OAuth2Authentication;
022
023/**
024 * Interface for saving and consuming OAuth2 authorization codes as AuthorizationCodeEntitys.
025 * 
026 * @author aanganes
027 *
028 */
029public interface AuthorizationCodeRepository {
030
031        /**
032         * Save an AuthorizationCodeEntity to the repository
033         * 
034         * @param authorizationCode the AuthorizationCodeEntity to save
035         * @return                                      the saved AuthorizationCodeEntity
036         */
037        public AuthorizationCodeEntity save(AuthorizationCodeEntity authorizationCode);
038
039        /**
040         * Consume an authorization code.
041         * 
042         * @param code                                          the authorization code value
043         * @return                                                      the authentication associated with the code
044         * @throws InvalidGrantException        if no AuthorizationCodeEntity is found with the given value
045         */
046        public OAuth2Authentication consume(String code) throws InvalidGrantException;
047
048}