org.springframework.social.connect

Class ConnectionData

java.lang.Object

org.springframework.social.connect.ConnectionData

All Implemented Interfaces:

Serializable

public class ConnectionData
extends Object
implements Serializable

A data transfer object that allows the internal state of a Connection to be persisted and transferred between layers of an application. Some fields may be null depending on the specific type of Connection. For example, an OAuth2Connection has a null 'secret' field while an OAuth1Connection has null 'refreshToken' and 'expireTime' fields.

See Also:

Connection.createData(), Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConnectionData(String providerId, String providerUserId, String displayName, String profileUrl, String imageUrl, String accessToken, String secret, String refreshToken, Long expireTime)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAccessToken() The access token required to make authorized API calls.
String	getDisplayName() A display name for the connection.
Long	getExpireTime() The time the connection expires.
String	getImageUrl() An image visualizing the connection.
String	getProfileUrl() A link to the provider's user profile page.
String	getProviderId() The id of the provider the connection is associated with.
String	getProviderUserId() The id of the provider user this connection is connected to.
String	getRefreshToken() A token use to renew this connection.
String	getSecret() The secret token needed to make authorized API calls.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ConnectionData

public ConnectionData(String providerId,
                      String providerUserId,
                      String displayName,
                      String profileUrl,
                      String imageUrl,
                      String accessToken,
                      String secret,
                      String refreshToken,
                      Long expireTime)

Method Detail

getProviderId

public String getProviderId()

The id of the provider the connection is associated with.

Returns:

The id of the provider the connection is associated with.

getProviderUserId

public String getProviderUserId()

The id of the provider user this connection is connected to.

Returns:

The id of the provider user this connection is connected to.

getDisplayName

public String getDisplayName()

A display name for the connection.

Returns:

A display name for the connection.

getProfileUrl

public String getProfileUrl()

A link to the provider's user profile page.

Returns:

A link to the provider's user profile page.

getImageUrl

public String getImageUrl()

An image visualizing the connection.

Returns:

An image visualizing the connection.

getAccessToken

public String getAccessToken()

The access token required to make authorized API calls.

Returns:

The access token required to make authorized API calls.

getSecret

public String getSecret()

The secret token needed to make authorized API calls. Required for OAuth1-based connections.

Returns:

The secret token needed to make authorized API calls.

getRefreshToken

public String getRefreshToken()

A token use to renew this connection. Optional. Always null for OAuth1-based connections.

Returns:

A token use to renew this connection. Optional.

getExpireTime

public Long getExpireTime()

The time the connection expires. Optional. Always null for OAuth1-based connections.

Returns:

The time the connection expires. Optional.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object