1 /*
2 * Copyright (C) 2016, 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.text.MessageFormat;
47
48 import org.eclipse.jgit.errors.PackProtocolException;
49 import org.eclipse.jgit.internal.JGitText;
50 import org.eclipse.jgit.lib.AnyObjectId;
51
52 /**
53 * Indicates client requested an object the server does not want to serve.
54 * <p>
55 * Typically visible only inside of the server implementation; clients are
56 * usually looking at the text message from the server in a generic
57 * {@link org.eclipse.jgit.errors.PackProtocolException}.
58 *
59 * @since 4.3
60 */
61 public class WantNotValidException extends PackProtocolException {
62 private static final long serialVersionUID = 1L;
63
64 /**
65 * Construct a {@code "want $id not valid"} exception.
66 *
67 * @param id
68 * invalid object identifier received from the client.
69 */
70 public WantNotValidException(AnyObjectId id) {
71 super(msg(id));
72 }
73
74 /**
75 * Construct a {@code "want $id not valid"} exception.
76 *
77 * @param id
78 * invalid object identifier received from the client.
79 * @param cause
80 * root cause of the object being invalid, such as an IOException
81 * from the storage system.
82 */
83 public WantNotValidException(AnyObjectId id, Throwable cause) {
84 super(msg(id), cause);
85 }
86
87 private static String msg(AnyObjectId id) {
88 return MessageFormat.format(JGitText.get().wantNotValid, id.name());
89 }
90 }