org.springframework.social.connect

Class UserProfile

java.lang.Object

org.springframework.social.connect.UserProfile

All Implemented Interfaces:

Serializable

public class UserProfile
extends Object
implements Serializable

A normalized model representing a service provider user profile. The structure of a "UserProfile" varies across providers (see the difference between Facebook and Twitter, for example). That said, there are generally a common set of profile fields that apply across providers. This model provides access to those common fields in an uniform way. This is particularly useful for pre-populating a local application registration form with provider profile data during a provider sign-in attempt.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static UserProfile	EMPTY Shared, empty profile that when used indicates no profile data is available (all property values are null).

Constructor Summary

Constructors

Constructor and Description
UserProfile(String name, String firstName, String lastName, String email, String username) Deprecated. Use other constructor instead
UserProfile(String id, String name, String firstName, String lastName, String email, String username) Creates an instance of a UserProfile.

Method Summary

Modifier and Type	Method and Description
String	getEmail() The user's registered email address.
String	getFirstName() The user's registered first name e.g.
String	getId() The user's id in the provider May be null if not exposed/supported by the provider.
String	getLastName() The user's registered last name e.g.
String	getName() The user's registered full name e.g.
String	getUsername() The user's registered username e.g.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EMPTY

public static final UserProfile EMPTY

Shared, empty profile that when used indicates no profile data is available (all property values are null).

Constructor Detail

UserProfile

@Deprecated
public UserProfile(String name,
                               String firstName,
                               String lastName,
                               String email,
                               String username)

Deprecated. Use other constructor instead

Creates an instance of a UserProfile.

Parameters:

name - The user's full name

firstName - The user's first name

lastName - The user's last name

email - The user's email address

username - The user's username

UserProfile

public UserProfile(String id,
                   String name,
                   String firstName,
                   String lastName,
                   String email,
                   String username)

Creates an instance of a UserProfile.

Parameters:

id - The user ID

name - The user's full name

firstName - The user's first name

lastName - The user's last name

email - The user's email address

username - The user's username

Method Detail

getId

public String getId()

The user's id in the provider May be null if not exposed/supported by the provider.

Returns:

the user's id in the provider

getName

public String getName()

The user's registered full name e.g. Keith Donald. May be null if not exposed/supported by the provider.

Returns:

the user's registered full name

getFirstName

public String getFirstName()

The user's registered first name e.g. Keith. May be null if not exposed/supported by the provider.

Returns:

The user's registered first name

getLastName

public String getLastName()

The user's registered last name e.g. Donald. May be null if not exposed/supported by the provider.

Returns:

The user's registered last name

getEmail

public String getEmail()

The user's registered email address. May be null if not exposed/supported by the provider.

Returns:

The user's registered email address.

getUsername

public String getUsername()

The user's registered username e.g. kdonald. May be null if not exposed/supported by the provider.

Returns:

The user's registered username