001    /**
002     * Copyright 2005-2012 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     */
016    package org.kuali.rice.krad.exception;
017    
018    import org.kuali.rice.core.api.util.RiceKeyConstants;
019    
020    import java.util.Collections;
021    import java.util.Map;
022    
023    /**
024     * This class 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     * 
028     */
029    public 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, Map<String, Object> requestAuthDetails) {
043            super(userId, action, documentId, "user '" + userId + "' is not authorized to " + action + " document '" + documentId + "'", requestAuthDetails);
044        }
045    
046        /**
047         * @see AuthorizationException#getErrorMessageKey()
048         */
049        public String getErrorMessageKey() {
050            return RiceKeyConstants.AUTHORIZATION_ERROR_DOCUMENT;
051        }
052    
053    }