1 /*
2 * ====================================================================
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 * ====================================================================
20 *
21 * This software consists of voluntary contributions made by many
22 * individuals on behalf of the Apache Software Foundation. For more
23 * information on the Apache Software Foundation, please see
24 * <http://www.apache.org/>.
25 *
26 */
27
28 package org.apache.hc.client5.http.classic.methods;
29
30 import java.net.URI;
31 import java.util.HashSet;
32 import java.util.Iterator;
33 import java.util.Set;
34
35 import org.apache.hc.core5.http.HeaderElement;
36 import org.apache.hc.core5.http.HttpResponse;
37 import org.apache.hc.core5.http.message.MessageSupport;
38 import org.apache.hc.core5.util.Args;
39
40 /**
41 * HTTP OPTIONS method.
42 *
43 * @since 4.0
44 */
45 public class HttpOptions extends HttpUriRequestBase {
46
47 private static final long serialVersionUID = 1L;
48
49 /**
50 * The method name {@value}.
51 */
52 public final static String METHOD_NAME = "OPTIONS";
53
54 /**
55 * Constructs a new instance initialized with the given URI.
56 *
57 * @param uri a non-null request URI.
58 * @throws IllegalArgumentException if the uri is null.
59 */
60 public HttpOptions(final URI uri) {
61 super(METHOD_NAME, uri);
62 }
63
64 /**
65 * Constructs a new instance initialized with the given URI.
66 *
67 * @param uri a non-null request URI.
68 * @throws IllegalArgumentException if the uri is invalid.
69 */
70 public HttpOptions(final String uri) {
71 this(URI.create(uri));
72 }
73
74 @Override
75 public String getMethod() {
76 return METHOD_NAME;
77 }
78
79 /**
80 * Gets the allowed method names defined by {@code "Allow"} headers.
81 *
82 * @param response the response to query.
83 * @return The response to query.
84 */
85 public Set<String> getAllowedMethods(final HttpResponse response) {
86 Args.notNull(response, "HTTP response");
87
88 final Iterator<HeaderElement> it = MessageSupport.iterate(response, "Allow");
89 final Set<String> methods = new HashSet<>();
90 while (it.hasNext()) {
91 final HeaderElement element = it.next();
92 methods.add(element.getName());
93 }
94 return methods;
95 }
96
97 }