refactor: 💡 Refactored all models

Author: Dominik Frantisek Bucik

perun-oidc-server/src/main/java/cz/muni/ics/oauth2/model/ClientDetailsEntity.java

@@ -26,14 +26,27 @@
 import com.nimbusds.jose.JWSAlgorithm;
 import com.nimbusds.jose.jwk.JWKSet;
 import com.nimbusds.jwt.JWT;
+import cz.muni.ics.oauth2.model.enums.AppType;
+import cz.muni.ics.oauth2.model.enums.AuthMethod;
+import cz.muni.ics.oauth2.model.enums.SubjectType;
 import java.util.Date;
 import java.util.Map;
 import java.util.Set;
+import lombok.AllArgsConstructor;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.Setter;
+import lombok.ToString;
 import org.springframework.security.core.GrantedAuthority;
 
 /**
  * @author jricher
  */
+@Getter
+@Setter
+@ToString
+@EqualsAndHashCode
+@AllArgsConstructor
 public class RegisteredClient {
 
 	private String registrationAccessToken;
@@ -57,14 +70,6 @@ public RegisteredClient(ClientDetailsEntity client, String registrationAccessTok
 		this.registrationClientUri = registrationClientUri;
 	}
 
-	public ClientDetailsEntity getClient() {
-		return client;
-	}
-
-	public void setClient(ClientDetailsEntity client) {
-		this.client = client;
-	}
-
 	public String getClientDescription() {
 		return client.getClientDescription();
 	}
@@ -201,11 +206,11 @@ public Map<String, Object> getAdditionalInformation() {
 		return client.getAdditionalInformation();
 	}
 
-	public ClientDetailsEntity.AppType getApplicationType() {
+	public AppType getApplicationType() {
 		return client.getApplicationType();
 	}
 
-	public void setApplicationType(ClientDetailsEntity.AppType applicationType) {
+	public void setApplicationType(AppType applicationType) {
 		client.setApplicationType(applicationType);
 	}
 
@@ -217,19 +222,19 @@ public void setClientName(String clientName) {
 		client.setClientName(clientName);
 	}
 
-	public ClientDetailsEntity.AuthMethod getTokenEndpointAuthMethod() {
+	public AuthMethod getTokenEndpointAuthMethod() {
 		return client.getTokenEndpointAuthMethod();
 	}
 
-	public void setTokenEndpointAuthMethod(ClientDetailsEntity.AuthMethod tokenEndpointAuthMethod) {
+	public void setTokenEndpointAuthMethod(AuthMethod tokenEndpointAuthMethod) {
 		client.setTokenEndpointAuthMethod(tokenEndpointAuthMethod);
 	}
 
-	public ClientDetailsEntity.SubjectType getSubjectType() {
+	public SubjectType getSubjectType() {
 		return client.getSubjectType();
 	}
 
-	public void setSubjectType(ClientDetailsEntity.SubjectType subjectType) {
+	public void setSubjectType(SubjectType subjectType) {
 		client.setSubjectType(subjectType);
 	}
 

perun-oidc-server/src/main/java/cz/muni/ics/oauth2/model/RegisteredClient.java

@@ -20,6 +20,8 @@
  */
 package cz.muni.ics.oauth2.model;
 
+import static cz.muni.ics.oauth2.model.SystemScope.*;
+
 import javax.persistence.Basic;
 import javax.persistence.Column;
 import javax.persistence.Entity;
@@ -29,15 +31,31 @@
 import javax.persistence.NamedQueries;
 import javax.persistence.NamedQuery;
 import javax.persistence.Table;
+import lombok.AllArgsConstructor;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+import lombok.ToString;
 
 /**
  * @author jricher
  */
+@Getter
+@Setter
+@ToString
+@EqualsAndHashCode
+@NoArgsConstructor
+@AllArgsConstructor
+// DB ANNOTATIONS
 @Entity
 @Table(name = "system_scope")
 @NamedQueries({
-	@NamedQuery(name = SystemScope.QUERY_ALL, query = "select s from SystemScope s ORDER BY s.id"),
-	@NamedQuery(name = SystemScope.QUERY_BY_VALUE, query = "select s from SystemScope s WHERE s.value = :" + SystemScope.PARAM_VALUE)
+	@NamedQuery(name = QUERY_ALL,
+			query = "SELECT s FROM SystemScope s ORDER BY s.id"),
+	@NamedQuery(name = QUERY_BY_VALUE,
+			query = "SELECT s FROM SystemScope s " +
+					"WHERE s.value = :" + PARAM_VALUE)
 })
 public class SystemScope {
 
@@ -46,145 +64,28 @@ public class SystemScope {
 
 	public static final String PARAM_VALUE = "value";
 
-	private Long id;
-	private String value; // scope value
-	private String description; // human-readable description
-	private String icon; // class of the icon to display on the auth page
-	private boolean defaultScope = false; // is this a default scope for newly-registered clients?
-	private boolean restricted = false; // is this scope restricted to admin-only registration access?
-
-	public SystemScope() { }
-
-	public SystemScope(String value) {
-		this.value = value;
-	}
-
 	@Id
 	@GeneratedValue(strategy = GenerationType.IDENTITY)
 	@Column(name = "id")
-	public Long getId() {
-		return id;
-	}
-
-	public void setId(Long id) {
-		this.id = id;
-	}
+	private Long id;
 
-	@Basic
 	@Column(name = "scope")
-	public String getValue() {
-		return value;
-	}
+	private String value;
 
-	public void setValue(String value) {
-		this.value = value;
-	}
-
-	@Basic
 	@Column(name = "description")
-	public String getDescription() {
-		return description;
-	}
-
-	public void setDescription(String description) {
-		this.description = description;
-	}
+	private String description; // human-readable description
 
-	@Basic
 	@Column(name = "icon")
-	public String getIcon() {
-		return icon;
-	}
-
-	public void setIcon(String icon) {
-		this.icon = icon;
-	}
+	private String icon; // class of the icon to display on the auth page
 
-	@Basic
 	@Column(name = "default_scope")
-	public boolean isDefaultScope() {
-		return defaultScope;
-	}
-
-	public void setDefaultScope(boolean defaultScope) {
-		this.defaultScope = defaultScope;
-	}
+	private boolean defaultScope = false; // is this a default scope for newly-registered clients?
 
-	@Basic
 	@Column(name = "restricted")
-	public boolean isRestricted() {
-		return restricted;
-	}
-
-	public void setRestricted(boolean restricted) {
-		this.restricted = restricted;
-	}
-
-	@Override
-	public int hashCode() {
-		final int prime = 31;
-		int result = 1;
-		result = prime * result + (defaultScope ? 1231 : 1237);
-		result = prime * result
-				+ ((description == null) ? 0 : description.hashCode());
-		result = prime * result + ((icon == null) ? 0 : icon.hashCode());
-		result = prime * result + ((id == null) ? 0 : id.hashCode());
-		result = prime * result + (restricted ? 1231 : 1237);
-		result = prime * result + ((value == null) ? 0 : value.hashCode());
-		return result;
-	}
-
-	@Override
-	public boolean equals(Object obj) {
-		if (this == obj) {
-			return true;
-		}
-		if (obj == null) {
-			return false;
-		}
-		if (getClass() != obj.getClass()) {
-			return false;
-		}
-		SystemScope other = (SystemScope) obj;
-		if (defaultScope != other.defaultScope) {
-			return false;
-		}
-		if (description == null) {
-			if (other.description != null) {
-				return false;
-			}
-		} else if (!description.equals(other.description)) {
-			return false;
-		}
-		if (icon == null) {
-			if (other.icon != null) {
-				return false;
-			}
-		} else if (!icon.equals(other.icon)) {
-			return false;
-		}
-		if (id == null) {
-			if (other.id != null) {
-				return false;
-			}
-		} else if (!id.equals(other.id)) {
-			return false;
-		}
-		if (restricted != other.restricted) {
-			return false;
-		}
-		if (value == null) {
-			return other.value == null;
-		} else {
-			return value.equals(other.value);
-		}
-	}
+	private boolean restricted = false; // is this scope restricted to admin-only registration access?
 
-	@Override
-	public String toString() {
-		return "SystemScope [id=" + id + ", value=" + value + ", description="
-				+ description + ", icon=" + icon + ", defaultScope="
-				+ defaultScope + ", restricted=" + restricted + "]";
+	public SystemScope(String value) {
+		this.value = value;
 	}
 
 }

perun-oidc-server/src/main/java/cz/muni/ics/oauth2/model/SystemScope.java

@@ -0,0 +1,27 @@
+package cz.muni.ics.oauth2.model.enums;
+
+import java.util.HashMap;
+import java.util.Map;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+
+@Getter
+@AllArgsConstructor
+public enum AppType {
+    WEB("web"), NATIVE("native");
+
+    private final String value;
+
+    // map to aid reverse lookup
+    private static final Map<String, AppType> lookup = new HashMap<>();
+    static {
+        for (AppType a : AppType.values()) {
+            lookup.put(a.getValue(), a);
+        }
+    }
+
+    public static AppType getByValue(String value) {
+        return lookup.get(value);
+    }
+
+}

perun-oidc-server/src/main/java/cz/muni/ics/oauth2/model/enums/AppType.java

@@ -0,0 +1,31 @@
+package cz.muni.ics.oauth2.model.enums;
+
+import java.util.HashMap;
+import java.util.Map;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+
+@Getter
+@AllArgsConstructor
+public enum AuthMethod {
+    SECRET_POST("client_secret_post"),
+    SECRET_BASIC("client_secret_basic"),
+    SECRET_JWT("client_secret_jwt"),
+    PRIVATE_KEY("private_key_jwt"),
+    NONE("none");
+
+    private final String value;
+
+    // map to aid reverse lookup
+    private static final Map<String, AuthMethod> lookup = new HashMap<>();
+    static {
+        for (AuthMethod a : AuthMethod.values()) {
+            lookup.put(a.getValue(), a);
+        }
+    }
+
+    public static AuthMethod getByValue(String value) {
+        return lookup.get(value);
+    }
+
+}

perun-oidc-server/src/main/java/cz/muni/ics/oauth2/model/enums/AuthMethod.java

@@ -0,0 +1,27 @@
+package cz.muni.ics.oauth2.model.enums;
+
+import java.util.HashMap;
+import java.util.Map;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+
+@Getter
+@AllArgsConstructor
+public enum SubjectType {
+
+    PAIRWISE("pairwise"), PUBLIC("public");
+
+    private final String value;
+
+    // map to aid reverse lookup
+    private static final Map<String, SubjectType> lookup = new HashMap<>();
+    static {
+        for (SubjectType u : SubjectType.values()) {
+            lookup.put(u.getValue(), u);
+        }
+    }
+
+    public static SubjectType getByValue(String value) {
+        return lookup.get(value);
+    }
+}