org.filesys.smb.server.notify.NotifyChangeEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jfileserver Show documentation
Java file server with SMB, FTP/FTPS and NFS support, virtual filesystems, database filesystems
The newest version!
/*
 * Copyright (C) 2006-2010 Alfresco Software Limited.
 * Copyright (C) 2018 GK Spencer
 *
 * This file is part of Alfresco
 *
 * Alfresco is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Alfresco is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Alfresco. If not, see .
 */

package org.filesys.smb.server.notify;

import org.filesys.server.filesys.NotifyAction;
import org.filesys.server.filesys.NotifyChange;

import java.util.EnumSet;
import java.util.Set;

/**
 * Notify Change Event Class
 *
 * Contains the details of a change notification event
 *
 * @author gkspencer
 */
public class NotifyChangeEvent {

    //	Notification event action and filter type
    private NotifyAction m_action;
    private Set m_filter = EnumSet.noneOf( NotifyChange.class);

    //	Notification file/directory name
    private String m_fileName;

    //	Path is a directory
    private boolean m_dir;

    //	Original file name for file/directory rename
    private String m_oldName;

    /**
     * Class constructor
     *
     * @param filter NotifyChange
     * @param action NotifyAction
     * @param fname  String
     * @param dir    boolean
     */
    public NotifyChangeEvent(NotifyChange filter, NotifyAction action, String fname, boolean dir) {
        m_filter.add( filter);
        m_action = action;
        m_fileName = fname;
        m_dir = dir;

        //	Normalize the path
        if (m_fileName.indexOf('/') != -1)
            m_fileName = m_fileName.replace('/', '\\');
    }

    /**
     * Class constructor
     *
     * @param filter  NotifyChange
     * @param action  NotifyAction
     * @param fname   String
     * @param oldname String
     * @param dir     boolean
     */
    public NotifyChangeEvent(NotifyChange filter, NotifyAction action, String fname, String oldname, boolean dir) {
        m_filter.add( filter);
        m_action = action;
        m_fileName = fname;
        m_oldName = oldname;
        m_dir = dir;

        //	Normalize the path
        if (m_fileName.indexOf('/') != -1)
            m_fileName = m_fileName.replace('/', '\\');

        if (m_oldName.indexOf('/') != -1)
            m_oldName.replace('/', '\\');
    }

    /**
     * Return the event filter type
     *
     * @return Set of NotifyChange
     */
    public final Set getFilter() {
        return m_filter;
    }

    /**
     * Return the action
     *
     * @return NotifyAction
     */
    public final NotifyAction getAction() {
        return m_action;
    }

    /**
     * Return the file/directory name
     *
     * @return String
     */
    public final String getFileName() {
        return m_fileName;
    }

    /**
     * Return the file/directory name only by stripping any leading path
     *
     * @return String
     */
    public final String getShortFileName() {

        //	Find the last '\' in the path string
        int pos = m_fileName.lastIndexOf("\\");
        if (pos != -1)
            return m_fileName.substring(pos + 1);
        return m_fileName;
    }

    /**
     * Return the old file/directory name, for rename events
     *
     * @return String
     */
    public final String getOldFileName() {
        return m_oldName;
    }

    /**
     * Return the old file/directory name only by stripping any leading path
     *
     * @return String
     */
    public final String getShortOldFileName() {

        //	Check if the old path string is valid
        if (m_oldName == null)
            return null;

        //	Find the last '\' in the path string
        int pos = m_oldName.lastIndexOf("\\");
        if (pos != -1)
            return m_oldName.substring(pos + 1);
        return m_oldName;
    }

    /**
     * Check if the old file/directory name is valid
     *
     * @return boolean
     */
    public final boolean hasOldFileName() {
        return m_oldName != null ? true : false;
    }

    /**
     * Check if the path refers to a directory
     *
     * @return boolean
     */
    public final boolean isDirectory() {
        return m_dir;
    }

    /**
     * Return the notify change event as a string
     *
     * @return String
     */
    public String toString() {
        StringBuffer str = new StringBuffer();

        str.append("[");
        str.append(getFilter().toString());
        str.append("-");
        str.append(getAction().name());
        str.append(":");
        str.append(getFileName());

        if (isDirectory())
            str.append(",DIR");

        if (hasOldFileName()) {
            str.append(",Old=");
            str.append(getOldFileName());
        }

        str.append("]");

        return str.toString();
    }
}