/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.xml.ws.api;
import com.sun.istack.Nullable;
import javax.xml.ws.WebServiceException;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.Proxy;
import java.net.ProxySelector;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.net.URLConnection;
import java.net.URLStreamHandler;
import java.util.Iterator;
/**
* Represents the endpoint address URI.
*
* <p>
* Conceptually this can be really thought of as an {@link URI},
* but it hides some of the details that improve the performance.
*
* <p>
* Being an {@link URI} allows this class to represent custom made-up URIs
* (like "jms" for example.) Whenever possible, this object
* also creates an {@link URL} (this is only possible when the address
* has a registered {@link URLStreamHandler}), so that if the clients
* of this code wants to use it, it can do so.
*
*
* <h3>How it improves the performance</h3>
* <ol>
* <li>
* Endpoint address is often eventually turned into an {@link URLConnection},
* and given that generally this value is read more often than being set,
* it makes sense to eagerly turn it into an {@link URL},
* thereby avoiding a repeated conversion.
*
* <li>
* JDK spends a lot of time choosing a list of {@link Proxy}
* to connect to an {@link URL}. Since the default proxy selector
* implementation always return the same proxy for the same URL,
* we can determine the proxy by ourselves to let JDK skip its
* proxy-discovery step.
*
* (That said, user-defined proxy selector can do a lot of interesting things
* --- like doing a round-robin, or pick one from a proxy farm randomly,
* and so it's dangerous to stick to one proxy. For this case,
* we still let JDK decide the proxy. This shouldn't be that much of an
* disappointment, since most people only mess with system properties,
* and never with {@link ProxySelector}. Also, avoiding optimization
* with non-standard proxy selector allows people to effectively disable
* this optimization, which may come in handy for a trouble-shooting.)
* </ol>
*
* @author Kohsuke Kawaguchi
*/
public final class EndpointAddress {
@Nullable
private URL url;
private final URI uri;
private final String stringForm;
private volatile boolean dontUseProxyMethod;
/**
* Pre-selected proxy.
*
* If {@link #url} is null, this field is null.
* Otherwise, this field could still be null if the proxy couldn't be chosen
* upfront.
*/
private Proxy proxy;
public EndpointAddress(URI uri) {
this.uri = uri;
this.stringForm = uri.toString();
try {
this.url = uri.toURL();
proxy = chooseProxy();
} catch (MalformedURLException e) {
// ignore
}
}
/**
*
* @see #create(String)
*/
public EndpointAddress(String url) throws URISyntaxException {
this.uri = new URI(url);
this.stringForm = url;
try {
this.url = new URL(url);
proxy = chooseProxy();
} catch (MalformedURLException e) {
// ignore
}
}
/**
* Creates a new {@link EndpointAddress} with a reasonably
* generic error handling.
*/
public static EndpointAddress create(String url) {
try {
return new EndpointAddress(url);
} catch(URISyntaxException e) {
throw new WebServiceException("Illegal endpoint address: "+url,e);
}
}
private Proxy chooseProxy() {
ProxySelector sel =
java.security.AccessController.doPrivileged(
new java.security.PrivilegedAction<ProxySelector>() {
public ProxySelector run() {
return ProxySelector.getDefault();
}
});
if(sel==null)
return Proxy.NO_PROXY;
if(!sel.getClass().getName().equals("sun.net.spi.DefaultProxySelector"))
// user-defined proxy. may return a different proxy for each invocation
return null;
Iterator<Proxy> it = sel.select(uri).iterator();
if(it.hasNext())
return it.next();
return Proxy.NO_PROXY;
}
/**
* Returns an URL of this endpoint adress.
*
* @return
* null if this endpoint address doesn't have a registered {@link URLStreamHandler}.
*/
public URL getURL() {
return url;
}
/**
* Returns an URI of the endpoint address.
*
* @return
* always non-null.
*/
public URI getURI() {
return uri;
}
/**
* Tries to open {@link URLConnection} for this endpoint.
*
* <p>
* This is possible only when an endpoint address has
* the corresponding {@link URLStreamHandler}.
*
* @throws IOException
* if {@link URL#openConnection()} reports an error.
* @throws AssertionError
* if this endpoint doesn't have an associated URL.
* if the code is written correctly this shall never happen.
*/
public URLConnection openConnection() throws IOException {
assert url!=null : uri+" doesn't have the corresponding URL";
if (url == null) {
throw new WebServiceException("URI="+uri+" doesn't have the corresponding URL");
}
if(proxy!=null && !dontUseProxyMethod) {
try {
return url.openConnection(proxy);
} catch(UnsupportedOperationException e) {
// Some OSGi and app server environments donot
// override URLStreamHandler.openConnection(URL, Proxy) as it
// is introduced in Java SE 5 API. Fallback to the other method.
dontUseProxyMethod = true;
}
}
return url.openConnection();
}
public String toString() {
return stringForm;
}
}