|
| 1 | +/* |
| 2 | + * Jooby https://jooby.io |
| 3 | + * Apache License Version 2.0 https://jooby.io/LICENSE.txt |
| 4 | + * Copyright 2014 Edgar Espina |
| 5 | + */ |
| 6 | +package io.jooby; |
| 7 | + |
| 8 | +/** |
| 9 | + * Router options: |
| 10 | + * |
| 11 | + * <ul> |
| 12 | + * <li>ignoreCase: Indicates whenever routing algorithm does case-sensitive matching on an |
| 13 | + * incoming request path. Default is <code> false</code> (case sensitive). |
| 14 | + * <li>ignoreTrailingSlash: Indicates whenever a trailing slash is ignored on an incoming request |
| 15 | + * path. |
| 16 | + * <li>normalizeSlash: Normalize an incoming request path by removing consecutive <code>/</code> |
| 17 | + * (slashes). |
| 18 | + * <li>resetHeadersOnError: Indicates whenever response headers are clear/reset in case of |
| 19 | + * exception. |
| 20 | + * </ul> |
| 21 | + * |
| 22 | + * @author edgar |
| 23 | + * @since 2.4.0 |
| 24 | + */ |
| 25 | +public class RouterOptions { |
| 26 | + /** |
| 27 | + * Indicates whenever routing algorithm does case-sensitive matching on an incoming request path. |
| 28 | + * Default is <code>case sensitive</code>. |
| 29 | + */ |
| 30 | + private boolean ignoreCase; |
| 31 | + |
| 32 | + /** Indicates whenever a trailing slash is ignored on an incoming request path. */ |
| 33 | + private boolean ignoreTrailingSlash; |
| 34 | + |
| 35 | + /** Normalize an incoming request path by removing multiple slash sequences. */ |
| 36 | + private boolean normalizeSlash; |
| 37 | + |
| 38 | + /** Indicates whenever response headers are clear/reset in case of exception. */ |
| 39 | + private boolean resetHeadersOnError; |
| 40 | + |
| 41 | + /** |
| 42 | + * Indicates whenever routing algorithm does case-sensitive matching on an incoming request path. |
| 43 | + * Default is <code>false (case sensitive)</code>. |
| 44 | + * |
| 45 | + * @return True when case is ignored. |
| 46 | + */ |
| 47 | + public boolean isIgnoreCase() { |
| 48 | + return ignoreCase; |
| 49 | + } |
| 50 | + |
| 51 | + /** |
| 52 | + * Indicates whenever routing algorithm does case-sensitive matching on an incoming request path. |
| 53 | + * Default is <code>false (case sensitive)</code>. |
| 54 | + * |
| 55 | + * @param ignoreCase True for case-insensitive. |
| 56 | + * @return This options. |
| 57 | + */ |
| 58 | + public RouterOptions setIgnoreCase(boolean ignoreCase) { |
| 59 | + this.ignoreCase = ignoreCase; |
| 60 | + return this; |
| 61 | + } |
| 62 | + |
| 63 | + /** |
| 64 | + * Indicates whenever routing algorithm does case-sensitive matching on an incoming request path. |
| 65 | + * Default is <code>false (case sensitive)</code>. |
| 66 | + * |
| 67 | + * @param ignoreCase True for case-insensitive. |
| 68 | + * @return This options. |
| 69 | + */ |
| 70 | + public RouterOptions ignoreCase(boolean ignoreCase) { |
| 71 | + return setIgnoreCase(ignoreCase); |
| 72 | + } |
| 73 | + |
| 74 | + /** |
| 75 | + * Indicates whenever a trailing slash is ignored on an incoming request path. |
| 76 | + * |
| 77 | + * @return Indicates whenever a trailing slash is ignored on an incoming request path. |
| 78 | + */ |
| 79 | + public boolean isIgnoreTrailingSlash() { |
| 80 | + return ignoreTrailingSlash; |
| 81 | + } |
| 82 | + |
| 83 | + /** |
| 84 | + * Set whenever a trailing slash is ignored on an incoming request path. |
| 85 | + * |
| 86 | + * @param ignoreTrailingSlash whenever a trailing slash is ignored on an incoming request path. |
| 87 | + * @return This options. |
| 88 | + */ |
| 89 | + public RouterOptions setIgnoreTrailingSlash(boolean ignoreTrailingSlash) { |
| 90 | + this.ignoreTrailingSlash = ignoreTrailingSlash; |
| 91 | + return this; |
| 92 | + } |
| 93 | + |
| 94 | + /** |
| 95 | + * Set whenever a trailing slash is ignored on an incoming request path. |
| 96 | + * |
| 97 | + * @param ignoreTrailingSlash whenever a trailing slash is ignored on an incoming request path. |
| 98 | + * @return This options. |
| 99 | + */ |
| 100 | + public RouterOptions ignoreTrailingSlash(boolean ignoreTrailingSlash) { |
| 101 | + return setIgnoreTrailingSlash(ignoreTrailingSlash); |
| 102 | + } |
| 103 | + |
| 104 | + /** |
| 105 | + * Normalize an incoming request path by removing multiple slash sequences. |
| 106 | + * |
| 107 | + * @return Normalize an incoming request path by removing multiple slash sequences. |
| 108 | + */ |
| 109 | + public boolean isNormalizeSlash() { |
| 110 | + return normalizeSlash; |
| 111 | + } |
| 112 | + |
| 113 | + /** |
| 114 | + * Set whenever normalize an incoming request path by removing multiple slash sequences. |
| 115 | + * |
| 116 | + * @param normalizeSlash True for normalize a path. |
| 117 | + * @return This options. |
| 118 | + */ |
| 119 | + public RouterOptions setNormalizeSlash(boolean normalizeSlash) { |
| 120 | + this.normalizeSlash = normalizeSlash; |
| 121 | + return this; |
| 122 | + } |
| 123 | + |
| 124 | + /** |
| 125 | + * Set whenever normalize an incoming request path by removing multiple slash sequences. |
| 126 | + * |
| 127 | + * @param normalizeSlash True for normalize a path. |
| 128 | + * @return This options. |
| 129 | + */ |
| 130 | + public RouterOptions normalizeSlash(boolean normalizeSlash) { |
| 131 | + return setNormalizeSlash(normalizeSlash); |
| 132 | + } |
| 133 | + |
| 134 | + /** |
| 135 | + * Indicates whenever response headers are clear/reset in case of exception. |
| 136 | + * |
| 137 | + * @return Indicates whenever response headers are clear/reset in case of exception. |
| 138 | + */ |
| 139 | + public boolean isResetHeadersOnError() { |
| 140 | + return resetHeadersOnError; |
| 141 | + } |
| 142 | + |
| 143 | + /** |
| 144 | + * Set whenever response headers are clear/reset in case of exception. |
| 145 | + * |
| 146 | + * @param resetHeadersOnError whenever response headers are clear/reset in case of exception. |
| 147 | + * @return This options. |
| 148 | + */ |
| 149 | + public RouterOptions setResetHeadersOnError(boolean resetHeadersOnError) { |
| 150 | + this.resetHeadersOnError = resetHeadersOnError; |
| 151 | + return this; |
| 152 | + } |
| 153 | + |
| 154 | + /** |
| 155 | + * Set whenever response headers are clear/reset in case of exception. |
| 156 | + * |
| 157 | + * @param resetHeadersOnError whenever response headers are clear/reset in case of exception. |
| 158 | + * @return This options. |
| 159 | + */ |
| 160 | + public RouterOptions resetHeaderOnError(boolean resetHeadersOnError) { |
| 161 | + return setResetHeadersOnError(resetHeadersOnError); |
| 162 | + } |
| 163 | + |
| 164 | + /** |
| 165 | + * Case-sensitive with reset headers on error enabled. |
| 166 | + * |
| 167 | + * @return Default options. |
| 168 | + */ |
| 169 | + public static RouterOptions defaults() { |
| 170 | + return new RouterOptions().resetHeaderOnError(true); |
| 171 | + } |
| 172 | + |
| 173 | + /** |
| 174 | + * Case-inSensitive with reset headers on error enabled. |
| 175 | + * |
| 176 | + * @return Default options. |
| 177 | + */ |
| 178 | + public static RouterOptions caseInsensitive() { |
| 179 | + return new RouterOptions().ignoreCase(true).resetHeaderOnError(true); |
| 180 | + } |
| 181 | +} |
0 commit comments