alfresco-community-repo/source/java/org/alfresco/repo/webdav/LockInfo.java

/*
 * Copyright (C) 2005-2009 Alfresco Software Limited.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.

 * This program 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 General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

 * As a special exception to the terms and conditions of version 2.0 of 
 * the GPL, you may redistribute this Program in connection with Free/Libre 
 * and Open Source Software ("FLOSS") applications as described in Alfresco's 
 * FLOSS exception.  You should have recieved a copy of the text describing 
 * the FLOSS exception, and it is also available here: 
 * http://www.alfresco.com/legal/licensing"
 */
package org.alfresco.repo.webdav;

import java.util.LinkedList;

/**
 * Class to represent a WebDAV lock info
 * 
 * @author Ivan Rybnikov
 *
 */
public class LockInfo
{
    // Exclusive lock token
    private String token = null;

    // Lock scope
    private String scope = null;

    // Lock depth
    private String depth = null;

    // If lock is shared
    private boolean shared = false;

    // Shared lock tokens
    private LinkedList<String> sharedLockTokens = null;

    // Shared lock token separator
    private static final String SHARED_LOCK_TOKEN_SEPARATOR = ",";

    /**
     * Default constructor
     * 
     */
    public LockInfo()
    {
    }

    /**
     * Constructor
     * 
     * @param token Exclusive lock token
     * @param scope Lock scope (shared/exclusive)
     * @param depth Lock depth (0/infinity)
     */
    public LockInfo(String token, String scope, String depth)
    {
        this.token = token;
        this.scope = scope;
        this.depth = depth;
    }

    /**
     * Returns true if node has shared or exclusive locks
     * 
     * @return boolean
     */
    public boolean isLocked()
    {
        if (token != null || (sharedLockTokens != null && !sharedLockTokens.isEmpty()))
        {
            return true;
        }
        return false;
    }
    
    /**
     * Setter for exclusive lock token
     * 
     * @param token Lock token
     */
    public void setToken(String token)
    {
        this.token = token;
    }

    /**
     * Getter for exclusive lock token
     * @return
     */
    public String getToken()
    {
        return token;
    }

    /**
     * Setter for lock scope.
     * 
     * @param scope
     */
    public void setScope(String scope)
    {
        this.scope = scope;
    }

    /**
     * Returns lock scope
     * 
     * @return lock scope
     */
    public String getScope()
    {
        return scope == null ? WebDAV.XML_EXCLUSIVE : scope;
    }

    /**
     * Setter for lock depth
     * 
     * @param depth lock depth
     */
    public void setDepth(String depth)
    {
        this.depth = depth;
    }

    /**
     * Returns lock depth
     * 
     * @return lock depth
     */
    public String getDepth()
    {
        return depth;
    }

    /**
     * Transforms shared lock tokens string to list. 
     * 
     * @param sharedLockTokens String contains all node's shared lock tokens
     *                         divided with SHARED_LOCK_TOKEN_SEPARATOR value.
     * @return List of shared lock tokens
     */
    public static LinkedList<String> parseSharedLockTokens(String sharedLockTokens)
    {
        if (sharedLockTokens == null)
        {
            return null;
        }
        
        LinkedList<String> result = new LinkedList<String>();
        String[] sl = sharedLockTokens.split(SHARED_LOCK_TOKEN_SEPARATOR);
        for (int i = 0; i < sl.length; i++)
        {
            result.add(sl[i]);
        }

        return result;
    }

    /**
     * Getter for sharedLockTokens list
     * 
     * @return LinkedList<String>
     */
    public LinkedList<String> getSharedLockTokens()
    {
        return sharedLockTokens;
    }

    /**
     * Setter for sharedLockTokens list
     * 
     * @param sharedLockTokens
     */
    public void setSharedLockTokens(LinkedList<String> sharedLockTokens)
    {
        this.sharedLockTokens = sharedLockTokens;
    }

    /**
     * Adds new shared lock token to sharedLockTokens list
     * 
     * @param token new token
     */
    public void addSharedLockToken(String token)
    {
        if (sharedLockTokens == null)
        {
            sharedLockTokens = new LinkedList<String>();
        }
        sharedLockTokens.add(token);
    }

    /**
     * Transforms list of shared locks to string.
     * Lock tokens separated with SHARED_LOCK_TOKEN_SEPARATOR value.
     * 
     * @param lockTokens list of shared locks
     * @return String
     */
    public static String makeSharedLockTokensString(LinkedList<String> lockTokens)
    {
        StringBuilder str = new StringBuilder();

        boolean first = true;
        for (String token : lockTokens)
        {
            if (!first)
            {
                str.append(SHARED_LOCK_TOKEN_SEPARATOR);
            }
            else
            {
                first = false;
            }
            str.append(token);
        }
        return str.toString();
    }
    
    /**
     * Setter for shared property
     * 
     * @param shared
     */
    public void setShared(boolean shared)
    {
        this.shared = shared;
    }

    /**
     * Returns true is lock is shared
     * 
     * @return boolean
     */
    public boolean isShared()
    {
        return shared;
    }
    
    /**
     * Return the lock info as a string
     * 
     * @return String
     */
    public String toString()
    {
        StringBuilder str = new StringBuilder();
        
        str.append("[");
        
        str.append("token=");
        str.append(getToken());
        str.append(",scope=");
        str.append(getScope());
        str.append(",depth=");
        str.append(getDepth());
        str.append(",shared locks=");
        str.append(getSharedLockTokens());

        str.append("]");
        
        return str.toString();
    }

}