org.apache.deltaspike.security.api.authorization.AccessDeniedException Maven / Gradle / Ivy

/*
 * 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.deltaspike.security.api.authorization;

import java.util.Set;

/**
 * Exception occurs in case of a security-violation.
 * It's aware of the reason for the violation as well as the error-view which should be used to display the restriction.
 */
public class AccessDeniedException extends SecurityException
{
    private static final long serialVersionUID = -4066763895951237969L;

    private Set violations;

    /**
     * Constructor for creating the exception for the given violations and error-view
     * @param violations current violations
     */
    public AccessDeniedException(Set violations)
    {
        this.violations = violations;
    }

    /**
     * All {@link SecurityViolation} which were found by a {@link AccessDecisionVoter}
     *
     * @return all security-violations
     */
    public Set getViolations()
    {
        return violations;
    }
}