com.iizix.server.oauth.services

Class LinkedIn

java.lang.Object

com.iizix.server.oauth.AbstractOAuth20Service

com.iizix.server.oauth.services.LinkedIn

All Implemented Interfaces:

IOAuthService

public class LinkedIn
extends AbstractOAuth20Service

The LinkedIn service.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SCOPE_r_emailaddress The scope: email address, read only.
static String	SCOPE_r_liteprofile The scope: basic profile, read only.

Fields inherited from class com.iizix.server.oauth.AbstractOAuth20Service

service, session

Constructor Summary

Constructors

Constructor and Description
LinkedIn()
LinkedIn(OAuthSession session, String clientID, String secret, String... scopes) Constructs the service.

Method Summary

Modifier and Type	Method and Description
Size	getApproximateSize() Gets the approximate size in pixels of the inner browser window requested.
JSONObject	getEmail(String id) Gets the email address for a LinkedIn profile ID.
protected Integer	getExpiresIn(com.github.scribejava.core.model.OAuth2AccessToken accessToken) Returns the "expires_in" value from the access token in seconds.
JSONObject	getLiteProfile() Gets the "light" profile ("r_liteprofile").
String	getServiceName() Gets the name of the human readable service name, e.g.
boolean	invalidateAccessToken() Invalidates the access token that may be valid for quite some time.

Methods inherited from class com.iizix.server.oauth.AbstractOAuth20Service

dispose, disposeBlocked, disposeUserCancel, doAuthenticate, getAccessToken

Methods inherited from class java.lang.Object

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

Field Detail

SCOPE_r_liteprofile

public static final String SCOPE_r_liteprofile

The scope: basic profile, read only. Today, only "r_liteprofile" is available and is unfortunately very limited.

"r_liteprofile" (v2)
"r_basicprofile" (v1), and
"r_fullprofile" (v1).

See Also:

Constant Field Values

SCOPE_r_emailaddress

public static final String SCOPE_r_emailaddress

The scope: email address, read only.

See Also:

Constant Field Values

Constructor Detail

LinkedIn

public LinkedIn(OAuthSession session,
                String clientID,
                String secret,
                String... scopes)

Constructs the service.

Parameters:

clientID - The client ID.

secret - The secret.

scopes - The list of scopes as an array, or as one space delimited string.

Throws:

IllegalStateException - If the authentication engine is not initialized.

LinkedIn

public LinkedIn()

Method Detail

getServiceName

public String getServiceName()

Gets the name of the human readable service name, e.g. Facebook, LinkedIn or Twitter.

Returns:

"LinkedIn".

getApproximateSize

public Size getApproximateSize()

Gets the approximate size in pixels of the inner browser window requested. This setting used when possible, but is not guaranteed.

Returns:

The size, or null if none is known (full screen).

getLiteProfile

public JSONObject getLiteProfile()
                          throws IllegalStateException,
                                 IOException,
                                 JSONException

Gets the "light" profile ("r_liteprofile"). The authentication process must have completed successfully.

Throws:

IllegalStateException - If the authentication has not completed successfully.

IOException - For I/O errors.

JSONException - For JSON problems.

getEmail

public JSONObject getEmail(String id)
                    throws IllegalStateException,
                           IOException,
                           JSONException

Gets the email address for a LinkedIn profile ID. The authentication process must have completed successfully.

Parameters:

id - The LinkedIn ID string.

Throws:

IllegalStateException - If the authentication has not completed successfully.

IOException - For I/O errors.

JSONException - For JSON problems.

getExpiresIn

protected Integer getExpiresIn(com.github.scribejava.core.model.OAuth2AccessToken accessToken)

Returns the "expires_in" value from the access token in seconds. For LinkedIn, the value is in milliseconds that needs to be parsed from JSON in the "rawResponse".

Overrides:

getExpiresIn in class AbstractOAuth20Service

Parameters:

accessToken - The access token.

Returns:

The expires_in value Integer, or null for not found. By default token.getExpiresIn() is used. If not found there, JSON parsing is attempted to look-up the "expires_in" value as a String or a Number. The value is sent from LinkedIn in milliseconds, so it needs to be converted to seconds.

invalidateAccessToken

public boolean invalidateAccessToken()
                              throws ExecutionException,
                                     InterruptedException,
                                     IOException

Invalidates the access token that may be valid for quite some time.

A service could also provide a sign out or alike.

The last access token is revoked and this might lead to IOException's.

This method just resets the token so it has to be retrieved again and just returns false for failure.

Overrides:

invalidateAccessToken in class AbstractOAuth20Service

Returns:

true for success, false for failure (no token to invalidate).

Throws:

ExecutionException - For execution errors.

InterruptedException - If the revocation action was interrupted.

IOException - For I/O errors.