Provide a mechanism for configuring which Soffit data model elements are included in the request; include none of them by default

Description

This change is a modest tweak to the contract for soffits.  As such, I'd like to apply it to 5.1.x only.

(added documentation below)

  1.  

    1. Sharing Data Model Objects with a Soffit

These objects can be shared by the portal with a soffit on each request, but
<strong>none of them will be sent automatically</strong>. Under the hood, data
model objects are sent to soffits as Jason Web Tokens (JWTs) using HTTP headers.
Web servers place limits (usually configurable) on the size of the header area
for inbound and outbound requests. The more data model elements sent, the
greater the risk of exceeding this limit. In typical cases sending all four
elements is somewhat risky; sending fewer (1, 2, or 3) should be safe.

You can instruct uPortal to send each data model object using a dedicated
<em>portlet preference</em> in the publishing record (metadata) of each soffit.
The default value of each preference is <code>false</code>; set it to
<code>true</code> to send the element.

  • <code>Bearer</code>: <code>org.apereo.portal.soffit.connector.SoffitConnectorController.includeAuthorization</code>

  • <code>PortalRequest</code>: <code>org.apereo.portal.soffit.connector.SoffitConnectorController.includePortalRequest</code>

  • <code>Preferences</code>: <code>org.apereo.portal.soffit.connector.SoffitConnectorController.includePreferences</code>

  • <code>Definition</code>: <code>org.apereo.portal.soffit.connector.SoffitConnectorController.includeDefinition</code>

Environment

None

Status

Assignee

Unassigned

Reporter

Andrew Wills

Labels

None

Estimated End Date

None

Fix versions

Priority

Major
Configure