Skip to content

Commit 917e4e0

Browse files
djoleFrejaEiddjoleFrejaEid
authored
Merge pull request #183 from Freja-eID/init-add-org-id-custom-text
Added support for setting text when initiating org id transaction.
2 parents 4343d90 + a77631e commit 917e4e0

4 files changed

Lines changed: 45 additions & 19 deletions

File tree

‎FrejaEidClient/pom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<modelVersion>4.0.0</modelVersion>
44
<groupId>com.verisec.frejaeid</groupId>
55
<artifactId>FrejaEidClient</artifactId>
6-
<version>2.33.0-SNAPSHOT</version>
6+
<version>2.34.0-SNAPSHOT</version>
77
<packaging>jar</packaging>
88

99
<name>FrejaEidClient</name>

‎FrejaEidClient/src/main/java/com/verisec/frejaeid/client/beans/organisationid/init/InitiateAddOrganisationIdRequest.java‎

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ public class InitiateAddOrganisationIdRequest implements RelyingPartyRequest {
2121
private final OrganisationId organisationId;
2222
private final MinRegistrationLevel minRegistrationLevel;
2323
private final Long expiry;
24+
private final String text;
2425
private final String relyingPartyId;
2526

2627
/**
@@ -35,7 +36,7 @@ public class InitiateAddOrganisationIdRequest implements RelyingPartyRequest {
3536
*/
3637
public static InitiateAddOrganisationIdRequest createDefaultWithEmail(String email, OrganisationId organisationId) {
3738
return new InitiateAddOrganisationIdRequest(UserInfoType.EMAIL, email, organisationId,
38-
MinRegistrationLevel.EXTENDED, null, null);
39+
MinRegistrationLevel.EXTENDED, null, null);
3940
}
4041

4142
/**
@@ -55,7 +56,7 @@ public static InitiateAddOrganisationIdRequest createDefaultWithSsn(SsnUserInfo
5556
OrganisationId organisationId)
5657
throws FrejaEidClientInternalException {
5758
return new InitiateAddOrganisationIdRequest(UserInfoType.SSN, UserInfoUtil.convertSsnUserInfo(ssnUserInfo),
58-
organisationId, MinRegistrationLevel.EXTENDED, null, null);
59+
organisationId, MinRegistrationLevel.EXTENDED, null, null);
5960
}
6061

6162
/**
@@ -75,18 +76,20 @@ private InitiateAddOrganisationIdRequest(
7576
@JsonProperty(value = "userInfo") String userInfo,
7677
@JsonProperty(value = "organisationId") OrganisationId organisationId,
7778
@JsonProperty(value = "minRegistrationLevel") MinRegistrationLevel minRegistrationLevel,
78-
@JsonProperty(value = "expiry") Long expiry) {
79-
this(userInfoType, userInfo, organisationId, minRegistrationLevel, expiry, null);
79+
@JsonProperty(value = "expiry") Long expiry,
80+
@JsonProperty(value = "text") String text) {
81+
this(userInfoType, userInfo, organisationId, minRegistrationLevel, expiry, text, null);
8082
}
8183

8284
InitiateAddOrganisationIdRequest(UserInfoType userInfoType, String userInfo,
8385
OrganisationId organisationId, MinRegistrationLevel minRegistrationLevel,
84-
Long expiry, String relyingPartyId) {
86+
Long expiry, String text, String relyingPartyId) {
8587
this.userInfoType = userInfoType;
8688
this.userInfo = userInfo;
8789
this.organisationId = organisationId;
8890
this.minRegistrationLevel = minRegistrationLevel;
8991
this.expiry = expiry;
92+
this.text = text;
9093
this.relyingPartyId = relyingPartyId;
9194
}
9295

@@ -110,14 +113,19 @@ public Long getExpiry() {
110113
return expiry;
111114
}
112115

116+
public String getText() {
117+
return text;
118+
}
119+
113120
@JsonIgnore
114121
public String getRelyingPartyId() {
115122
return relyingPartyId;
116123
}
117124

118125
@Override
119126
public int hashCode() {
120-
return Objects.hash(userInfoType, userInfo, organisationId, minRegistrationLevel, expiry, relyingPartyId);
127+
return Objects.hash(userInfoType, userInfo, organisationId, minRegistrationLevel,
128+
expiry, text, relyingPartyId);
121129
}
122130

123131
@Override
@@ -130,6 +138,7 @@ public boolean equals(Object o) {
130138
Objects.equals(organisationId, that.organisationId) &&
131139
minRegistrationLevel == that.minRegistrationLevel &&
132140
Objects.equals(expiry, that.expiry) &&
141+
Objects.equals(text, that.text) &&
133142
Objects.equals(relyingPartyId, that.relyingPartyId);
134143
}
135144

@@ -141,6 +150,7 @@ public String toString() {
141150
", organisationId=" + organisationId +
142151
", minRegistrationLevel=" + minRegistrationLevel +
143152
", expiry=" + expiry +
153+
", text=" + text +
144154
", relyingPartyId='" + relyingPartyId + '\'' +
145155
'}';
146156
}

‎FrejaEidClient/src/main/java/com/verisec/frejaeid/client/beans/organisationid/init/InitiateAddOrganisationIdRequestBuilders.java‎

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public SetOptionalParamsBuilder setEmailAndOrganisationId(String email, Organisa
4141
public SetOptionalParamsBuilder setSsnAndOrganisationId(SsnUserInfo ssnUserInfo, OrganisationId organisationId)
4242
throws FrejaEidClientInternalException {
4343
return new SetOptionalParamsBuilder(UserInfoType.SSN, UserInfoUtil.convertSsnUserInfo(ssnUserInfo),
44-
organisationId);
44+
organisationId);
4545
}
4646

4747
/**
@@ -75,7 +75,7 @@ public SetOptionalParamsBuilder setInferredAndOrganisationId(OrganisationId orga
7575
* Sets unique personal identifier as userInfo and {@link UserInfoType#UPI} as
7676
* {@linkplain UserInfoType} for initiating transaction.
7777
*
78-
* @param upi user's unique personal identifier that will be used to identify
78+
* @param upi user's unique personal identifier that will be used to identify
7979
* the end user in format 1234-123456-1234.
8080
* @param organisationId instance of {@linkplain OrganisationId} that
8181
* contains information regarding organisation id.
@@ -94,6 +94,7 @@ public static class SetOptionalParamsBuilder {
9494
private final OrganisationId organisationId;
9595
private MinRegistrationLevel minRegistrationLevel = MinRegistrationLevel.EXTENDED;
9696
private Long expiry = null;
97+
private String text = null;
9798
private String relyingPartyId = null;
9899

99100
private SetOptionalParamsBuilder(UserInfoType userInfoType, String userInfo, OrganisationId organisationId) {
@@ -134,6 +135,17 @@ public SetOptionalParamsBuilder setExpiry(Long timeToExpiry) {
134135
return this;
135136
}
136137

138+
/**
139+
* Text which will be displayed to the user when adding organisation id
140+
*
141+
* @param text optional parameter.
142+
* @return request builder
143+
*/
144+
public SetOptionalParamsBuilder setText(String text) {
145+
this.text = text;
146+
return this;
147+
}
148+
137149
/**
138150
* <b>Only relying parties that are integrators should use this
139151
* method.</b>
@@ -148,8 +160,9 @@ public SetOptionalParamsBuilder setRelyingPartyId(String relyingPartyId) {
148160
}
149161

150162
public InitiateAddOrganisationIdRequest build() {
151-
return new InitiateAddOrganisationIdRequest(userInfoType, userInfo, organisationId, minRegistrationLevel,
152-
expiry, relyingPartyId);
163+
return new InitiateAddOrganisationIdRequest(
164+
userInfoType, userInfo, organisationId, minRegistrationLevel,
165+
expiry, text, relyingPartyId);
153166
}
154167

155168
}

‎FrejaEidClient/src/test/java/com/verisec/frejaeid/client/beans/organisationid/init/InitiateAddOrganisationIdRequestBuildersTest.java‎

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ public class InitiateAddOrganisationIdRequestBuildersTest {
1717
private static final String PHONE_NUMBER = "123123123";
1818
private static final MinRegistrationLevel REGISTRATION_STATE = MinRegistrationLevel.PLUS;
1919
private static final Long EXPIRY = Long.MIN_VALUE;
20+
private static final String TEXT = "Custom text";
2021
private static final String ORGANISATION_ID_TITLE = "OrgananisationId title";
2122
private static final String IDENTIFIER_NAME = "Identifier name";
2223
private static final String IDENTIFIER = "identifier";
@@ -29,7 +30,7 @@ public class InitiateAddOrganisationIdRequestBuildersTest {
2930
public void createDefaultEmailRequest() {
3031
InitiateAddOrganisationIdRequest expectedInitiateAddOrganisationIdRequest =
3132
new InitiateAddOrganisationIdRequest(UserInfoType.EMAIL, EMAIL, ORGANISATION_ID,
32-
MinRegistrationLevel.EXTENDED, null, null);
33+
MinRegistrationLevel.EXTENDED, null, null, null);
3334
InitiateAddOrganisationIdRequest initiateAddOrganisationIdRequest =
3435
InitiateAddOrganisationIdRequest.createDefaultWithEmail(EMAIL, ORGANISATION_ID);
3536
Assert.assertEquals(expectedInitiateAddOrganisationIdRequest, initiateAddOrganisationIdRequest);
@@ -39,7 +40,7 @@ public void createDefaultEmailRequest() {
3940
public void createDefaultSsnRequest() throws FrejaEidClientInternalException {
4041
InitiateAddOrganisationIdRequest expectedInitiateAddOrganisationIdRequest =
4142
new InitiateAddOrganisationIdRequest(UserInfoType.SSN, UserInfoUtil.convertSsnUserInfo(SSN_USER_INFO),
42-
ORGANISATION_ID, MinRegistrationLevel.EXTENDED, null, null);
43+
ORGANISATION_ID, MinRegistrationLevel.EXTENDED, null, null, null);
4344
InitiateAddOrganisationIdRequest initiateAddOrganisationIdRequest =
4445
InitiateAddOrganisationIdRequest.createDefaultWithSsn(SSN_USER_INFO, ORGANISATION_ID);
4546
Assert.assertEquals(expectedInitiateAddOrganisationIdRequest, initiateAddOrganisationIdRequest);
@@ -49,13 +50,14 @@ public void createDefaultSsnRequest() throws FrejaEidClientInternalException {
4950
public void createCustomRequest_userInfoTypeEmail() {
5051
InitiateAddOrganisationIdRequest expectedInitiateAddOrganisationIdRequest =
5152
new InitiateAddOrganisationIdRequest(UserInfoType.EMAIL, EMAIL, ORGANISATION_ID,
52-
REGISTRATION_STATE, EXPIRY, RELYING_PARTY_ID);
53+
REGISTRATION_STATE, EXPIRY, TEXT, RELYING_PARTY_ID);
5354
InitiateAddOrganisationIdRequest initiateAddOrganisationIdRequest =
5455
InitiateAddOrganisationIdRequest.createCustom()
5556
.setEmailAndOrganisationId(EMAIL, ORGANISATION_ID)
5657
.setMinRegistrationLevel(REGISTRATION_STATE)
5758
.setExpiry(EXPIRY)
5859
.setRelyingPartyId(RELYING_PARTY_ID)
60+
.setText(TEXT)
5961
.build();
6062
Assert.assertEquals(expectedInitiateAddOrganisationIdRequest, initiateAddOrganisationIdRequest);
6163
}
@@ -64,7 +66,7 @@ public void createCustomRequest_userInfoTypeEmail() {
6466
public void createCustomRequest_userInfoTypeEmail_defaultRegistrationState() {
6567
InitiateAddOrganisationIdRequest expectedInitiateAddOrganisationIdRequest =
6668
new InitiateAddOrganisationIdRequest(UserInfoType.EMAIL, EMAIL, ORGANISATION_ID,
67-
MinRegistrationLevel.EXTENDED, null, RELYING_PARTY_ID);
69+
MinRegistrationLevel.EXTENDED, null, null, RELYING_PARTY_ID);
6870
InitiateAddOrganisationIdRequest initiateAddOrganisationIdRequest =
6971
InitiateAddOrganisationIdRequest.createCustom()
7072
.setEmailAndOrganisationId(EMAIL, ORGANISATION_ID)
@@ -77,7 +79,7 @@ public void createCustomRequest_userInfoTypeEmail_defaultRegistrationState() {
7779
public void createCustomRequest_userInfoTypeSsn() throws FrejaEidClientInternalException {
7880
InitiateAddOrganisationIdRequest expectedInitiateAddOrganisationIdRequest =
7981
new InitiateAddOrganisationIdRequest(UserInfoType.SSN, UserInfoUtil.convertSsnUserInfo(SSN_USER_INFO),
80-
ORGANISATION_ID, MinRegistrationLevel.EXTENDED, null,
82+
ORGANISATION_ID, MinRegistrationLevel.EXTENDED, null, null,
8183
RELYING_PARTY_ID);
8284
InitiateAddOrganisationIdRequest initiateAddOrganisationIdRequest =
8385
InitiateAddOrganisationIdRequest.createCustom()
@@ -91,7 +93,7 @@ public void createCustomRequest_userInfoTypeSsn() throws FrejaEidClientInternalE
9193
public void createCustomRequest_userInfoTypePhoneNumber() {
9294
InitiateAddOrganisationIdRequest expectedInitiateAddOrganisationIdRequest =
9395
new InitiateAddOrganisationIdRequest(UserInfoType.PHONE, PHONE_NUMBER, ORGANISATION_ID,
94-
MinRegistrationLevel.EXTENDED, EXPIRY, null);
96+
MinRegistrationLevel.EXTENDED, EXPIRY, null, null);
9597
InitiateAddOrganisationIdRequest initiateAddOrganisationIdRequest =
9698
InitiateAddOrganisationIdRequest.createCustom()
9799
.setPhoneNumberAndOrganisationId(PHONE_NUMBER, ORGANISATION_ID)
@@ -104,11 +106,12 @@ public void createCustomRequest_userInfoTypePhoneNumber() {
104106
public void createCustomRequest_userInfoTypeInferred() {
105107
InitiateAddOrganisationIdRequest expectedInitiateAuthenticationRequest =
106108
new InitiateAddOrganisationIdRequest(UserInfoType.INFERRED, INFERRED_USER_INFO, ORGANISATION_ID,
107-
MinRegistrationLevel.EXTENDED, EXPIRY, null);
109+
MinRegistrationLevel.EXTENDED, EXPIRY, TEXT, null);
108110
InitiateAddOrganisationIdRequest initiateAuthenticationRequest =
109111
InitiateAddOrganisationIdRequest.createCustom()
110112
.setInferredAndOrganisationId(ORGANISATION_ID)
111113
.setExpiry(EXPIRY)
114+
.setText(TEXT)
112115
.build();
113116
Assert.assertEquals(expectedInitiateAuthenticationRequest, initiateAuthenticationRequest);
114117
}
@@ -117,7 +120,7 @@ public void createCustomRequest_userInfoTypeInferred() {
117120
public void createCustomRequest_minRegistrationLevelAndRelyingPartyIdNull() {
118121
InitiateAddOrganisationIdRequest expectedInitiateAddOrganisationIdRequest =
119122
new InitiateAddOrganisationIdRequest(UserInfoType.PHONE, PHONE_NUMBER, ORGANISATION_ID,
120-
MinRegistrationLevel.EXTENDED, EXPIRY, null);
123+
MinRegistrationLevel.EXTENDED, EXPIRY, null, null);
121124
InitiateAddOrganisationIdRequest initiateAddOrganisationIdRequest =
122125
InitiateAddOrganisationIdRequest.createCustom()
123126
.setPhoneNumberAndOrganisationId(PHONE_NUMBER, ORGANISATION_ID)

0 commit comments

Comments
 (0)