Package hudson.plugins.project_inheritance.projects.creation

Class ProjectCreationEngine

java.lang.Object

hudson.model.ManagementLink

hudson.plugins.project_inheritance.projects.creation.ProjectCreationEngine

All Implemented Interfaces:

ExtensionPoint, Action, Describable<ProjectCreationEngine>, ModelObject, Saveable

public class ProjectCreationEngine
extends ManagementLink
implements Saveable, Describable<ProjectCreationEngine>

This class encapsulates the properties and actions of the project creation mechanism.

Since it is a global mechanism, this is a singleton that can be configured from a central configuration page and accessed from all objects.

Author:

Martin Schroeder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProjectCreationEngine.CreationClass	This class describes the fundamental properties of a creation class type.
static class	ProjectCreationEngine.CreationMating	This class references two creation class names and marks them as to be mated by this creation engine.
static class	ProjectCreationEngine.ProjectCreationEngineDescriptor
static class	ProjectCreationEngine.RenameRestriction
static class	ProjectCreationEngine.RenameWatcher

Nested classes/interfaces inherited from class hudson.model.ManagementLink

ManagementLink.Category

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	acceptableErrorUrls
protected boolean	copyOnRename
protected LinkedList<ProjectCreationEngine.CreationClass>	creationClasses
protected static LinkedList<Descriptor<ProjectCreationEngine.CreationClass>>	creationClassesDescriptors
protected Executor	creationExecutor
protected boolean	disallowVanillaArchiver
protected boolean	enableApplyButton
protected boolean	enableCreation
protected Boolean	enableLeakedLogCleaner	Deprecated. since 19.05.01
static ProjectCreationEngine	instance	The singleton instance used throughout a Jenkins-run.
protected Map<String,String>	lastCreationState
protected static LinkedList<Descriptor<ProjectCreationEngine.CreationMating>>	matingDescriptors
protected LinkedList<ProjectCreationEngine.CreationMating>	matings
protected ProjectCreationEngine.RenameRestriction	renameRestriction
protected List<ProjectTemplate>	templates	The list of jobs to be used as templates for the ProjectWizard.
protected boolean	triggerOnChange
protected boolean	triggerOnStartup

Fields inherited from class hudson.model.ManagementLink

LIST

Fields inherited from interface hudson.model.Saveable

NOOP

Method Summary

Modifier and Type	Method	Description
boolean	currentUserMayRename()
void	doConfigSubmit(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
void	doCreateProjects(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)	This starts the job creation and redirects the user to the result page.
static String	generateNameFor(String variance, String... projects)
static String	generateNameFor(String variance, List<String> projects)
String	getAcceptableErrorUrls()	Returns the list of error URLs that are safe to ignore when checking the validation fields of the job configuration files.
List<String>	getAcceptableErrorUrlsList()	Returns the list of error URLs that are safe to ignore when checking the validation fields of the job configuration files.
protected File	getConfigFile()
boolean	getCopyOnRename()
List<ProjectCreationEngine.CreationClass>	getCreationClasses()
static List<Descriptor<ProjectCreationEngine.CreationClass>>	getCreationClassesDescriptors()
String	getDescription()
Descriptor<ProjectCreationEngine>	getDescriptor()
boolean	getDisallowVanillaArchiver()
String	getDisplayName()
boolean	getEnableApplyButton()
boolean	getEnableCreation()
boolean	getEnableReflectionCaching()
String	getIconFileName()
Map<String,String>	getLastCreationState()
static List<Descriptor<ProjectCreationEngine.CreationMating>>	getMatingDescriptors()
List<ProjectCreationEngine.CreationMating>	getMatings()
String	getRenameRestriction()
ProjectCreationEngine.RenameRestriction	getRenameRestrictionValue()
List<ProjectTemplate>	getTemplates()
boolean	getTriggerOnChange()
boolean	getTriggerOnStartup()
String	getUrlName()
boolean	isFirstInCreationMating(String creationClass)
void	notifyJenkinsStartupComplete()
void	notifyProjectChange(InheritanceProject project)
void	notifyProjectDelete(InheritanceProject project)
void	notifyProjectNew(InheritanceProject project)
Object	readResolve()
void	save()
void	setEnableCreation(boolean enabled)
Map<String,String>	triggerCreateProjects()	Triggers creation of automatically generated projects; if enabled.

Methods inherited from class hudson.model.ManagementLink

all, getCategory, getCategoryName, getRequiredPermission, getRequiresConfirmation, getRequiresPOST

Methods inherited from class java.lang.Object

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

Field Detail

instance

@Extension(ordinal=100.0)
public static final ProjectCreationEngine instance

The singleton instance used throughout a Jenkins-run. As such, this field is created by Jenkins through the Extension annotation during startup. Do note that as this is a Singleton accessible through a static field, the Extension annotation must be on THIS field.

creationClassesDescriptors

protected static LinkedList<Descriptor<ProjectCreationEngine.CreationClass>> creationClassesDescriptors

matingDescriptors

protected static LinkedList<Descriptor<ProjectCreationEngine.CreationMating>> matingDescriptors

creationClasses

protected LinkedList<ProjectCreationEngine.CreationClass> creationClasses

matings

protected LinkedList<ProjectCreationEngine.CreationMating> matings

disallowVanillaArchiver

protected boolean disallowVanillaArchiver

enableCreation

protected boolean enableCreation

triggerOnChange

protected boolean triggerOnChange

triggerOnStartup

protected boolean triggerOnStartup

copyOnRename

protected boolean copyOnRename

enableApplyButton

protected boolean enableApplyButton

enableLeakedLogCleaner

protected final transient Boolean enableLeakedLogCleaner

Deprecated.

since 19.05.01

TODO: Remove after rollout of 19.05.01

acceptableErrorUrls

protected List<String> acceptableErrorUrls

renameRestriction

protected ProjectCreationEngine.RenameRestriction renameRestriction

lastCreationState

protected transient Map<String,String> lastCreationState

creationExecutor

protected final transient Executor creationExecutor

templates

protected List<ProjectTemplate> templates

The list of jobs to be used as templates for the ProjectWizard.

Method Detail

readResolve

public Object readResolve()

save

public void save()
          throws IOException

Specified by:

save in interface Saveable

Throws:

IOException

doConfigSubmit

public void doConfigSubmit(org.kohsuke.stapler.StaplerRequest req,
                           org.kohsuke.stapler.StaplerResponse rsp)
                    throws IOException,
                           javax.servlet.ServletException,
                           Descriptor.FormException

Throws:

IOException

javax.servlet.ServletException

Descriptor.FormException

triggerCreateProjects

public Map<String,String> triggerCreateProjects()

Triggers creation of automatically generated projects; if enabled.

Note: This does not check if the user has enough permissions to create jobs. It is up to the caller to ensure that.

Returns:

a map containing the results of the generation with entries: (project-name, human-readable-result)

doCreateProjects

public void doCreateProjects(org.kohsuke.stapler.StaplerRequest req,
                             org.kohsuke.stapler.StaplerResponse rsp)

This starts the job creation and redirects the user to the result page.

Do NOT call this directly, if not triggered by the user. Instead call triggerCreateProjects().

notifyJenkinsStartupComplete

public void notifyJenkinsStartupComplete()

notifyProjectChange

public void notifyProjectChange(InheritanceProject project)

notifyProjectNew

public void notifyProjectNew(InheritanceProject project)

notifyProjectDelete

public void notifyProjectDelete(InheritanceProject project)

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface Action

Specified by:

getIconFileName in class ManagementLink

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface Action

Specified by:

getUrlName in class ManagementLink

getDescription

public String getDescription()

Overrides:

getDescription in class ManagementLink

getEnableReflectionCaching

public boolean getEnableReflectionCaching()

Returns:

whether or not the results of some expensive reflection calls (Class.isAssignableFrom(Class)) should be cached.

getEnableCreation

public boolean getEnableCreation()

getTriggerOnChange

public boolean getTriggerOnChange()

getTriggerOnStartup

public boolean getTriggerOnStartup()

getCopyOnRename

public boolean getCopyOnRename()

getEnableApplyButton

public boolean getEnableApplyButton()

getRenameRestrictionValue

public ProjectCreationEngine.RenameRestriction getRenameRestrictionValue()

getRenameRestriction

public String getRenameRestriction()

currentUserMayRename

public boolean currentUserMayRename()

getDisallowVanillaArchiver

public boolean getDisallowVanillaArchiver()

getAcceptableErrorUrls

public String getAcceptableErrorUrls()

Returns the list of error URLs that are safe to ignore when checking the validation fields of the job configuration files. See: resources/hudson/plugins/project_inheritance/projects/InheritanceProject/adjunct/detectValidationErrors.js

Returns:

the value of getAcceptableErrorUrlsList() joined with '\n' as the separator.

getAcceptableErrorUrlsList

public List<String> getAcceptableErrorUrlsList()

Returns the list of error URLs that are safe to ignore when checking the validation fields of the job configuration files.

Returns:

the list of acceptable URLs. May be empty but never null. Returns a default list when the backing field is null.

getCreationClasses

public List<ProjectCreationEngine.CreationClass> getCreationClasses()

getCreationClassesDescriptors

public static List<Descriptor<ProjectCreationEngine.CreationClass>> getCreationClassesDescriptors()

getMatings

public List<ProjectCreationEngine.CreationMating> getMatings()

isFirstInCreationMating

public boolean isFirstInCreationMating(String creationClass)

getMatingDescriptors

public static List<Descriptor<ProjectCreationEngine.CreationMating>> getMatingDescriptors()

getTemplates

public List<ProjectTemplate> getTemplates()

Returns:

the list of templates. May be empty, but never null

getConfigFile

protected File getConfigFile()

getLastCreationState

public Map<String,String> getLastCreationState()

setEnableCreation

public void setEnableCreation(boolean enabled)

generateNameFor

public static final String generateNameFor(String variance,
                                           List<String> projects)

generateNameFor

public static final String generateNameFor(String variance,
                                           String... projects)

getDescriptor

public Descriptor<ProjectCreationEngine> getDescriptor()

Specified by:

getDescriptor in interface Describable<ProjectCreationEngine>