com.pingidentity.pa.sdk.util

Interface TemplateRenderer

public interface TemplateRenderer

Renders the templates defined in the conf/template/ directory of the PingAccess install. The current implementation uses Velocity.

Method Summary

Modifier and Type	Method and Description
LocalizedMessageResolver	getLocalizedMessageResolver() Gets an instance of LocalizedMessageResolver
String	render(Map<String,String> context, String templateName) Renders a template
void	render(Map<String,String> context, String templateName, Writer writer) Renders a template
Response	renderResponse(Exchange exc, Map<String,String> context, String templateName, ResponseBuilder builder) Renders a template and produces a Response

Method Detail

render

String render(Map<String,String> context,
              String templateName)

Renders a template

Parameters:

context - the template context

templateName - the template name

Returns:

the rendered template

render

void render(Map<String,String> context,
            String templateName,
            Writer writer)

Renders a template

Parameters:

context - the template context

templateName - the template name

writer - the Writer to write the rendered template

renderResponse

Response renderResponse(Exchange exc,
                        Map<String,String> context,
                        String templateName,
                        ResponseBuilder builder)

Renders a template and produces a Response

Parameters:

exc - the Exchange used to obtain variables to combine with the supplied context. Implementations will not mutate the Exchange instance.

context - the template context

templateName - the template name

builder - the ResponseBuilder. Implementations are expected to mutate this instance

Returns:

the Response generated from the provided ResponseBuilder, using the specified template to generate the body of the Response

getLocalizedMessageResolver

LocalizedMessageResolver getLocalizedMessageResolver()

Gets an instance of LocalizedMessageResolver

Returns:

An instance of LocalizedMessageResolver