JDK-8049845 : JavaDoc for KerberosKey.getPrincipal does not match the implementation
  • Type: Bug
  • Component: security-libs
  • Sub-Component: org.ietf.jgss:krb5
  • Affected Version: 8u5
  • Priority: P4
  • Status: Closed
  • Resolution: Duplicate
  • Submitted: 2014-06-27
  • Updated: 2014-07-10
  • Resolved: 2014-07-10
Related Reports
Duplicate :  
Description
FULL PRODUCT VERSION :
java version "1.8.0_05"
Java(TM) SE Runtime Environment (build 1.8.0_05-b13)
Java HotSpot(TM) 64-Bit Server VM (build 25.5-b02, mixed mode)

ADDITIONAL OS VERSION INFORMATION :
Microsoft Windows [Version 6.1.7601]

A DESCRIPTION OF THE PROBLEM :
In the JavaDoc

KerberosKey.getPrincipal does not throw any exception

in the implementation, it does throw

throw new IllegalStateException("This key is no longer valid");

The same issue exists for some of the other getters as well



STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
look at the code

EXPECTED VERSUS ACTUAL BEHAVIOR :
EXPECTED -
expect the javadoc to match the implementation
ACTUAL -
the javadoc does not match the implementation

REPRODUCIBILITY :
This bug can be reproduced always.


Comments
Will be fixed as part of JDK-8043071.
10-07-2014

Looks like something we could clarify in the javadocs. http://docs.oracle.com/javase/7/docs/api/javax/security/auth/kerberos/KerberosKey.html#getPrincipal() (and the neighbouring methods)
10-07-2014