org.picketbox.http.resource.ProtectedResourceManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of picketbox-http

PicketBox is a security framework for Java Applications

The newest version!

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2012, Red Hat, Inc., and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.picketbox.http.resource;

import java.util.List;

import org.picketbox.core.PicketBoxLifecycle;

/**
 * @author Pedro Silva
 * @author Anil Saldhana
 */
public interface ProtectedResourceManager extends PicketBoxLifecycle {

    /**
     * @return the resources
     */
    List getResources();

    /**
     * @param resources the resources to set
     */
    void setResources(List resources);

    /**
     * 
     * Add a new {@link ProtectedResource} to the list of protected resources.
     * 
     *
     * @param pattern
     * @param constraint
     */
    void addProtectedResource(String pattern, ProtectedResourceConstraint constraint);

    /**
     * 
     * Returns a {@link ProtectedResource} instance that matches the specified T instance. If no match is found, it will be
     * returned a default resource. See ProtectedResource.DEFAULT_RESOURCE.
     * 
     *
     * @param servletReq
     * @return
     */
    ProtectedResource getProtectedResource(T request);

    void addProtectedResource(ProtectedResource protectedResource);
}