FSRM Interfaces

The following interfaces are part of the File Server Resource Manager (FSRM) API.

In this section

DIFsrmClassificationEvents

Handles events that are received while processing a ClassifyFiles call.

IFsrmAccessDeniedRemediationClient

Used to show the Access Denied Remediation (ADR) client user interface.

IFsrmAction

The base class for all FSRM action interfaces.

IFsrmActionCommand

Used to run a command or script in response to a quota, file screen, or file management job event.

IFsrmActionEmail

Used to send an email message in response to a quota or file screen event.

IFsrmActionEmail2

Used to limit the number of expired files listed in the email notification.

IFsrmActionEventLog

Used to log an event to the Windows Application event log in response to a quota, file screen, or file management job event.

IFsrmActionReport

Used to generate a report in response to a quota or file screen event.

IFsrmAutoApplyQuota

Used to automatically add the quota to new and existing subdirectories of the directory on which the automatic quota is applied.

IFsrmClassificationManager

Manages file classification. Use this interface to define properties to use in classification, add classification rules for classifying files, define classification and storage modules, and enable classification reporting.

IFsrmClassificationManager2

Manages file classification. Use this interface to define properties to use in classification, add classification rules for classifying files, define classification and storage modules, and enable classification reporting.

IFsrmClassificationRule

Defines a classification rule.

IFsrmClassifierModuleDefinition

Defines a classifier module.

IFsrmClassifierModuleImplementation

Classifier modules implement this interface. FSRM calls the module's implementation when it runs classification.

IFsrmCollection

Defines a collection of FSRM objects.

IFsrmCommittableCollection

Defines a collection of FSRM objects that can have the same type of objects added to or removed from the collection. All objects in the collection can also be committed in a single batch operation.

IFsrmDerivedObjectsResult

Used to access the results when the source template calls the CommitAndUpdateDerived method.

IFsrmExportImport

Used to export and import FSRM objects.

IFsrmFileConditionProperty

Defines a file condition property.

IFsrmFileGroup

Used to define a group of files based on one or more file name patterns.

IFsrmFileGroupImported

Used to configure imported file group objects.

IFsrmFileGroupManager

Used to manage file group objects.

IFsrmFileManagementJob

Defines a file management job.

IFsrmFileManagementJobManager

Used to manage file management jobs.

IFsrmFileScreen

Used to configure a file screen that blocks groups of files from being saved to the specified directory.

IFsrmFileScreenBase

Base class for all file screen interfaces.

IFsrmFileScreenException

Used to configure an exception that excludes the specified files from the file screening process.

IFsrmFileScreenManager

Used to manage file screen objects.

IFsrmFileScreenTemplate

Used to configure templates from which new file screens can be derived.

IFsrmFileScreenTemplateImported

Used to save imported file screen templates.

IFsrmFileScreenTemplateManager

Used to manage file screen templates.

IFsrmMutableCollection

Used to manage a collection of FSRM objects that can have objects added to or removed from the collection.

IFsrmObject

Base class for all FSRM objects.

IFsrmPathMapper

Used to retrieve the network share paths that are mapped to a local path.

IFsrmPipelineModuleConnector

Creates the communication channel between FSRM and your pipeline module implementation.

IFsrmPipelineModuleDefinition

Defines a module that is used to classify files or store and retrieve properties from files.

IFsrmPipelineModuleImplementation

Abstract interface for IFsrmClassifierModuleImplementation and IFsrmStorageModuleImplementation.

IFsrmProperty

Defines an instance of a property.

IFsrmPropertyBag

Contains the classification properties for a file.

IFsrmPropertyBag2

IFsrmPropertyBag2 Interface

IFsrmPropertyCondition

Defines a property condition that the file management job uses to determine if the file is expired.

IFsrmPropertyDefinition

Defines a property that you want to use to classify files.

IFsrmPropertyDefinition2

Defines a property that you want to use to classify files.

IFsrmPropertyDefinitionValue

Contains properties that describe a classification property definition value.

IFsrmQuota

Used to define a quota for a specified directory and to retrieve use statistics.

IFsrmQuotaBase

Base interface for all quota interfaces.

IFsrmQuotaManager

Used to manage quotas.

IFsrmQuotaManagerEx

Used to manage quotas, extended version.

IFsrmQuotaObject

Base class for the quota and automatic quota interfaces.

IFsrmQuotaTemplate

Used to configure templates from which new quota objects can be derived.

IFsrmQuotaTemplateImported

Used to modify and save imported quota templates.

IFsrmQuotaTemplateManager

Used to manage quota templates.

IFsrmReport

Used to configure the description and filters for a single report.

IFsrmReportJob

Used to configure a report job.

IFsrmReportManager

Used to manage report jobs.

IFsrmReportScheduler

Used to manage scheduled tasks for report jobs and file management jobs.

IFsrmRule

Defines a rule.

IFsrmSetting

Used to configure FSRM.

IFsrmStorageModuleDefinition

Defines a local storage module that is used to read and write property values.

IFsrmStorageModuleImplementation

Storage modules implement this interface.