Skip to content

Commit

Permalink
Use special exception when failing because the SSLEngine was closed (#…
Browse files Browse the repository at this point in the history
…10783)

Motivation:

Sometimes it would be helpful to easily detect if an operation failed due the SSLEngine already be closed.

Modifications:

Add special exception that is used when the engine was closed

Result:

Easier to detect a failure caused by a closed exception
  • Loading branch information
normanmaurer committed Nov 9, 2020
1 parent b27d837 commit 1c37c8f
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 1 deletion.
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
/*
* Copyright 2020 The Netty Project
*
* The Netty Project licenses this file to you under the Apache License,
* version 2.0 (the "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at:
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/
package io.netty.handler.ssl;

import javax.net.ssl.SSLException;

/**
* {@link SSLException} which signals that the exception was caused by an {@link javax.net.ssl.SSLEngine} which was
* closed already.
*/
public final class SslClosedEngineException extends SSLException {

private static final long serialVersionUID = -5204207600474401904L;

public SslClosedEngineException(String reason) {
super(reason);
}
}
2 changes: 1 addition & 1 deletion handler/src/main/java/io/netty/handler/ssl/SslHandler.java
Original file line number Diff line number Diff line change
Expand Up @@ -851,7 +851,7 @@ private void wrap(ChannelHandlerContext ctx, boolean inUnwrap) throws SSLExcepti
if (exception == null) {
exception = sslClosePromise.cause();
if (exception == null) {
exception = new SSLException("SSLEngine closed already");
exception = new SslClosedEngineException("SSLEngine closed already");
}
}
promise.tryFailure(exception);
Expand Down

0 comments on commit 1c37c8f

Please sign in to comment.