Package org.springframework.social.github.api.impl

Class UserTemplate

java.lang.Object

org.springframework.social.github.api.impl.UserTemplate

All Implemented Interfaces:

UserOperations

public class UserTemplate
extends Object
implements UserOperations

User template implementation.

Author:

Willie Wheeler (willie.wheeler@gmail.com)

Constructor Summary

Constructors

Constructor	Description
UserTemplate(org.springframework.web.client.RestTemplate restTemplate, boolean isAuthorizedForUser)

Method Summary

Modifier and Type	Method	Description
protected String	buildUri(String path)
List<GitHubUser>	getFollowers(String user)	Public operation to return a given user's followers.
List<GitHubUser>	getFollowing(String user)	Public operation to return the users that a given user is following.
String	getProfileId()	Retrieves the user's GitHub profile ID.
String	getProfileUrl()	Retrieve the URL to the user's GitHub profile.
GitHubUserProfile	getUserProfile()	Retrieves the user's GitHub profile details.
protected void	requireAuthorization()

Methods inherited from class java.lang.Object

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

Constructor Detail

UserTemplate

public UserTemplate(org.springframework.web.client.RestTemplate restTemplate,
                    boolean isAuthorizedForUser)

Parameters:

restTemplate - RestTemplate

isAuthorizedForUser - boolean

Method Detail

getProfileId

public String getProfileId()

Description copied from interface: UserOperations

Retrieves the user's GitHub profile ID.

Specified by:

getProfileId in interface UserOperations

Returns:

the user's GitHub profile ID.

getUserProfile

public GitHubUserProfile getUserProfile()

Description copied from interface: UserOperations

Retrieves the user's GitHub profile details.

Specified by:

getUserProfile in interface UserOperations

Returns:

the user's GitHub profile

getProfileUrl

public String getProfileUrl()

Description copied from interface: UserOperations

Retrieve the URL to the user's GitHub profile.

Specified by:

getProfileUrl in interface UserOperations

Returns:

the URL to the user's GitHub profile.

getFollowers

public List<GitHubUser> getFollowers(String user)

Description copied from interface: UserOperations

Public operation to return a given user's followers.

Specified by:

getFollowers in interface UserOperations

Parameters:

user - GitHub user

Returns:

list of followers

getFollowing

public List<GitHubUser> getFollowing(String user)

Description copied from interface: UserOperations

Public operation to return the users that a given user is following.

Specified by:

getFollowing in interface UserOperations

Parameters:

user - GitHub user

Returns:

list of users the given user is following

requireAuthorization

protected void requireAuthorization()

buildUri

protected String buildUri(String path)