ScriptTourLoader (core 5.1.0-20240214 API)

java.lang.Object
- com.dtolabs.rundeck.core.plugins.AbstractDescribableScriptPlugin
- - com.dtolabs.rundeck.core.plugins.BaseScriptPlugin
  - - com.dtolabs.rundeck.core.execution.service.ScriptTourLoader

All Implemented Interfaces:: ProxySecretBundleCreator, Describable, TourLoaderPlugin

public class ScriptTourLoader
extends BaseScriptPlugin
implements TourLoaderPlugin

Field Summary
- Fields inherited from class com.dtolabs.rundeck.core.plugins.AbstractDescribableScriptPlugin
  CONFIG_BLANK_IF_UNEXPANDED, CONFIG_DEFAULT, CONFIG_DESCRIPTION, CONFIG_LABELS, CONFIG_NAME, CONFIG_PROP_PREFIX, CONFIG_RENDERING_OPTIONS, CONFIG_REQUIRED, CONFIG_SCOPE, CONFIG_TITLE, CONFIG_TYPE, CONFIG_VALUES, DESCRIPTION_PROP, SETTING_MERGE_ENVIRONMENT, TITLE_PROP

Constructor Summary

Constructors
Constructor Description

ScriptTourLoader(ScriptPluginProvider provider, ServiceProviderLoader pluginManager)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.Map`	`getTour(java.lang.String tourId)`
`java.util.Map`	`getTourManifest()`
`boolean`	`isAllowCustomProperties()`

Methods inherited from class com.dtolabs.rundeck.core.plugins.BaseScriptPlugin
createScriptArgs, createScriptArgsList, createScriptDataContext, createScriptDataContext, createStepItemDataContext, getScriptExecHelper, listSecretsPath, listSecretsPathWorkflowNodeStep, listSecretsPathWorkflowStep, prepareSecretBundle, prepareSecretBundleWorkflowNodeStep, prepareSecretBundleWorkflowStep, runPluginScript, setScriptExecHelper

Methods inherited from class com.dtolabs.rundeck.core.plugins.AbstractDescribableScriptPlugin
createDescription, createDescription, createPluginData, getDescription, getFramework, getProvider, isUseConventionalPropertiesMapping, loadConfigData, loadContentConversionPropertyValues, loadInstanceDataFromNodeAttributes

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.dtolabs.rundeck.core.execution.proxy.ProxySecretBundleCreator
listSecretsPathResourceModel, prepareSecretBundleResourceModel

Methods inherited from interface com.dtolabs.rundeck.plugins.tours.TourLoaderPlugin
getTour, getTourManifest

- Constructor Detail
  - ScriptTourLoader
```
public ScriptTourLoader(ScriptPluginProvider provider,
                        ServiceProviderLoader pluginManager)
```
- Method Detail
  - isAllowCustomProperties
```
public boolean isAllowCustomProperties()
```
    Specified by:
    
    isAllowCustomProperties in class AbstractDescribableScriptPlugin
    
    Returns:
    
    true if the script-plugin allows custom configuration properties defined in plugin metadata.
  - getTourManifest
```
public java.util.Map getTourManifest()
```
    Specified by:
    
    getTourManifest in interface TourLoaderPlugin
  - getTour
```
public java.util.Map getTour(java.lang.String tourId)
```
    Specified by:
    
    getTour in interface TourLoaderPlugin