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

CCM NG: More JavaDoc for the page model system 

git-svn-id: https://svn.libreccm.org/ccm/ccm_ng@4467 8810af33-2d31-482b-a856-94f89814c4df
ccm-docs
jensp 2016-12-06 18:10:29 +00:00
parent a65c37769e
commit 2570b5dfc3
3 changed files with 188 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

175
ccm-core/src/main/java/org/libreccm/pagemodel/PageModelManager.java
View File

@ -20,6 +20,8 @@ package org.libreccm.pagemodel;
import com.arsdigita.util.UncheckedWrapperException; import com.arsdigita.util.UncheckedWrapperException;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.libreccm.core.CoreConstants; import org.libreccm.core.CoreConstants;
import org.libreccm.modules.CcmModule; import org.libreccm.modules.CcmModule;
import org.libreccm.modules.Module; import org.libreccm.modules.Module;
@ -57,6 +59,9 @@ import javax.transaction.Transactional;
@RequestScoped @RequestScoped
public class PageModelManager { public class PageModelManager {
private static final Logger LOGGER = LogManager.getLogger(
PageModelManager.class);
@Inject @Inject
private EntityManager entityManager; private EntityManager entityManager;
@ -67,7 +72,7 @@ public class PageModelManager {
private ComponentModelRepository componentModelRepo; private ComponentModelRepository componentModelRepo;
private final Map<String, PageModelComponentModel> components private final Map<String, PageModelComponentModel> components
= new HashMap<>(); = new HashMap<>();
/** /**
* Called by CDI after an instance of this class is created. Initialises the * Called by CDI after an instance of this class is created. Initialises the
@ -76,21 +81,26 @@ public class PageModelManager {
*/ */
@PostConstruct @PostConstruct
private void init() { private void init() {
LOGGER.debug("Initalising {}...", PageModelManager.class.getName());
final ServiceLoader<CcmModule> modules = ServiceLoader.load( final ServiceLoader<CcmModule> modules = ServiceLoader.load(
CcmModule.class); CcmModule.class);
for (CcmModule module : modules) { for (CcmModule module : modules) {
final Module moduleData = module.getClass().getAnnotation( final Module moduleData = module.getClass().getAnnotation(
Module.class); Module.class);
final PageModelComponentModel[] models = moduleData final PageModelComponentModel[] models = moduleData
.pageModelComponentModels(); .pageModelComponentModels();
for (PageModelComponentModel model : models) { for (PageModelComponentModel model : models) {
components.put(model.modelClass().getName(), components.put(model.modelClass().getName(),
model); model);
} }
} }
LOGGER.debug("Initalised {}. Found {} ComponentModels.",
PageModelManager.class.getName(),
components.size());
} }
/** /**
@ -100,11 +110,11 @@ public class PageModelManager {
* Please note that this method will always return the <strong>live</strong> * Please note that this method will always return the <strong>live</strong>
* version of the page model. * version of the page model.
* *
* @param name The name of the new page model. Must be unique for the * @param name The name of the new page model. Must be unique for the
* application. * application.
* @param application The application for which the {@link PageModel} is * @param application The application for which the {@link PageModel} is
* created. * created.
* @param type Type of the page model (view technology). * @param type Type of the page model (view technology).
* *
* @return The new {@link PageModel}. * @return The new {@link PageModel}.
*/ */
@ -117,23 +127,32 @@ public class PageModelManager {
if (application == null) { if (application == null) {
throw new IllegalArgumentException( throw new IllegalArgumentException(
"Can't create a page model for application null"); "Can't create a page model for application null");
} }
if (name == null || name.trim().isEmpty()) { if (name == null || name.trim().isEmpty()) {
throw new IllegalArgumentException( throw new IllegalArgumentException(
"The name of a page model can't be null or empty."); "The name of a page model can't be null or empty.");
} }
LOGGER.debug(
"Creating new PageModel with name \"{}\" for application \"{}\" and type \"{}\".",
name,
application.getPrimaryUrl(),
type);
final long count = pageModelRepo.countByApplicationAndName(application, final long count = pageModelRepo.countByApplicationAndName(application,
name); name);
if (count > 0) { if (count > 0) {
LOGGER.error("A page model with the name \"{}\" for the "
+ "application \"{}\" already exists.",
name,
application.getPrimaryUrl());
throw new IllegalArgumentException(String.format( throw new IllegalArgumentException(String.format(
"A page model with the name \"%s\" for the application \"%s\" " "A page model with the name \"%s\" for the application \"%s\" "
+ "already exists.", + "already exists.",
name, name,
application.getPrimaryUrl())); application.getPrimaryUrl()));
} }
final PageModel pageModel = new PageModel(); final PageModel pageModel = new PageModel();
@ -152,22 +171,23 @@ public class PageModelManager {
* {@link CoreConstants#PRIVILEGE_ADMIN} privilege. * {@link CoreConstants#PRIVILEGE_ADMIN} privilege.
* *
* @param pageModel The {@link PageModel} for which the draft version is * @param pageModel The {@link PageModel} for which the draft version is
* retrieved. * retrieved.
*
* @return The draft version of the provided {@link PageModel}. * @return The draft version of the provided {@link PageModel}.
*/ */
@AuthorizationRequired @AuthorizationRequired
@Transactional(Transactional.TxType.REQUIRED) @Transactional(Transactional.TxType.REQUIRED)
public PageModel getDraftVersion( public PageModel getDraftVersion(
@RequiresPrivilege(CoreConstants.PRIVILEGE_ADMIN) @RequiresPrivilege(CoreConstants.PRIVILEGE_ADMIN)
final PageModel pageModel) { final PageModel pageModel) {
if (pageModel == null) { if (pageModel == null) {
throw new IllegalArgumentException( throw new IllegalArgumentException(
"Can't get draft version for page model null."); "Can't get draft version for page model null.");
} }
final TypedQuery<PageModel> query = entityManager.createNamedQuery( final TypedQuery<PageModel> query = entityManager.createNamedQuery(
"PageModel.findDraftVersion", PageModel.class); "PageModel.findDraftVersion", PageModel.class);
query.setParameter("uuid", pageModel.getModelUuid()); query.setParameter("uuid", pageModel.getModelUuid());
return query.getSingleResult(); return query.getSingleResult();
@ -177,30 +197,37 @@ public class PageModelManager {
* Checks if a {@link PageModel} has a live version. * Checks if a {@link PageModel} has a live version.
* *
* @param pageModel The {@link PageModel} to check for a live version. * @param pageModel The {@link PageModel} to check for a live version.
*
* @return {@code true} if there is a live version for the provided * @return {@code true} if there is a live version for the provided
* {@link PageModel}, {@code false} otherwise. * {@link PageModel}, {@code false} otherwise.
*/ */
@Transactional(Transactional.TxType.REQUIRED) @Transactional(Transactional.TxType.REQUIRED)
public boolean isLive(final PageModel pageModel) { public boolean isLive(final PageModel pageModel) {
final TypedQuery<Boolean> query = entityManager.createNamedQuery( final TypedQuery<Boolean> query = entityManager.createNamedQuery(
"PageModel.hasLiveVersion", Boolean.class); "PageModel.hasLiveVersion", Boolean.class);
query.setParameter("uuid", pageModel.getModelUuid()); query.setParameter("uuid", pageModel.getModelUuid());
return query.getSingleResult(); return query.getSingleResult();
} }
/** /**
* Retrieves the live version of a {@link PageModel}. This method does not
* require any privileges.
* *
* @param pageModel * @param pageModel The {@link PageModel} of which the live version is
* @return * retrieved.
*
* @return An {@link Optional} containing the live version of the provided
* {@link PageModel} if there is a live version. Otherwise an empty
* {@link Optional} is returned.
*/ */
@Transactional(Transactional.TxType.REQUIRED) @Transactional(Transactional.TxType.REQUIRED)
public Optional<PageModel> getLiveVersion(final PageModel pageModel) { public Optional<PageModel> getLiveVersion(final PageModel pageModel) {
if (isLive(pageModel)) { if (isLive(pageModel)) {
final TypedQuery<PageModel> query = entityManager.createNamedQuery( final TypedQuery<PageModel> query = entityManager.createNamedQuery(
"PageModel.findLiveVersion", "PageModel.findLiveVersion",
PageModel.class); PageModel.class);
query.setParameter("uuid", pageModel.getModelUuid()); query.setParameter("uuid", pageModel.getModelUuid());
return Optional.of(query.getSingleResult()); return Optional.of(query.getSingleResult());
} else { } else {
@ -208,12 +235,24 @@ public class PageModelManager {
} }
} }
/**
* Publishes the draft version of a {@link PageModel}. If there is already a
* live version of the provided {@link PageModel} the live version is
* updated. If no live version exists a new live version is created.
*
* @param pageModel The {@link PageModel} to publish.
*
* @return The live version of the provided {@link PageModel}.
*/
@AuthorizationRequired
@RequiresPrivilege(CoreConstants.PRIVILEGE_ADMIN)
@Transactional(Transactional.TxType.REQUIRED)
public PageModel publish(final PageModel pageModel) { public PageModel publish(final PageModel pageModel) {
final PageModel draftModel = getDraftVersion(pageModel); final PageModel draftModel = getDraftVersion(pageModel);
final PageModel liveModel; final PageModel liveModel;
if (isLive(pageModel)) { if (isLive(pageModel)) {
liveModel = getLiveVersion(pageModel).get(); liveModel = getLiveVersion(draftModel).get();
} else { } else {
liveModel = new PageModel(); liveModel = new PageModel();
} }
@ -222,12 +261,12 @@ public class PageModelManager {
liveModel.setModelUuid(draftModel.getModelUuid()); liveModel.setModelUuid(draftModel.getModelUuid());
for (Map.Entry<Locale, String> entry : draftModel.getTitle().getValues() for (Map.Entry<Locale, String> entry : draftModel.getTitle().getValues()
.entrySet()) { .entrySet()) {
liveModel.getTitle().addValue(entry.getKey(), entry.getValue()); liveModel.getTitle().addValue(entry.getKey(), entry.getValue());
} }
for (Map.Entry<Locale, String> entry : liveModel.getDescription() for (Map.Entry<Locale, String> entry : liveModel.getDescription()
.getValues().entrySet()) { .getValues().entrySet()) {
liveModel.getDescription().addValue(entry.getKey(), liveModel.getDescription().addValue(entry.getKey(),
entry.getValue()); entry.getValue());
} }
@ -244,6 +283,15 @@ public class PageModelManager {
return liveModel; return liveModel;
} }
/**
* Helper method for coping the {@link ComponentModel}s from the draft
* version to the live version.
*
* @param draftModel The draft version of the {@link ComponentModel} to copy
* to the live version of its {@link PageModel}.
*
* @return The live version of the {@link ComponentModel}.
*/
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
private ComponentModel publishComponentModel(final ComponentModel draftModel) { private ComponentModel publishComponentModel(final ComponentModel draftModel) {
@ -266,7 +314,7 @@ public class PageModelManager {
} }
for (final PropertyDescriptor propertyDescriptor : beanInfo. for (final PropertyDescriptor propertyDescriptor : beanInfo.
getPropertyDescriptors()) { getPropertyDescriptors()) {
final Class<?> propType = propertyDescriptor.getPropertyType(); final Class<?> propType = propertyDescriptor.getPropertyType();
final Method readMethod = propertyDescriptor.getReadMethod(); final Method readMethod = propertyDescriptor.getReadMethod();
final Method writeMethod = propertyDescriptor.getWriteMethod(); final Method writeMethod = propertyDescriptor.getWriteMethod();
@ -280,7 +328,7 @@ public class PageModelManager {
} }
if (propType != null if (propType != null
&& propType.isAssignableFrom(List.class)) { && propType.isAssignableFrom(List.class)) {
final List<Object> source; final List<Object> source;
final List<Object> target; final List<Object> target;
@ -288,14 +336,14 @@ public class PageModelManager {
source = (List<Object>) readMethod.invoke(draftModel); source = (List<Object>) readMethod.invoke(draftModel);
target = (List<Object>) readMethod.invoke(liveModel); target = (List<Object>) readMethod.invoke(liveModel);
} catch (IllegalAccessException } catch (IllegalAccessException
| IllegalArgumentException | IllegalArgumentException
| InvocationTargetException ex) { | InvocationTargetException ex) {
throw new UncheckedWrapperException(ex); throw new UncheckedWrapperException(ex);
} }
target.addAll(source); target.addAll(source);
} else if (propType != null } else if (propType != null
&& propType.isAssignableFrom(Map.class)) { && propType.isAssignableFrom(Map.class)) {
final Map<Object, Object> source; final Map<Object, Object> source;
final Map<Object, Object> target; final Map<Object, Object> target;
@ -304,15 +352,15 @@ public class PageModelManager {
source = (Map<Object, Object>) readMethod.invoke(draftModel); source = (Map<Object, Object>) readMethod.invoke(draftModel);
target = (Map<Object, Object>) readMethod.invoke(liveModel); target = (Map<Object, Object>) readMethod.invoke(liveModel);
} catch (IllegalAccessException } catch (IllegalAccessException
| IllegalArgumentException | IllegalArgumentException
| InvocationTargetException ex) { | InvocationTargetException ex) {
throw new UncheckedWrapperException(ex); throw new UncheckedWrapperException(ex);
} }
source.forEach((key, value) -> target.put(key, value)); source.forEach((key, value) -> target.put(key, value));
} else if (propType != null } else if (propType != null
&& propType.isAssignableFrom(Set.class)) { && propType.isAssignableFrom(Set.class)) {
final Set<Object> source; final Set<Object> source;
final Set<Object> target; final Set<Object> target;
@ -321,8 +369,8 @@ public class PageModelManager {
source = (Set<Object>) readMethod.invoke(draftModel); source = (Set<Object>) readMethod.invoke(draftModel);
target = (Set<Object>) readMethod.invoke(liveModel); target = (Set<Object>) readMethod.invoke(liveModel);
} catch (IllegalAccessException } catch (IllegalAccessException
| IllegalArgumentException | IllegalArgumentException
| InvocationTargetException ex) { | InvocationTargetException ex) {
throw new UncheckedWrapperException(ex); throw new UncheckedWrapperException(ex);
} }
@ -333,8 +381,8 @@ public class PageModelManager {
value = readMethod.invoke(draftModel); value = readMethod.invoke(draftModel);
writeMethod.invoke(liveModel, value); writeMethod.invoke(liveModel, value);
} catch (IllegalAccessException } catch (IllegalAccessException
| IllegalArgumentException | IllegalArgumentException
| InvocationTargetException ex) { | InvocationTargetException ex) {
throw new UncheckedWrapperException(ex); throw new UncheckedWrapperException(ex);
} }
} }
@ -345,6 +393,15 @@ public class PageModelManager {
return liveModel; return liveModel;
} }
/**
* Helper method to determine if a property is excluded from the publishing
* process.
*
* @param name The name of the property.
*
* @return {@code true} if the property is excluded from the publishing
* process, {@link false} if not.
*/
private boolean propertyIsExcluded(final String name) { private boolean propertyIsExcluded(final String name) {
final String[] excluded = new String[]{ final String[] excluded = new String[]{
"uuid", "uuid",
@ -362,19 +419,34 @@ public class PageModelManager {
return result; return result;
} }
/**
* Returns all available {@link ComponentModel}.
*
* @return A list of all available {@link ComponentModel}s.
*/
public List<PageModelComponentModel> findAvailableComponents() { public List<PageModelComponentModel> findAvailableComponents() {
final List<PageModelComponentModel> list = new ArrayList<>(components final List<PageModelComponentModel> list = new ArrayList<>(components
.values()); .values());
list.sort((component1, component2) -> { list.sort((component1, component2) -> {
return component1.modelClass().getName().compareTo( return component1.modelClass().getName().compareTo(
component2.modelClass().getName()); component2.modelClass().getName());
}); });
return list; return list;
} }
/**
* Finds the description specific {@link ComponentModel}.
*
* @param className The fully qualified name of the {@link ComponentModel}
* class.
*
* @return An {@link Optional} containing the description of the
* {@link ComponentModel} if there is a {@link ComponentModel} with
* the specified {@code name}. Otherwise an empty {@link Optional}.
*/
public Optional<PageModelComponentModel> findComponentModel( public Optional<PageModelComponentModel> findComponentModel(
final String className) { final String className) {
if (components.containsKey(className)) { if (components.containsKey(className)) {
return Optional.of(components.get(className)); return Optional.of(components.get(className));
@ -384,9 +456,10 @@ public class PageModelManager {
} }
/** /**
* Add a {@link ComponentModel} to a {@link PageModel}. * Adds a {@link ComponentModel} to a {@link PageModel}.
* *
* @param pageModel The {@link PageModel} to which component model is added. * @param pageModel The {@link PageModel} to which component model is
* added.
* @param componentModel The {@link ComponentModel} to add. * @param componentModel The {@link ComponentModel} to add.
*/ */
public void addComponentModel(final PageModel pageModel, public void addComponentModel(final PageModel pageModel,
@ -394,12 +467,12 @@ public class PageModelManager {
if (pageModel == null) { if (pageModel == null) {
throw new IllegalArgumentException( throw new IllegalArgumentException(
"Can't add a component model to page model null."); "Can't add a component model to page model null.");
} }
if (componentModel == null) { if (componentModel == null) {
throw new IllegalArgumentException( throw new IllegalArgumentException(
"Can't add component model null to a page model."); "Can't add component model null to a page model.");
} }
pageModel.addComponent(componentModel); pageModel.addComponent(componentModel);
@ -412,22 +485,22 @@ public class PageModelManager {
/** /**
* Removes a {@link ComponentModel} from a {@link PageModel}. * Removes a {@link ComponentModel} from a {@link PageModel}.
* *
* @param pageModel The {@link PageModel} from which the * @param pageModel The {@link PageModel} from which the
* {@link ComponentModel} is removed. * {@link ComponentModel} is removed.
* @param componentModel The {@link ComponentModel} to remove. The component * @param componentModel The {@link ComponentModel} to remove. The component
* model is also removed from the database. * model is also removed from the database.
*/ */
public void removeComponentModel(final PageModel pageModel, public void removeComponentModel(final PageModel pageModel,
final ComponentModel componentModel) { final ComponentModel componentModel) {
if (pageModel == null) { if (pageModel == null) {
throw new IllegalArgumentException( throw new IllegalArgumentException(
"Can't remove a component model from page model null."); "Can't remove a component model from page model null.");
} }
if (componentModel == null) { if (componentModel == null) {
throw new IllegalArgumentException( throw new IllegalArgumentException(
"Can't remove component model null from a page model."); "Can't remove component model null from a page model.");
} }
pageModel.removeComponent(componentModel); pageModel.removeComponent(componentModel);

62
ccm-core/src/main/java/org/libreccm/pagemodel/PageModelRepository.java
View File

@ -19,6 +19,9 @@
package org.libreccm.pagemodel; package org.libreccm.pagemodel;
import org.libreccm.core.AbstractEntityRepository; import org.libreccm.core.AbstractEntityRepository;
import org.libreccm.core.CoreConstants;
import org.libreccm.security.AuthorizationRequired;
import org.libreccm.security.RequiresPrivilege;
import org.libreccm.web.CcmApplication; import org.libreccm.web.CcmApplication;
import java.util.List; import java.util.List;
@ -27,8 +30,10 @@ import java.util.UUID;
import javax.enterprise.context.RequestScoped; import javax.enterprise.context.RequestScoped;
import javax.persistence.TypedQuery; import javax.persistence.TypedQuery;
import javax.transaction.Transactional;
/** /**
* Repository for {@link PageModel}s.
* *
* @author <a href="mailto:jens.pelzetter@googlemail.com">Jens Pelzetter</a> * @author <a href="mailto:jens.pelzetter@googlemail.com">Jens Pelzetter</a>
*/ */
@ -49,6 +54,11 @@ public class PageModelRepository extends AbstractEntityRepository<Long, PageMode
return pageModel.getPageModelId() == 0; return pageModel.getPageModelId() == 0;
} }
/**
* Sets the UUID field of a new {@link PageModel}.
*
* @param pageModel The new {@link PageModel}.
*/
@Override @Override
public void initNewEntity(final PageModel pageModel) { public void initNewEntity(final PageModel pageModel) {
if (pageModel == null) { if (pageModel == null) {
@ -64,6 +74,25 @@ public class PageModelRepository extends AbstractEntityRepository<Long, PageMode
} }
} }
@AuthorizationRequired
@RequiresPrivilege(CoreConstants.PRIVILEGE_ADMIN)
@Transactional(Transactional.TxType.REQUIRED)
@Override
public void save(final PageModel pageModel) {
super.save(pageModel);
}
/**
* Finds the draft version of all {@link PageModel}s for the provided
* application.
*
* @param application The application for which the {@link PageModel}s are
* retrieved.
*
* @return A list of the {@link PageModel}s defined for the provided {
*
* @coded application}.
*/
public List<PageModel> findByApplication(final CcmApplication application) { public List<PageModel> findByApplication(final CcmApplication application) {
if (application == null) { if (application == null) {
throw new IllegalArgumentException( throw new IllegalArgumentException(
@ -77,6 +106,15 @@ public class PageModelRepository extends AbstractEntityRepository<Long, PageMode
return query.getResultList(); return query.getResultList();
} }
/**
* Counts the {@link PageModel}s (draft version) defined for a application.
*
* @param application The application for which the {@link PageLink}s are
* counted.
*
* @return The number of {@link PageModel}s defined for the provided
* {@code application}.
*/
public long countByApplication(final CcmApplication application) { public long countByApplication(final CcmApplication application) {
if (application == null) { if (application == null) {
throw new IllegalArgumentException( throw new IllegalArgumentException(
@ -90,6 +128,19 @@ public class PageModelRepository extends AbstractEntityRepository<Long, PageMode
return query.getSingleResult(); return query.getSingleResult();
} }
/**
* Finds a {@link PageModel} (draft version) by the application and its
* {@code name}.
*
* @param application The application for which the {@link PageModel} is
* defined.
* @param name The name of the {@link PageModel}.
*
* @return An {@link Optional} containing the {@link PageModel} for the
* provided {@code application} with the provided {@code name}. If
* there is no {@link PageModel} matching the criteria an empty
* {@link Optional} is returned.
*/
public Optional<PageModel> findByApplicationAndName( public Optional<PageModel> findByApplicationAndName(
final CcmApplication application, final CcmApplication application,
final String name) { final String name) {
@ -117,6 +168,17 @@ public class PageModelRepository extends AbstractEntityRepository<Long, PageMode
return Optional.of(query.getSingleResult()); return Optional.of(query.getSingleResult());
} }
/**
* Counts the number of {@link PageModel} (draft version) defined for the
* provided application with the provided name.
*
* @param application The application for which the {@link PageModel} is
* defined.
* @param name The name of the {@link PageModel}.
*
* @return The number of {@link PageModel}s matching the criteria. Should be
* 0 or 1.
*/
public long countByApplicationAndName(final CcmApplication application, public long countByApplicationAndName(final CcmApplication application,
final String name) { final String name) {

3
ccm-core/src/main/java/org/libreccm/pagemodel/PageModelVersion.java
View File

@ -19,7 +19,8 @@
package org.libreccm.pagemodel; package org.libreccm.pagemodel;
/** /**
* * Enumeration for the possible values for the version of a {@link PageModel}.
*
* @author <a href="mailto:jens.pelzetter@googlemail.com">Jens Pelzetter</a> * @author <a href="mailto:jens.pelzetter@googlemail.com">Jens Pelzetter</a>
*/ */
public enum PageModelVersion { public enum PageModelVersion {