org.keycloak.email.EmailTemplateProvider インタフェース

org.keycloak.email.EmailTemplateProvider の継承関係図

org.keycloak.email.EmailTemplateProvider 連携図

公開メンバ関数
EmailTemplateProvider	setAuthenticationSession (AuthenticationSessionModel authenticationSession)
EmailTemplateProvider	setRealm (RealmModel realm)
EmailTemplateProvider	setUser (UserModel user)
EmailTemplateProvider	setAttribute (String name, Object value)
void	sendEvent (Event event) throws EmailException
void	sendPasswordReset (String link, long expirationInMinutes) throws EmailException
void	sendSmtpTestEmail (Map< String, String > config, UserModel user) throws EmailException
void	sendConfirmIdentityBrokerLink (String link, long expirationInMinutes) throws EmailException
void	sendExecuteActions (String link, long expirationInMinutes) throws EmailException
void	sendVerifyEmail (String link, long expirationInMinutes) throws EmailException
void	send (String subjectFormatKey, String bodyTemplate, Map< String, Object > bodyAttributes) throws EmailException
void	send (String subjectFormatKey, List< Object > subjectAttributes, String bodyTemplate, Map< String, Object > bodyAttributes) throws EmailException
void	close ()

公開変数類
String	IDENTITY_PROVIDER_BROKER_CONTEXT = "identityProviderBrokerCtx"

詳解

著者

Stian Thorgersen

関数詳解

close()

void org.keycloak.provider.Provider.close ( )

inherited

org.keycloak.models.sessions.infinispan.InfinispanUserSessionProvider, org.keycloak.storage.UserStorageManager, org.keycloak.protocol.saml.SamlProtocol, org.keycloak.storage.ldap.LDAPStorageProvider, org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider, org.keycloak.models.cache.infinispan.RealmCacheSession, org.keycloak.models.jpa.JpaUserProvider, org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider, org.keycloak.protocol.oidc.OIDCLoginProtocol, org.keycloak.models.jpa.session.JpaUserSessionPersisterProvider, org.keycloak.credential.UserCredentialStoreManager, org.keycloak.services.managers.DefaultBruteForceProtector, org.keycloak.connections.jpa.updater.liquibase.LiquibaseJpaUpdaterProvider, org.keycloak.email.freemarker.FreeMarkerEmailTemplateProvider, org.keycloak.protocol.saml.EntityDescriptorDescriptionConverter, org.keycloak.federation.kerberos.KerberosFederationProvider, org.keycloak.models.jpa.JpaUserCredentialStore, org.keycloak.storage.ClientStorageManager, org.keycloak.keys.infinispan.InfinispanPublicKeyStorageProvider, org.keycloak.models.sessions.infinispan.InfinispanAuthenticationSessionProvider, org.keycloak.services.clientregistration.AbstractClientRegistrationProvider, org.keycloak.authentication.authenticators.x509.AbstractX509ClientCertificateAuthenticator, org.keycloak.authentication.authenticators.resetcred.ResetCredentialEmail, org.keycloak.authentication.forms.RegistrationRecaptcha, org.keycloak.authentication.authenticators.browser.ScriptBasedAuthenticator, org.keycloak.email.DefaultEmailSenderProvider, org.keycloak.models.jpa.JpaRealmProvider, org.keycloak.exportimport.dir.DirImportProvider, org.keycloak.protocol.docker.DockerAuthV2Protocol, org.keycloak.authentication.authenticators.browser.SpnegoAuthenticator, org.keycloak.authorization.AuthorizationProvider, org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser, org.keycloak.authentication.forms.RegistrationUserCreation, org.keycloak.connections.jpa.updater.liquibase.lock.LiquibaseDBLockProvider, org.keycloak.theme.ExtendingThemeManager, org.keycloak.protocol.saml.installation.KeycloakSamlClientInstallation, org.keycloak.models.cache.infinispan.authorization.StoreFactoryCacheSession, org.keycloak.protocol.saml.installation.SamlIDPDescriptorClientInstallation, org.keycloak.authentication.authenticators.challenge.BasicAuthAuthenticator, org.keycloak.authentication.authenticators.cli.CliUsernamePasswordAuthenticator, org.keycloak.protocol.oidc.installation.KeycloakOIDCClientInstallation, org.keycloak.authentication.forms.RegistrationProfile, org.keycloak.authentication.requiredactions.UpdatePassword, org.keycloak.authentication.requiredactions.UpdateProfile, org.keycloak.protocol.saml.mappers.RoleNameMapper, org.keycloak.authentication.forms.RegistrationPassword, org.keycloak.protocol.oidc.OIDCWellKnownProvider, org.keycloak.events.log.JBossLoggingEventListenerProvider, org.keycloak.protocol.saml.profile.ecp.authenticator.HttpBasicAuthenticator, org.keycloak.connections.jpa.updater.liquibase.conn.DefaultLiquibaseConnectionProvider, org.keycloak.authentication.authenticators.console.ConsoleUsernamePasswordAuthenticator, org.keycloak.authentication.authenticators.broker.AbstractIdpAuthenticator, org.keycloak.protocol.saml.installation.ModAuthMellonClientInstallation, org.keycloak.authentication.authenticators.browser.IdentityProviderAuthenticator, org.keycloak.credential.hash.Pbkdf2PasswordHashProvider, org.keycloak.events.jpa.JpaEventStoreProvider, org.keycloak.authentication.authenticators.browser.UsernamePasswordForm, org.keycloak.authentication.authenticators.browser.OTPFormAuthenticator, org.keycloak.authentication.requiredactions.ConsoleUpdateTotp, org.keycloak.authentication.requiredactions.ConsoleVerifyEmail, org.keycloak.authentication.requiredactions.VerifyEmail, org.keycloak.authentication.requiredactions.TermsAndConditions, org.keycloak.authorization.protection.introspect.RPTIntrospectionProvider, org.keycloak.protocol.oidc.installation.KeycloakOIDCJbossSubsystemClientInstallation, org.keycloak.authentication.requiredactions.UpdateTotp, org.keycloak.models.UserProvider, org.keycloak.exportimport.dir.DirExportProvider, org.keycloak.models.UserSessionProvider, org.keycloak.scripting.DefaultScriptingProvider, org.keycloak.protocol.oidc.AccessTokenIntrospectionProvider, org.keycloak.protocol.saml.installation.SamlSPDescriptorClientInstallation, org.keycloak.exportimport.singlefile.SingleFileExportProvider, org.keycloak.exportimport.singlefile.SingleFileImportProvider, org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory, org.keycloak.services.migration.DefaultMigrationProvider, org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator, org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapper, org.keycloak.services.clientregistration.AdapterInstallationClientRegistrationProvider, org.keycloak.timer.basic.BasicTimerProvider, org.keycloak.theme.FolderThemeProvider, org.keycloak.models.RealmProvider, org.keycloak.policy.HistoryPasswordPolicyProvider, org.keycloak.protocol.saml.installation.KeycloakSamlSubsystemInstallation, org.keycloak.storage.jpa.JpaUserFederatedStorageProvider, org.keycloak.authentication.authenticators.browser.CookieAuthenticator, org.keycloak.keys.AbstractGeneratedSecretKeyProvider, org.keycloak.authorization.jpa.store.JPAStoreFactory, org.keycloak.events.email.EmailEventListenerProvider, org.keycloak.authentication.authenticators.challenge.NoCookieFlowRedirectAuthenticator, org.keycloak.policy.BlacklistPasswordPolicyProvider, org.keycloak.authentication.authenticators.console.ConsoleOTPFormAuthenticator, org.keycloak.authentication.requiredactions.ConsoleTermsAndConditions, org.keycloak.models.sessions.infinispan.InfinispanCodeToTokenStoreProvider, org.keycloak.policy.RegexPatternsPasswordPolicyProvider, org.keycloak.models.sessions.infinispan.InfinispanStickySessionEncoderProvider, org.keycloak.cluster.infinispan.InfinispanClusterProvider, org.keycloak.authentication.requiredactions.ConsoleUpdateProfile, org.keycloak.exportimport.KeycloakClientDescriptionConverter, org.keycloak.policy.DefaultPasswordPolicyManagerProvider, org.keycloak.services.x509.AbstractClientCertificateFromHttpHeadersLookup, org.keycloak.theme.ClasspathThemeProvider, org.keycloak.policy.DigitsPasswordPolicyProvider, org.keycloak.policy.LowerCasePasswordPolicyProvider, org.keycloak.policy.SpecialCharsPasswordPolicyProvider, org.keycloak.policy.UpperCasePasswordPolicyProvider, org.keycloak.models.session.DisabledUserSessionPersisterProvider, org.keycloak.policy.NotUsernamePasswordPolicyProvider, org.keycloak.theme.DefaultThemeSelectorProvider, org.keycloak.connections.infinispan.DefaultInfinispanConnectionProvider, org.keycloak.provider.ExceptionConverter, org.keycloak.policy.LengthPasswordPolicyProvider, org.keycloak.authentication.forms.RegistrationPage, org.keycloak.protocol.oidc.OIDCClientDescriptionConverter, org.keycloak.theme.ClasspathThemeResourceProviderFactory, org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory, org.keycloak.models.sessions.infinispan.InfinispanActionTokenStoreProvider, org.keycloak.authentication.authenticators.x509.X509ClientCertificateAuthenticator, org.keycloak.locale.DefaultLocaleSelectorProvider, org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory, org.keycloak.authentication.authenticators.directgrant.AbstractDirectGrantAuthenticator, org.keycloak.protocol.docker.installation.DockerComposeYamlInstallationProvider, org.keycloak.truststore.FileTruststoreProvider, org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper, org.keycloak.authentication.authenticators.AttemptedAuthenticator, org.keycloak.authorization.policy.provider.drools.DroolsPolicyProvider, org.keycloak.services.clientregistration.policy.ClientRegistrationPolicy, org.keycloak.services.x509.DefaultClientCertificateLookup, org.keycloak.connections.jpa.DefaultJpaConnectionProvider, org.keycloak.authorization.config.UmaWellKnownProvider, org.keycloak.protocol.saml.mappers.AbstractSAMLProtocolMapper, org.keycloak.urls.HostnameProvider, org.keycloak.authentication.authenticators.client.AbstractClientAuthenticator, org.keycloak.keys.KeyProvider, org.keycloak.protocol.docker.installation.DockerRegistryConfigFileInstallationProvider, org.keycloak.protocol.docker.installation.DockerVariableOverrideInstallationProvider, org.keycloak.protocol.docker.mapper.DockerAuthV2ProtocolMapper, org.keycloak.transaction.JtaTransactionManagerLookup, org.keycloak.broker.provider.AbstractIdentityProviderMapper, org.keycloak.authentication.AbstractFormAuthenticator, org.keycloak.crypto.SignatureProvider, org.keycloak.credential.CredentialProvider, org.keycloak.protocol.oidc.ext.OIDCExtProvider (計143項目)で実装されています。

send() [1/2]

void org.keycloak.email.EmailTemplateProvider.send	(	String	subjectFormatKey,
		String	bodyTemplate,
		Map< String, Object >	bodyAttributes
	)		throws EmailException

Send formatted email

引数

subjectFormatKey	message property that will be used to format email subject
bodyTemplate	freemarker template file
bodyAttributes	attributes used to fill template

例外

EmailException

org.keycloak.email.freemarker.FreeMarkerEmailTemplateProviderで実装されています。

send() [2/2]

void org.keycloak.email.EmailTemplateProvider.send	(	String	subjectFormatKey,
		List< Object >	subjectAttributes,
		String	bodyTemplate,
		Map< String, Object >	bodyAttributes
	)		throws EmailException

Send formatted email

引数

subjectFormatKey	message property that will be used to format email subject
subjectAttributes	attributes used to fill subject format message
bodyTemplate	freemarker template file
bodyAttributes	attributes used to fill template

例外

EmailException

org.keycloak.email.freemarker.FreeMarkerEmailTemplateProviderで実装されています。

sendConfirmIdentityBrokerLink()

void org.keycloak.email.EmailTemplateProvider.sendConfirmIdentityBrokerLink	(	String	link,
		long	expirationInMinutes
	)		throws EmailException

Send to confirm that user wants to link his account with identity broker link

org.keycloak.email.freemarker.FreeMarkerEmailTemplateProviderで実装されています。

sendEvent()

void org.keycloak.email.EmailTemplateProvider.sendEvent

(

Event

event

)

throws EmailException

org.keycloak.email.freemarker.FreeMarkerEmailTemplateProviderで実装されています。

sendExecuteActions()

void org.keycloak.email.EmailTemplateProvider.sendExecuteActions	(	String	link,
		long	expirationInMinutes
	)		throws EmailException

Change password email requested by admin

引数

link
expirationInMinutes

例外

EmailException

org.keycloak.email.freemarker.FreeMarkerEmailTemplateProviderで実装されています。

sendPasswordReset()

void org.keycloak.email.EmailTemplateProvider.sendPasswordReset	(	String	link,
		long	expirationInMinutes
	)		throws EmailException

Reset password sent from forgot password link on login

引数

link
expirationInMinutes

例外

EmailException

org.keycloak.email.freemarker.FreeMarkerEmailTemplateProviderで実装されています。

sendSmtpTestEmail()

void org.keycloak.email.EmailTemplateProvider.sendSmtpTestEmail	(	Map< String, String >	config,
		UserModel	user
	)		throws EmailException

Test SMTP connection with current logged in user

引数

config	SMTP server configuration
user	SMTP recipient

例外

EmailException

org.keycloak.email.freemarker.FreeMarkerEmailTemplateProviderで実装されています。

sendVerifyEmail()

void org.keycloak.email.EmailTemplateProvider.sendVerifyEmail	(	String	link,
		long	expirationInMinutes
	)		throws EmailException

org.keycloak.email.freemarker.FreeMarkerEmailTemplateProviderで実装されています。

setAttribute()

EmailTemplateProvider org.keycloak.email.EmailTemplateProvider.setAttribute	(	String	name,
		Object	value
	)

org.keycloak.email.freemarker.FreeMarkerEmailTemplateProviderで実装されています。

setAuthenticationSession()

EmailTemplateProvider org.keycloak.email.EmailTemplateProvider.setAuthenticationSession

(

AuthenticationSessionModel

authenticationSession

)

org.keycloak.email.freemarker.FreeMarkerEmailTemplateProviderで実装されています。

setRealm()

EmailTemplateProvider org.keycloak.email.EmailTemplateProvider.setRealm

(

RealmModel

realm

)

org.keycloak.email.freemarker.FreeMarkerEmailTemplateProviderで実装されています。

setUser()

EmailTemplateProvider org.keycloak.email.EmailTemplateProvider.setUser

(

UserModel

user

)

org.keycloak.email.freemarker.FreeMarkerEmailTemplateProviderで実装されています。

メンバ詳解

IDENTITY_PROVIDER_BROKER_CONTEXT

String org.keycloak.email.EmailTemplateProvider.IDENTITY_PROVIDER_BROKER_CONTEXT = "identityProviderBrokerCtx"

---

このインタフェース詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/email/EmailTemplateProvider.java