diff --git a/ccm-core/src/main/java/org/libreccm/core/Privilege.java b/ccm-core/src/main/java/org/libreccm/core/Privilege.java index 3a5551f3d..f02e22953 100644 --- a/ccm-core/src/main/java/org/libreccm/core/Privilege.java +++ b/ccm-core/src/main/java/org/libreccm/core/Privilege.java @@ -52,11 +52,11 @@ import javax.xml.bind.annotation.XmlRootElement; @NamedQueries({ @NamedQuery(name = "findPrivilegeByName", query = "SELECT p FROM Privilege p " - + "WHERE p.privilege = :name"), + + "WHERE p.label = :label"), @NamedQuery(name = "isPrivilegeInUse", query = "SELECT COUNT(p) FROM Permission p " + " JOIN p.grantedPrivilege g " - + " WHERE g.privilege = :name") + + " WHERE g.label = :label") }) @XmlRootElement(name = "privilege", namespace = CORE_XML_NS) public class Privilege implements Serializable { @@ -69,11 +69,10 @@ public class Privilege implements Serializable { @XmlElement(name = "privilege-id", namespace = CORE_XML_NS) private long privilegeId; - @Column(name = "privilege", length = 255, nullable = false) + @Column(name = "label", length = 255, nullable = false) //Field is named like this in the old PDL class, don't want to change it now - @SuppressWarnings("PMD.AvoidFieldNameMatchingTypeName") - @XmlElement(name = "privilege", namespace = CORE_XML_NS) - private String privilege; + @XmlElement(name = "label", namespace = CORE_XML_NS) + private String label; public long getPrivilegeId() { return privilegeId; @@ -83,19 +82,19 @@ public class Privilege implements Serializable { this.privilegeId = privilegeId; } - public String getPrivilege() { - return privilege; + public String getLabel() { + return label; } - public void setPrivilege(final String privilege) { - this.privilege = privilege; + public void setLabel(final String label) { + this.label = label; } @Override public int hashCode() { int hash = 7; hash = 43 * hash + (int) (privilegeId ^ (privilegeId >>> 32)); - hash = 43 * hash + Objects.hashCode(privilege); + hash = 43 * hash + Objects.hashCode(label); return hash; } @@ -115,7 +114,7 @@ public class Privilege implements Serializable { if (privilegeId != other.getPrivilegeId()) { return false; } - return Objects.equals(privilege, other.getPrivilege()); + return Objects.equals(label, other.getLabel()); } public boolean canEqual(final Object obj) { @@ -130,7 +129,7 @@ public class Privilege implements Serializable { + " }", super.toString(), privilegeId, - privilege); + label); } } diff --git a/ccm-core/src/main/java/org/libreccm/core/PrivilegeRepository.java b/ccm-core/src/main/java/org/libreccm/core/PrivilegeRepository.java index 39dd19ffd..2bf14d4e0 100644 --- a/ccm-core/src/main/java/org/libreccm/core/PrivilegeRepository.java +++ b/ccm-core/src/main/java/org/libreccm/core/PrivilegeRepository.java @@ -41,23 +41,23 @@ public class PrivilegeRepository { /** * Finds the {@link Privilege} identified by {@code name}. * - * @param name The name of the privilege to return. + * @param label The name of the privilege to return. * * @return The requested privilege. * * @throws UnknownPrivilegeException if there is no privilege identified by * the provided {@code name}. */ - public Privilege retrievePrivilege(final String name) { + public Privilege retrievePrivilege(final String label) { final TypedQuery query = entityManager.createNamedQuery( "findPrivilegeByName", Privilege.class); - query.setParameter("name", name); + query.setParameter("label", label); try { return query.getSingleResult(); } catch (NoResultException ex) { throw new UnknownPrivilegeException(String.format( - "There is no privilege \"%s\".", name), ex); + "There is no privilege \"%s\".", label), ex); } } @@ -68,13 +68,13 @@ public class PrivilegeRepository { * * ToDo: Check if current user is system user. * - * @param privilegeName The privilege to create. + * @param label The privilege to create. * * @return The new privilege. */ - public Privilege createPrivilege(final String privilegeName) { + public Privilege createPrivilege(final String label) { final Privilege privilege = new Privilege(); - privilege.setPrivilege(privilegeName); + privilege.setLabel(label); entityManager.persist(privilege); @@ -104,15 +104,15 @@ public class PrivilegeRepository { /** * Checks a {@link Privilege} is in use. * - * @param privilegeName The name of the privilege to check. + * @param label The name of the privilege to check. * * @return {@code true} if the privilege is in use (there is a least one * permission using it), {@code false} otherwise. */ - public boolean isPrivilegeInUse(final String privilegeName) { + public boolean isPrivilegeInUse(final String label) { final TypedQuery query = entityManager.createNamedQuery( "isPrivilegeInUse", Long.class); - query.setParameter("name", privilegeName); + query.setParameter("label", label); final Long result = query.getSingleResult(); diff --git a/ccm-core/src/main/java/org/libreccm/core/User.java b/ccm-core/src/main/java/org/libreccm/core/User.java index 6a8e5ce1e..452de1827 100644 --- a/ccm-core/src/main/java/org/libreccm/core/User.java +++ b/ccm-core/src/main/java/org/libreccm/core/User.java @@ -63,14 +63,15 @@ import javax.xml.bind.annotation.XmlTransient; query = "SELECT u FROM User u WHERE u.screenName = :screenname"), @NamedQuery(name = "findUserByEmailAddress", query = "SELECT u FROM User u JOIN u.emailAddresses e " - + "WHERE e.address = :emailAddress")}) + + "WHERE e.address = :emailAddress")}) @XmlRootElement(name = "user", namespace = CORE_XML_NS) //Supressing a few warnings from PMD because they misleading here. //User is perfectly fine class name, and the complexity is not to high... @SuppressWarnings({"PMD.ShortClassName", "PMD.CyclomaticComplexity", "PMD.StdCyclomaticComplexity", - "PMD.ModifiedCyclomaticComplexity"}) + "PMD.ModifiedCyclomaticComplexity", + "PMD.GodClass"}) public class User extends Subject implements Serializable { private static final long serialVersionUID = 892038270064849732L; @@ -80,10 +81,10 @@ public class User extends Subject implements Serializable { */ @Embedded @AssociationOverride( - name = "user_names", - joinTable = @JoinTable(name = "user_names", - joinColumns = { - @JoinColumn(name = " user_id")})) + name = "user_names", + joinTable = @JoinTable(name = "user_names", + joinColumns = { + @JoinColumn(name = " user_id")})) @XmlElement(name = "person-name", namespace = CORE_XML_NS) private PersonName name; @@ -294,7 +295,7 @@ public class User extends Subject implements Serializable { } protected void setGroupMemberships( - final List groupMemberships) { + final List groupMemberships) { this.groupMemberships = groupMemberships; } @@ -303,7 +304,7 @@ public class User extends Subject implements Serializable { } protected void removeGroupMembership( - final GroupMembership groupMembership) { + final GroupMembership groupMembership) { groupMemberships.remove(groupMembership); } @@ -386,12 +387,12 @@ public class User extends Subject implements Serializable { @Override public String toString(final String data) { return super.toString(String.format(", name = %s, " - + "screenName = \"%s\", " - + "emailAddress = { %s }" - + "banned = %b, " - + "ssoLogin = \"%s\" " - + "hashAlgorithm = \"%s\" " - + "passwordResetRequired = %b%s", + + "screenName = \"%s\", " + + "emailAddress = { %s }" + + "banned = %b, " + + "ssoLogin = \"%s\" " + + "hashAlgorithm = \"%s\" " + + "passwordResetRequired = %b%s", Objects.toString(name), screenName, Objects.toString(emailAddresses), diff --git a/ccm-core/src/test/java/org/libreccm/core/PermissionRepositoryTest.java b/ccm-core/src/test/java/org/libreccm/core/PermissionRepositoryTest.java index 3054d493d..9bdde6f73 100644 --- a/ccm-core/src/test/java/org/libreccm/core/PermissionRepositoryTest.java +++ b/ccm-core/src/test/java/org/libreccm/core/PermissionRepositoryTest.java @@ -162,7 +162,7 @@ public class PermissionRepositoryTest { assertThat(permissionsJdoe.size(), is(1)); assertThat(permissionsJdoe.get(0).getObject().getDisplayName(), is(equalTo("Test Object 2"))); - assertThat(permissionsJdoe.get(0).getGrantedPrivilege().getPrivilege(), + assertThat(permissionsJdoe.get(0).getGrantedPrivilege().getLabel(), is(equalTo("read"))); final List permissionsMmuster = permissionRepository @@ -173,7 +173,7 @@ public class PermissionRepositoryTest { .findPermissionsForSubject(admins); assertThat(permissionsAdmins.size(), is(1)); assertThat(permissionsAdmins.get(0).getObject(), is(nullValue())); - assertThat(permissionsAdmins.get(0).getGrantedPrivilege().getPrivilege(), + assertThat(permissionsAdmins.get(0).getGrantedPrivilege().getLabel(), is("admin")); final List permissionsUsers = permissionRepository @@ -181,7 +181,7 @@ public class PermissionRepositoryTest { assertThat(permissionsUsers.size(), is(1)); assertThat(permissionsUsers.get(0).getObject().getDisplayName(), is(equalTo("Test Object 1"))); - assertThat(permissionsUsers.get(0).getGrantedPrivilege().getPrivilege(), + assertThat(permissionsUsers.get(0).getGrantedPrivilege().getLabel(), is(equalTo("read"))); final List permissionsAuthors = permissionRepository @@ -193,9 +193,9 @@ public class PermissionRepositoryTest { is(equalTo("Test Object 1"))); final Set privileges = new HashSet<>(); privileges.add(permissionsAuthors.get(0).getGrantedPrivilege() - .getPrivilege()); + .getLabel()); privileges.add(permissionsAuthors.get(1).getGrantedPrivilege() - .getPrivilege()); + .getLabel()); assertThat(privileges, hasItem("read")); assertThat(privileges, hasItem("write")); } @@ -227,9 +227,9 @@ public class PermissionRepositoryTest { @Override public int compare(final Permission permission1, final Permission permission2) { - int result = permission1.getGrantedPrivilege().getPrivilege() + int result = permission1.getGrantedPrivilege().getLabel() .compareToIgnoreCase(permission2.getGrantedPrivilege() - .getPrivilege()); + .getLabel()); if (result == 0) { result = permission1.getObject().getDisplayName().compareTo( @@ -250,19 +250,19 @@ public class PermissionRepositoryTest { }); - assertThat(jdoePermissions.get(0).getGrantedPrivilege().getPrivilege(), + assertThat(jdoePermissions.get(0).getGrantedPrivilege().getLabel(), is(equalTo("read"))); assertThat(jdoePermissions.get(0).getObject().getDisplayName(), is(equalTo("Test Object 1"))); - assertThat(jdoePermissions.get(1).getGrantedPrivilege().getPrivilege(), + assertThat(jdoePermissions.get(1).getGrantedPrivilege().getLabel(), is(equalTo("read"))); assertThat(jdoePermissions.get(1).getObject().getDisplayName(), is(equalTo("Test Object 1"))); - assertThat(jdoePermissions.get(2).getGrantedPrivilege().getPrivilege(), + assertThat(jdoePermissions.get(2).getGrantedPrivilege().getLabel(), is(equalTo("read"))); assertThat(jdoePermissions.get(2).getObject().getDisplayName(), is(equalTo("Test Object 2"))); - assertThat(jdoePermissions.get(3).getGrantedPrivilege().getPrivilege(), + assertThat(jdoePermissions.get(3).getGrantedPrivilege().getLabel(), is(equalTo("write"))); assertThat(jdoePermissions.get(3).getObject().getDisplayName(), is(equalTo("Test Object 1"))); @@ -271,7 +271,7 @@ public class PermissionRepositoryTest { .findPermissionsForUser(mmuster); assertThat(mmusterPermissions.size(), is(1)); assertThat(mmusterPermissions.get(0).getGrantedPrivilege() - .getPrivilege(), + .getLabel(), is(equalTo("admin"))); assertThat(mmusterPermissions.get(0).getObject(), is(nullValue())); } @@ -308,21 +308,21 @@ public class PermissionRepositoryTest { }); assertThat(object1Permissions.get(0).getGrantedPrivilege() - .getPrivilege(), + .getLabel(), is(equalTo("read"))); assertThat(object1Permissions.get(0).getGrantee(), is(instanceOf(Group.class))); assertThat(((Group) object1Permissions.get(0).getGrantee()).getName(), is(equalTo("authors"))); assertThat(object1Permissions.get(1).getGrantedPrivilege() - .getPrivilege(), + .getLabel(), is(equalTo("write"))); assertThat(object1Permissions.get(1).getGrantee(), is(instanceOf(Group.class))); assertThat(((Group) object1Permissions.get(1).getGrantee()).getName(), is(equalTo("authors"))); assertThat(object1Permissions.get(2).getGrantedPrivilege() - .getPrivilege(), + .getLabel(), is(equalTo("read"))); assertThat(object1Permissions.get(2).getGrantee(), is(instanceOf(Group.class))); @@ -333,7 +333,7 @@ public class PermissionRepositoryTest { .findPermissionsForCcmObject(object2); assertThat(object2Permissions.size(), is(1)); assertThat(object2Permissions.get(0).getGrantedPrivilege() - .getPrivilege(), + .getLabel(), is(equalTo("read"))); assertThat(object2Permissions.get(0).getGrantee(), is(instanceOf(User.class))); @@ -366,10 +366,10 @@ public class PermissionRepositoryTest { final User mmuster = userRepository.findByScreenName("mmuster"); final TypedQuery query1 = entityManager.createQuery( - "SELECT p FROM Privilege p WHERE p.privilege = 'read'", + "SELECT p FROM Privilege p WHERE p.label = 'read'", Privilege.class); final TypedQuery query2 = entityManager.createQuery( - "SELECT p FROM Privilege p WHERE p.privilege = 'write'", + "SELECT p FROM Privilege p WHERE p.label = 'write'", Privilege.class); final CcmObject object = ccmObjectRepository.findById(-40L); diff --git a/ccm-core/src/test/java/org/libreccm/core/PrivilegeRepositoryTest.java b/ccm-core/src/test/java/org/libreccm/core/PrivilegeRepositoryTest.java index 46b45c5b0..7bc0facda 100644 --- a/ccm-core/src/test/java/org/libreccm/core/PrivilegeRepositoryTest.java +++ b/ccm-core/src/test/java/org/libreccm/core/PrivilegeRepositoryTest.java @@ -131,9 +131,9 @@ public class PrivilegeRepositoryTest { assertThat(read, is(not(nullValue()))); assertThat(write, is(not(nullValue()))); - assertThat(admin.getPrivilege(), is(equalTo("admin"))); - assertThat(read.getPrivilege(), is(equalTo("read"))); - assertThat(write.getPrivilege(), is(equalTo("write"))); + assertThat(admin.getLabel(), is(equalTo("admin"))); + assertThat(read.getLabel(), is(equalTo("read"))); + assertThat(write.getLabel(), is(equalTo("write"))); } @Test(expected = UnknownPrivilegeException.class) diff --git a/ccm-core/src/test/resources/datasets/org/libreccm/core/PermissionRepositoryTest/after-delete.json b/ccm-core/src/test/resources/datasets/org/libreccm/core/PermissionRepositoryTest/after-delete.json index fa83060ea..5e66d96a1 100644 --- a/ccm-core/src/test/resources/datasets/org/libreccm/core/PermissionRepositoryTest/after-delete.json +++ b/ccm-core/src/test/resources/datasets/org/libreccm/core/PermissionRepositoryTest/after-delete.json @@ -94,19 +94,19 @@ [ { "privilege_id": -10, - "privilege": "admin" + "label": "admin" }, { "privilege_id": -20, - "privilege": "read" + "label": "read" }, { "privilege_id": -30, - "privilege": "write" + "label": "write" }, { "privilege_id": -40, - "privilege": "unused" + "label": "unused" } ], "ccm_objects": diff --git a/ccm-core/src/test/resources/datasets/org/libreccm/core/PermissionRepositoryTest/after-save-changed.json b/ccm-core/src/test/resources/datasets/org/libreccm/core/PermissionRepositoryTest/after-save-changed.json index 2d9b862aa..2c4143eca 100644 --- a/ccm-core/src/test/resources/datasets/org/libreccm/core/PermissionRepositoryTest/after-save-changed.json +++ b/ccm-core/src/test/resources/datasets/org/libreccm/core/PermissionRepositoryTest/after-save-changed.json @@ -94,19 +94,19 @@ [ { "privilege_id": -10, - "privilege": "admin" + "label": "admin" }, { "privilege_id": -20, - "privilege": "read" + "label": "read" }, { "privilege_id": -30, - "privilege": "write" + "label": "write" }, { "privilege_id": -40, - "privilege": "unused" + "label": "unused" } ], "ccm_objects": diff --git a/ccm-core/src/test/resources/datasets/org/libreccm/core/PermissionRepositoryTest/after-save-new.json b/ccm-core/src/test/resources/datasets/org/libreccm/core/PermissionRepositoryTest/after-save-new.json index 69f2af189..91094bc33 100644 --- a/ccm-core/src/test/resources/datasets/org/libreccm/core/PermissionRepositoryTest/after-save-new.json +++ b/ccm-core/src/test/resources/datasets/org/libreccm/core/PermissionRepositoryTest/after-save-new.json @@ -94,19 +94,19 @@ [ { "privilege_id": -10, - "privilege": "admin" + "label": "admin" }, { "privilege_id": -20, - "privilege": "read" + "label": "read" }, { "privilege_id": -30, - "privilege": "write" + "label": "write" }, { "privilege_id": -40, - "privilege": "unused" + "label": "unused" } ], "ccm_objects": diff --git a/ccm-core/src/test/resources/datasets/org/libreccm/core/PermissionRepositoryTest/data.json b/ccm-core/src/test/resources/datasets/org/libreccm/core/PermissionRepositoryTest/data.json index 02a64ad3d..ab77f63c6 100644 --- a/ccm-core/src/test/resources/datasets/org/libreccm/core/PermissionRepositoryTest/data.json +++ b/ccm-core/src/test/resources/datasets/org/libreccm/core/PermissionRepositoryTest/data.json @@ -94,19 +94,19 @@ [ { "privilege_id": -10, - "privilege": "admin" + "label": "admin" }, { "privilege_id": -20, - "privilege": "read" + "label": "read" }, { "privilege_id": -30, - "privilege": "write" + "label": "write" }, { "privilege_id": -40, - "privilege": "unused" + "label": "unused" } ], "ccm_objects": diff --git a/ccm-core/src/test/resources/datasets/org/libreccm/core/PrivilegeRepositoryTest/after-create.json b/ccm-core/src/test/resources/datasets/org/libreccm/core/PrivilegeRepositoryTest/after-create.json index 74e45a1e1..8a4c9bf9e 100644 --- a/ccm-core/src/test/resources/datasets/org/libreccm/core/PrivilegeRepositoryTest/after-create.json +++ b/ccm-core/src/test/resources/datasets/org/libreccm/core/PrivilegeRepositoryTest/after-create.json @@ -3,19 +3,19 @@ [ { "privilege_id": -10, - "privilege": "admin" + "label": "admin" }, { "privilege_id": -20, - "privilege": "read" + "label": "read" }, { "privilege_id": -30, - "privilege": "write" + "label": "write" }, { "privilege_id": -40, - "privilege": "publish" + "label": "publish" } ] } \ No newline at end of file diff --git a/ccm-core/src/test/resources/datasets/org/libreccm/core/PrivilegeRepositoryTest/after-delete.json b/ccm-core/src/test/resources/datasets/org/libreccm/core/PrivilegeRepositoryTest/after-delete.json index 74a440b00..4b77b8c71 100644 --- a/ccm-core/src/test/resources/datasets/org/libreccm/core/PrivilegeRepositoryTest/after-delete.json +++ b/ccm-core/src/test/resources/datasets/org/libreccm/core/PrivilegeRepositoryTest/after-delete.json @@ -3,11 +3,11 @@ [ { "privilege_id": -10, - "privilege": "admin" + "label": "admin" }, { "privilege_id": -20, - "privilege": "read" + "label": "read" } ] } \ No newline at end of file diff --git a/ccm-core/src/test/resources/datasets/org/libreccm/core/PrivilegeRepositoryTest/data.json b/ccm-core/src/test/resources/datasets/org/libreccm/core/PrivilegeRepositoryTest/data.json index 4a1bcef27..5d16284e5 100644 --- a/ccm-core/src/test/resources/datasets/org/libreccm/core/PrivilegeRepositoryTest/data.json +++ b/ccm-core/src/test/resources/datasets/org/libreccm/core/PrivilegeRepositoryTest/data.json @@ -3,15 +3,15 @@ [ { "privilege_id": -10, - "privilege": "admin" + "label": "admin" }, { "privilege_id": -20, - "privilege": "read" + "label": "read" }, { "privilege_id": -30, - "privilege": "write" + "label": "write" } ] } \ No newline at end of file