hudson.plugins.openstf.util

クラス Utils

java.lang.Object

hudson.plugins.openstf.util.Utils

public class Utils
extends Object

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
Utils()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
static Map<String,String>	convertDeviceToMap(io.swagger.client.model.DeviceListResponseDevices device) Convert DeviceListResponseDevices class instance to Map for serializability on Jenkins.
static Map<String,String>	expandVariables(hudson.EnvVars envVars, Map<String,String> buildVars, Map<String,String> filter) Expands the variable in the given string to its value in the variables available to this build.
static Charset	getDefaultCharset() Gets default charset on node.
static List<io.swagger.client.model.DeviceListResponseDevices>	getDeviceList()
static List<io.swagger.client.model.DeviceListResponseDevices>	getDeviceList(Map<String,String> filter) Gets a list of devices that match the given filter.
static hudson.util.ListBoxModel	getSTFDeviceAttributeListBoxItems() Gets Attribute names of the STF device.
static hudson.util.ComboBoxModel	getSTFDeviceAttributeValueComboBoxItems(String attribute) Gets Attribute values of the STF device.
static hudson.util.ListBoxModel	getSTFDeviceAttributeValueListBoxItems(String attribute) Gets Attribute values of the STF device.
static io.swagger.client.model.DeviceListResponseDevices	getSTFDeviceById(String deviceId) Gets a STF device that matches the given id.
static void	releaseSTFDevice(io.swagger.client.model.DeviceListResponseDevices device) Release a STF device.
static void	remoteConnectSTFDevice(io.swagger.client.model.DeviceListResponseDevices device) Remote connect to a STF device.
static void	remoteDisconnectSTFDevice(io.swagger.client.model.DeviceListResponseDevices device) Remote disconnect to a STF device.
static void	reserveSTFDevice(io.swagger.client.model.DeviceListResponseDevices device) Reserve a STF device.
static void	setupSTFApiClient(String stfApiEndpoint, boolean ignoreCertError, String stfToken) Set the STF API client up by using given information.
static boolean	validateDeviceFilter(Map<String,String> filter) Validates whether the given device filter looks like a valid Regex value.
static boolean	validateRegexValue(String value) Validates whether the given string looks like a valid Regex value.
static hudson.util.FormValidation	validateSTFApiEndpoint(String stfApiEndpoint, boolean ignoreCertError) Validates whether the given URL looks like a valid STF API endpoint.
static hudson.util.FormValidation	validateSTFToken(String stfApiEndpoint, boolean ignoreCertError, String stfToken) Validates whether the given token looks like a valid STF access token.

クラスから継承されたメソッド java.lang.Object

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

コンストラクタの詳細

Utils

public Utils()

メソッドの詳細

convertDeviceToMap

public static Map<String,String> convertDeviceToMap(io.swagger.client.model.DeviceListResponseDevices device)

Convert DeviceListResponseDevices class instance to Map for serializability on Jenkins. This used for STFReservedDeviceAction.

パラメータ:

device - DeviceListResponseDevices class instance.

戻り値:

device information converted as Map instalce.

expandVariables

public static Map<String,String> expandVariables(hudson.EnvVars envVars,
                                                 Map<String,String> buildVars,
                                                 Map<String,String> filter)

Expands the variable in the given string to its value in the variables available to this build. The Jenkins-specific build variables take precedence over environment variables.

パラメータ:

envVars - Map of the environment variables.

buildVars - Map of the build-specific variables.

filter - The json token set which may or may not contain variables in the format ${foo}.

戻り値:

The given json, with applicable variable expansions done.

getDefaultCharset

public static Charset getDefaultCharset()

Gets default charset on node. This method try to get the charset by using Jenkins method first. If that fails, get the JVM Default Charset.

戻り値:

detected charset.

getSTFDeviceAttributeListBoxItems

public static hudson.util.ListBoxModel getSTFDeviceAttributeListBoxItems()

Gets Attribute names of the STF device.

戻り値:

Attribute names of the STF device as ListBoxModel.

getSTFDeviceAttributeValueComboBoxItems

public static hudson.util.ComboBoxModel getSTFDeviceAttributeValueComboBoxItems(String attribute)

Gets Attribute values of the STF device.

パラメータ:

attribute - Attribute name you want to get the values.

戻り値:

Attribute values of the STF device as ComboBoxModel.

getSTFDeviceAttributeValueListBoxItems

public static hudson.util.ListBoxModel getSTFDeviceAttributeValueListBoxItems(String attribute)

Gets Attribute values of the STF device.

パラメータ:

attribute - Attribute name you want to get the values.

戻り値:

Attribute values of the STF device as ListBoxModel.

setupSTFApiClient

public static void setupSTFApiClient(String stfApiEndpoint,
                                     boolean ignoreCertError,
                                     String stfToken)

Set the STF API client up by using given information.

パラメータ:

stfApiEndpoint - stfApiEndpoint The STF API endpoint URL.

stfToken - stfToken The STF access token.

getDeviceList

public static List<io.swagger.client.model.DeviceListResponseDevices> getDeviceList()
                                                                             throws ApiFailedException

例外:

ApiFailedException

getDeviceList

public static List<io.swagger.client.model.DeviceListResponseDevices> getDeviceList(Map<String,String> filter)
                                                                             throws ApiFailedException

Gets a list of devices that match the given filter.

パラメータ:

filter - Conditions of the STF device you want to get.

戻り値:

List of STF devices that meet the filter.

例外:

ApiFailedException - Failed STF API request.

getSTFDeviceById

public static io.swagger.client.model.DeviceListResponseDevices getSTFDeviceById(String deviceId)
                                                                          throws ApiFailedException

Gets a STF device that matches the given id.

パラメータ:

deviceId - The id of the device you want to get.

戻り値:

a STF device that matches the given id.

例外:

ApiFailedException - Failed STF API request.

reserveSTFDevice

public static void reserveSTFDevice(io.swagger.client.model.DeviceListResponseDevices device)
                             throws ApiFailedException

Reserve a STF device.

パラメータ:

device - The device you want to reserve.

例外:

ApiFailedException - Failed STF API request.

remoteConnectSTFDevice

public static void remoteConnectSTFDevice(io.swagger.client.model.DeviceListResponseDevices device)
                                   throws ApiFailedException

Remote connect to a STF device.

パラメータ:

device - The device you want to connect.

例外:

ApiFailedException - Failed STF API request.

remoteDisconnectSTFDevice

public static void remoteDisconnectSTFDevice(io.swagger.client.model.DeviceListResponseDevices device)
                                      throws ApiFailedException

Remote disconnect to a STF device.

パラメータ:

device - The device you want to disconnect.

例外:

ApiFailedException - Failed STF API request.

releaseSTFDevice

public static void releaseSTFDevice(io.swagger.client.model.DeviceListResponseDevices device)
                             throws ApiFailedException

Release a STF device.

パラメータ:

device - The device you want to release.

例外:

ApiFailedException - Failed STF API request.

validateRegexValue

public static boolean validateRegexValue(String value)

Validates whether the given string looks like a valid Regex value.

パラメータ:

value - The Regex string, such as: "/REGEX_VALUE/"

戻り値:

Whether the Regex value looks valid or not.

validateDeviceFilter

public static boolean validateDeviceFilter(Map<String,String> filter)

Validates whether the given device filter looks like a valid Regex value.

パラメータ:

filter - The device condition set.

戻り値:

Whether the Regex value looks valid or not.

validateSTFApiEndpoint

public static hudson.util.FormValidation validateSTFApiEndpoint(String stfApiEndpoint,
                                                                boolean ignoreCertError)

Validates whether the given URL looks like a valid STF API endpoint.

パラメータ:

stfApiEndpoint - The URL string to validate.

戻り値:

Whether the URL looks valid or not.

validateSTFToken

public static hudson.util.FormValidation validateSTFToken(String stfApiEndpoint,
                                                          boolean ignoreCertError,
                                                          String stfToken)

Validates whether the given token looks like a valid STF access token.

パラメータ:

stfApiEndpoint - The STF API Endpoint URL for use in verification.

stfToken - The token string to validate.

戻り値:

Whether the STF token looks valid or not.