| /* |
| * Copyright (c) OSGi Alliance (2002, 2013). All Rights Reserved. |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * 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 CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package org.osgi.service.url; |
| |
| import java.net.InetAddress; |
| import java.net.URL; |
| import java.net.URLConnection; |
| import org.osgi.annotation.versioning.ConsumerType; |
| |
| /** |
| * Service interface with public versions of the protected |
| * {@code java.net.URLStreamHandler} methods. |
| * <p> |
| * The important differences between this interface and the |
| * {@code URLStreamHandler} class are that the {@code setURL} method is absent |
| * and the {@code parseURL} method takes a {@link URLStreamHandlerSetter} object |
| * as the first argument. Classes implementing this interface must call the |
| * {@code setURL} method on the {@code URLStreamHandlerSetter} object received |
| * in the {@code parseURL} method instead of {@code URLStreamHandler.setURL} to |
| * avoid a {@code SecurityException}. |
| * |
| * @see AbstractURLStreamHandlerService |
| * |
| * @ThreadSafe |
| * @author $Id: 810d8718f5ad689981fbb2c22886ad2695f17297 $ |
| */ |
| @ConsumerType |
| public interface URLStreamHandlerService { |
| /** |
| * @see "java.net.URLStreamHandler.openConnection" |
| */ |
| @SuppressWarnings("javadoc") |
| public URLConnection openConnection(URL u) throws java.io.IOException; |
| |
| /** |
| * Parse a URL. This method is called by the {@code URLStreamHandler} proxy, |
| * instead of {@code java.net.URLStreamHandler.parseURL}, passing a |
| * {@code URLStreamHandlerSetter} object. |
| * |
| * @param realHandler The object on which {@code setURL} must be invoked for |
| * this URL. |
| * @see "java.net.URLStreamHandler.parseURL" |
| */ |
| @SuppressWarnings("javadoc") |
| public void parseURL(URLStreamHandlerSetter realHandler, URL u, String spec, int start, int limit); |
| |
| /** |
| * @see "java.net.URLStreamHandler.toExternalForm" |
| */ |
| @SuppressWarnings("javadoc") |
| public String toExternalForm(URL u); |
| |
| /** |
| * @see "java.net.URLStreamHandler.equals(URL, URL)" |
| */ |
| @SuppressWarnings("javadoc") |
| public boolean equals(URL u1, URL u2); |
| |
| /** |
| * @see "java.net.URLStreamHandler.getDefaultPort" |
| */ |
| @SuppressWarnings("javadoc") |
| public int getDefaultPort(); |
| |
| /** |
| * @see "java.net.URLStreamHandler.getHostAddress" |
| */ |
| @SuppressWarnings("javadoc") |
| public InetAddress getHostAddress(URL u); |
| |
| /** |
| * @see "java.net.URLStreamHandler.hashCode(URL)" |
| */ |
| @SuppressWarnings("javadoc") |
| public int hashCode(URL u); |
| |
| /** |
| * @see "java.net.URLStreamHandler.hostsEqual" |
| */ |
| @SuppressWarnings("javadoc") |
| public boolean hostsEqual(URL u1, URL u2); |
| |
| /** |
| * @see "java.net.URLStreamHandler.sameFile" |
| */ |
| @SuppressWarnings("javadoc") |
| public boolean sameFile(URL u1, URL u2); |
| } |