Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved javadocs #173

Merged
merged 1 commit into from
Feb 26, 2025
+3 −3
Merged

Improved javadocs #173

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Loading status checks…
Improved javadocs
@scottslewis
scottslewis committed Feb 26, 2025
commit 374a9827746149a21ef1da4dd5d967f9bf5622f8
6 changes: 3 additions & 3 deletions framework/bundles/org.eclipse.ecf/src/org/eclipse/ecf/core/security/SSLContextFactory.java
View file
Original file line number Diff line number Diff line change
@@ -25,19 +25,19 @@
public interface SSLContextFactory {

/**
* 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>
* See <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/javax/net/ssl/SSLContext.html#getDefault()">SSLContext.getDefault()</a><br>
* NOTE: Rather than the using the {@link #SSLContext.setDefault SSLContext.setDefault(SSLContext)}
* 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.
*/
SSLContext getDefault() throws NoSuchAlgorithmException, NoSuchProviderException;

/**
* 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>
* See <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>
*/
SSLContext getInstance(String protocol) throws NoSuchAlgorithmException, NoSuchProviderException;

/**
* 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>
* See <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>
*/
SSLContext getInstance(String protocol, String providerName) throws NoSuchAlgorithmException, NoSuchProviderException;