com.viviquity.jenkins.yumparamater

Class PersistentYumParameterDefinition

java.lang.Object

hudson.model.ParameterDefinition

hudson.model.SimpleParameterDefinition

com.viviquity.jenkins.yumparamater.PersistentYumParameterDefinition

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.model.ParameterDefinition>, Serializable

public class PersistentYumParameterDefinition
extends hudson.model.SimpleParameterDefinition

yum-paramater Definition for a parameter that looks up the deployed packages for a given repository. This is specifically for AWS S3 hosted repos at the moment, but would be nice to extend this to accommodate other location types. It should be very straightforward to do this.

Since:

14/02/15

Author:

Declan Newman (467689)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PersistentYumParameterDefinition.DescriptorImpl The descriptor for outlining the behavior of the config panel.

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

hudson.model.ParameterDefinition.ParameterDescriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.ParameterDefinition

LIST

Constructor Summary

Constructors

Constructor and Description
PersistentYumParameterDefinition(String name, String description, boolean useAwsKeys, String awsAccessKeyId, String awsSecretAccessKey, String bucketName, String repoPath) Default constructor

Method Summary

Modifier and Type	Method and Description
static boolean	areValidChoices(String choices) Allows us to validate the choices.
hudson.model.ParameterValue	createValue(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject jo) Create a parameter value from a form submission.
hudson.model.ParameterValue	createValue(String value) Creates a ParameterValue from the string representation.
String	getAwsAccessKeyId() Parameter for retrieving the value in the config form
String	getAwsSecretAccessKey() Parameter for retrieving the value in the config form
String	getBucketName() Parameter for retrieving the value in the config form
Map<String,String>	getChoices() Returns the choices for the drop down.
String	getRepoPath() Parameter for retrieving the value in the config form
boolean	isUseAwsKeys() Parameter for retrieving the value in the config form

Methods inherited from class hudson.model.SimpleParameterDefinition

createValue, createValue

Methods inherited from class hudson.model.ParameterDefinition

all, copyWithDefaultValue, getDefaultParameterValue, getDescription, getDescriptor, getFormattedDescription, getName, getType

Methods inherited from class java.lang.Object

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

Constructor Detail

PersistentYumParameterDefinition

@DataBoundConstructor
public PersistentYumParameterDefinition(String name,
                                                              String description,
                                                              boolean useAwsKeys,
                                                              String awsAccessKeyId,
                                                              String awsSecretAccessKey,
                                                              String bucketName,
                                                              String repoPath)

Default constructor

Parameters:

name - the name of the parameter. This will passed to the build as a variable

description - what is the description that the user has supplied for the parameter

useAwsKeys - the boolean flag, that tells us if we need to supply authentication when calling S3.

awsAccessKeyId - the access key, if required.

awsSecretAccessKey - the secret access key, if required.

bucketName - the name of the S3 bucket where the repo is hosted.

repoPath - the path to target the S3 repo.

Method Detail

areValidChoices

public static boolean areValidChoices(String choices)

Allows us to validate the choices. Currently always returns true.

Parameters:

choices - to be validated

Returns:

true if the choices are valid (always true)

createValue

public hudson.model.ParameterValue createValue(String value)

Creates a ParameterValue from the string representation.

Specified by:

createValue in class hudson.model.SimpleParameterDefinition

Parameters:

value - the value of the parameter to be used

createValue

public hudson.model.ParameterValue createValue(org.kohsuke.stapler.StaplerRequest req,
                                               net.sf.json.JSONObject jo)

Create a parameter value from a form submission. This method is invoked when the user fills in the parameter values in the HTML form and submits it to the server.

Specified by:

createValue in class hudson.model.ParameterDefinition

Parameters:

req - the StaplerRequest when the user saves values for the parameter

jo - the JSONObject containing the values for the parameter

getChoices

@Exported
public Map<String,String> getChoices()
                                        throws JAXBException,
                                               IOException

Returns the choices for the drop down. This is will attempt to locate the primary.xml repo data, and populate the drop-down.

Returns:

the Map of options to be displayed to the user when building with parameters.

Throws:

JAXBException - if unable to unmarshal the data

IOException - if we're unable to open the stream for whatever reason. This could be that the AWS S3 request failed for other reasons too.

isUseAwsKeys

public boolean isUseAwsKeys()

Parameter for retrieving the value in the config form

Returns:

true if the checkbox has been selected.

getAwsAccessKeyId

public String getAwsAccessKeyId()

Parameter for retrieving the value in the config form

Returns:

the AWS access key that has been stored in the config.

getAwsSecretAccessKey

public String getAwsSecretAccessKey()

Parameter for retrieving the value in the config form

Returns:

the AWS secret access key that has been stored in the config.

getBucketName

public String getBucketName()

Parameter for retrieving the value in the config form

Returns:

the AWS secret bucket name that has been stored in the config.

getRepoPath

public String getRepoPath()

Parameter for retrieving the value in the config form

Returns:

the repo to be used when looking for the primary.xml file