org.keycloak.email.freemarker.FreeMarkerEmailTemplateProvider クラス

org.keycloak.email.freemarker.FreeMarkerEmailTemplateProvider の継承関係図

org.keycloak.email.freemarker.FreeMarkerEmailTemplateProvider 連携図

クラス
class	EmailTemplate

公開メンバ関数
	FreeMarkerEmailTemplateProvider (KeycloakSession session, FreeMarkerUtil freeMarker)
EmailTemplateProvider	setRealm (RealmModel realm)
EmailTemplateProvider	setUser (UserModel user)
EmailTemplateProvider	setAttribute (String name, Object value)
EmailTemplateProvider	setAuthenticationSession (AuthenticationSessionModel authenticationSession)
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"

限定公開メンバ関数
String	getRealmName ()
void	addLinkInfoIntoAttributes (String link, long expirationInMinutes, Map< String, Object > attributes) throws EmailException
EmailTemplate	processTemplate (String subjectKey, List< Object > subjectAttributes, String template, Map< String, Object > attributes) throws EmailException
Theme	getTheme () throws IOException
void	send (String subject, String textBody, String htmlBody) throws EmailException
void	send (Map< String, String > config, String subject, String textBody, String htmlBody) throws EmailException
String	toCamelCase (EventType event)

限定公開変数類
KeycloakSession	session
AuthenticationSessionModel	authenticationSession
FreeMarkerUtil	freeMarker
RealmModel	realm
UserModel	user
final Map< String, Object >	attributes = new HashMap<>()

詳解

著者

Stian Thorgersen

構築子と解体子

FreeMarkerEmailTemplateProvider()

org.keycloak.email.freemarker.FreeMarkerEmailTemplateProvider.FreeMarkerEmailTemplateProvider ( KeycloakSession  session, FreeMarkerUtil  freeMarker  )

inline

                                                                                               {
        this.session = session;
        this.freeMarker = freeMarker;
    }

関数詳解

addLinkInfoIntoAttributes()

void org.keycloak.email.freemarker.FreeMarkerEmailTemplateProvider.addLinkInfoIntoAttributes ( String  link, long  expirationInMinutes, Map< String, Object >  attributes  ) throws EmailException

inlineprotected

Add link info into template attributes.

引数

link	to add
expirationInMinutes	to add
attributes	to add link info into

                                                                                                                                          {
        attributes.put("link", link);
        attributes.put("linkExpiration", expirationInMinutes);
        try {
            Locale locale = session.getContext().resolveLocale(user);
            attributes.put("linkExpirationFormatter", new LinkExpirationFormatterMethod(getTheme().getMessages(locale), locale));
        } catch (IOException e) {
            throw new EmailException("Failed to template email", e);
        }
    }

close()

void org.keycloak.email.freemarker.FreeMarkerEmailTemplateProvider.close ( )

inline

org.keycloak.provider.Providerを実装しています。

                        {
    }

getRealmName()

String org.keycloak.email.freemarker.FreeMarkerEmailTemplateProvider.getRealmName ( )

inlineprotected

                                    {
        if (realm.getDisplayName() != null) {
            return realm.getDisplayName();
        } else {
            return ObjectUtil.capitalize(realm.getName());
        }
    }

getTheme()

Theme org.keycloak.email.freemarker.FreeMarkerEmailTemplateProvider.getTheme ( ) throws IOException

inlineprotected

                                                  {
        return session.theme().getTheme(Theme.Type.EMAIL);
    }

processTemplate()

EmailTemplate org.keycloak.email.freemarker.FreeMarkerEmailTemplateProvider.processTemplate ( String  subjectKey, List< Object >  subjectAttributes, String  template, Map< String, Object >  attributes  ) throws EmailException

inlineprotected

                                                                                                                                                                      {
        try {
            Theme theme = getTheme();
            Locale locale = session.getContext().resolveLocale(user);
            attributes.put("locale", locale);
            Properties rb = theme.getMessages(locale);
            attributes.put("msg", new MessageFormatterMethod(locale, rb));
            String subject = new MessageFormat(rb.getProperty(subjectKey, subjectKey), locale).format(subjectAttributes.toArray());
            String textTemplate = String.format("text/%s", template);
            String textBody;
            try {
                textBody = freeMarker.processTemplate(attributes, textTemplate, theme);
            } catch (final FreeMarkerException e) {
                textBody = null;
            }
            String htmlTemplate = String.format("html/%s", template);
            String htmlBody;
            try {
                htmlBody = freeMarker.processTemplate(attributes, htmlTemplate, theme);
            } catch (final FreeMarkerException e) {
                htmlBody = null;
            }

            return new EmailTemplate(subject, textBody, htmlBody);
        } catch (Exception e) {
            throw new EmailException("Failed to template email", e);
        }
    }

send() [1/4]

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

inline

org.keycloak.email.EmailTemplateProviderを実装しています。

                                                                                                                             {
        send(subjectFormatKey, Collections.emptyList(), bodyTemplate, bodyAttributes);
    }

send() [2/4]

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

inline

org.keycloak.email.EmailTemplateProviderを実装しています。

                                                                                                                                                             {
        try {
            EmailTemplate email = processTemplate(subjectFormatKey, subjectAttributes, bodyTemplate, bodyAttributes);
            send(email.getSubject(), email.getTextBody(), email.getHtmlBody());
        } catch (EmailException e) {
            throw e;
        } catch (Exception e) {
            throw new EmailException("Failed to template email", e);
        }
    }

send() [3/4]

void org.keycloak.email.freemarker.FreeMarkerEmailTemplateProvider.send ( String  subject, String  textBody, String  htmlBody  ) throws EmailException

inlineprotected

                                                                                                {
        send(realm.getSmtpConfig(), subject, textBody, htmlBody);
    }

send() [4/4]

void org.keycloak.email.freemarker.FreeMarkerEmailTemplateProvider.send ( Map< String, String >  config, String  subject, String  textBody, String  htmlBody  ) throws EmailException

inlineprotected

                                                                                                                            {
        EmailSenderProvider emailSender = session.getProvider(EmailSenderProvider.class);
        emailSender.send(config, user, subject, textBody, htmlBody);
    }

sendConfirmIdentityBrokerLink()

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

inline

org.keycloak.email.EmailTemplateProviderを実装しています。

                                                                                                           {
        Map<String, Object> attributes = new HashMap<String, Object>(this.attributes);
        attributes.put("user", new ProfileBean(user));
        addLinkInfoIntoAttributes(link, expirationInMinutes, attributes);

        attributes.put("realmName", getRealmName());

        BrokeredIdentityContext brokerContext = (BrokeredIdentityContext) this.attributes.get(IDENTITY_PROVIDER_BROKER_CONTEXT);
        String idpAlias = brokerContext.getIdpConfig().getAlias();
        idpAlias = ObjectUtil.capitalize(idpAlias);

        attributes.put("identityProviderContext", brokerContext);
        attributes.put("identityProviderAlias", idpAlias);

        List<Object> subjectAttrs = Arrays.<Object> asList(idpAlias);
        send("identityProviderLinkSubject", subjectAttrs, "identity-provider-link.ftl", attributes);
    }

sendEvent()

void org.keycloak.email.freemarker.FreeMarkerEmailTemplateProvider.sendEvent ( Event  event ) throws EmailException

inline

org.keycloak.email.EmailTemplateProviderを実装しています。

                                                             {
        Map<String, Object> attributes = new HashMap<String, Object>();
        attributes.put("user", new ProfileBean(user));
        attributes.put("event", new EventBean(event));

        send(toCamelCase(event.getType()) + "Subject", "event-" + event.getType().toString().toLowerCase() + ".ftl", attributes);
    }

sendExecuteActions()

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

inline

org.keycloak.email.EmailTemplateProviderを実装しています。

                                                                                                {
        Map<String, Object> attributes = new HashMap<String, Object>(this.attributes);
        attributes.put("user", new ProfileBean(user));
        addLinkInfoIntoAttributes(link, expirationInMinutes, attributes);

        attributes.put("realmName", getRealmName());

        send("executeActionsSubject", "executeActions.ftl", attributes);
    }

sendPasswordReset()

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

inline

org.keycloak.email.EmailTemplateProviderを実装しています。

                                                                                               {
        Map<String, Object> attributes = new HashMap<String, Object>(this.attributes);
        attributes.put("user", new ProfileBean(user));
        addLinkInfoIntoAttributes(link, expirationInMinutes, attributes);

        attributes.put("realmName", getRealmName());

        send("passwordResetSubject", "password-reset.ftl", attributes);
    }

sendSmtpTestEmail()

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

inline

org.keycloak.email.EmailTemplateProviderを実装しています。

                                                                                                    {
        setRealm(session.getContext().getRealm());
        setUser(user);

        Map<String, Object> attributes = new HashMap<String, Object>(this.attributes);
        attributes.put("user", new ProfileBean(user));
        attributes.put("realmName", realm.getName());

        EmailTemplate email = processTemplate("emailTestSubject", Collections.emptyList(), "email-test.ftl", attributes);
        send(config, email.getSubject(), email.getTextBody(), email.getHtmlBody());
    }

sendVerifyEmail()

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

inline

org.keycloak.email.EmailTemplateProviderを実装しています。

                                                                                             {
        Map<String, Object> attributes = new HashMap<String, Object>(this.attributes);
        attributes.put("user", new ProfileBean(user));
        addLinkInfoIntoAttributes(link, expirationInMinutes, attributes);

        attributes.put("realmName", getRealmName());

        send("emailVerificationSubject", "email-verification.ftl", attributes);
    }

setAttribute()

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

inline

org.keycloak.email.EmailTemplateProviderを実装しています。

                                                                         {
        attributes.put(name, value);
        return this;
    }

setAuthenticationSession()

EmailTemplateProvider org.keycloak.email.freemarker.FreeMarkerEmailTemplateProvider.setAuthenticationSession ( AuthenticationSessionModel  authenticationSession )

inline

org.keycloak.email.EmailTemplateProviderを実装しています。

                                                                                                            {
        this.authenticationSession = authenticationSession;
        return this;
    }

setRealm()

EmailTemplateProvider org.keycloak.email.freemarker.FreeMarkerEmailTemplateProvider.setRealm ( RealmModel  realm )

inline

org.keycloak.email.EmailTemplateProviderを実装しています。

                                                            {
        this.realm = realm;
        return this;
    }

setUser()

EmailTemplateProvider org.keycloak.email.freemarker.FreeMarkerEmailTemplateProvider.setUser ( UserModel  user )

inline

org.keycloak.email.EmailTemplateProviderを実装しています。

                                                         {
        this.user = user;
        return this;
    }

toCamelCase()

String org.keycloak.email.freemarker.FreeMarkerEmailTemplateProvider.toCamelCase ( EventType  event )

inlineprotected

                                                  {
        StringBuilder sb = new StringBuilder("event");
        for (String s : event.name().toLowerCase().split("_")) {
            sb.append(ObjectUtil.capitalize(s));
        }
        return sb.toString();
    }

メンバ詳解

attributes

final Map<String, Object> org.keycloak.email.freemarker.FreeMarkerEmailTemplateProvider.attributes = new HashMap<>()

protected

authenticationSession

AuthenticationSessionModel org.keycloak.email.freemarker.FreeMarkerEmailTemplateProvider.authenticationSession

protected

authenticationSession can be null for some email sendings, it is filled only for email sendings performed as part of the authentication session (email verification, password reset, broker link etc.)!

freeMarker

FreeMarkerUtil org.keycloak.email.freemarker.FreeMarkerEmailTemplateProvider.freeMarker

protected

IDENTITY_PROVIDER_BROKER_CONTEXT

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

inherited

realm

RealmModel org.keycloak.email.freemarker.FreeMarkerEmailTemplateProvider.realm

protected

session

KeycloakSession org.keycloak.email.freemarker.FreeMarkerEmailTemplateProvider.session

protected

user

UserModel org.keycloak.email.freemarker.FreeMarkerEmailTemplateProvider.user

protected

---

このクラス詳解は次のファイルから抽出されました:

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