Skip to content

Commit 5458bf5

Browse files
committed
Added javadocs
1 parent 8915e3b commit 5458bf5

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/security/SSLContextFactory.java

+15
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,29 @@
1616
import javax.net.ssl.SSLContext;
1717

1818
/**
19+
* This class exposes three legacy static methods from the {@link SSLContext} class as
20+
* methods on an implementing instance. Implementing instances should be registered
21+
* as OSGi services.
22+
*
1923
* @since 3.12
2024
*/
2125
public interface SSLContextFactory {
2226

27+
/**
28+
* See javadocs for {@link <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/javax/net/ssl/SSLContext.html#getDefault()">SSLContext.getDefault()</a>}<br>
29+
* NOTE: Rather than the using the {@link #SSLContext.setDefault SSLContext.setDefault(SSLContext)}
30+
* to set the default SSLContext as described in the SSLContext.getDefault() javadocs, the default for the implementer is set upon construction of the service instance.
31+
*/
2332
SSLContext getDefault() throws NoSuchAlgorithmException, NoSuchProviderException;
2433

34+
/**
35+
* See javadocs for {@link <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/javax/net/ssl/SSLContext.html#getInstance(java.lang.String)">SSLContext.getInstance(String protocol)</a>}<br>
36+
*/
2537
SSLContext getInstance(String protocol) throws NoSuchAlgorithmException, NoSuchProviderException;
2638

39+
/**
40+
* See javadocs for {@link <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/javax/net/ssl/SSLContext.html#getInstance(java.lang.String,java.security.Provider)">SSLContext.getInstance(String protocol, String provider)</a>}<br>
41+
*/
2742
SSLContext getInstance(String protocol, String providerName) throws NoSuchAlgorithmException, NoSuchProviderException;
2843

2944
}

0 commit comments

Comments
 (0)