UP-4792: Provide an annotation-based mechanism for soffits based on … #813

drewwills · 2017-01-24T02:16:53Z

…the SoffitRendererController to inject model attributes

https://issues.jasig.org/browse/UP-4792

Checklist

the individual contributor license agreement is signed
commit message follows commit guidelines
tests are included
documentation is changed or added

Description of change

This feature is inspired by the ModelAttribute annotation in Spring MVC: https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/web/bind/annotation/ModelAttribute.html

uPortal soffit support should provide a similar annotation (e.g. SoffitModelAttribute) that allows soffit developers to inject arbitrary beans and/or return values on bean methods into the EL context when a JSP is rendered via the SoffitRendererController.

Code Examples

Bean class that uses `@SoffitModelAttribute`

@Component
public class SnooperModelAttributes {

    private final ObjectMapper mapper = new ObjectMapper();

    @SoffitModelAttribute(value="bearerJson",viewRegex=".*/snooper/.*")
    public String getBearerJson(Bearer bearer) {
        String rslt = null;
        try {
            rslt = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(bearer);
        } catch (JsonProcessingException e) {
            final String msg = "Unable to write the Bearer object to JSON";
            throw new RuntimeException(msg, e);
        }
        return rslt;
    }

    @SoffitModelAttribute(value="portalRequestJson",viewRegex=".*/snooper/.*")
    public String getPortalRequestJson(PortalRequest portalRequest) {
        String rslt = null;
        try {
            rslt = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(portalRequest);
        } catch (JsonProcessingException e) {
            final String msg = "Unable to write the PortalRequest object to JSON";
            throw new RuntimeException(msg, e);
        }
        return rslt;
    }

    @SoffitModelAttribute(value="preferencesJson",viewRegex=".*/snooper/.*")
    public String getPreferencesJson(Preferences preferences) {
        String rslt = null;
        try {
            rslt = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(preferences);
        } catch (JsonProcessingException e) {
            final String msg = "Unable to write the Preferences object to JSON";
            throw new RuntimeException(msg, e);
        }
        return rslt;
    }

    @SoffitModelAttribute(value="definitionJson",viewRegex=".*/snooper/.*")
    public String getDefinitionJson(Definition definition) {
        String rslt = null;
        try {
            rslt = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(definition);
        } catch (JsonProcessingException e) {
            final String msg = "Unable to write the Definition object to JSON";
            throw new RuntimeException(msg, e);
        }
        return rslt;
    }
}

JSP page that uses these model attributes

<%@ page import="com.fasterxml.jackson.databind.ObjectMapper" %>
<jsp:directive.include file="/WEB-INF/soffit/include.jsp"/>

<c:set var="n" value="${portalRequest.attributes['namespace'][0]}" />

<div id="${n}">

    <h2 class="text-primary">Snooper</h2>
    <p>Here is an example of data elements available to a remote soffit endpoint.</p>

    <h3>Request Headers</h3>
    <ul>
        <c:forEach items="${header}" var="entry">
            <li><code><strong><c:out value="${entry.key}" />:</strong> <c:out value="${entry.value}" /></code></li>
        </c:forEach>
    </ul>

    <h3>Bearer:</h3>
    <pre>${bearerJson}</pre>

    <h3>Portal Request:</h3>
    <pre>${portalRequestJson}</pre>

    <h3>Preferences:</h3>
    <pre>${preferencesJson}</pre>

    <h3>Definition:</h3>
    <pre>${definitionJson}</pre>

</div>

coveralls · 2017-01-24T02:32:24Z

Coverage increased (+0.004%) to 23.026% when pulling fb7ab03 on drewwills:UP-4792 into 096ed0e on Jasig:master.

ChristianMurphy

Great start!
This will be a nice addition to Soffits!
I left a few comments and suggestions below.

ChristianMurphy · 2017-01-24T15:05:31Z