ws.osiris.awsdeploy

Interface DeployableProject

public DeployableProject

Implemented for each build system to hook into the project configuration.

The configuration allows the code and CloudFormation template to be generated and the project to be deployed.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DeployableProject.DefaultImpls Implemented for each build system to hook into the project configuration.

Method Summary

Modifier and Type	Method and Description
ws.osiris.aws.ApiFactory<?>	createApiFactory(java.lang.ClassLoader parentClassLoader) Returns a factory that can build the API, the components and the application configuration.
java.util.Map<java.lang.String,java.lang.String>	deploy()
void	generateCloudFormation()
java.lang.String	getAwsProfile() The name of the AWS profile; if not specified the default chain is used to find the profile and region.
java.nio.file.Path	getBuildDir() The root of the build directory.
java.lang.String	getEnvironmentName() The name of the environment into which the code is being deployed; used in resource and bucket names.
java.lang.String	getName() The project name; must be specified by the user in the Maven or Gradle project.
java.nio.file.Path	getProjectJar() The jar containing the project classes and resources.
java.lang.String	getRootPackage() The root package of the application; used when generating the CloudFormation template.
java.util.List<java.nio.file.Path>	getRuntimeClasspath() The jar files on the runtime classpath.
java.nio.file.Path	getSourceDir() The root of the main source directory; normally src/main.
java.lang.String	getStackName() The name of the CloudFormation stack; if not specified a name is generated from the app and environment names.
java.lang.String	getStaticFilesDirectory() The directory containing the static files; null if the API doesn't serve static files.
java.lang.String	getVersion() The project version; Maven requires a version but it's optional in Gradle.
java.nio.file.Path	getZipBuildDir() The directory where jar files are built.
void	openBrowser(java.lang.String stage, java.lang.String path) Opens a path from a stage in the system default browser.

Method Detail

getName

@NotNull
java.lang.String getName()

The project name; must be specified by the user in the Maven or Gradle project.

getVersion

@Nullable
java.lang.String getVersion()

The project version; Maven requires a version but it's optional in Gradle.

getBuildDir

@NotNull
java.nio.file.Path getBuildDir()

The root of the build directory.

getZipBuildDir

@NotNull
java.nio.file.Path getZipBuildDir()

The directory where jar files are built.

getSourceDir

@NotNull
java.nio.file.Path getSourceDir()

The root of the main source directory; normally src/main.

getRootPackage

@NotNull
java.lang.String getRootPackage()

The root package of the application; used when generating the CloudFormation template.

getEnvironmentName

@Nullable
java.lang.String getEnvironmentName()

The name of the environment into which the code is being deployed; used in resource and bucket names.

getStaticFilesDirectory

@Nullable
java.lang.String getStaticFilesDirectory()

The directory containing the static files; null if the API doesn't serve static files.

getAwsProfile

@Nullable
java.lang.String getAwsProfile()

The name of the AWS profile; if not specified the default chain is used to find the profile and region.

getStackName

@Nullable
java.lang.String getStackName()

The name of the CloudFormation stack; if not specified a name is generated from the app and environment names.

getRuntimeClasspath

@NotNull
java.util.List<java.nio.file.Path> getRuntimeClasspath()

The jar files on the runtime classpath.

getProjectJar

@NotNull
java.nio.file.Path getProjectJar()

The jar containing the project classes and resources.

createApiFactory

@NotNull
ws.osiris.aws.ApiFactory<?> createApiFactory(@NotNull
                                                      java.lang.ClassLoader parentClassLoader)

Returns a factory that can build the API, the components and the application configuration.

generateCloudFormation

void generateCloudFormation()

deploy

@NotNull
java.util.Map<java.lang.String,java.lang.String> deploy()

openBrowser

void openBrowser(@NotNull
                 java.lang.String stage,
                 @NotNull
                 java.lang.String path)

Opens a path from a stage in the system default browser.