com.absint.a3

Class A3Builder.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<T>

hudson.tasks.BuildStepDescriptor<hudson.tasks.Builder>

com.absint.a3.A3Builder.DescriptorImpl

All Implemented Interfaces:

hudson.model.Saveable

Enclosing class:

A3Builder

@Extension
public static final class A3Builder.DescriptorImpl
extends hudson.tasks.BuildStepDescriptor<hudson.tasks.Builder>

Descriptor for A3Builder. Used as a singleton. The class is marked as public so that it can be accessed from views.

Nested Class Summary

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

hudson.model.Descriptor.FormException, hudson.model.Descriptor.PropertyType, hudson.model.Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
DescriptorImpl() Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData) Sets a new configuration.
static boolean	containsEnvVars(String s) Helper method to check whether a string contains an environment variable of form ${IDENTIFIER}
hudson.util.FormValidation	doCheckA3packages(String value) Performs on-the-fly validation of the form field 'a3packages'.
hudson.util.FormValidation	doCheckAlauncher(String value) Performs on-the-fly validation of the form field 'alauncher'.
hudson.util.FormValidation	doCheckAnalysis_ids(String value) Performs on-the-fly validation of the form field 'timingprofiler_dir'.
hudson.util.FormValidation	doCheckProject_file(String value) Performs on-the-fly validation of the form field 'project_file'.
String	getA3packages() Returns the build number a3 installation is restricted to.
String	getAlauncher() Returns the currently configured a3 windows installer package.
String	getAlmport() Returns the currently configured alm (AbsInt Licenseserver manager) server name
String	getAlmserver() Returns the currently configured alm (AbsInt Licenseserver manager) server name
String	getDisplayName() Return the human readable name used in the configuration screen.
boolean	isApplicable(Class<? extends hudson.model.AbstractProject> aClass) Indicates that this builder can be used with all kinds of project types.

Methods inherited from class hudson.tasks.BuildStepDescriptor

filter

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, findByDescribableClassName, findById, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

DescriptorImpl

public DescriptorImpl()

Constructor.
Constructs a new object of this class and loads the persisted global configuration.

Method Detail

getDisplayName

public String getDisplayName()

Return the human readable name used in the configuration screen.

Specified by:

getDisplayName in class hudson.model.Descriptor<hudson.tasks.Builder>

Returns:

java.lang.String

doCheckAnalysis_ids

public hudson.util.FormValidation doCheckAnalysis_ids(@QueryParameter
                                                      String value)
                                               throws IOException,
                                                      javax.servlet.ServletException

Performs on-the-fly validation of the form field 'timingprofiler_dir'.

Parameters:

value - The value that the user has typed.

Returns:

Indicates the outcome of the validation. This is sent to the browser.
Note that returning FormValidation.error(String) does not prevent the form from being saved. It just means that a message will be displayed to the user.

Throws:

IOException - as super class

javax.servlet.ServletException - as super class

containsEnvVars

public static final boolean containsEnvVars(String s)

Helper method to check whether a string contains an environment variable of form
${IDENTIFIER}

Parameters:

s - String to scan for environment variable expressions

Returns:

Outcome of the check as a boolean (true if such an expression was found, otherwise false).

doCheckAlauncher

public hudson.util.FormValidation doCheckAlauncher(@QueryParameter
                                                   String value)
                                            throws IOException,
                                                   javax.servlet.ServletException

Performs on-the-fly validation of the form field 'alauncher'.

Parameters:

value - The value that the user has typed.

Returns:

Indicates the outcome of the validation. This is sent to the browser.
Note that returning FormValidation.error(String) does not prevent the form from being saved. It just means that a message will be displayed to the user.

Throws:

IOException - as super class

javax.servlet.ServletException - as super class

doCheckA3packages

public hudson.util.FormValidation doCheckA3packages(@QueryParameter
                                                    String value)
                                             throws IOException,
                                                    javax.servlet.ServletException

Performs on-the-fly validation of the form field 'a3packages'.

Parameters:

value - The value that the user has typed.

Returns:

Indicates the outcome of the validation. This is sent to the browser.
Note that returning FormValidation.error(String) does not prevent the form from being saved. It just means that a message will be displayed to the user.

Throws:

IOException - as super class

javax.servlet.ServletException - as super class

doCheckProject_file

public hudson.util.FormValidation doCheckProject_file(@QueryParameter
                                                      String value)
                                               throws IOException,
                                                      javax.servlet.ServletException

Performs on-the-fly validation of the form field 'project_file'.

Parameters:

value - This parameter receives the value that the user has typed.

Returns:

Indicates the outcome of the validation. This is sent to the browser.
Note that returning FormValidation.error(String) does not prevent the form from being saved. It just means that a message will be displayed to the user.

Throws:

IOException - as super class

javax.servlet.ServletException - as super class

isApplicable

public boolean isApplicable(Class<? extends hudson.model.AbstractProject> aClass)

Indicates that this builder can be used with all kinds of project types.

Specified by:

isApplicable in class hudson.tasks.BuildStepDescriptor<hudson.tasks.Builder>

Returns:

boolean

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest req,
                         net.sf.json.JSONObject formData)
                  throws hudson.model.Descriptor.FormException

Sets a new configuration.

Overrides:

configure in class hudson.model.Descriptor<hudson.tasks.Builder>

Throws:

FormException - as super class

hudson.model.Descriptor.FormException

getAlauncher

public String getAlauncher()

Returns the currently configured a3 windows installer package.

Returns:

java.lang.String

getA3packages

public String getA3packages()

Returns the build number a3 installation is restricted to.

Returns:

java.lang.String

getAlmserver

public String getAlmserver()

Returns the currently configured alm (AbsInt Licenseserver manager) server name

Returns:

java.lang.String

getAlmport

public String getAlmport()

Returns the currently configured alm (AbsInt Licenseserver manager) server name

Returns:

java.lang.String