001    /*
002     * Copyright (c) 2007-2015 Concurrent, Inc. All Rights Reserved.
003     *
004     * Project and contact information: http://www.cascading.org/
005     *
006     * This file is part of the Cascading project.
007     *
008     * Licensed under the Apache License, Version 2.0 (the "License");
009     * you may not use this file except in compliance with the License.
010     * 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, software
015     * distributed under the License is distributed on an "AS IS" BASIS,
016     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017     * See the License for the specific language governing permissions and
018     * limitations under the License.
019     */
020    
021    package cascading.provider;
022    
023    import java.util.Map;
024    
025    /**
026     * Interface CascadingService defines a pluggable "service" class that can be loaded by the {@link ServiceLoader}
027     * utility.
028     *
029     * @see ServiceLoader
030     */
031    public interface CascadingService
032      {
033      void setProperties( Map<Object, Object> properties );
034    
035      /** May be called more than once, but only the first invocation will start the service. */
036      void startService();
037    
038      /** May be called more than once, but only the first invocation will stop the service. */
039      void stopService();
040    
041      /**
042       * Returns true if this service has been enabled.
043       *
044       * @return boolean
045       */
046      boolean isEnabled();
047      }