com.perforce.halm.jenkins.globalconfig

Class HALMConnection

java.lang.Object

hudson.model.AbstractDescribableImpl<HALMConnection>

com.perforce.halm.jenkins.globalconfig.HALMConnection

All Implemented Interfaces:

Describable<HALMConnection>, Serializable

public class HALMConnection
extends AbstractDescribableImpl<HALMConnection>
implements Serializable

Global setting that defines a single Helix ALM REST API connection

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HALMConnection.AbstractResult Abstract base class for results, provides common error handling.
static class	HALMConnection.AuthInfoResult Authorization information result
static class	HALMConnection.CredentialDetailsResult Credentials information result
static class	HALMConnection.DescriptorImpl Used for validating the HALMConnection's config.jelly
static class	HALMConnection.OptionalConnectionProps Optional connection properties

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	acceptSSLCertificates Deprecated. See HALMConnection.OptionalConnectionProps. This is only here to ensure we can upgrade old configurations.

Constructor Summary

Constructors

Constructor and Description
HALMConnection(String connectionUUID, String connectionName, String halmAPIAddress, String credentialsID) Constructor.

Method Summary

Modifier and Type	Method and Description
List<String>	getAcceptedSSLCertificates()
boolean	getAcceptSSLCertificates() This is here due to what looks like an odd bug in Jenkins? I would expect HALMConnection.OptionalConnectionProps to be invoked to retrieve this information, however the setting did not appear to be populated in the UI until I added this.
HALMConnection.AuthInfoResult	getAuthInfo() We need to check for a variety of conditions while parsing the credentials.
protected static HALMConnection.AuthInfoResult	getAuthInfo(com.perforce.halm.reportingtool.APIAuthType authType, String credentialsID) We need to check for a variety of conditions while parsing the credentials.
String	getConnectionName()
String	getConnectionUUID()
HALMConnection.CredentialDetailsResult	getCredentialDetails() Retrieves credential info (username // password)
static HALMConnection.CredentialDetailsResult	getCredentialDetails(String credentialsID) Retrieves credential info (username // password)
String	getCredentialsID()
com.perforce.halm.reportingtool.APIAuthType	getCredentialsType()
String	getCredentialTypeValue()
String	getHalmAPIAddress()
HALMConnection.OptionalConnectionProps	getOptionalConnectionProps()
boolean	getOptionalConnectionPropsIsSet() This governs if the 'optional' checkbox is checked or not.
protected Object	readResolve() This allows upgrading old, saved XML configuration values to the current format.
void	setAcceptedSSLCertificates(List<String> acceptedSSLCertificates)
void	setAcceptSSLCertificates(boolean acceptSSLCertificates) This is left for legacy support when 'AcceptSSLCertificates' was a top-level property.
void	setConnectionName(String connectionName)
void	setCredentialsID(String credentialsID)
void	setCredentialType(com.perforce.halm.reportingtool.APIAuthType credentialType)
void	setCredentialTypeValue(String credentialType)
void	setHalmAPIAddress(String halmAPIAddress)
void	setOptionalConnectionProps(HALMConnection.OptionalConnectionProps optionalConnectionProps) Sets the optional connection properties

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Field Detail

acceptSSLCertificates

protected transient Boolean acceptSSLCertificates

Deprecated. See HALMConnection.OptionalConnectionProps. This is only here to ensure we can upgrade old configurations.

Constructor Detail

HALMConnection

@DataBoundConstructor
public HALMConnection(String connectionUUID,
                                            String connectionName,
                                            String halmAPIAddress,
                                            String credentialsID)

Constructor.

Parameters:

connectionUUID - - Unique connection ID

connectionName - - the (hopefully unique) connection name.

halmAPIAddress - - Helix ALM API REST API address

credentialsID - - ID of the credentials

Method Detail

getConnectionUUID

public String getConnectionUUID()

Returns:

Unique, unfriendly, connection ID

getConnectionName

public String getConnectionName()

Returns:

Friendly connection name. May be empty. Maybe a duplicate of another connection. Prefer this (if it exists) when generating Pipeline syntax.

setConnectionName

@DataBoundSetter
public final void setConnectionName(String connectionName)

Parameters:

connectionName - New connection ID to set

getHalmAPIAddress

public String getHalmAPIAddress()

Returns:

Helix ALM REST API address

setHalmAPIAddress

@DataBoundSetter
public final void setHalmAPIAddress(String halmAPIAddress)

Parameters:

halmAPIAddress - Helix ALM REST API address

getCredentialTypeValue

public String getCredentialTypeValue()

Returns:

Credential type, for use w/ setting the global config dropdown

setCredentialTypeValue

@DataBoundSetter
public final void setCredentialTypeValue(String credentialType)

Parameters:

credentialType - Credential type, as set on the global config dropdown.

getCredentialsType

public com.perforce.halm.reportingtool.APIAuthType getCredentialsType()

Returns:

Type of credentials (basic vs API Key)

setCredentialType

public void setCredentialType(com.perforce.halm.reportingtool.APIAuthType credentialType)

Parameters:

credentialType - Type of credentials (basic vs API Key)

getCredentialsID

public String getCredentialsID()

Returns:

ID of the credentials as stored in the Credentials plugin

setCredentialsID

@DataBoundSetter
public final void setCredentialsID(String credentialsID)

Parameters:

credentialsID - ID of the credentials as stored in the Credentials plugin

setAcceptSSLCertificates

@DataBoundSetter
public final void setAcceptSSLCertificates(boolean acceptSSLCertificates)

This is left for legacy support when 'AcceptSSLCertificates' was a top-level property. Old configurations may be saved with this setting and they need this function to self-upgrade the configuration.

Parameters:

acceptSSLCertificates - Are we accepting SSL certificates

getAcceptSSLCertificates

public final boolean getAcceptSSLCertificates()

This is here due to what looks like an odd bug in Jenkins? I would expect HALMConnection.OptionalConnectionProps to be invoked to retrieve this information, however the setting did not appear to be populated in the UI until I added this.

Returns:

Returns the current setting for 'acceptSSLCertificates'

getOptionalConnectionPropsIsSet

public boolean getOptionalConnectionPropsIsSet()

This governs if the 'optional' checkbox is checked or not.

Returns:

Is the optional connection props set?

getOptionalConnectionProps

public HALMConnection.OptionalConnectionProps getOptionalConnectionProps()

Returns:

The currently set optional properties object. This may be null

setOptionalConnectionProps

@DataBoundSetter
public void setOptionalConnectionProps(HALMConnection.OptionalConnectionProps optionalConnectionProps)

Sets the optional connection properties

Parameters:

optionalConnectionProps - Optional connection properties to set.

getAcceptedSSLCertificates

public List<String> getAcceptedSSLCertificates()

Returns:

List of accepted SSL certificates.

setAcceptedSSLCertificates

@DataBoundSetter
public void setAcceptedSSLCertificates(List<String> acceptedSSLCertificates)

Parameters:

acceptedSSLCertificates - Set list of accepted SSL certificates

readResolve

protected Object readResolve()

This allows upgrading old, saved XML configuration values to the current format.

Returns:

The newly resolved // read in object.

getCredentialDetails

public HALMConnection.CredentialDetailsResult getCredentialDetails()

Retrieves credential info (username // password)

Returns:

A CredentialDetailsResult object with either the credentials, or an error.

getCredentialDetails

public static HALMConnection.CredentialDetailsResult getCredentialDetails(String credentialsID)

Retrieves credential info (username // password)

Parameters:

credentialsID - Jenkins Credentials ID

Returns:

A CredentialDetailsResult object with either the credentials, or an error.

getAuthInfo

public HALMConnection.AuthInfoResult getAuthInfo()

We need to check for a variety of conditions while parsing the credentials. This handles all the odd edge cases and ensures we handle and return appropriate errors.

Returns:

An authorization info result which either contains the auth info, or an error message indicating failure.

getAuthInfo

protected static HALMConnection.AuthInfoResult getAuthInfo(com.perforce.halm.reportingtool.APIAuthType authType,
                                                           String credentialsID)

We need to check for a variety of conditions while parsing the credentials. This handles all the odd edge cases and ensures we handle and return appropriate errors.

Parameters:

authType - Authorization type (API Key vs Basic)

credentialsID - Jenkins Credentials ID

Returns:

An authorization info result which either contains the auth info, or an error message indicating failure.