org.springframework.social.connect

Class ConnectionKey

java.lang.Object

org.springframework.social.connect.ConnectionKey

All Implemented Interfaces:

Serializable

public final class ConnectionKey
extends Object
implements Serializable

The unique business key for a Connection instance. A composite key that consists of the providerId (e.g. "facebook") plus providerUserId (e.g. "125660"). Provides the basis for connection equals() and hashCode().

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConnectionKey(String providerId, String providerUserId) Creates a new ConnectionKey.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getProviderId() The id of the provider as it is registered in the system.
String	getProviderUserId() The id of the external provider user representing the remote end of the connection.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionKey

public ConnectionKey(String providerId,
             String providerUserId)

Creates a new ConnectionKey.

Parameters:

providerId - the id of the provider e.g. facebook

providerUserId - id of the provider user account e.g. '125660'

Method Detail

getProviderId

public String getProviderId()

The id of the provider as it is registered in the system. This value should never change. Never null.

Returns:

The id of the provider as it is registered in the system.

getProviderUserId

public String getProviderUserId()

The id of the external provider user representing the remote end of the connection. May be null if this information is not exposed by the provider. This value should never change. Must be present to support sign-in by the provider user. Must be present to establish multiple connections with the provider.

Returns:

The id of the external provider user representing the remote end of the connection.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object