Package com.janeirodigital.sai.authentication

Interface AuthorizedSessionAccessor

All Known Implementing Classes:

BasicAuthorizedSessionAccessor

public interface AuthorizedSessionAccessor

Provides an interface for sai-java to lookup an AuthorizedSession based on an AccessToken or the session itself, which is necessary for applications that operate on behalf of multiple social agents.

Method Summary

Modifier and Type	Method	Description
AuthorizedSession	get(AccessToken accessToken)	Get an AuthorizedSession based on the value of an AccessToken
AuthorizedSession	get(AuthorizedSession session)	Get the provided AuthorizedSession
AuthorizedSession	get(URI socialAgentId, URI applicationId, URI oidcProviderId)	Get an AuthorizedSession matching the provided socialAgentId, applicationId, oidcProviderId
AuthorizedSession	refresh(AuthorizedSession session)	Refreshes and updates the stored version of the AuthorizedSession

Method Details

get

AuthorizedSession get(AccessToken accessToken)

Get an AuthorizedSession based on the value of an AccessToken

Parameters:

accessToken - AccessToken to lookup session for

Returns:

AuthorizedSession or null if it can't be found

get

AuthorizedSession get(AuthorizedSession session)
               throws SaiAuthenticationException

Get the provided AuthorizedSession

Parameters:

session - AuthorizedSession to lookup

Returns:

AuthorizedSession or null if it can't be found

Throws:

SaiAuthenticationException

get

AuthorizedSession get(URI socialAgentId,
 URI applicationId,
 URI oidcProviderId)
               throws SaiAuthenticationException

Get an AuthorizedSession matching the provided socialAgentId, applicationId, oidcProviderId

Parameters:

socialAgentId - URI identifier of the session's social agent

applicationId - URI identifier of the session's application

oidcProviderId - URI identifier of the session's openid connect provider

Returns:

AuthorizedSession or null if it can't be found

Throws:

SaiAuthenticationException

refresh

AuthorizedSession refresh(AuthorizedSession session)
                   throws SaiAuthenticationException

Refreshes and updates the stored version of the AuthorizedSession

Parameters:

session - AuthorizedSession to refresh and update

Returns:

Refreshed and updated AuthorizedSession

Throws:

SaiAuthenticationException