/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF 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
*
* http://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 org.apache.sshd.common.session;
import java.util.Map;
import org.apache.sshd.common.kex.KexProposalOption;
import org.apache.sshd.common.util.SshdEventListener;
/**
* Represents an interface receiving session events.
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
public interface SessionListener extends SshdEventListener {
enum Event {
KeyEstablished, Authenticated, KexCompleted
}
/**
* A new session just been created
*
* @param session The created {@link Session}
*/
default void sessionCreated(Session session) {
// ignored
}
/**
* Signals the start of the negotiation options handling
*
* @param session The referenced {@link Session}
* @param clientProposal The client proposal options (un-modifiable)
* @param serverProposal The server proposal options (un-modifiable)
*/
default void sessionNegotiationStart(Session session,
Map<KexProposalOption, String> clientProposal, Map<KexProposalOption, String> serverProposal) {
// ignored
}
/**
* Signals the end of the negotiation options handling
*
* @param session The referenced {@link Session}
* @param clientProposal The client proposal options (un-modifiable)
* @param serverProposal The server proposal options (un-modifiable)
* @param negotiatedOptions The successfully negotiated options so far
* - even if exception occurred (un-modifiable)
* @param reason Negotiation end reason - {@code null} if successful
*/
default void sessionNegotiationEnd(Session session,
Map<KexProposalOption, String> clientProposal, Map<KexProposalOption, String> serverProposal,
Map<KexProposalOption, String> negotiatedOptions, Throwable reason) {
// ignored
}
/**
* An event has been triggered
*
* @param session The referenced {@link Session}
* @param event The generated {@link Event}
*/
default void sessionEvent(Session session, Event event) {
// ignored
}
/**
* An exception was caught and the session will be closed
* (if not already so). <B>Note:</B> the code makes no guarantee
* that at this stage {@link #sessionClosed(Session)} will be called
* or perhaps has already been called
*
* @param session The referenced {@link Session}
* @param t The caught exception
*/
default void sessionException(Session session, Throwable t) {
// ignored
}
/**
* A session has been closed
*
* @param session The closed {@link Session}
*/
default void sessionClosed(Session session) {
// ignored
}
static <L extends SessionListener> L validateListener(L listener) {
return SshdEventListener.validateListener(listener, SessionListener.class.getSimpleName());
}
}