enterprises.orbital.oauth

Interface UserAuthSource

public interface UserAuthSource

Interface representing a user authentication source. The embedding context should implement this interface as needed.

Method Summary

Modifier and Type	Method and Description
String	getBody() Get the source-dependent body material retrieved when this source was created.
Date	getLastSignOn() Retrieve the time at which this source was last used to sign on, or null if this source has never been used.
UserAccount	getOwner() Get the user account associated with this source.
String	getScreenName() Get the displayable screen name associated with this source.
String	getSource() Get the name of this source.
void	touch() Update the last time this source was used to login to the current time.
void	updateAccount(UserAccount existing) Change the user account this source is associated with to the given account.

Method Detail

getSource

String getSource()

Get the name of this source.

Returns:

source name

getScreenName

String getScreenName()

Get the displayable screen name associated with this source.

Returns:

screen name

getBody

String getBody()

Get the source-dependent body material retrieved when this source was created.

Returns:

source body material

touch

void touch()

Update the last time this source was used to login to the current time.

updateAccount

void updateAccount(UserAccount existing)

Change the user account this source is associated with to the given account. This is used to consolidate sources for the same logical account (e.g. if a user logs in with multiple sources which should be tied together).

Parameters:

existing - the new account to be associated with this source.

getOwner

UserAccount getOwner()

Get the user account associated with this source.

Returns:

the user account associated with this source.

getLastSignOn

Date getLastSignOn()

Retrieve the time at which this source was last used to sign on, or null if this source has never been used.

Returns:

the time at which this source was last used to sign on, or null if this source has never been used.