[JavaJaxRS] ServiceImpl and ServiceFactory classes should not be overwritten

[willgorman]

Description

Prior to #4074, all generated *ServiceImpl and *ServiceFactory classes would never be overwritten due to io.swagger.codegen.languages.AbstractJavaJAXRSServerCodegen#shouldOverwrite which was removed in the previously mentioned issue. I believe that the previous behavior was correct because those classes are intended to contain user-written code and are also written to a different directory than the rest of the generated classes. There's no reason to allow them to be overwritten and this change breaks anyone that relied on this.

Swagger-codegen version

2.2.2-SNAPSHOT

Swagger declaration file content or url

Command line used for generation

<plugin>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-codegen-maven-plugin</artifactId>
    <version>2.2.2-SNAPSHOT</version>
    <executions>
        <execution>
            <goals>
                <goal>generate</goal>
            </goals>
            <configuration>
                <inputSpec>${project.basedir}/src/main/resources/api.yml</inputSpec>
                <language>jaxrs</language>
                <output>${project.basedir}</output>
                <modelPackage>com.foo.model</modelPackage>
                <apiPackage>com.foo.api</apiPackage>
                <configOptions>
                    <dateLibrary>java8</dateLibrary>
                    <sourceFolder>src/generated/java</sourceFolder>
                </configOptions>
                <environmentVariables>
                    <hideGenerationTimestamp/>
                    <models/>
                    <apis/>
                    <supportingFiles>
                     ApiException.java,ApiOriginFilter.java,ApiResponseMessage.java,JacksonJsonProvider.java,NotFoundException.java,StringUtil.java,RFC3339DateFormat.java
                    </supportingFiles>
                </environmentVariables>
                <addCompileSourceRoot>false</addCompileSourceRoot>
            </configuration>
        </execution>
    </executions>
</plugin>

Steps to reproduce

Related issues

Suggest a Fix

Restore https://github.com/swagger-api/swagger-codegen/pull/4074/files#diff-c48b6e5f92076a98e3f2b0e940fd5eecL205

[wing328]

@willgorman what about using .swagger-codegen-ignore to skip the overwrite instead?

[andylowry]

@wing328 The ignore option is not suitable for iterative development, and the prior behavior is really quite crucial. It's important for some but not all of the files to be overwritten if they exist. Previously, for example, all the JAX-RS generators left anything named *SerivceImpl.java and *ServiceFactory.java untouched, but overwrote everything else by default. One really needs to leave files that are intended to be manually edited untouched.

[fehguy]

@andylowry why is that not suitable? Seems like the best solution actually, it gives you full control over what is and is not overwritten. There are situations where you may actually want to overwrite everything.

[andylowry]

@fehguy My mistake... I stupidly thought we were talking about -skip-overwrite option. Hadn't ever noticed .swagger-codegen-ignore, which as you say puts developers in complete control.

I might still suggest generating a default that retains the prior convention in JAX-RS-based projects (and others that override - or formerly overrode - #shouldOverwrite). It's seems to still be a reasonable default for those generators, and this would result in a change in the implementation of the behavior, rather than a change in the behavior that could trip people up.