-
Notifications
You must be signed in to change notification settings - Fork 583
HV-1970 Add Korean specific RRN annotation #1338
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
bafee67
HV-1970 Adding KorRRN annotation
ing9990 e4d3227
HV-1970 Adding KorRRN validator tests
ing9990 123f252
HV-1970 Refactoring to the Hibernate Code Style
ing9990 a672e04
HV-1970 Remove type field
ing9990 98a5164
HV-1970 Encoding Javadoc url
ing9990 ec01653
HV-1970 Adding RRN validation criteria and modifying test code
ing9990 883f3ef
HV-1970 Encoding javadoc url
ing9990 103eac2
HV-1970 Adding test cases and refactoring the RRNValidator
ing9990 00ddc91
HV-1970 fix error
ing9990 a3f45bc
HV-1970 Add attribute to optionally validate check-digit, adding and …
ing9990 f60784f
HV-1970 Remove private signature for Java8 version
ing9990 d0962dc
HV-1970 Change 'if' statement to 'switch' statement for Readability,…
ing9990 5f1337b
HV-1970 Change 'switch' statement to 'if' statement for Java 11
ing9990 f8e4c09
HV-1970 Change attribute name from BEFORE_OCTOBER_2020_ONLY to ALWAYS
ing9990 c625080
HV-1970 Adding test case for default value of validateCheckDigit()
ing9990 9566047
HV-1970 Fix typos
ing9990 7962786
HV-1970 Refactor: Moving validation methods to RRNValidationAlgorithm…
ing9990 b8951fb
HV-1970 Fix typo
ing9990 c589eb0
HV-1970 Adding asciidoc for KorRRN Annotation
ing9990 974c616
HV-1970 Modifying test case to pass the test
ing9990 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
22 changes: 22 additions & 0 deletions
22
engine/src/main/java/org/hibernate/validator/cfg/defs/kor/KorRRNDef.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| /* | ||
| * Hibernate Validator, declare and validate application constraints | ||
| * | ||
| * License: Apache License, Version 2.0 | ||
| * See the license.txt file in the root directory or <http://www.apache.org/licenses/LICENSE-2.0>. | ||
| */ | ||
| package org.hibernate.validator.cfg.defs.kor; | ||
|
|
||
| import org.hibernate.validator.cfg.ConstraintDef; | ||
| import org.hibernate.validator.constraints.kor.KorRRN; | ||
|
|
||
| public class KorRRNDef extends ConstraintDef<KorRRNDef, KorRRN> { | ||
|
|
||
| public KorRRNDef() { | ||
| super( KorRRN.class ); | ||
| } | ||
|
|
||
| public KorRRNDef validateCheckDigit(KorRRN.ValidateCheckDigit validateCheckDigit) { | ||
| addParameter( "validateCheckDigit", validateCheckDigit ); | ||
| return this; | ||
| } | ||
| } |
12 changes: 12 additions & 0 deletions
12
engine/src/main/java/org/hibernate/validator/cfg/defs/kor/package-info.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| /* | ||
| * Hibernate Validator, declare and validate application constraints | ||
| * | ||
| * License: Apache License, Version 2.0 | ||
| * See the license.txt file in the root directory or <http://www.apache.org/licenses/LICENSE-2.0>. | ||
| */ | ||
|
|
||
| /** | ||
| * <p>Korean specific constraint definition classes for programmatic constraint definition API.</p> | ||
| * <p>This package is part of the public Hibernate Validator API.</p> | ||
| */ | ||
| package org.hibernate.validator.cfg.defs.kor; |
86 changes: 86 additions & 0 deletions
86
engine/src/main/java/org/hibernate/validator/constraints/kor/KorRRN.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| /* | ||
| * Hibernate Validator, declare and validate application constraints | ||
| * | ||
| * License: Apache License, Version 2.0 | ||
| * See the license.txt file in the root directory or <http://www.apache.org/licenses/LICENSE-2.0>. | ||
| */ | ||
| package org.hibernate.validator.constraints.kor; | ||
|
|
||
| import static java.lang.annotation.ElementType.ANNOTATION_TYPE; | ||
| import static java.lang.annotation.ElementType.CONSTRUCTOR; | ||
| import static java.lang.annotation.ElementType.FIELD; | ||
| import static java.lang.annotation.ElementType.METHOD; | ||
| import static java.lang.annotation.ElementType.PARAMETER; | ||
| import static java.lang.annotation.ElementType.TYPE_USE; | ||
| import static java.lang.annotation.RetentionPolicy.RUNTIME; | ||
| import static org.hibernate.validator.constraints.kor.KorRRN.ValidateCheckDigit.NEVER; | ||
|
|
||
| import jakarta.validation.Constraint; | ||
| import jakarta.validation.Payload; | ||
| import jakarta.validation.ReportAsSingleViolation; | ||
|
|
||
| import java.lang.annotation.Documented; | ||
| import java.lang.annotation.Repeatable; | ||
| import java.lang.annotation.Retention; | ||
| import java.lang.annotation.Target; | ||
|
|
||
| /** | ||
| * Checks that the annotated character sequence is a valid Korean resident registration number. | ||
| * | ||
| * @author Taewoo Kim | ||
| * @see <a href="https://ko.wikipedia.org/wiki/%EC%A3%BC%EB%AF%BC%EB%93%B1%EB%A1%9D%EB%B2%88%ED%98%B8">Korean resident registration number</a> | ||
| */ | ||
|
|
||
| @Documented | ||
| @Constraint(validatedBy = {}) | ||
| @Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE }) | ||
| @Retention(RUNTIME) | ||
| @Repeatable(KorRRN.List.class) | ||
| @ReportAsSingleViolation | ||
| public @interface KorRRN { | ||
|
|
||
| String message() default "{org.hibernate.validator.constraints.kor.KorRRN.message}"; | ||
|
|
||
| Class<?>[] groups() default {}; | ||
|
|
||
| Class<? extends Payload>[] payload() default {}; | ||
|
|
||
| ValidateCheckDigit validateCheckDigit() default NEVER; | ||
|
|
||
| /** | ||
| * Defines the validation rules this constraint applies to the Korean resident registration number. | ||
| * <p> | ||
| * Each type specifies which particular checks will be applied. | ||
| */ | ||
| enum ValidateCheckDigit { | ||
| /** | ||
| * Perform the checks on: | ||
| * <ul> | ||
| * <li>The length of an RRN</li> | ||
| * <li>The validity of the Gender-Digit in an RRN</li> | ||
| * <li>The validity of the date in an RRN</li> | ||
| * </ul> | ||
| */ | ||
| NEVER, | ||
| /** | ||
| * Perform the checks on: | ||
| * <ul> | ||
| * <li>The length of an RRN</li> | ||
| * <li>The validity of the Gender-Digit in an RRN</li> | ||
| * <li>The validity of the date in an RRN</li> | ||
| * <li>The Validity of check-digit in RRN</li> | ||
| * </ul> | ||
| */ | ||
| ALWAYS | ||
| } | ||
marko-bekhta marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| /** | ||
| * Defines several {@code @KorRRN} annotations on the same element. | ||
| */ | ||
| @Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE }) | ||
| @Retention(RUNTIME) | ||
| @Documented | ||
| @interface List { | ||
| KorRRN[] value(); | ||
| } | ||
| } | ||
134 changes: 134 additions & 0 deletions
134
...in/java/org/hibernate/validator/internal/constraintvalidators/hv/kor/KorRRNValidator.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
|
|
||
| /* | ||
| * Hibernate Validator, declare and validate application constraints | ||
| * | ||
| * License: Apache License, Version 2.0 | ||
| * See the license.txt file in the root directory or <http://www.apache.org/licenses/LICENSE-2.0>. | ||
| */ | ||
| package org.hibernate.validator.internal.constraintvalidators.hv.kor; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
|
|
||
| import jakarta.validation.ConstraintValidator; | ||
| import jakarta.validation.ConstraintValidatorContext; | ||
|
|
||
| import org.hibernate.validator.constraints.kor.KorRRN; | ||
| import org.hibernate.validator.internal.util.Contracts; | ||
| import org.hibernate.validator.internal.util.ModUtil; | ||
|
|
||
| /** | ||
| * Checks that a given character sequence is a valid RRN. | ||
| * | ||
| * @author Taewoo Kim | ||
| * @see <a href="https://www.law.go.kr/LSW/lsInfoP.do?lsId=008230&ancYnChk=0#0000">Korean Resident Registration Act Implementation Rules</a> | ||
| */ | ||
| public class KorRRNValidator implements ConstraintValidator<KorRRN, CharSequence> { | ||
marko-bekhta marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| private static final List<Integer> GENDER_DIGIT = List.of( 1, 2, 3, 4 ); | ||
| // Check sum weight for ModUtil | ||
| private static final int[] CHECK_SUM_WEIGHT = new int[] { 5, 4, 3, 2, 9, 8, 7, 6, 5, 4, 3, 2 }; | ||
| // index of the digit representing the gender | ||
| private static final int GENDER_DIGIT_INDEX = 6; | ||
|
|
||
| private RRNValidationAlgorithm rrnValidationAlgorithm; | ||
|
|
||
| @Override | ||
| public void initialize(KorRRN constraintAnnotation) { | ||
| this.rrnValidationAlgorithm = RRNValidationAlgorithm.from( constraintAnnotation.validateCheckDigit() ); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean isValid(CharSequence rrnValue, ConstraintValidatorContext context) { | ||
| if ( rrnValue == null ) { | ||
| return true; | ||
| } | ||
| return rrnValidationAlgorithm.isValid( rrnValue.toString().replace( "-", "" ) ); | ||
| } | ||
|
|
||
| private interface RRNValidationAlgorithm { | ||
marko-bekhta marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| int VALID_LENGTH = 13; | ||
| int THRESHOLD = 9; | ||
| int MODULDO = 11; | ||
|
|
||
| boolean isValid(String rrn); | ||
|
|
||
| // Returns an implementation of the algorithm based on the value of ValidateCheckDigit | ||
| static RRNValidationAlgorithm from(KorRRN.ValidateCheckDigit validateCheckDigit) { | ||
| Contracts.assertNotNull( validateCheckDigit ); | ||
| if ( validateCheckDigit == KorRRN.ValidateCheckDigit.ALWAYS ) { | ||
| return RRNValidationAlgorithmImpl.ALWAYS; | ||
| } | ||
| return RRNValidationAlgorithmImpl.NEVER; | ||
| } | ||
| } | ||
|
|
||
| private enum RRNValidationAlgorithmImpl implements RRNValidationAlgorithm { | ||
| NEVER { | ||
| @Override | ||
| public boolean isValid(String rrn) { | ||
| return isValidLength( rrn ) && isValidDate( rrn ) && isValidGenderDigit( rrn ); | ||
| } | ||
| }, | ||
| ALWAYS { | ||
| @Override | ||
| public boolean isValid(String rrn) { | ||
| return isValidLength( rrn ) && isValidDate( rrn ) && isValidGenderDigit( rrn ) && isValidChecksum( rrn ); | ||
| } | ||
| }; | ||
|
|
||
| // Check the check-digit of the RRN using ModUtil | ||
| boolean isValidChecksum(final String rrn) { | ||
| int checksum = ModUtil.calculateModXCheckWithWeights( | ||
| toChecksumDigits( rrn ), | ||
| MODULDO, | ||
| THRESHOLD, | ||
| CHECK_SUM_WEIGHT | ||
| ); | ||
| checksum = checksum >= 10 ? checksum - 10 : checksum; | ||
| return checksum == getChectDigit( rrn ); | ||
| } | ||
|
|
||
| boolean isValidDate(final String rrn) { | ||
| final int month = extractMonth( rrn ); | ||
| final int day = extractDay( rrn ); | ||
| if ( month > 12 || day < 0 || day > 31 ) { | ||
| return false; | ||
| } | ||
| return day <= 31 && ( day <= 30 || ( month != 4 && month != 6 && month != 9 && month != 11 ) ) && ( day <= 29 || month != 2 ); | ||
| } | ||
|
|
||
| boolean isValidLength(String rrn) { | ||
| return rrn.length() == VALID_LENGTH; | ||
| } | ||
|
|
||
| boolean isValidGenderDigit(String rrn) { | ||
| return GENDER_DIGIT.contains( extractGenderDigit( rrn ) ); | ||
| } | ||
|
|
||
| int extractGenderDigit(String rrn) { | ||
| return Character.getNumericValue( rrn.charAt( GENDER_DIGIT_INDEX ) ); | ||
| } | ||
|
|
||
| List<Integer> toChecksumDigits(String rrn) { | ||
| List<Integer> collect = new ArrayList<>(); | ||
| for ( int i = 0; i < rrn.length() - 1; i++ ) { | ||
| collect.add( Character.getNumericValue( rrn.charAt( i ) ) ); | ||
| } | ||
| return collect; | ||
| } | ||
|
|
||
| int getChectDigit(String rrn) { | ||
| return Character.getNumericValue( rrn.charAt( rrn.length() - 1 ) ); | ||
| } | ||
|
|
||
| int extractDay(String rrn) { | ||
| return Integer.parseInt( rrn.substring( 4, 6 ) ); | ||
| } | ||
|
|
||
| int extractMonth(String rrn) { | ||
| return Integer.parseInt( rrn.substring( 2, 4 ) ); | ||
| } | ||
| } | ||
| } | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.