com.ca.mat.application.performance.view

Class MultipleEntryFields<T>

java.lang.Object

com.ca.mat.application.performance.view.PerformanceBenchmarking

com.ca.mat.application.performance.view.MultipleEntryFields<T>

Type Parameters:

T - - the generic type that represents the entry

All Implemented Interfaces:

ExtensionPoint, Action, Describable<PerformanceBenchmarking>, ModelObject

Direct Known Subclasses:

CreateProfile, InclusionsAndExclusions

public abstract class MultipleEntryFields<T>
extends PerformanceBenchmarking

This abstract class represents the superclass for the CreateProfile class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	MultipleEntryFields.ProgressViewRendering This class represents the progressive rendering that displays the progress bar on the UI.

Nested classes/interfaces inherited from class com.ca.mat.application.performance.view.PerformanceBenchmarking

PerformanceBenchmarking.SourceFile

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
protected ZoweCommandLineBuilder	zoweCmd The command line builder.

Constructor Summary

Constructors

Constructor and Description
MultipleEntryFields() Default constructor.

Method Summary

Modifier and Type	Method and Description
org.kohsuke.stapler.HttpResponse	doConfigSubmit(org.kohsuke.stapler.StaplerRequest req) This method handles the post request after pressing the save button on the config UI.
ProgressiveRendering	entries() This method returns the class instance that will handle the progress bar handler.
XmlFile	getConfigFile() Get the configuration file.
List<EntryAction<T>>	getDifferentEntries(List<T> firstCompared, List<T> secondCompared, EntryAction.ActionType type) Get the different entries.
abstract List<T>	getEntries() Returns the list of entries.
protected abstract String	getFinalUpdatedMessage(boolean isUpdated, String actionText, T entry) Returns the final message from a update of new entry action.
protected abstract String	getMainField(T entry) Refers to an unique field that represents the entry, e.g.: a name or ID.
protected abstract String	getMainFieldLabel(T entry) Refers to an unique label field that represents the entry, like a name or ID.
List<EntryAction<T>>	getModifiedEntries() Retrieves the list of modified entries.
abstract Collection<Callable<List<T>>>	getProcesses() Get the collection of the processes to retrieve the configuration on the start-up.
List<PerformanceBenchmarking.SourceFile>	getSourceFiles() Source files associated with this sample.
abstract String	getXMLFile() Returns the XMLFile name to be stored in the jenkins_home.
protected abstract String	handleSingleDelete(EntryAction<T> entry) Handles a single new delete entry after saving the configuration.
protected abstract String	handleSingleNewEntry(EntryAction<T> entry) Handles a single new swipeable entry after saving the configuration.
protected abstract String	handleSingleUpdate(UpdateAction<T> entry) Handles a single new update entry after saving the configuration.
protected abstract boolean	invalidEntries() Evaluates whether the configuration has invalid entries.
protected abstract boolean	isSuccessful(String result) Handles whether the output of the entry action is successful.
protected abstract void	postProcessEntries() Post processes the entries after the action items.
protected void	processSingleEntry(EntryAction<T> entry) Processes the single entry action.
protected abstract void	setConfig(MultipleEntryFields<T> read) Sets the configuration after the object modification.
abstract List<T>	setEntries(List<T> entries) Set the list of entries.

Methods inherited from class com.ca.mat.application.performance.view.PerformanceBenchmarking

all, doSourceFile, getDescription, getDescriptor, getDisplayName, getGroovySamples, getIconFileName, getOtherSamples, getUrlName

Methods inherited from class java.lang.Object

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

Field Detail

zoweCmd

protected ZoweCommandLineBuilder zoweCmd

The command line builder.

Constructor Detail

MultipleEntryFields

public MultipleEntryFields()

Default constructor.

Method Detail

getConfigFile

public XmlFile getConfigFile()

Get the configuration file.

Returns:

the configuration file.

getModifiedEntries

public List<EntryAction<T>> getModifiedEntries()

Retrieves the list of modified entries.

Returns:

the list of entry actions.

getXMLFile

public abstract String getXMLFile()

Returns the XMLFile name to be stored in the jenkins_home.

Returns:

the xml file name

setConfig

protected abstract void setConfig(MultipleEntryFields<T> read)

Sets the configuration after the object modification.

Parameters:

read - - the previous instance.

postProcessEntries

protected abstract void postProcessEntries()

Post processes the entries after the action items.

isSuccessful

protected abstract boolean isSuccessful(String result)

Handles whether the output of the entry action is successful.

Parameters:

result - - the result of the entry action, e.g.: the command output after saving the config file.

Returns:

whether the result is successful or not

getFinalUpdatedMessage

protected abstract String getFinalUpdatedMessage(boolean isUpdated,
                                                 String actionText,
                                                 T entry)

Returns the final message from a update of new entry action.

Parameters:

isUpdated - - whether an update action occurred.

actionText - - action response, .e.g: the command output

entry - - the generic type that represents the entry

Returns:

the final updated message

handleSingleNewEntry

protected abstract String handleSingleNewEntry(EntryAction<T> entry)

Handles a single new swipeable entry after saving the configuration. e.g.: a command, a rest call, a file save.

Parameters:

entry - - the generic type that corresponds the entry.

Returns:

the entry action or result

handleSingleUpdate

protected abstract String handleSingleUpdate(UpdateAction<T> entry)

Handles a single new update entry after saving the configuration. e.g.: a command, a rest call, a file save.

Parameters:

entry - - the generic type that corresponds the entry.

Returns:

the entry action or result

handleSingleDelete

protected abstract String handleSingleDelete(EntryAction<T> entry)

Handles a single new delete entry after saving the configuration.

Parameters:

entry - - the generic type that corresponds the entry.

Returns:

the entry action or result

getMainFieldLabel

protected abstract String getMainFieldLabel(T entry)

Refers to an unique label field that represents the entry, like a name or ID.

Parameters:

entry - - the generic type that corresponds the entry.

Returns:

the entry action or result

getMainField

protected abstract String getMainField(T entry)

Refers to an unique field that represents the entry, e.g.: a name or ID.

Parameters:

entry - - the generic type that corresponds the entry.

Returns:

the entry action or result

invalidEntries

protected abstract boolean invalidEntries()

Evaluates whether the configuration has invalid entries.

Returns:

whether the configuration has an invalid entry

getEntries

public abstract List<T> getEntries()

Returns the list of entries.

Returns:

List of saved entries

setEntries

public abstract List<T> setEntries(List<T> entries)

Set the list of entries.

Parameters:

entries - the list of entries

Returns:

the list of entries.

getProcesses

public abstract Collection<Callable<List<T>>> getProcesses()

Get the collection of the processes to retrieve the configuration on the start-up.

Returns:

the future processes to be concurrently processed.

getSourceFiles

public List<PerformanceBenchmarking.SourceFile> getSourceFiles()

Description copied from class: PerformanceBenchmarking

Source files associated with this sample.

Overrides:

getSourceFiles in class PerformanceBenchmarking

Returns:

the list of source files

entries

public ProgressiveRendering entries()

This method returns the class instance that will handle the progress bar handler.

Returns:

the instance that binds the UI with the control class.

processSingleEntry

protected void processSingleEntry(EntryAction<T> entry)

Processes the single entry action.

Parameters:

entry - the generic type representing the entry.

doConfigSubmit

@POST
public org.kohsuke.stapler.HttpResponse doConfigSubmit(org.kohsuke.stapler.StaplerRequest req)
                                                       throws javax.servlet.ServletException,
                                                              IOException

This method handles the post request after pressing the save button on the config UI.

Parameters:

req - - the POST request

Returns:

The POST request HTTP response

Throws:

javax.servlet.ServletException - if an error occurs in the application server

IOException - if an I/O error occurs

getDifferentEntries

public List<EntryAction<T>> getDifferentEntries(List<T> firstCompared,
                                                List<T> secondCompared,
                                                EntryAction.ActionType type)

Get the different entries.

Parameters:

firstCompared - the first compared list

secondCompared - the second compared list

type - the action type

Returns:

list of entry actions.