001/**
002 * Copyright 2005-2016 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.krad.exception;
017
018import org.kuali.rice.core.api.util.RiceKeyConstants;
019
020import java.util.Collections;
021import java.util.Map;
022
023/**
024 * Represents an exception that is thrown when a given user is not authorized to take a given action on the given
025 * document type
026 *
027 * @author Kuali Rice Team (rice.collab@kuali.org)
028 */
029public class DocumentAuthorizationException extends AuthorizationException {
030
031    /**
032     * Constructs a DocumentAuthorizationException for a specific document rather than a documentType.
033     *
034     * @param userId
035     * @param action
036     * @param documentId
037     */
038    public DocumentAuthorizationException(String userId, String action, String documentId) {
039        this(userId, action, documentId, Collections.<String, Object>emptyMap());
040    }
041
042    public DocumentAuthorizationException(String userId, String action, String documentId,
043            Map<String, Object> requestAuthDetails) {
044        super(userId, action, documentId,
045                "user '" + userId + "' is not authorized to " + action + " document '" + documentId + "'",
046                requestAuthDetails);
047    }
048
049    /**
050     * @see AuthorizationException#getErrorMessageKey()
051     */
052    public String getErrorMessageKey() {
053        return RiceKeyConstants.AUTHORIZATION_ERROR_DOCUMENT;
054    }
055
056}