1 /*
2 * Copyright 2008 Web Cohesion
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * https://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package org.springframework.security.oauth.provider;
18
19 import org.springframework.security.oauth.common.OAuthException;
20
21 /**
22 * A service that provides the details about an oauth consumer.
23 *
24 * @author Ryan Heaton
25 */
26 public interface ConsumerDetailsService {
27
28 /**
29 * Load a consumer by the consumer key. This method must NOT return null.
30 *
31 * @param consumerKey The consumer key.
32 * @return The consumer details.
33 * @throws OAuthException If the consumer account is locked, expired, disabled, or for any other reason.
34 */
35 ConsumerDetails loadConsumerByConsumerKey(String consumerKey) throws OAuthException;
36
37 }