View Javadoc
1   /*
2    * Copyright (C) 2011-2012, Google Inc.
3    * and other copyright owners as documented in the project's IP log.
4    *
5    * This program and the accompanying materials are made available
6    * under the terms of the Eclipse Distribution License v1.0 which
7    * accompanies this distribution, is reproduced below, and is
8    * available at http://www.eclipse.org/org/documents/edl-v10.php
9    *
10   * All rights reserved.
11   *
12   * Redistribution and use in source and binary forms, with or
13   * without modification, are permitted provided that the following
14   * conditions are met:
15   *
16   * - Redistributions of source code must retain the above copyright
17   *   notice, this list of conditions and the following disclaimer.
18   *
19   * - Redistributions in binary form must reproduce the above
20   *   copyright notice, this list of conditions and the following
21   *   disclaimer in the documentation and/or other materials provided
22   *   with the distribution.
23   *
24   * - Neither the name of the Eclipse Foundation, Inc. nor the
25   *   names of its contributors may be used to endorse or promote
26   *   products derived from this software without specific prior
27   *   written permission.
28   *
29   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30   * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42   */
43  
44  package org.eclipse.jgit.transport;
45  
46  import java.io.IOException;
47  
48  import org.eclipse.jgit.internal.JGitText;
49  
50  /**
51   * Indicates a transport service may not continue execution.
52   *
53   * @since 2.0
54   */
55  public class ServiceMayNotContinueException extends IOException {
56  	private static final long serialVersionUID = 1L;
57  
58  	private boolean output;
59  
60  	/** Initialize with no message. */
61  	public ServiceMayNotContinueException() {
62  		// Do not set a message.
63  	}
64  
65  	/**
66  	 * @param msg
67  	 *            a message explaining why it cannot continue. This message may
68  	 *            be shown to an end-user.
69  	 */
70  	public ServiceMayNotContinueException(String msg) {
71  		super(msg);
72  	}
73  
74  	/**
75  	 * @param msg
76  	 *            a message explaining why it cannot continue. This message may
77  	 *            be shown to an end-user.
78  	 * @param cause
79  	 *            the cause of the exception.
80  	 * @since 3.2
81  	 */
82  	public ServiceMayNotContinueException(String msg, Throwable cause) {
83  		super(msg);
84  		initCause(cause);
85  	}
86  
87  	/**
88  	 * Initialize with an "internal server error" message and a cause.
89  	 *
90  	 * @param cause
91  	 *            the cause of the exception.
92  	 * @since 3.2
93  	 */
94  	public ServiceMayNotContinueException(Throwable cause) {
95  		this(JGitText.get().internalServerError, cause);
96  	}
97  
98  	/** @return true if the message was already output to the client. */
99  	public boolean isOutput() {
100 		return output;
101 	}
102 
103 	/** Mark this message has being sent to the client. */
104 	public void setOutput() {
105 		output = true;
106 	}
107 }