001/*
002 * Copyright 2012-2017 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.boot.autoconfigure.session;
018
019import java.util.Collections;
020import java.util.List;
021
022import org.springframework.session.SessionRepository;
023import org.springframework.util.ObjectUtils;
024
025/**
026 * Exception thrown when multiple {@link SessionRepository} implementations are available
027 * with no way to know which implementation should be used.
028 *
029 * @author Stephane Nicoll
030 * @since 2.0.0
031 */
032public class NonUniqueSessionRepositoryException extends RuntimeException {
033
034        private final List<Class<?>> availableCandidates;
035
036        public NonUniqueSessionRepositoryException(List<Class<?>> availableCandidates) {
037                super("Multiple session repository candidates are available, set the "
038                                + "'spring.session.store-type' property accordingly");
039                this.availableCandidates = (!ObjectUtils.isEmpty(availableCandidates)
040                                ? availableCandidates : Collections.emptyList());
041        }
042
043        public List<Class<?>> getAvailableCandidates() {
044                return this.availableCandidates;
045        }
046
047}