001    /**
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    package org.apache.xbean.kernel;
018    
019    /**
020     * Signifies that a kernel operation timed out before it could be completed.  The kernel will always leave the
021     * system in a stable state before returning to the caller.
022     *
023     * @author Dain Sundstrom
024     * @version $Id$
025     * @since 2.0
026     */
027    public class KernelOperationTimoutException extends RuntimeException {
028        private final ServiceName serviceName;
029        private final String operationName;
030    
031        /**
032         * Created a KernelOperationTimoutException for the specified operation on the specified service.
033         *
034         * @param serviceName the name of the service for which the operation timed out
035         * @param operationName the name of the operation that timed out
036         */
037        public KernelOperationTimoutException(ServiceName serviceName, String operationName) {
038            super("Kernel operation timed out: serviceName=" + serviceName + ", operationName=" + operationName);
039            if (serviceName == null) throw new NullPointerException("serviceName is null");
040            if (operationName == null) throw new NullPointerException("operationName is null");
041            this.serviceName = serviceName;
042            this.operationName = operationName;
043        }
044    
045        /**
046         * Created a KernelOperationTimoutException using the specified custom message.
047         *
048         * @param message a custom message for this exception
049         * @param serviceName the name of the service for which the operation timed out
050         * @param operationName the name of the operation that timed out
051         */
052        public KernelOperationTimoutException(String message, ServiceName serviceName, String operationName) {
053            super(message);
054            if (serviceName == null) throw new NullPointerException("serviceName is null");
055            if (operationName == null) throw new NullPointerException("operationName is null");
056            this.serviceName = serviceName;
057            this.operationName = operationName;
058        }
059    
060        /**
061         * Gets the name of the service for which the operation timed out.
062         *
063         * @return the name of the service for which the operation timed out
064         */
065        public ServiceName getServiceName() {
066            return serviceName;
067        }
068    
069        /**
070         * Gets the name of the operation that timed out.
071         *
072         * @return the name of the operation that timed out
073         */
074        public String getOperationName() {
075            return operationName;
076        }
077    }