LibreCCM
/
libreccm
3
0
Fork 0
Code Issues 10 Pull Requests Packages Releases Wiki Activity

Some JavaDoc 

Former-commit-id: da8f3bb3035715a982cc4ff47b783f1a209e8ce2
pull/10/head
Jens Pelzetter 2021-03-09 21:08:22 +01:00
parent faf1ce622a
commit 3925b228bb
4 changed files with 133 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
ccm-cms/src/main/java/org/librecms/ui/CmsApplication.java
View File

@ -14,7 +14,8 @@ import javax.ws.rs.ApplicationPath;
import javax.ws.rs.core.Application;
/**
*
* The CMS application acts as entry point for all CMS related user interfaces.
*
* @author <a href="mailto:jens.pelzetter@googlemail.com">Jens Pelzetter</a>
*/
@ApplicationPath("/@cms")

80
ccm-cms/src/main/java/org/librecms/ui/CmsController.java
View File

@ -34,6 +34,8 @@ import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.Response;
/**
* Controller for the CMS application which allows the management of content
* sections.
*
* @author <a href="mailto:jens.pelzetter@googlemail.com">Jens Pelzetter</a>
*/
@ -57,6 +59,13 @@ public class CmsController {
@Inject
private PermissionChecker permissionChecker;
/**
* Redirects requests to the root path ({@code /@cms} or {@code /@cms/}) to
* the {@code /@cms/contentsections}.
*
* @return A redirect response with the {@link Response.Status#SEE_OTHER}
* response code.
*/
@GET
@Path("/")
@AuthorizationRequired
@ -81,6 +90,11 @@ public class CmsController {
}
}
/**
* Shows all available content sections.
*
* @return The template to use.
*/
@GET
@Path("/contentsections/")
@AuthorizationRequired
@ -88,6 +102,13 @@ public class CmsController {
return "org/librecms/ui/cms/contentsections-list.xhtml";
}
/**
* Creates a new content section.
*
* @param sectionName The name of the new section.
*
* @return Redirect to the content sections list.
*/
@POST
@Path("/contentsections/new")
@AuthorizationRequired
@ -101,6 +122,16 @@ public class CmsController {
return "redirect:/contentsections/";
}
/**
* Renames a content section.
*
* @param identifierParam The identifier (see {@link Identifier} and
* {@link IdentifierParser}) of the content section
* to rename.
* @param sectionName The new name of the content section.
*
* @return Redirect to the list of content sections.
*/
@POST
@Path("/contentsections/{sectionIdentifier}/rename")
@AuthorizationRequired
@ -117,6 +148,19 @@ public class CmsController {
return "redirect:/contentsections/";
}
/**
* Deletes a content section. The content section must be empty (no items,
* assets or folders in it).
*
* @param identifierParam The identifier (see {@link Identifier} and
* {@link IdentifierParser}) of the content section
* to delete.
* @param confirmed A string which must contain the value {@code true}
* to be sure that the user confirmed the deletion of
* the content section.
*
* @return Redirect to the list of content sections.
*/
@POST
@Path("/contentsections/{sectionIdentifier}/delete")
@AuthorizationRequired
@ -145,6 +189,11 @@ public class CmsController {
return "redirect:/contentsections/";
}
/**
* ToDo: Show UI for managing pages.
*
* @return Placeholder
*/
@GET
@Path("/pages")
@AuthorizationRequired
@ -152,6 +201,11 @@ public class CmsController {
return "org/librecms/ui/cms/pages.xhtml";
}
/**
* ToDo: Search for content items (and assets?) in all content sections.
*
* @return Placeholder
*/
@GET
@Path("/search")
@AuthorizationRequired
@ -159,6 +213,22 @@ public class CmsController {
return "org/librecms/ui/cms/search.xhtml";
}
/**
* Helper function for retrieving a content section by an identifier.
*
* @param identifierParam The identifier paramter.
*
* @return The content section if a section identified by the provided
* identifier exists.
*
* @throws WebApplicationException A {@link WebApplicationException} with
* {@link Response.Status#NOT_FOUND} status
* code if there is not content section
* identified by the provided identifier.
*
* @see IdentifierParser
* @see Identifier
*/
private ContentSection findContentSection(final String identifierParam) {
final Identifier identifier = identifierParser.parseIdentifier(
identifierParam
@ -213,6 +283,16 @@ public class CmsController {
return section;
}
/**
* Helper function to determine of a content section can be deleted. Checks
* if the {@link ContentSection#rootAssetsFolder} and the
* {@link ContentSection#rootDocumentsFolder} are empty.
*
* @param section The section
*
* @return {@code true} if the content section is empty can be deleted,
* {@code false} is not.
*/
protected boolean canDelete(final ContentSection section) {
final Folder rootAssetsFolder = section.getRootAssetsFolder();
final Folder rootDocumentsFolder = section.getRootDocumentsFolder();

29
ccm-cms/src/main/java/org/librecms/ui/ContentSectionsTableModel.java
View File

@ -19,6 +19,7 @@
package org.librecms.ui;
import org.libreccm.security.AuthorizationRequired;
import org.libreccm.ui.admin.contentsections.ContentSectionTableRow;
import org.librecms.contentsection.ContentSection;
import org.librecms.contentsection.ContentSectionRepository;
@ -30,8 +31,10 @@ import javax.inject.Inject;
import javax.inject.Named;
import javax.transaction.Transactional;
/**
* Model for table of content sections.
*
* @see CmsController#getContentSections()
*
* @author <a href="mailto:jens.pelzetter@googlemail.com">Jens Pelzetter</a>
*/
@ -39,14 +42,24 @@ import javax.transaction.Transactional;
@Named("ContentSectionsTableModel")
public class ContentSectionsTableModel {
/**
* The controller.
*/
@Inject
private CmsController controller;
/**
* Repository for content sections.
*/
@Inject
private ContentSectionRepository sectionRepo;
/**
* Retrieves all available content sections and builds a
* {@link ContentSectionTableRow} for each content sections.
*
* @return A list of {@link ContentSectionTableRow}s.
*/
@AuthorizationRequired
@Transactional
public List<ContentSectionsTableRow> getContentSections() {
@ -58,6 +71,14 @@ public class ContentSectionsTableModel {
.collect(Collectors.toList());
}
/**
* Helper method for building a {@link ContentSectionTableRow} for a
* {@link ContentSection}.
*
* @param section The content section.
*
* @return A {@link ContentSectionTableRow} for the section.
*/
private ContentSectionsTableRow buildTableRow(
final ContentSection section
) {

27
ccm-cms/src/main/java/org/librecms/ui/ContentSectionsTableRow.java
View File

@ -18,19 +18,35 @@
*/
package org.librecms.ui;
import org.libreccm.ui.admin.contentsections.ContentSectionTableRow;
import java.util.Comparator;
import java.util.Objects;
/**
*
* Model for row in the table listing a available content sections.
*
* @see CmsController#getContentSections()
* @see ContentSectionsTableModel
*
* @author <a href="mailto:jens.pelzetter@googlemail.com">Jens Pelzetter</a>
*/
public class ContentSectionsTableRow implements
Comparable<ContentSectionsTableRow> {
/**
* The ID of the content section.
*/
private long sectionId;
/**
* The label of the content section.
*/
private String label;
/**
* Is the section empty and can be deleted?
*/
private boolean deletable;
public long getSectionId() {
@ -57,6 +73,15 @@ public class ContentSectionsTableRow implements
this.deletable = deletable;
}
/**
* Compares two {@link ContentSectionTableRow}s using the {@link #label} and
* {@link #sectionId}.
*
* @param other The other row
* @return The result
*
* @see Comparator#compare(java.lang.Object, java.lang.Object)
*/
@Override
public int compareTo(final ContentSectionsTableRow other) {
int result;