Skip to content

Commit 8ad9018

Browse files
author
Poonam Bajaj
committedAug 22, 2022
8285400: Add '@APinote' to the APIs defined in Java SE 8 MR 3
Reviewed-by: mchung, iris, andrew Backport-of: 3740d05c063e1f80a0808a969a2cc136cafa48cb
1 parent 3a5b2cd commit 8ad9018

12 files changed

+40
-16
lines changed
 

‎jdk/src/share/classes/java/security/Signature.java

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 1996, 2020, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 1996, 2022, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -591,8 +591,6 @@ public final void initVerify(Certificate certificate)
591591
* is not encoded properly or does not include required parameter
592592
* information or cannot be used for digital signature purposes.
593593
* @exception InvalidAlgorithmParameterException if the params is invalid.
594-
*
595-
* @since 8
596594
*/
597595
final void initVerify(Certificate certificate,
598596
AlgorithmParameterSpec params)

‎jdk/src/share/classes/java/security/interfaces/RSAKey.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 1999, 2020, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 1999, 2022, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -56,6 +56,7 @@ public interface RSAKey {
5656
* explicitly specified or implicitly created during
5757
* key pair generation.
5858
*
59+
* @apiNote This method is defined in Java SE 8 Maintenance Release 3.
5960
* @implSpec
6061
* The default implementation returns {@code null}.
6162
*

‎jdk/src/share/classes/java/security/spec/MGF1ParameterSpec.java

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2003, 2020, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2003, 2022, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -98,12 +98,18 @@ public class MGF1ParameterSpec implements AlgorithmParameterSpec {
9898

9999
/**
100100
* The MGF1ParameterSpec which uses SHA-512/224 message digest
101+
*
102+
* @apiNote This field is defined in Java SE 8 Maintenance Release 3.
103+
* @since 8
101104
*/
102105
public static final MGF1ParameterSpec SHA512_224 =
103106
new MGF1ParameterSpec("SHA-512/224");
104107

105108
/**
106109
* The MGF1ParameterSpec which uses SHA-512/256 message digest
110+
*
111+
* @apiNote This field is defined in Java SE 8 Maintenance Release 3.
112+
* @since 8
107113
*/
108114
public static final MGF1ParameterSpec SHA512_256 =
109115
new MGF1ParameterSpec("SHA-512/256");

‎jdk/src/share/classes/java/security/spec/PSSParameterSpec.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2001, 2020, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2001, 2022, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -96,6 +96,7 @@ public class PSSParameterSpec implements AlgorithmParameterSpec {
9696
/**
9797
* The {@code TrailerFieldBC} constant as defined in PKCS#1
9898
*
99+
* @apiNote This field is defined in Java SE 8 Maintenance Release 3.
99100
* @since 8
100101
*/
101102
public static final int TRAILER_FIELD_BC = 1;

‎jdk/src/share/classes/java/security/spec/RSAKeyGenParameterSpec.java

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 1999, 2020, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 1999, 2022, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -70,6 +70,7 @@ public RSAKeyGenParameterSpec(int keysize, BigInteger publicExponent) {
7070
* Constructs a new {@code RSAKeyGenParameterSpec} object from the
7171
* given keysize, public-exponent value, and key parameters.
7272
*
73+
* @apiNote This method is defined in Java SE 8 Maintenance Release 3.
7374
* @param keysize the modulus size (specified in number of bits)
7475
* @param publicExponent the public exponent
7576
* @param keyParams the key parameters, may be null
@@ -103,6 +104,7 @@ public BigInteger getPublicExponent() {
103104
/**
104105
* Returns the parameters to be associated with key.
105106
*
107+
* @apiNote This method is defined in Java SE 8 Maintenance Release 3.
106108
* @return the associated parameters, may be null if
107109
* not present
108110
* @since 8

‎jdk/src/share/classes/java/security/spec/RSAMultiPrimePrivateCrtKeySpec.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2001, 2020, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2001, 2022, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -104,6 +104,7 @@ public RSAMultiPrimePrivateCrtKeySpec(BigInteger modulus,
104104
* are copied to protect against subsequent modification when
105105
* constructing this object.
106106
*
107+
* @apiNote This method is defined in Java SE 8 Maintenance Release 3.
107108
* @param modulus the modulus n
108109
* @param publicExponent the public exponent e
109110
* @param privateExponent the private exponent d

‎jdk/src/share/classes/java/security/spec/RSAPrivateCrtKeySpec.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 1998, 2020, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 1998, 2022, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -81,6 +81,7 @@ public RSAPrivateCrtKeySpec(BigInteger modulus,
8181
* Creates a new {@code RSAPrivateCrtKeySpec} with additional
8282
* key parameters.
8383
*
84+
* @apiNote This method is defined in Java SE 8 Maintenance Release 3.
8485
* @param modulus the modulus n
8586
* @param publicExponent the public exponent e
8687
* @param privateExponent the private exponent d

‎jdk/src/share/classes/java/security/spec/RSAPrivateKeySpec.java

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 1998, 2020, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 1998, 2022, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -60,6 +60,7 @@ public RSAPrivateKeySpec(BigInteger modulus, BigInteger privateExponent) {
6060
/**
6161
* Creates a new RSAPrivateKeySpec with additional key parameters.
6262
*
63+
* @apiNote This method is defined in Java SE 8 Maintenance Release 3.
6364
* @param modulus the modulus
6465
* @param privateExponent the private exponent
6566
* @param params the parameters associated with this key, may be null
@@ -94,6 +95,7 @@ public BigInteger getPrivateExponent() {
9495
* Returns the parameters associated with this key, may be null if not
9596
* present.
9697
*
98+
* @apiNote This method is defined in Java SE 8 Maintenance Release 3.
9799
* @return the parameters associated with this key
98100
* @since 8
99101
*/

‎jdk/src/share/classes/java/security/spec/RSAPublicKeySpec.java

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 1998, 2020, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 1998, 2022, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -60,6 +60,7 @@ public RSAPublicKeySpec(BigInteger modulus, BigInteger publicExponent) {
6060
/**
6161
* Creates a new RSAPublicKeySpec with additional key parameters.
6262
*
63+
* @apiNote This method is defined in Java SE 8 Maintenance Release 3.
6364
* @param modulus the modulus
6465
* @param publicExponent the public exponent
6566
* @param params the parameters associated with this key, may be null
@@ -95,6 +96,7 @@ public BigInteger getPublicExponent() {
9596
* Returns the parameters associated with this key, may be null if not
9697
* present.
9798
*
99+
* @apiNote This method is defined in Java SE 8 Maintenance Release 3.
98100
* @return the parameters associated with this key
99101
* @since 8
100102
*/

‎jdk/src/share/classes/javax/net/ssl/SSLEngine.java

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2003, 2020, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2003, 2022, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -1265,6 +1265,7 @@ public void setSSLParameters(SSLParameters params) {
12651265
* Application-Layer Protocol Negotiation (ALPN), can negotiate
12661266
* application-level values between peers.
12671267
*
1268+
* @apiNote This method is defined in Java SE 8 Maintenance Release 3.
12681269
* @implSpec
12691270
* The implementation in this class throws
12701271
* {@code UnsupportedOperationException} and performs no other action.
@@ -1290,6 +1291,7 @@ public String getApplicationProtocol() {
12901291
* a connection may be in the middle of a handshake. The
12911292
* application protocol may or may not yet be available.
12921293
*
1294+
* @apiNote This method is defined in Java SE 8 Maintenance Release 3.
12931295
* @implSpec
12941296
* The implementation in this class throws
12951297
* {@code UnsupportedOperationException} and performs no other action.
@@ -1350,7 +1352,8 @@ public String getHandshakeApplicationProtocol() {
13501352
* });
13511353
* }</pre>
13521354
*
1353-
* @apiNote
1355+
* @apiNote This method is defined in Java SE 8 Maintenance Release 3.
1356+
* <p>
13541357
* This method should be called by TLS server applications before the TLS
13551358
* handshake begins. Also, this {@code SSLEngine} should be configured with
13561359
* parameters that are compatible with the application protocol selected by
@@ -1380,6 +1383,7 @@ public void setHandshakeApplicationProtocolSelector(
13801383
* setHandshakeApplicationProtocolSelector}
13811384
* for the function's type parameters.
13821385
*
1386+
* @apiNote This method is defined in Java SE 8 Maintenance Release 3.
13831387
* @implSpec
13841388
* The implementation in this class throws
13851389
* {@code UnsupportedOperationException} and performs no other action.

‎jdk/src/share/classes/javax/net/ssl/SSLParameters.java

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2005, 2020, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2005, 2022, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -486,6 +486,7 @@ public final boolean getUseCipherSuitesOrder() {
486486
* <p>
487487
* This method will return a new array each time it is invoked.
488488
*
489+
* @apiNote This method is defined in Java SE 8 Maintenance Release 3.
489490
* @return a non-null, possibly zero-length array of application protocol
490491
* {@code String}s. The array is ordered based on protocol
491492
* preference, with {@code protocols[0]} being the most preferred.
@@ -518,6 +519,7 @@ public String[] getApplicationProtocols() {
518519
* action to take. (For example, ALPN will send a
519520
* {@code "no_application_protocol"} alert and terminate the connection.)
520521
*
522+
* @apiNote This method is defined in Java SE 8 Maintenance Release 3.
521523
* @implSpec
522524
* This method will make a copy of the {@code protocols} array.
523525
*

‎jdk/src/share/classes/javax/net/ssl/SSLSocket.java

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 1997, 2020, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 1997, 2022, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -674,6 +674,7 @@ public void setSSLParameters(SSLParameters params) {
674674
* Application-Layer Protocol Negotiation (ALPN), can negotiate
675675
* application-level values between peers.
676676
*
677+
* @apiNote This method is defined in Java SE 8 Maintenance Release 3.
677678
* @implSpec
678679
* The implementation in this class throws
679680
* {@code UnsupportedOperationException} and performs no other action.
@@ -699,6 +700,7 @@ public String getApplicationProtocol() {
699700
* a connection may be in the middle of a handshake. The
700701
* application protocol may or may not yet be available.
701702
*
703+
* @apiNote This method is defined in Java SE 8 Maintenance Release 3.
702704
* @implSpec
703705
* The implementation in this class throws
704706
* {@code UnsupportedOperationException} and performs no other action.
@@ -760,7 +762,8 @@ public String getHandshakeApplicationProtocol() {
760762
* });
761763
* }</pre>
762764
*
763-
* @apiNote
765+
* @apiNote This method is defined in Java SE 8 Maintenance Release 3.
766+
* <p>
764767
* This method should be called by TLS server applications before the TLS
765768
* handshake begins. Also, this {@code SSLSocket} should be configured with
766769
* parameters that are compatible with the application protocol selected by
@@ -789,6 +792,7 @@ public void setHandshakeApplicationProtocolSelector(
789792
* setHandshakeApplicationProtocolSelector}
790793
* for the function's type parameters.
791794
*
795+
* @apiNote This method is defined in Java SE 8 Maintenance Release 3.
792796
* @implSpec
793797
* The implementation in this class throws
794798
* {@code UnsupportedOperationException} and performs no other action.

1 commit comments

Comments
 (1)

openjdk-notifier[bot] commented on Aug 22, 2022

@openjdk-notifier[bot]
Please sign in to comment.