Gh 1659 portlet pref rest controller #1660

j-crawford · 2019-04-05T23:41:15Z

Checklist

the individual contributor license agreement is signed
commit message follows commit guidelines
tests are included
documentation is changed or added
message properties have been updated with new phrases
view conforms with WCAG 2.0 AA

Description of change

added the Portlet Preference REST Controller to allow web-components and soffits to store and retrieve preferences

…ortal

…tests to be more thorough, added a new method to be consistent with current implementation

…o code spec

docs/developer/other/API.md

jonathanmtran · 2019-04-15T15:09:10Z

...al-api/uPortal-api-rest/src/main/java/org/apereo/portal/rest/PortletPrefsRESTController.java

+            IPortletEntity entity =
+                    portletEntityRegistry.getOrCreateDefaultPortletEntity(
+                            request, portletDefinition.getPortletDefinitionId());
+            StringBuilder stringBuilder = new StringBuilder();


I feel that the JSON response should be built using POJOs and converted to JSON using something such as Jackson. Is there a reason behind building the response by hand?

you can take this REST API as example

jgribonvald

Here a quick first review 😉
thanks for this nice purpose !

jgribonvald · 2019-04-15T15:38:05Z

...al-api/uPortal-api-rest/src/main/java/org/apereo/portal/rest/PortletPrefsRESTController.java

+            IPortletEntity entity =
+                    portletEntityRegistry.getOrCreateDefaultPortletEntity(
+                            request, portletDefinition.getPortletDefinitionId());
+            StringBuilder stringBuilder = new StringBuilder();


you can take this REST API as example

jgribonvald · 2019-04-15T15:41:46Z

...al-api/uPortal-api-rest/src/main/java/org/apereo/portal/rest/PortletPrefsRESTController.java

+                    .contentType(MediaType.APPLICATION_JSON)
+                    .body(mapper.writeValueAsString(eprefs));
+        } catch (IllegalArgumentException e) {
+            if (e.getMessage().contains("No portlet definition found for id '")) {


There isn't a better error ? because intercepting only on a message is never good. As example if there is a change on the text message this interception won't work anymore and nothing can permit to track it/keep the link to the case to intercept.

There might be, but the error I'm catching is coming from the depths of uPortal itself, I didn't make that part. I'm not sure where it's coming from so I don't know where I'd even start to change it. If you know where that error is being generated I could look into it but I don't want to break any current functionality.

...al-api/uPortal-api-rest/src/main/java/org/apereo/portal/rest/PortletPrefsRESTController.java

jgribonvald · 2019-04-15T15:47:37Z

...al-api/uPortal-api-rest/src/main/java/org/apereo/portal/rest/PortletPrefsRESTController.java

+            }
+
+            if (!canConfigure(person, portletDefinition.getPortletDefinitionId())) {
+                logger.warn(


With SLF4j loggers you can apply a replace form automatically without appending the properties, like

logger.warn("My text with a prop {} and an other prop {}", prop1, prop2). And you won't have a NPE as it's managed automatically.

to resolve conversation

to resolve problem

drewwills · 2019-05-20T21:36:55Z

I have some comments I'm planning to add, but I want to start by saying that this is a very desirable & valuable contribution!

drewwills · 2019-05-20T21:43:27Z

docs/developer/other/API.md

@@ -106,3 +106,47 @@ Example response:
  }
 }
 ```
+### Portlet Preferences
+
+`/api/prefs/{task}`


I suggest...

/api/v5-6/preferences/{fname} AND /api/v5-6/preferences/{fname}/windowId

The first would be for preferences common to the entire publication record, the second for a specific instance of a publication record.

@drewwills Ok, so why the windowId? most webcomponents won't have access to their own windowID since they aren't bundled into uportal and I don't know of an easy way for them to access it- unless you are referring to their layoutID, in the which case they would still need some way of accessing it if we take out the getEntity call. Also they don't need to know their own windowId, uPortal figures all of that from the call made internally anyways. Or are you saying to just put the word windowId to differentiate the two?

@drewwills Also, are you saying that the first would be the definition ones while the second is the entity? I'm not familiar with what you mean by a publication record.

drewwills · 2019-05-20T21:43:30Z

docs/developer/other/API.md

+
+`/api/prefs/{task}`
+
+(example: `http://localhost:8080/uPortal/api/prefs/getprefs/weather` )


At first glance, it seems we should support GET (read) and PUT (update) out of the gate.

I'm not sure if it makes sense to support POST (create), because a basic collection of favorites is created whenever you publish in the first place.

(REST URIs should not contain verbs within them.)

@drewwills I am already supporting gets and puts

drewwills · 2019-05-20T21:46:04Z

...al-api/uPortal-api-rest/src/main/java/org/apereo/portal/rest/PortletPrefsRESTController.java

+    }
+
+    public PortletPrefsRESTController() {
+        this.mapper = new ObjectMapper();


Can be moved above, to where the member is defined.

drewwills · 2019-05-20T21:56:28Z

...al-api/uPortal-api-rest/src/main/java/org/apereo/portal/rest/PortletPrefsRESTController.java

+     * I used this primarily for testing, could be useful given that it returns the windowstate, etc
+     * up to you if you want to keep it or modify it
+     * */
+    @RequestMapping(value = "/prefs/getentity/{fname}", method = RequestMethod.GET)


We shouldn't use verbs in URIs.

I'm not sure this method is a good fit for this @Controller class.

@drewwills I wasn't sure that the method was appropriate either, which is why I put the comment above it. Do you want me to remove it?

@drewwills note that if you want them to know their own windowId, we will need some sort of replacement call to allow them access to that.

drewwills · 2019-05-20T21:57:10Z

...al-api/uPortal-api-rest/src/main/java/org/apereo/portal/rest/PortletPrefsRESTController.java

+     * please set any of these to read-only
+     */
+    // returns the entity composite preferences for the portlet in question
+    @RequestMapping(value = "/prefs/getprefs/{fname}", method = RequestMethod.GET)


We shouldn't use verbs in URIs.

jgribonvald · 2022-07-27T09:21:45Z

@bjagg this is about what we talked on last uPSC ;)

bjagg · 2022-10-14T15:38:36Z

Ah! ... I am finally wrapping up some projects. Starting to get back to coding and hope to review PRs again next week.

j-crawford added 8 commits April 5, 2019 17:35

uPortal-Project#1659 adding the PortletPreferenceRESTController to uP…

29fb699

…ortal

uPortal-Project#1659 missed a test case for invalid json

9fa0f25

uPortal-Project#1659 got most of the javadoc done, fixed some of the …

e132032

…tests to be more thorough, added a new method to be consistent with current implementation

uPortal-Project#1659 some more documentation

6db24b6

uPortal-Project#1659 added to the readme

20c0b4b

uPortal-Project#1659 PortletPreferenceRESTController: getting it up t…

99c6dab

…o code spec

uPortal-Project#1659 getting missed code spec

0b6a889

uPortal-Project#1659 updated API.md with necessary information

4962b32

ChristianMurphy requested review from drewwills, ChristianMurphy and bjagg April 6, 2019 01:08

ChristianMurphy modified the milestones: 5.5.0, 5.6.0 Apr 9, 2019

ChristianMurphy requested review from jgribonvald and jonathanmtran April 12, 2019 22:55

jonathanmtran reviewed Apr 15, 2019

View reviewed changes

docs/developer/other/API.md Outdated Show resolved Hide resolved

jonathanmtran reviewed Apr 15, 2019

View reviewed changes

jgribonvald reviewed Apr 15, 2019

View reviewed changes

j-crawford added 3 commits April 24, 2019 19:21

resolving comment

9ad7ca6

update PortletPrefsRESTController.java

6a306bc

to resolve conversation

Update PortletPrefsRESTController.java

c8f5284

to resolve problem

drewwills reviewed May 20, 2019

View reviewed changes

ChristianMurphy modified the milestones: 5.6.0, 5.7.0 May 23, 2019

bjagg added work in progress help wanted labels Nov 10, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Gh 1659 portlet pref rest controller #1660

Gh 1659 portlet pref rest controller #1660

j-crawford commented Apr 5, 2019 •

edited

jonathanmtran Apr 15, 2019

jgribonvald Apr 15, 2019

jgribonvald left a comment •

edited

jgribonvald Apr 15, 2019

jgribonvald Apr 15, 2019

j-crawford Apr 17, 2019

jgribonvald Apr 15, 2019

drewwills commented May 20, 2019

drewwills May 20, 2019

j-crawford May 30, 2019 •

edited

j-crawford May 30, 2019

drewwills May 20, 2019 •

edited

j-crawford May 30, 2019

drewwills May 20, 2019

drewwills May 20, 2019

j-crawford May 30, 2019

j-crawford May 30, 2019

drewwills May 20, 2019

jgribonvald commented Jul 27, 2022

bjagg commented Oct 14, 2022


		`/api/prefs/{task}`

		(example: `http://localhost:8080/uPortal/api/prefs/getprefs/weather` )

Gh 1659 portlet pref rest controller #1660

Are you sure you want to change the base?

Gh 1659 portlet pref rest controller #1660

Conversation

j-crawford commented Apr 5, 2019 • edited

Checklist

Description of change

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jgribonvald left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

drewwills commented May 20, 2019

Choose a reason for hiding this comment

j-crawford May 30, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

drewwills May 20, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jgribonvald commented Jul 27, 2022

bjagg commented Oct 14, 2022

j-crawford commented Apr 5, 2019 •

edited

jgribonvald left a comment •

edited

j-crawford May 30, 2019 •

edited

drewwills May 20, 2019 •

edited