> For the complete documentation index, see [llms.txt](https://cbfs.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cbfs.ortusbooks.com/digging-deeper/interceptors.md).

# Interceptors

There are [ColdBox interception points](https://coldbox.ortusbooks.com/the-basics/interceptors) announced when working with CBFS disks, directories, and files. You can use them to log file access, secure folders, and add application behavior.

Each example shows the BoxLang class first and the equivalent CFML class second.

## cbfsOnDiskStart

Invoked after a disk has been started. CBFS manages disk startup automatically.

{% tabs %}
{% tab title="BoxLang" %}

```boxlang
class {
    function cbfsOnDiskStart( disk ) {
        // Handle the event.
    }
}
```

{% endtab %}

{% tab title="CFML" %}

```cfml
component {
    function cbfsOnDiskStart( disk ) {
        // Handle the event.
    }
}
```

{% endtab %}
{% endtabs %}

## cbfsOnDiskShutdown

Invoked after a disk has been shut down. CBFS manages disk shutdown automatically.

{% tabs %}
{% tab title="BoxLang" %}

```boxlang
class {
    function cbfsOnDiskShutdown( disk ) {
        // Handle the event.
    }
}
```

{% endtab %}

{% tab title="CFML" %}

```cfml
component {
    function cbfsOnDiskShutdown( disk ) {
        // Handle the event.
    }
}
```

{% endtab %}
{% endtabs %}

## File events

The file events are `cbfsOnFileCreate`, `cbfsOnFileMove`, `cbfsOnFileCopy`, `cbfsOnFileDelete`, and `cbfsOnFileInfoRequest`. Each receives the affected `file`.

{% tabs %}
{% tab title="BoxLang" %}

```boxlang
class {
    function cbfsOnFileCreate( file ) {}
    function cbfsOnFileMove( file ) {}
    function cbfsOnFileCopy( file ) {}
    function cbfsOnFileDelete( file ) {}
    function cbfsOnFileInfoRequest( file ) {}
}
```

{% endtab %}

{% tab title="CFML" %}

```cfml
component {
    function cbfsOnFileCreate( file ) {}
    function cbfsOnFileMove( file ) {}
    function cbfsOnFileCopy( file ) {}
    function cbfsOnFileDelete( file ) {}
    function cbfsOnFileInfoRequest( file ) {}
}
```

{% endtab %}
{% endtabs %}

## Directory events

The directory events are `cbfsOnDirectoryMove`, `cbfsOnDirectoryCreate`, `cbfsOnDirectoryCopy`, and `cbfsOnDirectoryDelete`.

{% tabs %}
{% tab title="BoxLang" %}

```boxlang
class {
    function cbfsOnDirectoryMove( source, destination, disk ) {}
    function cbfsOnDirectoryCreate( directory, disk ) {}
    function cbfsOnDirectoryCopy( source, destination, disk ) {}
    function cbfsOnDirectoryDelete( directory, disk ) {}
}
```

{% endtab %}

{% tab title="CFML" %}

```cfml
component {
    function cbfsOnDirectoryMove( source, destination, disk ) {}
    function cbfsOnDirectoryCreate( directory, disk ) {}
    function cbfsOnDirectoryCopy( source, destination, disk ) {}
    function cbfsOnDirectoryDelete( directory, disk ) {}
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://cbfs.ortusbooks.com/digging-deeper/interceptors.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
