Deprecate remote shell support

Closes gh-7044
This commit is contained in:
Stephane Nicoll 2016-10-11 17:39:28 +02:00
parent 5976d44f6c
commit cfee9bab81
8 changed files with 58 additions and 3 deletions

View File

@ -121,6 +121,7 @@ import org.springframework.util.StringUtils;
@EnableConfigurationProperties(ShellProperties.class)
@AutoConfigureAfter({ SecurityAutoConfiguration.class,
ManagementWebSecurityAutoConfiguration.class })
@Deprecated
public class CrshAutoConfiguration {
public static final String AUTH_PREFIX = ShellProperties.SHELL_PREFIX + ".auth";

View File

@ -40,6 +40,7 @@ import org.springframework.util.StringUtils;
* @author Stephane Nicoll
*/
@ConfigurationProperties(prefix = ShellProperties.SHELL_PREFIX, ignoreUnknownFields = true)
@Deprecated
public class ShellProperties {
public static final String SHELL_PREFIX = "management.shell";

View File

@ -68,6 +68,7 @@ import static org.hamcrest.CoreMatchers.isA;
* @author Stephane Nicoll
*/
@SuppressWarnings({ "rawtypes", "unchecked" })
@Deprecated
public class CrshAutoConfigurationTests {
private AnnotationConfigWebApplicationContext context;

View File

@ -49,6 +49,7 @@ import static org.assertj.core.api.Assertions.assertThat;
* @author Christian Dupuis
* @author Stephane Nicoll
*/
@Deprecated
public class ShellPropertiesTests {
@Rule

View File

@ -803,7 +803,7 @@ If you are using Jolokia but you don't want Spring Boot to configure it, simply
[[production-ready-remote-shell]]
== Monitoring and management using a remote shell
== Monitoring and management using a remote shell (deprecated)
Spring Boot supports an integrated Java shell called '`CRaSH`'. You can use CRaSH to
`ssh` or `telnet` into your running application. To enable remote shell support, add
the following dependency to your project:

View File

@ -7,9 +7,9 @@
<version>1.5.0.BUILD-SNAPSHOT</version>
</parent>
<artifactId>spring-boot-starter-remote-shell</artifactId>
<name>Spring Boot Remote Shell Starter</name>
<name>spring-boot-starter-remote-shell (DEPRECATED)</name>
<description>Starter for using the CRaSH remote shell to monitor and manage your
application over SSH</description>
application over SSH. Deprecated since 1.5</description>
<url>http://projects.spring.io/spring-boot/</url>
<organization>
<name>Pivotal Software, Inc.</name>

View File

@ -0,0 +1,49 @@
/*
* Copyright 2012-2016 the original author or authors.
*
* Licensed 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.springframework.boot.starter.remote.shell;
import javax.annotation.PostConstruct;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.context.annotation.Configuration;
/**
* {@link EnableAutoConfiguration Auto-configuration} to print a deprecation warning about
* the starter.
*
* @author Stephane Nicoll
* @since 1.4.0
*/
@Configuration
@Deprecated
public class RemoteShellStarterDeprecatedWarningAutoConfiguration {
private static final Log logger = LogFactory
.getLog(RemoteShellStarterDeprecatedWarningAutoConfiguration.class);
@PostConstruct
public void logWarning() {
logger.warn("spring-boot-starter-remote-shell is deprecated since Spring Boot " +
"1.5 and will be removed in Spring Boot 2.0");
}
}

View File

@ -0,0 +1,2 @@
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.starter.remote.shell.RemoteShellStarterDeprecatedWarningAutoConfiguration