org.jumpmind.symmetric.web.IServletResource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of symmetric-ds Show documentation

SymmetricDS is an open source database synchronization solution. It is platform-independent, web-enabled, and database-agnostic. SymmetricDS was first built to replicate changes between 'retail store' databases and ad centralized 'corporate' database.

The newest version!

/*
 * Licensed to JumpMind Inc under one or more contributor 
 * license agreements.  See the NOTICE file distributed
 * with this work for additional information regarding 
 * copyright ownership.  JumpMind Inc licenses this file
 * to you under the GNU Lesser General Public License (the
 * "License"); you may not use this file except in compliance
 * with the License. 
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, see           
 * .
 * 
 * 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.jumpmind.symmetric.web;

import javax.servlet.ServletRequest;

/**
 * This interface can be used by a servlet or a filter that is managed by
 * Spring.
 * 
 * @since 1.4.0
 * 
 *
 * 
 */
public interface IServletResource {

    public abstract void setDisabled(boolean disabled);

    public abstract void setUriPattern(String uriPattern);

    public abstract void setUriPatterns(String[] uriPatterns);

    public abstract boolean isDisabled();

    public abstract String[] getUriPatterns();

    public abstract void destroy();

    /**
     * Returns true if the request path matches the uriPattern on this filter.
     * 
     * @param request
     * @return
     */
    public abstract boolean matches(ServletRequest request);

    /**
     * Returns true if this should be container compatible
     * 
     * @return
     */
    public boolean isContainerCompatible();

}