org.springframework.social.connect

Class UserProfile

java.lang.Object

org.springframework.social.connect.UserProfile

All Implemented Interfaces:

java.io.Serializable

public class UserProfile
extends java.lang.Object
implements java.io.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.

Author:

Keith Donald

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).

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getEmail() The user's registered email address.
java.lang.String	getFirstName() The user's registered first name e.g.
java.lang.String	getLastName() The user's registered last name e.g.
java.lang.String	getName() The user's registered full name e.g.
java.lang.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).

Method Detail

getName

public java.lang.String getName()

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

getFirstName

public java.lang.String getFirstName()

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

getLastName

public java.lang.String getLastName()

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

getEmail

public java.lang.String getEmail()

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

getUsername

public java.lang.String getUsername()

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