001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.rest.server.httppart;
018
019import static org.apache.juneau.commons.httppart.HttpPartType.*;
020
021import java.lang.reflect.*;
022import java.util.regex.*;
023
024import org.apache.juneau.http.*;
025import org.apache.juneau.http.header.*;
026import org.apache.juneau.marshall.*;
027import org.apache.juneau.marshall.httppart.*;
028import org.apache.juneau.rest.server.*;
029
030/**
031 * Represents a single header on an HTTP request.
032 *
033 * <p>
034 * Typically accessed through the {@link RequestHeaderList} class.
035 *
036 * <p>
037 *    Some important methods on this class are:
038 * </p>
039 * <ul class='javatree'>
040 *    <li class='jc'>{@link RequestHeader}
041 *    <ul class='spaced-list'>
042 *       <li>Methods for retrieving simple string values:
043 *       <ul class='javatreec'>
044 *          <li class='jm'>{@link RequestHeader#asString() asString()}
045 *          <li class='jm'>{@link RequestHeader#get() get()}
046 *          <li class='jm'>{@link RequestHeader#isPresent() isPresent()}
047 *          <li class='jm'>{@link RequestHeader#orElse(String) orElse(String)}
048 *       </ul>
049 *       <li>Methods for retrieving as other common types:
050 *       <ul class='javatreec'>
051 *          <li class='jm'>{@link RequestHeader#asBoolean() asBoolean()}
052 *          <li class='jm'>{@link RequestHeader#asBooleanHeader() asBooleanHeader()}
053 *          <li class='jm'>{@link RequestHeader#asCsvArray() asCsvArray()}
054 *          <li class='jm'>{@link RequestHeader#asCsvHeader() asCsvHeader()}
055 *          <li class='jm'>{@link RequestHeader#asDate() asDate()}
056 *          <li class='jm'>{@link RequestHeader#asDateHeader() asDateHeader()}
057 *          <li class='jm'>{@link RequestHeader#asEntityTagsHeader() asEntityTagsHeader()}
058 *          <li class='jm'>{@link RequestHeader#asEntityTagHeader() asEntityTagHeader()}
059 *          <li class='jm'>{@link RequestHeader#asInteger() asInteger()}
060 *          <li class='jm'>{@link RequestHeader#asIntegerHeader() asIntegerHeader()}
061 *          <li class='jm'>{@link RequestHeader#asLong() asLong()}
062 *          <li class='jm'>{@link RequestHeader#asLongHeader() asLongHeader()}
063 *          <li class='jm'>{@link RequestHeader#asMatcher(Pattern) asMatcher(Pattern)}
064 *          <li class='jm'>{@link RequestHeader#asMatcher(String) asMatcher(String)}
065 *          <li class='jm'>{@link RequestHeader#asMatcher(String,int) asMatcher(String,int)}
066 *          <li class='jm'>{@link RequestHeader#asStringHeader() asStringHeader()}
067 *          <li class='jm'>{@link RequestHeader#asStringRangesHeader() asStringRangesHeader()}
068 *          <li class='jm'>{@link RequestHeader#asUriHeader() asUriHeader()}
069 *       </ul>
070 *       <li>Methods for retrieving as custom types:
071 *       <ul class='javatreec'>
072 *          <li class='jm'>{@link RequestHeader#as(Class) as(Class)}
073 *          <li class='jm'>{@link RequestHeader#as(ClassMeta) as(ClassMeta)}
074 *          <li class='jm'>{@link RequestHeader#as(Type,Type...) as(Type,Type...)}
075 *          <li class='jm'>{@link RequestHeader#parser(HttpPartParserSession) parser(HttpPartParserSession)}
076 *          <li class='jm'>{@link RequestHeader#schema(HttpPartSchema) schema(HttpPartSchema)}
077 *       </ul>
078 *       <li>Methods for performing assertion checks:
079 *       <ul class='javatreec'>
080 *          <li class='jm'>{@link RequestHeader#assertCsvArray() assertCsvArray()}
081 *          <li class='jm'>{@link RequestHeader#assertDate() assertDate()}
082 *          <li class='jm'>{@link RequestHeader#assertInteger() assertInteger()}
083 *          <li class='jm'>{@link RequestHeader#assertLong() assertLong()}
084 *          <li class='jm'>{@link RequestHeader#assertString() assertString()}
085 *       </ul>
086 *       <li>Other methods:
087 *       <ul class='javatreec'>
088 *          <li class='jm'>{@link RequestHeader#getName() getName()}
089 *          <li class='jm'>{@link RequestHeader#getValue() getValue()}
090 *       </ul>
091 *    </ul>
092 * </ul>
093 *
094 * <h2 class='section'>See Also:</h2><ul>
095 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/RestServerHttpParts">HTTP parts in REST servers</a>
096 * </ul>
097 */
098public class RequestHeader extends RequestHttpPart implements HttpHeader {
099
100   /**
101    * Constructor.
102    *
103    * @param request The request object.
104    * @param name The header name.
105    * @param value The header value.
106    */
107   public RequestHeader(RestRequest request, String name, String value) {
108      super(HEADER, request, name, value);
109   }
110
111   /**
112    * Returns the value of this header as an {@link HttpBooleanHeader}.
113    *
114    * @return The value of this header as an {@link HttpBooleanHeader}, never <jk>null</jk>.
115    */
116   public HttpBooleanHeader asBooleanHeader() {
117      return HttpBooleanHeader.of(getName(), getValue());
118   }
119
120   /**
121    * Returns the value of this header as an {@link HttpCsvHeader}.
122    *
123    * @return The value of this header as an {@link HttpCsvHeader}, never <jk>null</jk>.
124    */
125   public HttpCsvHeader asCsvHeader() {
126      return HttpCsvHeader.of(getName(), getValue());
127   }
128
129   /**
130    * Returns the value of this header as an {@link HttpDateHeader}.
131    *
132    * @return The value of this header as an {@link HttpDateHeader}, never <jk>null</jk>.
133    */
134   public HttpDateHeader asDateHeader() {
135      return HttpDateHeader.of(getName(), getValue());
136   }
137
138   /**
139    * Returns the value of this header as an {@link HttpEntityTagHeader}.
140    *
141    * @return The value of this header as an {@link HttpEntityTagHeader}, never <jk>null</jk>.
142    */
143   public HttpEntityTagHeader asEntityTagHeader() {
144      return HttpEntityTagHeader.of(getName(), getValue());
145   }
146
147   /**
148    * Returns the value of this header as an {@link HttpEntityTagsHeader}.
149    *
150    * @return The value of this header as an {@link HttpEntityTagsHeader}, never <jk>null</jk>.
151    */
152   public HttpEntityTagsHeader asEntityTagsHeader() {
153      return HttpEntityTagsHeader.of(getName(), getValue());
154   }
155
156   /**
157    * Returns the value of this header as an {@link HttpIntegerHeader}.
158    *
159    * @return The value of this header as an {@link HttpIntegerHeader}, never <jk>null</jk>.
160    */
161   public HttpIntegerHeader asIntegerHeader() {
162      return HttpIntegerHeader.of(getName(), getValue());
163   }
164
165   /**
166    * Returns the value of this header as an {@link HttpLongHeader}.
167    *
168    * @return The value of this header as an {@link HttpLongHeader}, never <jk>null</jk>.
169    */
170   public HttpLongHeader asLongHeader() {
171      return HttpLongHeader.of(getName(), getValue());
172   }
173
174   /**
175    * Returns the value of this header as an {@link HttpStringHeader}.
176    *
177    * @return The value of this header as an {@link HttpStringHeader}, never <jk>null</jk>.
178    */
179   public HttpStringHeader asStringHeader() {
180      return HttpStringHeader.of(getName(), getValue());
181   }
182
183   /**
184    * Returns the value of this header as an {@link HttpStringRangesHeader}.
185    *
186    * @return The value of this header as an {@link HttpStringRangesHeader}, never <jk>null</jk>.
187    */
188   public HttpStringRangesHeader asStringRangesHeader() {
189      return HttpStringRangesHeader.of(getName(), getValue());
190   }
191
192   /**
193    * Returns the value of this header as an {@link HttpUriHeader}.
194    *
195    * @return The value of this header as an {@link HttpUriHeader}, never <jk>null</jk>.
196    */
197   public HttpUriHeader asUriHeader() {
198      return HttpUriHeader.of(getName(), getValue());
199   }
200
201   @Override /* Overridden from RequestHttpPart */
202   public RequestHeader def(String def) {
203      super.def(def);
204      return this;
205   }
206
207   @Override /* Overridden from RequestHttpPart */
208   public RequestHeader parser(HttpPartParserSession value) {
209      super.parser(value);
210      return this;
211   }
212
213   @Override /* Overridden from RequestHttpPart */
214   public RequestHeader schema(HttpPartSchema value) {
215      super.schema(value);
216      return this;
217   }
218
219   @Override /* Overridden from Object */
220   public String toString() {
221      return getName() + ": " + getValue();
222   }
223}