ProcessorConfiguration.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.sling.rewriter;

import java.util.Map;


/**
 * Configuration of a processor.
 */
public interface ProcessorConfiguration {

    /**
     * The name/type of the component.
     * @return A unique name for this component.
     */
    String getType();

    /**
     * Return the configuration for this component.
     * @return The configuration for this component or an empty map if there is none.
     */
    Map<String, Object> getConfiguration();

    /**
     * Check if this processor configuration matches for the current request.
     * @return true or false
     */
    boolean match(ProcessingContext context);
}