cz.ues.platform.security.authn.oauth

Interface OAuthAccountManager

@UESComponent
public interface OAuthAccountManager

Component for OAuth account management.

Since:

UES8-23

Method Summary

Methods

Modifier and Type	Method and Description
OAuthAccountAttributes	createAccount(java.lang.String identity, OAuthAccountCreate attributes) Creates OAuth account.
void	deleteAccount(java.lang.String realm, java.lang.String accountId) Deletes an OAuth account.
OAuthAccountAttributes	getAccountByIdentity(java.lang.String realm, java.lang.String identity) Returns OAuth account according realm and identity.
OAuthAccountAttributes	getAccountByPrincipal(java.lang.String realm, java.lang.String principal) Returns OAuth account according realm and principal.
java.lang.String	getProviderName(java.lang.String realm) Return provider name for the specified realm.
java.util.Collection<java.lang.String>	getSupportedOAuthRealms() Returns collection of supported OAuth realms.
boolean	isOAuthRealm(java.lang.String realm) Determines whether is the specified realm an OAuth realm.

Method Detail

isOAuthRealm

boolean isOAuthRealm(java.lang.String realm)

Determines whether is the specified realm an OAuth realm.

Parameters:

realm - realm to be tested

Returns:

true the realm is an OAuth realm; false otherwise

Since:

UES8-23

getSupportedOAuthRealms

java.util.Collection<java.lang.String> getSupportedOAuthRealms()

Returns collection of supported OAuth realms.

Returns:

collection of supported OAuth realms

Since:

UES8-23

getProviderName

java.lang.String getProviderName(java.lang.String realm)

Return provider name for the specified realm.

Parameters:

realm - OAuth realm

Returns:

provider name

Since:

UES8-23

createAccount

OAuthAccountAttributes createAccount(java.lang.String identity,
OAuthAccountCreate attributes)

Creates OAuth account.

Parameters:

identity - identity for which is the OAuth account created

attributes - OAuth account attributes

Returns:

attributes of the newly created OAuth account (some other attributes determined during creation may be filled in this DTO)

Since:

UES8-23

deleteAccount

void deleteAccount(java.lang.String realm,
java.lang.String accountId)

Deletes an OAuth account.

Parameters:

realm - OAuth realm

accountId - OAuth account Id

Since:

UES8-23

getAccountByIdentity

OAuthAccountAttributes getAccountByIdentity(java.lang.String realm,
java.lang.String identity)

Returns OAuth account according realm and identity.

Parameters:

realm - OAuth realm

identity - identity

Returns:

OAuth account attributes DTO or null if no OAuth account for the realm and identity exist

Since:

UES8-23

getAccountByPrincipal

OAuthAccountAttributes getAccountByPrincipal(java.lang.String realm,
java.lang.String principal)

Returns OAuth account according realm and principal.

Parameters:

realm - OAuth realm

principal - principal

Returns:

OAuth account attributes DTO or null if no OAuth account for the realm and principal exist

Since:

UES8-23