View Javadoc
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.oauth2.provider;
18  
19  
20  /**
21   * A service that provides the details about an OAuth2 client.
22   *
23   * @author Ryan Heaton
24   */
25  public interface ClientDetailsService {
26  
27    /**
28     * Load a client by the client id. This method must not return null.
29     *
30     * @param clientId The client id.
31     * @return The client details (never null).
32     * @throws ClientRegistrationException If the client account is locked, expired, disabled, or invalid for any other reason.
33     */
34    ClientDetails loadClientByClientId(String clientId) throws ClientRegistrationException;
35  
36  }