mae-components/mae-project-tools/src/main/java/org/apache/maven/mae/project/session/ProjectToolsSession.java

/*
 * 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.maven.mae.project.session;

import java.io.File;
import java.util.Collection;
import java.util.List;

import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.execution.MavenExecutionRequest;
import org.apache.maven.mae.project.event.EventDispatcher;
import org.apache.maven.model.Repository;
import org.apache.maven.project.MavenProject;
import org.apache.maven.project.ProjectBuildingRequest;
import org.sonatype.aether.RepositorySystemSession;
import org.sonatype.aether.artifact.Artifact;
import org.sonatype.aether.collection.DependencySelector;
import org.sonatype.aether.graph.DependencyFilter;
import org.sonatype.aether.repository.RemoteRepository;

public interface ProjectToolsSession
{

    public static final String SESSION_KEY = "dependency-resolver-session";

    List<ArtifactRepository> getRemoteArtifactRepositories();

    ProjectToolsSession setRemoteArtifactRepositories( final List<ArtifactRepository> remoteArtifactRepositories );

    Repository[] getResolveRepositories();

    File getLocalRepositoryDirectory();

    List<RemoteRepository> getRemoteRepositories();

    ProjectToolsSession setRemoteRepositories( final List<RemoteRepository> remoteRepositories );

    ProjectBuildingRequest getProjectBuildingRequest();

    ProjectToolsSession setProjectBuildingRequest( final ProjectBuildingRequest projectBuildingRequest );

    RepositorySystemSession getRepositorySystemSession();

    ProjectToolsSession setRepositorySystemSession( final RepositorySystemSession repositorySystemSession );

    ProjectToolsSession addReactorProject( final MavenProject project );

    ProjectToolsSession setReactorProjects( final MavenProject... projects );

    ProjectToolsSession setReactorProjects( final Iterable<MavenProject> projects );

    Collection<MavenProject> getReactorProjects();

    File getReactorPom( final Artifact artifact );

    MavenProject getReactorProject( final Artifact artifact );

    ProjectToolsSession copy();

    RemoteRepository[] getRemoteRepositoriesArray();

    ProjectToolsSession setExecutionRequest( MavenExecutionRequest request );

    MavenExecutionRequest getExecutionRequest();

    ProjectToolsSession setResolveThreads( int threads );

    int getResolveThreads();

    boolean isProcessPomPlugins();

    ProjectToolsSession setProcessPomPlugins( boolean resolvePlugins );

    DependencySelector getDependencySelector();

    ProjectToolsSession setDependencySelector( DependencySelector selector );

    DependencyFilter getDependencyFilter();

    ProjectToolsSession setDependencyFilter( DependencyFilter filter );

    ProjectToolsSession connectProjectHierarchy( Artifact parent, boolean parentPreResolved, Artifact child,
                                                 boolean childPreResolved );

    <T> T setState( T state );

    <T> T getState( Class<T> stateType );

    <T> T clearState( Class<T> stateType );

    void clearStates();

    int getPomValidationLevel();

    ProjectToolsSession setPomValidationLevel( int pomValidationLevel );

    ProjectBuildingRequest getTemplateProjectBuildingRequest();

    <E> EventDispatcher<E> getEventDispatcher( Class<E> eventType );

    <E> ProjectToolsSession setEventDispatcher( Class<E> eventType, EventDispatcher<E> dispatcher );

}