com.threewks.thundr.user.gae.authentication.ObjectifyAuthentication Maven / Gradle / Ivy

Go to download
/*
 * This file is a component of thundr, a software library from 3wks.
 * Read more: http://3wks.github.io/thundr/
 * Copyright (C) 2015 3wks, 
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.threewks.thundr.user.gae.authentication;

import com.googlecode.objectify.Objectify;
import com.threewks.thundr.user.authentication.Authentication;
import com.threewks.thundr.user.gae.UserGae;

/**
 * Authentications stored into the User object with Objectify implement this interface.
 */
public interface ObjectifyAuthentication> extends Authentication {
	public void setUser(UserGae user);

	/**
	 * Find the user for this type of authentication. If this authentication is unverified, a search
	 * may need to be performed, if it is verified the user will already have been set previously.
	 * 
	 * @param ofy
	 * @return the user for this authentication, or null if none
	 */
	public UserGae getUser(Objectify ofy);

	/**
	 * Find the authentication matching the given one - that is the authentication that is of the same type for the same user.
	 * 
	 * @param authentication
	 * @return
	 */
	public Self getMatchingAuthentication(Objectify ofy, Self authentication);
}