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 int FORBIDDEN = 403;
57 private static final long serialVersionUID = 1L;
58
59 private final int statusCode;
60 private boolean output;
61
62 /** Initialize with no message. */
63 public ServiceMayNotContinueException() {
64 // Do not set a message.
65 statusCode = FORBIDDEN;
66 }
67
68 /**
69 * @param msg
70 * a message explaining why it cannot continue. This message may
71 * be shown to an end-user.
72 */
73 public ServiceMayNotContinueException(String msg) {
74 super(msg);
75 statusCode = FORBIDDEN;
76 }
77
78 /**
79 * @param msg
80 * a message explaining why it cannot continue. This message may
81 * be shown to an end-user.
82 * @param statusCode
83 * the HTTP status code.
84 * @since 4.5
85 */
86 public ServiceMayNotContinueException(String msg, int statusCode) {
87 super(msg);
88 this.statusCode = statusCode;
89 }
90
91 /**
92 * @param msg
93 * a message explaining why it cannot continue. This message may
94 * be shown to an end-user.
95 * @param cause
96 * the cause of the exception.
97 * @since 3.2
98 */
99 public ServiceMayNotContinueException(String msg, Throwable cause) {
100 super(msg, cause);
101 statusCode = FORBIDDEN;
102 }
103
104 /**
105 * @param msg
106 * a message explaining why it cannot continue. This message may
107 * be shown to an end-user.
108 * @param cause
109 * the cause of the exception.
110 * @param statusCode
111 * the HTTP status code.
112 * @since 4.5
113 */
114 public ServiceMayNotContinueException(
115 String msg, Throwable cause, int statusCode) {
116 super(msg, cause);
117 this.statusCode = statusCode;
118 }
119
120 /**
121 * Initialize with an "internal server error" message and a cause.
122 *
123 * @param cause
124 * the cause of the exception.
125 * @since 3.2
126 */
127 public ServiceMayNotContinueException(Throwable cause) {
128 this(JGitText.get().internalServerError, cause);
129 }
130
131 /** @return true if the message was already output to the client. */
132 public boolean isOutput() {
133 return output;
134 }
135
136 /** Mark this message has being sent to the client. */
137 public void setOutput() {
138 output = true;
139 }
140
141 /**
142 * @return true if the message was already output to the client.
143 * @since 4.5
144 */
145 public int getStatusCode() {
146 return statusCode;
147 }
148 }