001/*******************************************************************************
002 * Copyright 2017 The MIT Internet Trust Consortium
003 *
004 * Portions copyright 2011-2013 The MITRE Corporation
005 *
006 * Licensed under the Apache License, Version 2.0 (the "License");
007 * you may not use this file except in compliance with the License.
008 * You may obtain a copy of the 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
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 *******************************************************************************/
018package org.mitre.openid.connect.service;
019
020import org.mitre.openid.connect.model.UserInfo;
021
022/**
023 * Interface for UserInfo service
024 *
025 * @author Michael Joseph Walsh
026 *
027 */
028public interface UserInfoService {
029
030        /**
031         * Get the UserInfo for the given username (usually maps to the
032         * preferredUsername field).
033         * @param username
034         * @return
035         */
036        public UserInfo getByUsername(String username);
037
038        /**
039         * Get the UserInfo for the given username (usually maps to the
040         * preferredUsername field) and clientId. This allows pairwise
041         * client identifiers where appropriate.
042         * @param username
043         * @param clientId
044         * @return
045         */
046        public UserInfo getByUsernameAndClientId(String username, String clientId);
047
048        /**
049         * Get the user registered at this server with the given email address.
050         *
051         * @param email
052         * @return
053         */
054        public UserInfo getByEmailAddress(String email);
055
056}