public class OrcidClient extends BaseOAuth20Client<OrcidProfile>
This class is the OAuth client to authenticate users in ORCiD.
It returns a OrcidProfile
.
More information at http://support.orcid.org/knowledgebase/articles/175079-tutorial-retrieve-data-from-an-orcid-record-with
OrcidProfile
Modifier and Type | Field and Description |
---|---|
protected static String |
DEFAULT_SCOPE |
protected String |
scope |
logger, OAUTH_CODE
connectTimeout, key, proxyHost, proxyPort, readTimeout, secret, service, tokenAsHeader
ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, callbackUrlResolver, NEEDS_CLIENT_REDIRECTION_PARAMETER
Constructor and Description |
---|
OrcidClient() |
OrcidClient(String key,
String secret) |
Modifier and Type | Method and Description |
---|---|
protected OrcidProfile |
extractUserProfile(String body)
Extract the user profile from the response (JSON, XML...) of the profile url.
|
protected String |
getProfileUrl(org.scribe.model.Token accessToken)
Retrieve the url of the profile of the authenticated user for the provider.
|
String |
getScope() |
protected boolean |
hasBeenCancelled(WebContext context)
Return if the authentication has been cancelled.
|
protected void |
internalInit(WebContext context)
Internal initialization of the object.
|
protected OrcidClient |
newClient()
Create a new instance of the client.
|
void |
setScope(String scope) |
getAccessToken, getOAuthCredentials, isDirectRedirection, retrieveAuthorizationUrl
addAccessTokenToProfile, clone, createProxyRequest, getClientType, getConnectTimeout, getKey, getProxyHost, getProxyPort, getReadTimeout, getSecret, getUserProfile, isTokenAsHeader, retrieveCredentials, retrieveRedirectAction, retrieveUserProfile, retrieveUserProfileFromToken, sendRequestForData, sendRequestForData, setConnectTimeout, setKey, setProxyHost, setProxyPort, setReadTimeout, setSecret, setTokenAsHeader
computeFinalCallbackUrl, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCredentials, getRedirectAction, getRedirectionUrl, getStateParameter, isIncludeClientNameInCallbackUrl, redirect, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setIncludeClientNameInCallbackUrl
addAuthorizationGenerator, getAuthorizationGenerators, getName, getUserProfile, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setName, toString
init, reinit
protected static final String DEFAULT_SCOPE
protected String scope
protected boolean hasBeenCancelled(WebContext context)
BaseOAuthClient
hasBeenCancelled
in class BaseOAuthClient<OrcidProfile>
context
- the web context.protected String getProfileUrl(org.scribe.model.Token accessToken)
BaseOAuthClient
getProfileUrl
in class BaseOAuthClient<OrcidProfile>
accessToken
- only used when constructing dynamic urls from data in the tokenprotected void internalInit(WebContext context)
InitializableWebObject
internalInit
in class BaseOAuthClient<OrcidProfile>
context
- the web contextpublic String getScope()
public void setScope(String scope)
protected OrcidProfile extractUserProfile(String body)
BaseOAuthClient
extractUserProfile
in class BaseOAuthClient<OrcidProfile>
body
- the response bodyprotected OrcidClient newClient()
BaseClient
newClient
in class BaseClient<OAuthCredentials,OrcidProfile>
Copyright © 2016. All rights reserved.