/* * Copyright 2015 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.connect; /** * A configuration interface used to set values on a {@link Connection} from a specific service provider API instance. * {@link #setProviderUserId(String)} maps to {@link ConnectionKey#getProviderUserId()} * {@link #setDisplayName(String)} maps to {@link Connection#getDisplayName()} * {@link #setProfileUrl(String)} maps to {@link Connection#getProfileUrl()} * {@link #setImageUrl(String)} maps to {@link Connection#getImageUrl()} * @author Keith Donald * @see ApiAdapter#setConnectionValues(Object, ConnectionValues) */ public interface ConnectionValues { /** * Sets value mapped to {@link ConnectionKey#getProviderUserId()}. * @param providerUserId the user's identity on the provider */ public void setProviderUserId(String providerUserId); /** * Sets value mapped to {@link Connection#getDisplayName()}. * @param displayName the user's display name */ public void setDisplayName(String displayName); /** * Sets value mapped to {@link Connection#getProfileUrl()} * @param profileUrl the user's profile URL */ public void setProfileUrl(String profileUrl); /** * Sets value mapped to {@link Connection#getImageUrl()} * @param imageUrl the user's image URL */ public void setImageUrl(String imageUrl); }