LastFmAuthServiceProvider.java

/*
 * Copyright 2011 the original author or authors.
 *
 * 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 org.springframework.social.lastfm.auth;

import org.springframework.social.ServiceProvider;
import org.springframework.social.lastfm.api.LastFm;

/**
 * @author Michael Lavelle
 */
public interface LastFmAuthServiceProvider extends ServiceProvider<LastFm> {

	/**
	 * Get the service interface for carrying out the "Pseudo-OAuth dance" with
	 * LastFm The result of the LastFm-Auth dance is an access token that can be
	 * used to obtain a {@link #getApi(String,String) API binding}.
	 */
	LastFmAuthOperations getLastFmAuthOperations();

	/**
	 * Returns an API interface allowing the client application to access
	 * protected resources on behalf of a user.
	 * 
	 * @param token
	 *            the LastFm-API access token
	 * @param sessionKey
	 *            the LastFm-API sessionKey
	 * @return a binding to the LastFm's API
	 */
	LastFm getApi(LastFmAccessGrant lastFmAccessGrant);

}