io.micronaut.starter.api.create.zip

Class ZipCreateController

java.lang.Object

io.micronaut.starter.api.create.AbstractCreateController

io.micronaut.starter.api.create.zip.ZipCreateController

All Implemented Interfaces:

ZipCreateOperation

@Controller
 @ExecuteOn(value="io")
public class ZipCreateController
extends AbstractCreateController
implements ZipCreateOperation

Implements the ZipCreateOperation interface for applications.

Since:

1.0.0

Author:

graemerocher

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MEDIA_TYPE_APPLICATION_ZIP

Fields inherited from class io.micronaut.starter.api.create.AbstractCreateController

projectGenerator

Constructor Summary

Constructors

Constructor and Description
ZipCreateController(ProjectGenerator projectGenerator, io.micronaut.context.event.ApplicationEventPublisher eventPublisher) Default constructor.

Method Summary

Modifier and Type	Method and Description
io.micronaut.http.HttpResponse<io.micronaut.core.io.Writable>	createApp(ApplicationType type, @Pattern(regexp="[\\w\\d-_\\.]+") java.lang.String name, java.util.List<java.lang.String> features, BuildTool build, TestFramework test, Language lang, JdkVersion javaVersion, java.lang.String userAgent) Creates an application, generating a ZIP file as the response.
io.micronaut.http.HttpResponse<io.micronaut.core.io.Writable>	createZip(ApplicationType type, @Pattern(regexp="[\\w\\d-_]+") @NotBlank java.lang.String name, java.util.List<java.lang.String> features, BuildTool build, TestFramework test, Language lang, JdkVersion javaVersion, java.lang.String userAgent) Creates the default application type using the name of the given Zip.
io.micronaut.http.HttpResponse<io.micronaut.core.io.Writable>	generateAppIntoZipFile(@NotNull ApplicationType type, @NotNull java.lang.String name, java.util.List<java.lang.String> features, BuildTool buildTool, TestFramework testFramework, Language lang, JdkVersion javaVersion, java.lang.String userAgent)
protected java.lang.String	getFilename(Project project)

Methods inherited from class io.micronaut.starter.api.create.AbstractCreateController

createProjectGeneratorContext, getOperatingSystem

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MEDIA_TYPE_APPLICATION_ZIP

public static final java.lang.String MEDIA_TYPE_APPLICATION_ZIP

See Also:

Constant Field Values

Constructor Detail

ZipCreateController

public ZipCreateController(ProjectGenerator projectGenerator,
                           io.micronaut.context.event.ApplicationEventPublisher eventPublisher)

Default constructor.

Parameters:

projectGenerator - The project generator

eventPublisher - The event publisher

Method Detail

createApp

@Get(uri="/create/{type}/{name}{?features,lang,build,test,javaVersion}",
     produces="application/zip")
public io.micronaut.http.HttpResponse<io.micronaut.core.io.Writable> createApp(ApplicationType type,
                                                                                                                                                                                         @Pattern(regexp="[\\w\\d-_\\.]+")
                                                                                                                                                                                         @Pattern(regexp="[\\w\\d-_\\.]+") java.lang.String name,
                                                                                                                                                                                         @Nullable
                                                                                                                                                                                         java.util.List<java.lang.String> features,
                                                                                                                                                                                         @Nullable
                                                                                                                                                                                         BuildTool build,
                                                                                                                                                                                         @Nullable
                                                                                                                                                                                         TestFramework test,
                                                                                                                                                                                         @Nullable
                                                                                                                                                                                         Language lang,
                                                                                                                                                                                         @Nullable
                                                                                                                                                                                         JdkVersion javaVersion,
                                                                                                                                                                                         @Nullable @Header(value="User-Agent")
                                                                                                                                                                                         java.lang.String userAgent)

Creates an application, generating a ZIP file as the response.

Specified by:

createApp in interface ZipCreateOperation

Parameters:

type - The application type The application type

name - The name of the application The name of the application

features - The features The chosen features

build - The build type (optional, defaults to Gradle)

test - The test framework (optional, defaults to JUnit)

lang - The language (optional, defaults to Java)

Returns:

A ZIP file containing the generated application.

createZip

@Get(uri="/{name}.zip{?type,features,lang,build,test}",
     produces="application/zip")
public io.micronaut.http.HttpResponse<io.micronaut.core.io.Writable> createZip(@Bindable(defaultValue="default")
                                                                                                                                                                        ApplicationType type,
                                                                                                                                                                        @Pattern(regexp="[\\w\\d-_]+") @NotBlank
                                                                                                                                                                        @Pattern(regexp="[\\w\\d-_]+") @NotBlank java.lang.String name,
                                                                                                                                                                        @Nullable
                                                                                                                                                                        java.util.List<java.lang.String> features,
                                                                                                                                                                        @Nullable
                                                                                                                                                                        BuildTool build,
                                                                                                                                                                        @Nullable
                                                                                                                                                                        TestFramework test,
                                                                                                                                                                        @Nullable
                                                                                                                                                                        Language lang,
                                                                                                                                                                        @Nullable
                                                                                                                                                                        JdkVersion javaVersion,
                                                                                                                                                                        @Nullable @Header(value="User-Agent")
                                                                                                                                                                        java.lang.String userAgent)

Creates the default application type using the name of the given Zip.

Parameters:

type - The type

name - The ZIP name

features - The features

build - The build tool

test - The test framework

lang - The language

Returns:

A Zip file containing the application

generateAppIntoZipFile

public io.micronaut.http.HttpResponse<io.micronaut.core.io.Writable> generateAppIntoZipFile(@NotNull
                                                                                            @NotNull ApplicationType type,
                                                                                            @NotNull
                                                                                            @NotNull java.lang.String name,
                                                                                            @Nullable
                                                                                            java.util.List<java.lang.String> features,
                                                                                            @Nullable
                                                                                            BuildTool buildTool,
                                                                                            @Nullable
                                                                                            TestFramework testFramework,
                                                                                            @Nullable
                                                                                            Language lang,
                                                                                            @Nullable
                                                                                            JdkVersion javaVersion,
                                                                                            @Nullable
                                                                                            java.lang.String userAgent)

getFilename

@NonNull
protected java.lang.String getFilename(@NonNull
                                                Project project)

Parameters:

project - The project

Returns:

The file name to return.