OriginArtifactLoader.java

/**
 * OpenSpotLight - Open Source IT Governance Platform
 *
 * Copyright (c) 2009, CARAVELATECH CONSULTORIA E TECNOLOGIA EM INFORMATICA LTDA
 * or third-party contributors as indicated by the @author tags or express
 * copyright attribution statements applied by the authors.  All third-party
 * contributions are distributed under license by CARAVELATECH CONSULTORIA E
 * TECNOLOGIA EM INFORMATICA LTDA.
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * 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 Lesser General Public License  for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 *
 ***********************************************************************
 * OpenSpotLight - Plataforma de Governança de TI de Código Aberto
 *
 * Direitos Autorais Reservados (c) 2009, CARAVELATECH CONSULTORIA E TECNOLOGIA
 * EM INFORMATICA LTDA ou como contribuidores terceiros indicados pela etiqueta
 * @author ou por expressa atribuição de direito autoral declarada e atribuída pelo autor.
 * Todas as contribuições de terceiros estão distribuídas sob licença da
 * CARAVELATECH CONSULTORIA E TECNOLOGIA EM INFORMATICA LTDA.
 *
 * Este programa é software livre; você pode redistribuí-lo e/ou modificá-lo sob os
 * termos da Licença Pública Geral Menor do GNU conforme publicada pela Free Software
 * Foundation.
 *
 * Este programa é distribuído na expectativa de que seja útil, porém, SEM NENHUMA
 * GARANTIA; nem mesmo a garantia implícita de COMERCIABILIDADE OU ADEQUAÇÃO A UMA
 * FINALIDADE ESPECÍFICA. Consulte a Licença Pública Geral Menor do GNU para mais detalhes.
 *
 * Você deve ter recebido uma cópia da Licença Pública Geral Menor do GNU junto com este
 * programa; se não, escreva para:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.openspotlight.federation.finder;

import java.util.Set;

import org.openspotlight.common.Disposable;
import org.openspotlight.domain.ArtifactSource;
import org.openspotlight.federation.domain.artifact.Artifact;

/**
 * The Interface OriginArtifactLoader. It should work on a multi threaded environmnent. It should be very easy to do, since
 * there's no need to store any state on this class.
 */
public interface OriginArtifactLoader extends Disposable {

    public interface LoaderInternalMethods {

        public <A extends Artifact> boolean accept(ArtifactSource source,
                                                    Class<A> type);

        public Set<Class<? extends Artifact>> getAvailableTypes();

        /**
         * This method verifies if the artifact with given name is changed comparing with the old one. It may return false yes,
         * but never false no. It is used to get few optimizations on artifact loading process.
         * 
         * @param artifactName
         * @param oldOne
         * @return
         */
        public <A extends Artifact> boolean isMaybeChanged(ArtifactSource source,
                                                            String artifactName,
                                                            A oldOne);

        public boolean isTypeSupported(Class<? extends Artifact> type);

        /**
         * Retrieve all artifact names.
         * 
         * @param artifactSource the artifact source
         * @return the set< string>
         */
        public <A extends Artifact> Set<String> retrieveOriginalNames(Class<A> type,
                                                                       ArtifactSource source,
                                                                       String initialPath);

    }

    /**
     * Find by path.
     * 
     * @param path the path
     * @param source the artifact source
     * @return the stream artifact
     */
    public <A extends Artifact> A findByPath(Class<A> type,
                                              ArtifactSource source,
                                              String path, String encoding);

    /**
     * Find by relative path.
     * 
     * @param relativeTo the relative to
     * @param path the path
     * @param source the artifact source
     * @return the stream artifact
     */
    public <A extends Artifact> A findByRelativePath(Class<A> type,
                                                      ArtifactSource source,
                                                      A relativeTo,
                                                      String path, String encoding);

    public LoaderInternalMethods getInternalMethods();

    /**
     * List by path.
     * 
     * @param path the path
     * @param source the artifact source
     * @return the set< stream artifact>
     */
    public <A extends Artifact> Set<A> listByPath(Class<A> type,
                                                   ArtifactSource source,
                                                   String path, String encoding);

}