org.apache.jackrabbit.server.io.PropertyManagerImpl Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jackrabbit-jcr-server Show documentation
WebDAV server implementations for JCR
There is a newer version: 2.23.0-beta
Show newest version
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.jackrabbit.server.io;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;

import javax.jcr.RepositoryException;

import org.apache.jackrabbit.webdav.property.PropEntry;

/**
 * PropertyManagerImpl...
 */
public class PropertyManagerImpl implements PropertyManager {

    private static PropertyManager DEFAULT_MANAGER;

    private final List propertyHandlers = new ArrayList();

    /**
     * Create a new PropertyManagerImpl.
     * Note, that this manager does not define any PropertyHandlers by
     * default. Use {@link #addPropertyHandler(PropertyHandler)} in order to populate the
     * internal list of handlers that are called for importProperties and
     * exportProperties respectively. See {@link #getDefaultManager()}
     * for an instance of this class populated with default handlers.
     */
    public PropertyManagerImpl() {
    }

    /**
     * @see PropertyManager#exportProperties(PropertyExportContext, boolean)
     */
    public boolean exportProperties(PropertyExportContext context, boolean isCollection) throws RepositoryException {
        boolean success = false;
        PropertyHandler[] propertyHandlers = getPropertyHandlers();
        for (int i = 0; i < propertyHandlers.length && !success; i++) {
            PropertyHandler ph = propertyHandlers[i];
            if (ph.canExport(context, isCollection)) {
                success = ph.exportProperties(context, isCollection);
            }
        }
        context.informCompleted(success);
        return success;
    }

    /**
     * @see PropertyManager#alterProperties(PropertyImportContext, boolean)
     */
    public Map alterProperties(PropertyImportContext context, boolean isCollection) throws RepositoryException {
        Map failures = null;
        for (PropertyHandler ph : getPropertyHandlers()) {
            if (ph.canImport(context, isCollection)) {
                failures = ph.importProperties(context, isCollection);
                break;
            }
        }
        if (failures == null) {
            throw new RepositoryException("Unable to alter properties: No matching handler found.");
        }
        context.informCompleted(failures.isEmpty());
        return failures;
    }

    /**
     * @see PropertyManager#addPropertyHandler(PropertyHandler)
     */
    public void addPropertyHandler(PropertyHandler propertyHandler) {
        if (propertyHandler == null) {
            throw new IllegalArgumentException("'null' is not a valid IOHandler.");
        }
        propertyHandlers.add(propertyHandler);
    }

    /**
     * @see PropertyManager#getPropertyHandlers()
     */
    public PropertyHandler[] getPropertyHandlers() {
        return propertyHandlers.toArray(new PropertyHandler[propertyHandlers.size()]);
    }

    /**
     * @return an instance of PropertyManager populated with default handlers.
     */
    public static PropertyManager getDefaultManager() {
        if (DEFAULT_MANAGER == null) {
            PropertyManager manager = new PropertyManagerImpl();
            manager.addPropertyHandler(new ZipHandler());
            manager.addPropertyHandler(new XmlHandler());
            manager.addPropertyHandler(new DefaultHandler());
            DEFAULT_MANAGER = manager;
        }
        return DEFAULT_MANAGER;
    }
}