com.centurylink.mdw.cli

Class Setup

java.lang.Object

com.centurylink.mdw.cli.Setup

All Implemented Interfaces:

Operation

Direct Known Subclasses:

BpmnImport, Codegen, Convert, DbOperation, Dependencies, Discover, Export, Hierarchy, Import, Init, Install, Paths, Status, Test, Token, Update, Vercheck

public abstract class Setup
extends java.lang.Object
implements Operation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Setup.Project

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	assetLoc Asset loc is taken from project.yaml, falling back to mdw.yaml, and finally "assets"
protected java.lang.String	configLoc
protected static java.lang.String	MDW_COMMON_PATH
protected static java.lang.String	META_DIR
protected java.io.File	projectDir
protected java.lang.String	sourceGroup
protected java.lang.String	templateDir
protected static java.lang.String	VERSIONS

Fields inherited from interface com.centurylink.mdw.cli.Operation

MAVEN_CENTRAL_URL, SONATYPE_URL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Setup(java.io.File projectDir)

Method Summary

Modifier and Type	Method and Description
void	createAsset(java.lang.String assetPath, byte[] content)
void	debug() Override for extended debug info (always calling super.debug()).
protected void	downloadTemplates(ProgressMonitor... monitors) Downloads asset templates for codegen, etc.
java.util.Map<java.lang.String,java.util.List<java.io.File>>	findAllAssets(java.lang.String ext)
java.lang.String	findMdwVersion(boolean snapshots) Crawls to find the latest stable version.
java.io.File	getAssetFile(java.lang.String assetPath)
protected java.util.List<java.io.File>	getAssetFiles(java.lang.String packageName)
java.lang.String	getAssetLoc()
java.lang.String	getAssetName(java.lang.String assetPath)
AssetPath	getAssetPath(java.io.File file)
java.lang.String	getAssetRelativePath(java.io.File file)
java.io.File	getAssetRoot()
java.util.List<java.lang.String>	getBaseAssetPackages()
protected java.lang.String	getBaseUrl()
java.lang.String	getConfigLoc()
java.io.File	getConfigRoot()
java.lang.String	getDatabaseDriver()
java.lang.String	getDatabasePassword()
java.lang.String	getDatabaseUrl()
java.lang.String	getDatabaseUser()
java.util.List<Dependency>	getDependencies() Dependencies that need to be downloaded for this operation to run.
java.io.PrintStream	getErr()
java.lang.String	getGitBranch()
java.lang.String	getGitPath(java.io.File file)
java.lang.String	getGitRemoteUrl()
java.io.File	getGitRoot()
java.lang.String	getGitUser()
protected java.io.File	getImplsDir()
java.lang.String	getJava()
java.lang.String	getMdwConfig()
java.io.File	getMdwHome()
java.lang.String	getMdwVersion() Reads from project.yaml
java.io.PrintStream	getOut()
java.io.File	getPackageDir(java.lang.String packageName)
protected Packages	getPackageDirs()
java.io.File	getPackageMeta(java.io.File packageDir)
java.io.File	getPackageMeta(java.lang.String packageName)
java.lang.String	getPackageName(java.lang.String assetPath)
Setup.Project	getProject()
java.io.File	getProjectDir()
YamlProperties	getProjectYaml()
java.lang.String	getRelativePath(java.io.File from, java.io.File to) Returns 'to' file or dir path relative to 'from' dir.
java.lang.String	getReleasesUrl()
java.lang.String	getServicesUrl()
java.lang.String	getSnapshotsUrl()
java.lang.String	getSourceGroup()
java.io.File	getTempDir()
protected java.io.File	getTemplateDir()
java.lang.String	getTemplatesUrl()
java.lang.Object	getValue(java.lang.String name)
protected java.util.Map<java.lang.String,java.util.Properties>	getVersionProps(java.util.Map<java.lang.String,java.io.File> packageDirs)
boolean	gitExists()
protected void	initBaseAssetPackages() Checks for any existing packages.
protected boolean	isCommandLine()
boolean	isDebug()
boolean	isDependencies()
boolean	isNoProgress()
boolean	isSnapshots() Reads from project.yaml
void	mkPackage(java.lang.String name) Creates a package if it doesn't exist.
protected boolean	needsConfig()
void	setAssetLoc(java.lang.String assetLoc)
void	setBaseAssetPackages(java.util.List<java.lang.String> packages)
void	setConfigLoc(java.lang.String configLoc)
void	setDatabaseDriver(java.lang.String driver)
void	setDatabasePassword(java.lang.String password)
void	setDatabaseUrl(java.lang.String url)
void	setDatabaseUser(java.lang.String user)
void	setDebug(boolean debug)
void	setDependencies(boolean dependencies)
void	setErr(java.io.PrintStream err)
void	setGitBranch(java.lang.String branch)
void	setGitPassword(java.lang.String password)
void	setGitRemoteUrl(java.lang.String url)
void	setGitRoot(java.io.File gitRoot)
void	setGitUser(java.lang.String user)
void	setMdwVersion(java.lang.String version)
void	setNoProgress(boolean noProgress)
void	setOut(java.io.PrintStream out)
void	setReleasesUrl(java.lang.String url)
void	setServicesUrl(java.lang.String url)
void	setSnapshotsUrl(java.lang.String url)
void	setSourceGroup(java.lang.String sourceGroup)
void	setTemplateDir(java.lang.String templateDir)
void	status()
protected void	subst(java.io.File dir)
static java.lang.String	substitute(java.lang.String input, java.util.Map<java.lang.String,java.lang.Object> values) Simple substitution mechanism.
java.lang.String	toCamel(java.lang.String hyphenated)
protected void	updateBuildFile()
boolean	validate() Override for extended validation (always calling super.validate()).

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.centurylink.mdw.cli.Operation

run

Field Detail

META_DIR

protected static final java.lang.String META_DIR

See Also:

Constant Field Values

VERSIONS

protected static final java.lang.String VERSIONS

See Also:

Constant Field Values

MDW_COMMON_PATH

protected static final java.lang.String MDW_COMMON_PATH

See Also:

Constant Field Values

projectDir

protected java.io.File projectDir

sourceGroup

protected java.lang.String sourceGroup

templateDir

protected java.lang.String templateDir

configLoc

protected java.lang.String configLoc

assetLoc

protected java.lang.String assetLoc

Asset loc is taken from project.yaml, falling back to mdw.yaml, and finally "assets"

Constructor Detail

Setup

protected Setup(java.io.File projectDir)

Method Detail

getDependencies

public java.util.List<Dependency> getDependencies()
                                           throws java.io.IOException

Dependencies that need to be downloaded for this operation to run.

Throws:

java.io.IOException

getOut

public java.io.PrintStream getOut()

Specified by:

getOut in interface Operation

setOut

public void setOut(java.io.PrintStream out)

Specified by:

setOut in interface Operation

getErr

public java.io.PrintStream getErr()

Specified by:

getErr in interface Operation

setErr

public void setErr(java.io.PrintStream err)

Specified by:

setErr in interface Operation

isDependencies

public boolean isDependencies()

setDependencies

public void setDependencies(boolean dependencies)

getProjectDir

public java.io.File getProjectDir()

isDebug

public boolean isDebug()

setDebug

public void setDebug(boolean debug)

isNoProgress

public boolean isNoProgress()

setNoProgress

public void setNoProgress(boolean noProgress)

getReleasesUrl

public java.lang.String getReleasesUrl()

setReleasesUrl

public void setReleasesUrl(java.lang.String url)

getServicesUrl

public java.lang.String getServicesUrl()

setServicesUrl

public void setServicesUrl(java.lang.String url)

getBaseAssetPackages

public java.util.List<java.lang.String> getBaseAssetPackages()

setBaseAssetPackages

public void setBaseAssetPackages(java.util.List<java.lang.String> packages)

getGitRemoteUrl

public java.lang.String getGitRemoteUrl()

setGitRemoteUrl

public void setGitRemoteUrl(java.lang.String url)

getGitBranch

public java.lang.String getGitBranch()

setGitBranch

public void setGitBranch(java.lang.String branch)

getGitUser

public java.lang.String getGitUser()

setGitUser

public void setGitUser(java.lang.String user)

setGitPassword

public void setGitPassword(java.lang.String password)

getDatabaseUrl

public java.lang.String getDatabaseUrl()

setDatabaseUrl

public void setDatabaseUrl(java.lang.String url)

getDatabaseUser

public java.lang.String getDatabaseUser()

setDatabaseUser

public void setDatabaseUser(java.lang.String user)

getDatabasePassword

public java.lang.String getDatabasePassword()

setDatabasePassword

public void setDatabasePassword(java.lang.String password)

getDatabaseDriver

public java.lang.String getDatabaseDriver()

setDatabaseDriver

public void setDatabaseDriver(java.lang.String driver)

getSourceGroup

public java.lang.String getSourceGroup()

setSourceGroup

public void setSourceGroup(java.lang.String sourceGroup)

setTemplateDir

public void setTemplateDir(java.lang.String templateDir)

getSnapshotsUrl

public java.lang.String getSnapshotsUrl()

setSnapshotsUrl

public void setSnapshotsUrl(java.lang.String url)

getProjectYaml

public YamlProperties getProjectYaml()
                              throws java.io.IOException

Throws:

java.io.IOException

getMdwVersion

public java.lang.String getMdwVersion()
                               throws java.io.IOException

Reads from project.yaml

Throws:

java.io.IOException

setMdwVersion

public void setMdwVersion(java.lang.String version)

isSnapshots

public boolean isSnapshots()
                    throws java.io.IOException

Reads from project.yaml

Throws:

java.io.IOException

getConfigLoc

public java.lang.String getConfigLoc()
                              throws java.io.IOException

Throws:

java.io.IOException

setConfigLoc

public void setConfigLoc(java.lang.String configLoc)

getAssetLoc

public java.lang.String getAssetLoc()
                             throws java.io.IOException

Throws:

java.io.IOException

setAssetLoc

public void setAssetLoc(java.lang.String assetLoc)

findMdwVersion

public java.lang.String findMdwVersion(boolean snapshots)
                                throws java.io.IOException

Crawls to find the latest stable version.

Throws:

java.io.IOException

initBaseAssetPackages

protected void initBaseAssetPackages()
                              throws java.io.IOException

Checks for any existing packages. If none present, adds the defaults.

Throws:

java.io.IOException

subst

protected void subst(java.io.File dir)
              throws java.io.IOException

Throws:

java.io.IOException

getValue

public java.lang.Object getValue(java.lang.String name)

toCamel

public java.lang.String toCamel(java.lang.String hyphenated)

getConfigRoot

public java.io.File getConfigRoot()

getRelativePath

public java.lang.String getRelativePath(java.io.File from,
                                        java.io.File to)

Returns 'to' file or dir path relative to 'from' dir. Result always uses forward slashes and has no trailing slash.

getAssetRelativePath

public java.lang.String getAssetRelativePath(java.io.File file)
                                      throws java.io.IOException

Throws:

java.io.IOException

getAssetPath

public AssetPath getAssetPath(java.io.File file)
                       throws java.io.IOException

Throws:

java.io.IOException

getPackageName

public java.lang.String getPackageName(java.lang.String assetPath)

getAssetName

public java.lang.String getAssetName(java.lang.String assetPath)

getAssetFile

public java.io.File getAssetFile(java.lang.String assetPath)
                          throws java.io.IOException

Throws:

java.io.IOException

getAssetRoot

public java.io.File getAssetRoot()
                          throws java.io.IOException

Throws:

java.io.IOException

getGitRoot

public java.io.File getGitRoot()
                        throws java.io.IOException

Throws:

java.io.IOException

setGitRoot

public void setGitRoot(java.io.File gitRoot)

getGitPath

public java.lang.String getGitPath(java.io.File file)
                            throws java.io.IOException

Throws:

java.io.IOException

gitExists

public boolean gitExists()
                  throws java.io.IOException

Throws:

java.io.IOException

getMdwConfig

public java.lang.String getMdwConfig()

getMdwHome

public java.io.File getMdwHome()
                        throws java.io.IOException

Throws:

java.io.IOException

getTemplatesUrl

public java.lang.String getTemplatesUrl()
                                 throws java.io.IOException

Throws:

java.io.IOException

validate

public boolean validate()
                 throws java.io.IOException

Override for extended validation (always calling super.validate()).

Throws:

java.io.IOException

needsConfig

protected boolean needsConfig()

debug

public void debug()
           throws java.io.IOException

Override for extended debug info (always calling super.debug()).

Throws:

java.io.IOException

status

public void status()
            throws java.io.IOException

Throws:

java.io.IOException

getJava

public java.lang.String getJava()

mkPackage

public void mkPackage(java.lang.String name)
               throws java.io.IOException

Creates a package if it doesn't exist. Only works from 6.1.

Throws:

java.io.IOException

createAsset

public void createAsset(java.lang.String assetPath,
                        byte[] content)
                 throws java.io.IOException

Throws:

java.io.IOException

getTemplateDir

protected java.io.File getTemplateDir()
                               throws java.io.IOException

Throws:

java.io.IOException

getImplsDir

protected java.io.File getImplsDir()
                            throws java.io.IOException

Throws:

java.io.IOException

downloadTemplates

protected void downloadTemplates(ProgressMonitor... monitors)
                          throws java.io.IOException

Downloads asset templates for codegen, etc.

Throws:

java.io.IOException

getTempDir

public java.io.File getTempDir()
                        throws java.io.IOException

Throws:

java.io.IOException

getPackageDirs

protected Packages getPackageDirs()
                           throws java.io.IOException

Throws:

java.io.IOException

getPackageDir

public java.io.File getPackageDir(java.lang.String packageName)
                           throws java.io.IOException

Throws:

java.io.IOException

getPackageMeta

public java.io.File getPackageMeta(java.io.File packageDir)

getPackageMeta

public java.io.File getPackageMeta(java.lang.String packageName)
                            throws java.io.IOException

Throws:

java.io.IOException

findAllAssets

public java.util.Map<java.lang.String,java.util.List<java.io.File>> findAllAssets(java.lang.String ext)
                                                                           throws java.io.IOException

Throws:

java.io.IOException

getAssetFiles

protected java.util.List<java.io.File> getAssetFiles(java.lang.String packageName)
                                              throws java.io.IOException

Throws:

java.io.IOException

getBaseUrl

protected java.lang.String getBaseUrl()
                               throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

updateBuildFile

protected void updateBuildFile()
                        throws java.io.IOException

Throws:

java.io.IOException

getVersionProps

protected java.util.Map<java.lang.String,java.util.Properties> getVersionProps(java.util.Map<java.lang.String,java.io.File> packageDirs)
                                                                        throws java.io.IOException

Throws:

java.io.IOException

substitute

public static java.lang.String substitute(java.lang.String input,
                                          java.util.Map<java.lang.String,java.lang.Object> values)

Simple substitution mechanism. Missing values substituted with empty string.

isCommandLine

protected boolean isCommandLine()

getProject

public Setup.Project getProject()