001    package org.apache.maven.scm.command;
002    
003    /*
004     * Licensed to the Apache Software Foundation (ASF) under one
005     * or more contributor license agreements.  See the NOTICE file
006     * distributed with this work for additional information
007     * regarding copyright ownership.  The ASF licenses this file
008     * to you under the Apache License, Version 2.0 (the
009     * "License"); you may not use this file except in compliance
010     * with the License.  You may obtain a copy of the License at
011     *
012     * http://www.apache.org/licenses/LICENSE-2.0
013     *
014     * Unless required by applicable law or agreed to in writing,
015     * software distributed under the License is distributed on an
016     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017     * KIND, either express or implied.  See the License for the
018     * specific language governing permissions and limitations
019     * under the License.
020     */
021    
022    import org.apache.maven.scm.CommandParameters;
023    import org.apache.maven.scm.ScmException;
024    import org.apache.maven.scm.ScmFileSet;
025    import org.apache.maven.scm.ScmResult;
026    import org.apache.maven.scm.log.ScmLogger;
027    import org.apache.maven.scm.provider.ScmProviderRepository;
028    
029    /**
030     * @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
031     * @author <a href="mailto:trygvis@inamo.no">Trygve Laugst&oslash;l</a>
032     *
033     */
034    public abstract class AbstractCommand
035        implements Command
036    {
037        private ScmLogger logger;
038    
039        protected abstract ScmResult executeCommand( ScmProviderRepository repository, ScmFileSet fileSet,
040                                                     CommandParameters parameters )
041            throws ScmException;
042    
043        /** {@inheritDoc} */
044        public final ScmResult execute( ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters )
045            throws ScmException
046        {
047            if ( repository == null )
048            {
049                throw new NullPointerException( "repository cannot be null" );
050            }
051    
052            if ( fileSet == null )
053            {
054                throw new NullPointerException( "fileSet cannot be null" );
055            }
056    
057            try
058            {
059                return executeCommand( repository, fileSet, parameters );
060            }
061            catch ( Exception ex )
062            {
063                throw new ScmException( "Exception while executing SCM command.", ex );
064            }
065        }
066    
067        /** {@inheritDoc} */
068        public final ScmLogger getLogger()
069        {
070            return logger;
071        }
072    
073        /** {@inheritDoc} */
074        public final void setLogger( ScmLogger logger )
075        {
076            this.logger = logger;
077        }
078    }