Documentation
7.16. Extension API¶
The extension event handler can be configured to allow the creation of custom event handlers implemented using the SFTPPlus API.
The extension code will be placed inside the extension folder located in the SFTPPlus base installation folder.
This event handler is targeted toward application developers.
7.16.1. name¶
- Default value
''
- Optional
No
- From version
2.10.0
- Values
Any text.
- Description
Human-readable short text used to identify this event handler.
7.16.2. description¶
- Default value
''
- Optional
Yes
- From version
2.10.0
- Values
Any text.
- Description
Human-readable text that describes the purpose of this event handler.
7.16.3. type¶
- Default value
''
- Optional
No
- From version
2.10.0
- Values
file-dispatcher - Dispatch a file into one or multiple paths.
http - HTTP POST request (unsecured).
local-file - Append events to a file located on the local file system.
email-sender - Send emails as an SMTP client.
windows-eventlog - Send events to Windows EventLog Service.
standard-stream - Send events to standard output.
syslog - Local Unix socket or remote IP:PORT address for Syslog.
create-archive - Create/Compresses one or more files.
extract-archive - Extract/Uncompressed a file.
external-executable - Execute an external script or program.
openpgp - Encrypt/Decrypt files using OpenPGP.
rabbitmq - Publish event to RabbitMQ AMQP 0-9-1 server.
extension - For custom event handlers implemented using our API.
- Description
This option specifies the type of the event handler. Each type has a set of specific configuration options.
7.16.4. target¶
- Default value
''
- Optional
Yes
- Values
Comma separated list of event ids.
Comma separated list of event ids starting with an exclamation mark.
Leave empty to handle all events.
- From version
2.10.0
- Description
Define a comma separated list of event ids to have the event handler triggered only for those events.
When you want to have it triggered for all the events, excepting a few events you should prefix each event id with the exclamation mark (!).
Leave it empty to handle all events.
Note
Combining the two methods is not supported as the same result can be achieved by allowing only the desired events, all the others will be ignored.
7.16.5. groups¶
- Default value
''
- Optional
Yes
- Values
Comma separated list of event groups.
Comma separated list of event groups starting with an exclamation mark.
Empty.
- From version
3.39.0
- Description
Defines the list of event groups for which this handler is active.
When you want to handle all the events, except for the ones from a set of groups, prefix the group names with the exclamation mark (!).
An event can be a member of one or multiple groups. The event is handled if any of its groups is found in the list of configured allowed groups. The event is not handled if any of its groups is found in the list of configured ignored groups (starting with !).
Leave it empty to handle events from all groups.
7.16.6. usernames¶
- Default value
''
- Optional
Yes
- Values
Comma separated list of usernames.
Comma separated list of usernames starting with an exclamation mark.
Leave empty to handle all events.
- From version
3.9.0
- Description
Comma separated list of usernames whose events are handled by this event handler. A username can include OS accounts, application accounts, and any accounts accepted by any authentication method including external HTTP accounts.
When you want to have it triggered for all the events, excepting a few events you should prefix each username with the exclamation mark (!).
Leave it empty to handle events from any users or events which are not associated with any user.
7.16.7. components¶
- Default value
''
- Optional
Yes
- Values
Comma separated list of UUIDs.
Comma separated list of UUIDs starting with an exclamation mark.
Leave empty to handle all events.
- From version
3.18.0
- Description
Comma separated list of component UUIDs for which events are handled by this event handler.
When you want to have it triggered for all the events, excepting a few events you should prefix each UUID with the exclamation mark (!).
Leave it empty to handle events emitted by any component.
7.16.8. source_addresses¶
- Default value
Empty
- Optional
Yes
- Values
Comma separated list of IP addresses.
List of IP addresses starting with an exclamation mark.
Empty.
- From version
3.40.0
- Description
Comma separated list of source IP addresses of the remote peers, which are handled by this event handler.
When you want to have it triggered for all the addresses, excepting a few addresses you should prefix each address with the exclamation mark (!).
Leave it empty to handle events emitted by any source address.
7.16.9. data_filter¶
- Default value
''
- Optional
Yes
- Values
Comma separated list of data member name and filter expression.
Leave empty to handle all events.
- From version
3.22.0
- Description
Comma separated definition with name of attribute data member and the targeted matching expression.
Data member names are configured with insensitive cases.
For more details about the available expressions see the matching expression documentation.
The following example will extract the to be matched/filtered value from the path data member of the event. The extracted value is then matched against the
*/folderA/*globbing expression:[event-handlers/b904ed23-a234-4ccf-8abd-edcae4d3324f] data_filter = path, */folderA/*
See the usage instructions for more operational details.
You can filter only based on a single data member with a single matching expression.
Leave it empty to not filter based on the event's attached data.
7.16.10. fail_after_errors¶
- Default value
10
- Optional
Yes
- From version
3.0.0
- Values
An integer number greater than 0.
0 Disabled.
- Description
Number of consecutive errors after which the event handler will automatically stop with a failed state.
Setting this to 0 will disable the feature. The event handler will no longer stop regardless of the number of errors encountered.
7.16.11. entry_point¶
- Default value
empty
- Optional
No
- Values
python:dotted.path.EntryClassHandler
- From version
3.28.0
- Description
The API entry point is defined in the format LANGUAGE:DOTTED.ENTRY.POINT,
LANGUAGE is the name of the language in which the extension is written.
DOTTED.ENTRY.POINT is an expression defining the package, module, and class name which will receive the event.
Note
At this moment, the event handler API supports the development of custom handlers based on the Python programming language.
As an example, for the file
extension/demo_event_handler.pydefining theDemoEventHandlerclass, the configuration will be:entry_point = python:demo_event_handler.DemoEventHandler
See Python API Event Handler developer documentation for more details about how to use the event handler.
7.16.12. configuration¶
- Default value
empty
- Optional
Yes
- Values
Free text
- From version
4.0.0
- Description
A text value which is passed to the event handler together with each event.
You can set it as JSON for structured data or BASE64 for binary data and decode it in the event handler.