com.cisco.provisioning.cpe.events
Interface FileListener

All Superinterfaces:
ProvAPIEventListener
All Known Implementing Classes:
FileAdapter

public interface FileListener
extends ProvAPIEventListener

The Listener interface for FileEvent. The addFileListener method on the PACEConnection instance may be used to register FileListener instances.

Sample Usage:

      // Implement FileListener interface
      public class MyFileListener implements  FileListener
      {
          ...
      }

      // Create an instance of FileEventQualifier
      // [You may also use an instance of QualifyAll
      // that performs no filtering.]
      myQualifier = new FileEventQualifier();
      // We care about new files only
      myQualifier.setNewFile();

      // Register listener using PACEConnection
      ...
      conn.addFileListener(
          new MyFileListener(), // FileListener
          myQualifier // Qualifier
          );
       ...
 

See Also:
ProvAPIEventListener

Field Summary
static int ADD_FILE
          Event ID that indicates the ADD_FILE sub-event type of the FileEvent.
static int CHANGED_PROPERTIES
          Event ID that indicates the CHANGE_PROPERTIES sub-event type of the FileEvent.
static int DELETE_FILE
          Event ID that indicates the DELETE_FILE sub-event type of the FileEvent.
static int REPLACE_FILE
          Event ID that indicates the REPLACE_FILE sub-event type of the FileEvent.
 
Method Summary
 void added(FileEvent ev)
          The method invoked when an FileEvent arrives when a new file is created.
 void deleted(FileEvent ev)
          The method invoked when an FileEvent arrives when a file is deleted.
 void propertiesChanged(FileEvent ev)
          The method invoked when an FileEvent arrives when a file is change Properties.
 void replaced(FileEvent ev)
          The method invoked when an FileEvent arrives when a file is replaced.
 
Methods inherited from interface com.cisco.provisioning.cpe.events.ProvAPIEventListener
getOneShot, setOneShot
 

Field Detail

ADD_FILE

static final int ADD_FILE
Event ID that indicates the ADD_FILE sub-event type of the FileEvent. This indicates that a file has been added to BAC.

See Also:
Constant Field Values

REPLACE_FILE

static final int REPLACE_FILE
Event ID that indicates the REPLACE_FILE sub-event type of the FileEvent. This indicates that a file has been replaced in BAC.

See Also:
Constant Field Values

DELETE_FILE

static final int DELETE_FILE
Event ID that indicates the DELETE_FILE sub-event type of the FileEvent. This indicates that a file has been deleted from BAC.

See Also:
Constant Field Values

CHANGED_PROPERTIES

static final int CHANGED_PROPERTIES
Event ID that indicates the CHANGE_PROPERTIES sub-event type of the FileEvent. This indicates that a file Properties has been changed from BAC.

See Also:
Constant Field Values
Method Detail

added

void added(FileEvent ev)
The method invoked when an FileEvent arrives when a new file is created.

Parameters:
ev - The object containing the FileEvent data.

replaced

void replaced(FileEvent ev)
The method invoked when an FileEvent arrives when a file is replaced.

Parameters:
ev - The object containing the FileEvent data.

deleted

void deleted(FileEvent ev)
The method invoked when an FileEvent arrives when a file is deleted.

Parameters:
ev - The object containing the FileEvent data.

propertiesChanged

void propertiesChanged(FileEvent ev)
The method invoked when an FileEvent arrives when a file is change Properties.

Parameters:
ev - The object containing the FileEvent data.