AbtractBaseObject.java

/***************************************************************************
 * Copyright (C) 2003-2009 eXo Platform SAS.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Affero General Public License
 * as published by the Free Software Foundation; either version 3
 * 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, see<http://www.gnu.org/licenses/>.
 *
 **************************************************************************/
package org.exoplatform.commons.model.impl;

import org.apache.commons.lang.StringUtils;
import org.exoplatform.commons.api.event.data.BaseObject;
import org.exoplatform.commons.utils.CommonsUtils;
import org.exoplatform.services.jcr.impl.core.NodeImpl;
import org.exoplatform.services.log.ExoLogger;
import org.exoplatform.services.log.Log;

import javax.jcr.*;
import javax.jcr.lock.LockException;
import javax.jcr.nodetype.ConstraintViolationException;
import javax.jcr.nodetype.NoSuchNodeTypeException;
import javax.jcr.version.VersionException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Calendar;
import java.util.List;

/**
 * Created by The eXo Platform SARL
 * Author : Dang Van Minh
 *          minh.dang@exoplatform.com
 * Oct 25, 2012
 * 3:26:08 PM  
 */
public abstract class AbtractBaseObject implements BaseObject {

    protected static final Log LOG = ExoLogger.getLogger(AbtractBaseObject.class);
    protected String workspace;
    protected String path;
    protected String UUID;
    protected boolean isSystem = false;

    public AbtractBaseObject(String workspace, String path) {
        this.workspace = workspace;
        this.path = path;
    }

    public AbtractBaseObject(String workspace, String path, boolean isSystem) {
        this.workspace = workspace;
        this.path = path;
        this.isSystem = isSystem;
    }  

    /**
     * Get object name  
     * @return
     */
    public String getName() {
        return path.substring(path.lastIndexOf("/") + 1, path.length());
    }

    /**
     * Get Object path  
     * @return
     */
    public String getPath() {
        return path;
    }

    /**
     * Get Object created date
     * @return
     */
    public Calendar getCreatedDate() {
        try {
            return getJCRNode().getProperty("exo:dateCreated").getDate();
        } catch (ValueFormatException e) {
           if(LOG.isDebugEnabled()) {
               LOG.error(e);
           }
        } catch (PathNotFoundException e) {
            if(LOG.isDebugEnabled()) {
                LOG.error(e);
            }
        } catch (RepositoryException e) {
            if(LOG.isDebugEnabled()) {
                LOG.error(e);
            }
        }
        return null;
    }

    /**
     * Get Object last modified date
     * @return
     */
    public Calendar getLastModifiedDate() {
        try {
            return getJCRNode().getProperty("exo:lastModifiedDate").getDate();
        } catch (ValueFormatException e) {
            if(LOG.isDebugEnabled()) {
                LOG.error(e);
            }
        } catch (PathNotFoundException e) {
           if(LOG.isDebugEnabled()) {
               LOG.error(e);
           }
        } catch (RepositoryException e) {
           if(LOG.isDebugEnabled()) {
               LOG.error(e);
           }
        }
        return null;
    }

    /**
     * Get Object Creator
     * @return
     */
    public String getCreator() {
        try {
            return getJCRNode().getProperty("exo:owner").toString();
        } catch (PathNotFoundException e) {
           if(LOG.isDebugEnabled()) {
               LOG.error(e);
           }
        } catch (RepositoryException e) {
           if(LOG.isDebugEnabled()) {
               LOG.error(e);
           }
        }
        return null;
    }

    /**
     * Get Object Primary Type
     * @return
     */
    public String getPrimaryType() {
        try {
            return getJCRNode().getPrimaryNodeType().getName();
        } catch (PathNotFoundException e) {
           if(LOG.isDebugEnabled()) {
               LOG.error(e);
           }
        } catch (RepositoryException e) {
           if(LOG.isDebugEnabled()) {
               LOG.error(e);
           }
        }
        return null;
    }

    /**
     * Get Object mixin types
     */
    public List<String> getMixinTypes() {
        try {
            return new ArrayList<String>(Arrays.asList(((NodeImpl)getJCRNode()).getMixinTypeNames()));
        } catch (PathNotFoundException e) {
           if(LOG.isDebugEnabled()) {
               LOG.error(e);
           }
        } catch (RepositoryException e) {
           if(LOG.isDebugEnabled()) {
               LOG.error(e);
           }
        }
        return new ArrayList<String>();
    }

    /**
     * Get workspace name where stored current object.
     * @return Name of Workspace
     */
    public String getWorkspace() {
        return workspace;
    }

    /**
     * Get Object UUID
     * @return UUID of current Object
     */
    public String getUUID() {
        try {
            return getJCRNode().getUUID();
        } catch (UnsupportedRepositoryOperationException e) {
           if(LOG.isDebugEnabled()) {
               LOG.error(e);
           }
        } catch (PathNotFoundException e) {
           if(LOG.isDebugEnabled()) {
               LOG.error(e);
           }
        } catch (RepositoryException e) {
           if(LOG.isDebugEnabled()) {
               LOG.error(e);
           }
        }
        return null;
    }

    /**
     * 
     * @return
     * @throws RepositoryException 
     * @throws NoSuchWorkspaceException 
     * @throws LoginException 
     */
    protected Session getSession() throws LoginException, NoSuchWorkspaceException, RepositoryException {
        if(isSystem) {
            return CommonsUtils.getSystemSessionProvider().getSession(workspace, CommonsUtils.getRepository());
        }
        return CommonsUtils.getUserSessionProvider().getSession(workspace, CommonsUtils.getRepository());
    }

    /**
     *
     */
    public void save() {
        try {
            getSession().save();
        } catch (AccessDeniedException e) {
           if(LOG.isDebugEnabled()) {
               LOG.error(e);
           }
        } catch (ItemExistsException e) {
           if(LOG.isDebugEnabled()) {
               LOG.error(e);
           }
        } catch (ConstraintViolationException e) {
           if(LOG.isDebugEnabled()) {
               LOG.error(e);
           }
        } catch (InvalidItemStateException e) {
           if(LOG.isDebugEnabled()) {
               LOG.error(e);
           }
        } catch (VersionException e) {
           if(LOG.isDebugEnabled()) {
               LOG.error(e);
           }
        } catch (LockException e) {
           if(LOG.isDebugEnabled()) {
               LOG.error(e);
           }
        } catch (NoSuchNodeTypeException e) {
           if(LOG.isDebugEnabled()) {
               LOG.error(e);
           }
        } catch (LoginException e) {
           if(LOG.isDebugEnabled()) {
               LOG.error(e);
           }
        } catch (NoSuchWorkspaceException e) {
           if(LOG.isDebugEnabled()) {
               LOG.error(e);
           }
        } catch (RepositoryException e) {
           if(LOG.isDebugEnabled()) {
               LOG.error(e);
           }
        }
    }

    @Override
    public String getTitle() {
        try {
            return getJCRNode().getProperty("exo:title").getString();
        } catch (ValueFormatException e) {
           if(LOG.isDebugEnabled()) {
               LOG.error(e);
           }
        } catch (PathNotFoundException e) {
            if(LOG.isDebugEnabled()) {
                LOG.error(e);
            }
        } catch (RepositoryException e) {
            if(LOG.isDebugEnabled()) {
                LOG.error(e);
            }
        }
        return null;
    }

    @Override
    public String getLastModifier() {
        try {
            return getJCRNode().getProperty("exo:lastModifier").getString();
        } catch (ValueFormatException e) {
           if(LOG.isDebugEnabled()) {
               LOG.error(e);
           }
        } catch (PathNotFoundException e) {
            if(LOG.isDebugEnabled()) {
                LOG.error(e);
            }
        } catch (RepositoryException e) {
            if(LOG.isDebugEnabled()) {
                LOG.error(e);
            }
        }
        return null;
    }

    @Override
    public String getOwner() {
        try {
            return getJCRNode().getProperty("exo:owner").getString();
        } catch (ValueFormatException e) {
           if(LOG.isDebugEnabled()) {
               LOG.error(e);
           }
        } catch (PathNotFoundException e) {
            if(LOG.isDebugEnabled()) {
                LOG.error(e);
            }
        } catch (RepositoryException e) {
            if(LOG.isDebugEnabled()) {
                LOG.error(e);
            }
        }
        return null;
    }
    
    public List<String> getTags() {
        return new ArrayList<String>();
    }
    
    public String getRating() {
        return StringUtils.EMPTY;
    }

    /**
     * 
     * @return
     */
    public abstract String getObjectType();  

    /**
     * 
     * @return
     */
    protected Node getJCRNode() {
        try {
            return (Node)getSession().getItem(path);
        } catch (PathNotFoundException e) {
           if(LOG.isDebugEnabled()) {
               LOG.error(e);
           }
        } catch (LoginException e) {
           if(LOG.isDebugEnabled()) {
               LOG.error(e);
           }
        } catch (NoSuchWorkspaceException e) {
           if(LOG.isDebugEnabled()) {
               LOG.error(e);
           }
        } catch (RepositoryException e) {
           if(LOG.isDebugEnabled()) {
               LOG.error(e);
           }
        }
        return null;
    }
    
}