PipelineManager (Ametys 4.2.x

java.lang.Object
- org.ametys.runtime.plugin.component.AbstractLogEnabled
- - org.ametys.plugins.extraction.execution.pipeline.PipelineManager

All Implemented Interfaces:: LogEnabled, Disposable, Initializable, Component, Serviceable

public class PipelineManager
extends AbstractLogEnabled
implements Component, Serviceable, Initializable, Disposable

Manager of PipelineDescriptors

Field Summary

Fields
Modifier and Type	Field and Description
`private static String`	`__NO_OP_PIPELINE_ID`
`private Map<String,Long>`	`_lastReading`
`private PipelineDescriptor`	`_noOpPipelineDesc`
`private Map<String,PipelineDescriptor>`	`_pipelineDescCache`
`private SourceResolver`	`_resolver`
`private PipelineSerializerModelExtensionPoint`	`_serializerEP`
`static String`	`ROLE` The Avalon role.

Constructor Summary

Constructors
Constructor and Description

PipelineManager()

Constructors
Constructor and Description
`PipelineManager()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private Path`	`_absolutePath(String relativePath)`
`private static Long`	`_now()`
`private void`	`_readAll()`
`private PipelineDescriptor`	`_readAndGetPipeline(String id)`
`private Pair<String,PipelineDescriptor>`	`_readPipeline(Path pipelinePath)`
`void`	`dispose()`
`PipelineDescriptor`	`get(String id)` Gets the `PipelineDescriptor` for the given id
`String`	`getDefaultPipeline()` Gets the id of the default `PipelineDescriptor`
`Map<String,I18nizableText>`	`getEnumeration()` Gets all the `PipelineDescriptor`s labels by id
`List<Map<String,Object>>`	`getJsonEnumeration()` Gets all the `PipelineDescriptor`s as JSON
`boolean`	`has(String id)` Returns `true` if the `PipelineDescriptor` for asked id exists
`void`	`initialize()`
`void`	`service(ServiceManager manager)`

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled
getLogger, setLogger

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

- Field Detail
  - ROLE
```
public static final String ROLE
```
    The Avalon role.
  - __NO_OP_PIPELINE_ID
```
private static final String __NO_OP_PIPELINE_ID
```
  - _noOpPipelineDesc
```
private PipelineDescriptor _noOpPipelineDesc
```
  - _pipelineDescCache
```
private Map<String,PipelineDescriptor> _pipelineDescCache
```
  - _lastReading
```
private Map<String,Long> _lastReading
```
  - _resolver
```
private SourceResolver _resolver
```
  - _serializerEP
```
private PipelineSerializerModelExtensionPoint _serializerEP
```
- Constructor Detail
  - PipelineManager
```
public PipelineManager()
```
- Method Detail
  - service
```
public void service(ServiceManager manager)
             throws ServiceException
```
    Specified by:
    
    service in interface Serviceable
    
    Throws:
    
    ServiceException
  - initialize
```
public void initialize()
                throws Exception
```
    Specified by:
    
    initialize in interface Initializable
    
    Throws:
    
    Exception
  - dispose
```
public void dispose()
```
    Specified by:
    
    dispose in interface Disposable
  - has
```
public boolean has(String id)
            throws IOException
```
    Returns true if the PipelineDescriptor for asked id exists
    
    Parameters:
    
    id - The id of the PipelineDescriptor
    
    Returns:
    
    true if the asked pipeline exists
    
    Throws:
    
    IOException - if an I/O exception occured when accessing the root folder of pipeline files
  - get
```
public PipelineDescriptor get(String id)
                       throws IOException
```
    Gets the PipelineDescriptor for the given id
    
    Parameters:
    
    id - The id of the PipelineDescriptor
    
    Returns:
    
    the request PipelineDescriptor, or null if not found
    
    Throws:
    
    IOException - if an I/O exception occured when accessing the root folder of pipeline files
  - getEnumeration
```
public Map<String,I18nizableText> getEnumeration()
                                          throws IOException
```
    Gets all the PipelineDescriptors labels by id
    
    Returns:
    
    the PipelineDescriptors labels by id
    
    Throws:
    
    IOException - if an I/O exception occured when accessing the root folder of pipeline files
  - getJsonEnumeration
```
public List<Map<String,Object>> getJsonEnumeration()
                                            throws IOException
```
    Gets all the PipelineDescriptors as JSON
    
    Returns:
    
    the PipelineDescriptors as JSON
    
    Throws:
    
    IOException - if an I/O exception occured when accessing the root folder of pipeline files
  - getDefaultPipeline
```
public String getDefaultPipeline()
```
    Gets the id of the default PipelineDescriptor
    
    Returns:
    
    the id of the default PipelineDescriptor
  - _readAndGetPipeline
```
private PipelineDescriptor _readAndGetPipeline(String id)
                                        throws IOException
```
    Throws:
    
    IOException
  - _readAll
```
private void _readAll()
               throws IOException
```
    Throws:
    
    IOException
  - _absolutePath
```
private Path _absolutePath(String relativePath)
                    throws IOException
```
    Throws:
    
    IOException
  - _readPipeline
```
private Pair<String,PipelineDescriptor> _readPipeline(Path pipelinePath)
```
  - _now
```
private static Long _now()
```

Class PipelineManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

Methods inherited from class java.lang.Object

Field Detail

ROLE

__NO_OP_PIPELINE_ID

_noOpPipelineDesc

_pipelineDescCache

_lastReading

_resolver

_serializerEP

Constructor Detail

PipelineManager

Method Detail

service

initialize

dispose

has

get

getEnumeration

getJsonEnumeration

getDefaultPipeline

_readAndGetPipeline

_readAll

_absolutePath

_readPipeline

_now