KEYCLOAK-17324 Fix javadoc for CredentialModel

* There are errors in the deprecation notes in the javadoc where the new methods are referred.
* Some places where getCredentialData() and getSecretData() have been referred to should actually refer to getPasswordCredentialData() and getPassowordSecretData() respectively for PasswordCredentialModel.
* Similarly, for OTPCredentialModel, getOTPCredentialData() anad getOTPSecretData() should be referred.
This commit is contained in:
Madhurjya Roy 2021-03-04 12:57:44 +05:30 committed by Hynek Mlnařík
parent 47f736f819
commit 740248fd54

View file

@ -132,7 +132,7 @@ public class CredentialModel implements Serializable {
// DEPRECATED - the methods below exists for the backwards compatibility // DEPRECATED - the methods below exists for the backwards compatibility
/** /**
* @deprecated Recommended to use PasswordCredentialModel.getSecretData().getValue() or OTPCredentialModel.getSecretData().getValue() * @deprecated Recommended to use PasswordCredentialModel.getPasswordSecretData().getValue() or OTPCredentialModel.getOTPSecretData().getValue()
*/ */
@Deprecated @Deprecated
@JsonIgnore @JsonIgnore
@ -149,7 +149,7 @@ public class CredentialModel implements Serializable {
} }
/** /**
* @deprecated Recommended to use OTPCredentialModel.getCredentialData().getDevice() * @deprecated Recommended to use OTPCredentialModel.getOTPCredentialData().getDevice()
*/ */
@Deprecated @Deprecated
@JsonIgnore @JsonIgnore
@ -166,7 +166,7 @@ public class CredentialModel implements Serializable {
} }
/** /**
* @deprecated Recommended to use PasswordCredentialModel.getSecretData().getSalt() * @deprecated Recommended to use PasswordCredentialModel.getPasswordSecretData().getSalt()
*/ */
@Deprecated @Deprecated
@JsonIgnore @JsonIgnore
@ -189,7 +189,7 @@ public class CredentialModel implements Serializable {
} }
/** /**
* @deprecated Recommended to use PasswordCredentialModel.getCredentialData().getHashIterations() * @deprecated Recommended to use PasswordCredentialModel.getPasswordCredentialData().getHashIterations()
*/ */
@Deprecated @Deprecated
@JsonIgnore @JsonIgnore
@ -206,7 +206,7 @@ public class CredentialModel implements Serializable {
} }
/** /**
* @deprecated Recommended to use OTPCredentialModel.getCredentialData().getCounter() * @deprecated Recommended to use OTPCredentialModel.getOTPCredentialData().getCounter()
*/ */
@Deprecated @Deprecated
@JsonIgnore @JsonIgnore
@ -223,7 +223,7 @@ public class CredentialModel implements Serializable {
} }
/** /**
* @deprecated Recommended to use PasswordCredentialModel.getCredentialData().getAlgorithm() or OTPCredentialModel.getCredentialData().getAlgorithm() * @deprecated Recommended to use PasswordCredentialModel.getPasswordCredentialData().getAlgorithm() or OTPCredentialModel.getOTPCredentialData().getAlgorithm()
*/ */
@Deprecated @Deprecated
@JsonIgnore @JsonIgnore
@ -240,7 +240,7 @@ public class CredentialModel implements Serializable {
} }
/** /**
* @deprecated Recommended to use OTPCredentialModel.getCredentialData().getDigits() * @deprecated Recommended to use OTPCredentialModel.getOTPCredentialData().getDigits()
*/ */
@Deprecated @Deprecated
@JsonIgnore @JsonIgnore
@ -257,7 +257,7 @@ public class CredentialModel implements Serializable {
} }
/** /**
* @deprecated Recommended to use OTPCredentialModel.getCredentialData().getPeriod() * @deprecated Recommended to use OTPCredentialModel.getOTPCredentialData().getPeriod()
*/ */
@Deprecated @Deprecated
@JsonIgnore @JsonIgnore