![[Jenkins]](/ci/static/9dfc6a38/images/svgs/logo.svg){kind=logo}
Package: HttpStatusException
HttpStatusException
| name | instruction | branch | complexity | line | method | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| HttpStatusException(int) |
|
|
|
|
|
||||||||||||||||||||
| HttpStatusException(int, Map) |
|
|
|
|
|
||||||||||||||||||||
| createUrl(Site, String) |
|
|
|
|
|
||||||||||||||||||||
| isError() |
|
|
|
|
|
||||||||||||||||||||
| permanentRedirect(Site, String) |
|
|
|
|
|
||||||||||||||||||||
| static {...} |
|
|
|
|
|
||||||||||||||||||||
| temporaryRedirect(Site, String) |
|
|
|
|
|
||||||||||||||||||||
| withHeader(String, String) |
|
|
|
|
|
||||||||||||||||||||
Coverage
1: /*
2: * *************************************************************************************************************************************************************
3: *
4: * NorthernWind - lightweight CMS
5: * http://tidalwave.it/projects/northernwind
6: *
7: * Copyright (C) 2011 - 2025 Tidalwave s.a.s. (http://tidalwave.it)
8: *
9: * *************************************************************************************************************************************************************
10: *
11: * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
12: * You may obtain a copy of the License at
13: *
14: * http://www.apache.org/licenses/LICENSE-2.0
15: *
16: * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
17: * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
18: *
19: * *************************************************************************************************************************************************************
20: *
21: * git clone https://bitbucket.org/tidalwave/northernwind-src
22: * git clone https://github.com/tidalwave-it/northernwind-src
23: *
24: * *************************************************************************************************************************************************************
25: */
26: package it.tidalwave.northernwind.core.model;
27:
28: import javax.annotation.Nonnull;
29: import java.util.Collections;
30: import java.util.HashMap;
31: import java.util.List;
32: import java.util.Map;
33: import lombok.Getter;
34: import lombok.ToString;
35: import static javax.servlet.http.HttpServletResponse.*;
36:
37: /***************************************************************************************************************************************************************
38: *
39: * An exceptional response representing a situation that should be reported to the client with a specific HTTP status
40: * code. Note that this class doesn't necessarily represent an error, but it could be e.g. a redirect and such. This
41: * class can also carry headers to be included as part of the response
42: *
43: * @author Fabrizio Giudici
44: *
45: **************************************************************************************************************************************************************/
46: @ToString
47: public class HttpStatusException extends Exception
48: {
49: /** Status codes that don't imply an error. */
50: private static final List<Integer> GOOD_CODES = List.of(SC_FOUND, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY);
51:
52: @Getter
53: private final int httpStatus;
54:
55: @Getter
56: private final Map<String, String> headers;
57:
58: /***********************************************************************************************************************************************************
59: * Creates an exception representing a temporary redirect.
60: *
61: * @param site the {@link Site}
62: * @param target the target to redirect to
63: * @return the exception
64: **********************************************************************************************************************************************************/
65: @Nonnull
66: public static HttpStatusException temporaryRedirect (@Nonnull final Site site, @Nonnull final String target)
67: {
68: // FIXME: inject Site
69: return new HttpStatusException(SC_MOVED_TEMPORARILY).withHeader("Location", createUrl(site, target));
70: }
71:
72: /***********************************************************************************************************************************************************
73: * Creates an exception representing a permanent redirect.
74: *
75: * @param site the {@link Site}
76: * @param target the target to redirect to
77: * @return the exception
78: **********************************************************************************************************************************************************/
79: @Nonnull
80: public static HttpStatusException permanentRedirect (@Nonnull final Site site, @Nonnull final String target)
81: {
82: // FIXME: inject Site
83: return new HttpStatusException(SC_MOVED_PERMANENTLY).withHeader("Location", createUrl(site, target));
84: }
85:
86: /***********************************************************************************************************************************************************
87: * Creates an instance with the given HTTP status.
88: *
89: * @param httpStatus the status
90: **********************************************************************************************************************************************************/
91: public HttpStatusException (final int httpStatus)
92: {
93: this(httpStatus, Collections.emptyMap());
94: }
95:
96: /***********************************************************************************************************************************************************
97: *
98: **********************************************************************************************************************************************************/
99: private HttpStatusException (final int httpStatus, @Nonnull final Map<String, String> headers)
100: {
101: super(String.format("httpStatus=%d, headers=%s", httpStatus, headers));
102: this.httpStatus = httpStatus;
103: this.headers = headers;
104: }
105:
106: /***********************************************************************************************************************************************************
107: * Creates a clone with the given header.
108: *
109: * @param name the header name
110: * @param value the header value
111: * @return the clone
112: **********************************************************************************************************************************************************/
113: @Nonnull
114: public HttpStatusException withHeader (@Nonnull final String name, @Nonnull final String value)
115: {
116: final Map<String, String> newHeaders = new HashMap<>(headers);
117: newHeaders.put(name, value);
118: return new HttpStatusException(httpStatus, newHeaders);
119: }
120:
121: /***********************************************************************************************************************************************************
122: * Return {@code true} whether this exception represents an error.
123: *
124: * @return {@code true} in case of error
125: **********************************************************************************************************************************************************/
126: public boolean isError()
127: {
128:• return !GOOD_CODES.contains(httpStatus);
129: }
130:
131: /***********************************************************************************************************************************************************
132: * @param site
133: * @param target
134: * @return
135: **********************************************************************************************************************************************************/
136: @Nonnull
137: private static String createUrl (@Nonnull final Site site, @Nonnull final String target)
138: {
139:• return target.startsWith("http://") || target.startsWith("https://")
140: ? target
141: : site.createLink(ResourcePath.of(target));
142: }
143: }