PluginConstructorParameters (Apama API Documentation 10.15.1.2)

All Known Subinterfaces:

ManagedTransportConstructorParameters, PluginConstructorParameters.CodecConstructorParameters, PluginConstructorParameters.TransportConstructorParameters
```
public interface PluginConstructorParameters
```
A base interface for parameters passed to the constructor of transport or codec plug-ins.
Compatibility note: new methods may be added to this interface in future releases.

Since:

9.12.0.1

See Also:

PluginConstructorParameters.TransportConstructorParameters, PluginConstructorParameters.CodecConstructorParameters

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static interface`	`PluginConstructorParameters.CodecConstructorParameters`	A container for parameters passed to the constructor of a codec plug-in.
`static interface`	`PluginConstructorParameters.TransportConstructorParameters`	A container for parameters passed to the constructor of a transport plug-in.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.lang.String`	`getChainId()`
`java.util.Map<java.lang.String,java.lang.Object>`	`getConfig()`	Get the configuration for this plug-in.
`PluginHost`	`getPluginHost()`
`java.lang.String`	`getPluginName()`
`StatusReporter`	`getStatusReporter()`

- Method Detail
  - getConfig
```
java.util.Map<java.lang.String,java.lang.Object> getConfig()
```
    Get the configuration for this plug-in. Consider using MapExtractor to extract the required values from the configuration map(s).
    
    Returns:
    
    the configuration for this plug-in. This object is owned by the plug-in and can be mutated by the plug-in if desired.
    
    See Also:
    
    MapExtractor
  - getChainId
```
java.lang.String getChainId()
```
    Returns:
    
    the identifier used for the chain this plug-in is part of.
  - getPluginName
```
java.lang.String getPluginName()
```
    Returns:
    
    the name used for this plug-in in the configuration file.
  - getStatusReporter
```
StatusReporter getStatusReporter()
```
    Returns:
    
    an interface that can be used for reporting status values to the host.
    
    Since:
    
    10.0
  - getPluginHost
```
PluginHost getPluginHost()
```
    Returns:
    
    Interface to support miscellaneous requests from this plug-in to the host system.
    
    Since:
    
    10.0