enterprises.orbital.oauth

Interface UserAccountProvider

public interface UserAccountProvider

Interface which should be implemented by the embedding context to provide user account information when needed.

Method Summary

Modifier and Type	Method and Description
UserAccount	createNewUserAccount(boolean disabled) Create and store a new user account.
UserAuthSource	createSource(UserAccount newUser, String source, String screenName, String body) Create and associate a new source with the given user.
UserAccount	getAccount(String uid) Retrieve the account with the specified ID, or null if no such account exists.
UserAuthSource	getBySourceScreenname(String source, String screenName) Get the source with the given source name and screen name, or null if no such source exists.
UserAuthSource	getSource(UserAccount acct, String source) Retrieve the named source for the given UserAccount, or null if no such account exists.
void	removeSourceIfExists(UserAccount acct, String source) Remove a named source from a UserAccount.

Method Detail

getAccount

UserAccount getAccount(String uid)

Retrieve the account with the specified ID, or null if no such account exists.

Parameters:

uid - the account ID to retrieve.

Returns:

the specified account, or null if no such account exists.

getSource

UserAuthSource getSource(UserAccount acct,
                         String source)

Retrieve the named source for the given UserAccount, or null if no such account exists.

Parameters:

acct - the account for which a source will be retrieved.

source - the source to retrieve.

Returns:

the specified UserAuthSource, or null if no such source exists.

removeSourceIfExists

void removeSourceIfExists(UserAccount acct,
                          String source)

Remove a named source from a UserAccount. Fails silently if the named source does not exist.

Parameters:

acct - the account from which the source will be removed.

source - the name of the source to remove.

getBySourceScreenname

UserAuthSource getBySourceScreenname(String source,
                                     String screenName)

Get the source with the given source name and screen name, or null if no such source exists.

Parameters:

source - the source to retrieve.

screenName - the screen name associated with the source to retrieve.

Returns:

the specified source, or null if no such source exists.

createSource

UserAuthSource createSource(UserAccount newUser,
                            String source,
                            String screenName,
                            String body)

Create and associate a new source with the given user. If a source with the given name already exists, then it will be replaced by the new source.

Parameters:

newUser - the user to which the new source will be associated.

source - the name of the source.

screenName - the screen name associated with this source.

body - the "body" or other account context which should be associated with this source.

Returns:

the new source.

createNewUserAccount

UserAccount createNewUserAccount(boolean disabled)

Create and store a new user account.

Parameters:

disabled - if true, mark the account as disabled (unable to login).

Returns:

the new user account.