(Data Transfer Object) classes for your Identity Access module - Wiz-DevTech/prettygirllz GitHub Wiki

I'll create the requested DTO (Data Transfer Object) classes for your Identity Access module and explain each one to help you understand their purpose and structure.

package com.wizdevtech.identityaccess.dto;

import jakarta.validation.constraints.Email;
import jakarta.validation.constraints.NotBlank;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@NoArgsConstructor
@AllArgsConstructor
public class AuthenticationRequest {
    
    @NotBlank(message = "Email is required")
    @Email(message = "Valid email address is required")
    private String email;
    
    @NotBlank(message = "Password is required")
    private String password;
}

Explanation:

• Purpose: This class represents the data needed to authenticate a user (login credentials).
• Fields:
  • email: The user's email address, used as their username
  • password: The user's password (plain text, will be verified against stored hash)
• Annotations:
  • @Data: Lombok annotation that automatically generates getters, setters, equals, hashCode, and toString methods
  • @NoArgsConstructor: Generates a constructor with no parameters
  • @AllArgsConstructor: Generates a constructor with all parameters
  • @NotBlank: Bean validation annotation that ensures the field is not null and not empty
  • @Email: Bean validation annotation that ensures the field contains a valid email format
• Validation: Both fields are required, and email must be in valid format

package com.wizdevtech.identityaccess.dto;

import jakarta.validation.constraints.NotBlank;
import jakarta.validation.constraints.NotEmpty;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.util.List;

@Data
@NoArgsConstructor
@AllArgsConstructor
public class AuthorizationRequest {
    
    @NotBlank(message = "Resource identifier is required")
    private String resourceId;
    
    @NotBlank(message = "Action is required")
    private String action;
    
    @NotEmpty(message = "Subject identifier is required")
    private String subjectId;
    
    private List<String> contextAttributes;
}

Explanation:

• Purpose: This class represents a request to check if a user (subject) is authorized to perform an action on a resource.
• Fields:
  • resourceId: Identifies the resource the user wants to access (e.g., "document-123", "api/users")
  • action: The action the user wants to perform (e.g., "read", "write", "delete")
  • subjectId: The user's identifier (typically user ID from the token)
  • contextAttributes: Optional additional contextual information that might affect authorization decisions
• Annotations:
  • @NotBlank: Ensures resourceId and action are not null and not empty
  • @NotEmpty: Ensures subjectId is not null and not empty
• Authorization Model: Follows the standard subject-action-resource authorization model

package com.wizdevtech.identityaccess.dto;

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class AuthorizationResponse {
    
    private boolean permitted;
    private String resourceId;
    private String action;
    private String reason;
    
    // Helper static methods for common responses
    public static AuthorizationResponse permitted(String resourceId, String action) {
        return AuthorizationResponse.builder()
                .permitted(true)
                .resourceId(resourceId)
                .action(action)
                .build();
    }
    
    public static AuthorizationResponse denied(String resourceId, String action, String reason) {
        return AuthorizationResponse.builder()
                .permitted(false)
                .resourceId(resourceId)
                .action(action)
                .reason(reason)
                .build();
    }
}

Explanation:

• Purpose: This class represents the result of an authorization check.
• Fields:
  • permitted: Boolean indicating whether the action is allowed (true) or denied (false)
  • resourceId: Echo of the resource from the request for context
  • action: Echo of the action from the request for context
  • reason: Optional explanation of why access was denied (empty if permitted)
• Annotations:
  • @Builder: Lombok annotation that creates a builder pattern for object creation
• Helper Methods:
  • permitted(): Static factory method to create a successful authorization response
  • denied(): Static factory method to create a failed authorization response with reason
• Design Pattern: Uses the builder pattern for creating instances with flexible parameters

package com.wizdevtech.identityaccess.dto;

import jakarta.validation.constraints.Email;
import jakarta.validation.constraints.NotBlank;
import jakarta.validation.constraints.Size;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.util.HashSet;
import java.util.Set;

@Data
@NoArgsConstructor
public class RegistrationRequest {
    
    @NotBlank(message = "Email is required")
    @Email(message = "Valid email address is required")
    private String email;
    
    @NotBlank(message = "Password is required")
    @Size(min = 8, message = "Password must be at least 8 characters")
    private String password;
    
    private Set<String> roles = new HashSet<>();
    
    private String sensitiveData;
}

Explanation:

• Purpose: This class represents the data needed to register a new user.
• Fields:
  • email: The user's email address, which will also serve as their username
  • password: The password in plain text (will be hashed before storage)
  • roles: Set of roles assigned to the user (e.g., "USER", "ADMIN")
  • sensitiveData: Optional sensitive data that should be encrypted in the database
• Annotations:
  • @Size: Bean validation annotation that ensures the field has a minimum length
• Default Value: The roles field is initialized with an empty HashSet to avoid null values
• Security Consideration: Password will be validated for minimum length but should be transformed (hashed) before storage

These DTO classes form the core of the communication layer in your Identity Access module:

1. Authentication: Handles login credentials
2. Authorization: Determines what actions users can perform
3. Registration: Manages new user creation

Each class follows the principles of encapsulation, validation, and separation of concerns. They use Lombok to reduce boilerplate code and Bean Validation annotations to ensure data integrity.

Would you like me to explain any particular aspect of these classes in more detail?