001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *  
010 *    https://www.apache.org/licenses/LICENSE-2.0
011 *  
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License. 
018 *  
019 */
020package org.apache.directory.api.ldap.model.exception;
021
022
023/**
024 * A LdapTlsException is thrown if the SSL/TLS handshake failed.
025 * 
026 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
027 */
028public class LdapTlsHandshakeException extends LdapException
029{
030    private static final long serialVersionUID = 1L;
031
032    private LdapTlsHandshakeFailCause failCause;
033
034
035    /**
036     * The constructor with a reason string argument.
037     * 
038     * @param message the message
039     * @param cause the root cause
040     */
041    public LdapTlsHandshakeException( String message, Throwable cause )
042    {
043        super( message, cause );
044        this.failCause = LdapTlsHandshakeExceptionClassifier.classify( cause, null );
045    }
046
047
048    public LdapTlsHandshakeFailCause getFailCause()
049    {
050        return failCause;
051    }
052
053
054    @Override
055    public String getMessage()
056    {
057        String message = super.getMessage();
058
059        message += ", reason: " + failCause.getReasonPhrase();
060        Throwable rootCause = failCause.getRootCause();
061        if ( rootCause != null && rootCause != this )
062        {
063            message += ": " + rootCause.getMessage();
064        }
065
066        return message;
067    }
068
069}