https://github.com/umd-lib/hippo-permissions-servlet
A simple servlet for use with the CMS for displaying Hippo/JCR permissions on JCR nodes.
https://github.com/umd-lib/hippo-permissions-servlet
Last synced: 3 days ago
JSON representation
A simple servlet for use with the CMS for displaying Hippo/JCR permissions on JCR nodes.
- Host: GitHub
- URL: https://github.com/umd-lib/hippo-permissions-servlet
- Owner: umd-lib
- License: apache-2.0
- Created: 2016-08-02T20:23:19.000Z (almost 10 years ago)
- Default Branch: develop
- Last Pushed: 2020-08-25T17:59:53.000Z (almost 6 years ago)
- Last Synced: 2025-02-27T12:42:04.991Z (over 1 year ago)
- Language: Java
- Size: 44.9 KB
- Stars: 0
- Watchers: 16
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hippo-permissions-servlet
A simple servlet for use with the CMS for displaying Hippo/JCR permissions on JCR nodes.
## Introduction
This servlet can be used within the Hippo CMS to display the permissions a given Hippo user has on a particular JCR node.
This servlet was derived from Hippo's servlets/src/main/java/org/hippoecm/repository/RepositoryServlet.java code, and extensively modified. Like the Repository Servlet, it uses HTTP Basic Authentication for gaining access to the servlet.
## Sample Screenshot
The above screenshot shows the results of fetching the permissions to the root node of the JCR repository ("/") for the "author" user.
As can be seen in the screenshot, after logging in, the servlet provides a very simple interface consisting of "User id" and "JCR Path" fields.
| Field | Description |
| -------- | ------------------------------------------------------- |
| User id | The Hippo user id to return the permission for |
| JCR Path | The JCR path to the node to retrieve the permissions of |
The "Fetch" button causes the permissions for the given fields to be queried and returned in the table.
The permissions table consists of the individual permissions ("jcr:read", "jcr:write", "hippo:author", etc.) for the node. See the following documention for additional information about the permissions:
* [https://www.onehippo.org/library/concepts/security/repository-authorization-and-permissions.html]()
* [https://docs.adobe.com/content/docs/en/spec/jcr/2.0/16_Access_Control_Management.html]()
A value of "true" indicates the user has the permission, "false" indicates that the user does not.
## Integration with Hippo
The Permissions servlet has been designed to work with Hippo v7.9.12. It may work with other versions, but this has not been tested.
The servlet is intended to work with the Hippo CMS. It consists of a single jar file (hippo-permissions-servlet-[VERSION].jar), which can be added to the classpath of the web container in which the CMS runs. The following stanzas should be added to the web.xml file:
```
PermissonsServlet
edu.umd.lib.servlets.permissions.PermissionsServlet
6
PermissonsServlet
/permissions/*
```
Once properly configured, the servlet should be accessible at [CMS URL]/permissions. For example, in a local development environment, the URL will likely be http://localhost:8080/cms/permissions.
## Integration with a Hippo Build
The Permissions servlet jar file is available from a Nexus repository maintained by the University of Maryland, College Park Library. To access the repository, add the following to your pom.xml file:
```
nexus
Releases
https://maven.lib.umd.edu/nexus/content/repositories/releases
nexus
Snapshots
https://maven.lib.umd.edu/nexus/content/repositories/snapshots
```
The dependency for the servlet is:
```
edu.umd.lib.servlets
permissions-servlet
[VERSION]
```
where [VERSION] is the version number of the servlet to download.
## License
The Permissions servlet was created by copying and rewriting the Repository servlet available from Hippo. As such is is available under the Apache License v2.0. See [LICENSE]() for more information.