org.apache.sshd.client.config.hosts.HostConfigEntryResolver Maven / Gradle / Ivy
Go to download
This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including
all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and
JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up
with different versions on classes on the class path).
The newest version!
/*
* 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.client.config.hosts;
import java.io.IOException;
import java.net.SocketAddress;
import org.apache.sshd.common.AttributeRepository;
/**
* @author Apache MINA SSHD Project
* @see ssh_config
*/
@FunctionalInterface
public interface HostConfigEntryResolver {
/**
* An "empty" implementation that does not resolve any entry - i.e., uses the original entry as-is
*/
HostConfigEntryResolver EMPTY = new HostConfigEntryResolver() {
@Override
public HostConfigEntry resolveEffectiveHost(
String host, int port, SocketAddress localAddress, String username, String proxyJump,
AttributeRepository context)
throws IOException {
return null;
}
@Override
public String toString() {
return "EMPTY";
}
};
/**
* Invoked when creating a new client session in order to allow for overriding of the original parameters
*
* @param host The requested host - never {@code null}/empty
* @param port The requested port
* @param localAddress Optional binding endpoint for the local peer
* @param username The requested username
* @param proxyJump The requested proxyJump
* @param context An optional "context" provided during the connection request (to be attached to
* the established session if successfully connected)
* @return A {@link HostConfigEntry} for the actual target - {@code null} if use original parameters.
* Note: if any identity files are attached to the configuration then they must point to
* existing locations. This means that any macros such as ~, %d, %h, etc.
* must be resolved prior to returning the value
* @throws IOException If failed to resolve the configuration
*/
HostConfigEntry resolveEffectiveHost(
String host, int port, SocketAddress localAddress, String username, String proxyJump, AttributeRepository context)
throws IOException;
}