UriDeploymentScanner.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.ignite.spi.deployment.uri.scanners;

import java.net.URI;

/**
 * URI deployment scanner.
 */
public interface UriDeploymentScanner {
    /**
     * Check whether scanner is able to process the given URI.
     *
     * @param uri URI.
     * @return {@code true} if scanner is able to process the URI.
     */
    boolean acceptsURI(URI uri);

    /**
     * Scan the given URI.
     *
     * @param scanCtx Scan context.
     */
    void scan(UriDeploymentScannerContext scanCtx);

    /**
     * Gets default scan frequency in milliseconds.
     *
     * @return Default scan frequency.
     */
    long getDefaultScanFrequency();
}