Package org.apache.felix.framework

Class URLHandlersStreamHandlerProxy

java.lang.Object

java.net.URLStreamHandler

org.apache.felix.framework.URLHandlersStreamHandlerProxy

All Implemented Interfaces:

InvocationHandler, URLStreamHandlerSetter

public class URLHandlersStreamHandlerProxy
extends URLStreamHandler
implements URLStreamHandlerSetter, InvocationHandler

This class implements a stream handler proxy. When the stream handler proxy instance is created, it is associated with a particular protocol and will answer all future requests for handling of that stream type. It does not directly handle the stream handler requests, but delegates the requests to an underlying stream handler service.

The proxy instance for a particular protocol is used for all framework instances that may contain their own stream handler services. When performing a stream handler operation, the proxy retrieves the handler service from the framework instance associated with the current call stack and delegates the call to the handler service.

The proxy will create simple stream handler service trackers for each framework instance. The trackers will listen to service events in its respective framework instance to maintain a reference to the "best" stream handler service at any given time.

Field Summary

Fields

Modifier and Type	Field	Description
private static final Method	EQUALS
private static final Method	GET_DEFAULT_PORT
private static final Method	GET_HOST_ADDRESS
private static final Method	HASH_CODE
private static final Method	HOSTS_EQUAL
private final SecureAction	m_action
private final URLStreamHandler	m_builtIn
private final URL	m_builtInURL
private static final ThreadLocal<Thread>	m_loopCheck
private final String	m_protocol
private final Object	m_service
private static final Method	OPEN_CONNECTION
private static final Method	OPEN_CONNECTION_PROXY
private static final Method	SAME_FILE
private static final Class<?>[]	STRING_TYPES
private static final Method	TO_EXTERNAL_FORM
private static final Class<?>[]	URL_PROXY_CLASS

Constructor Summary

Constructors

Constructor	Description
URLHandlersStreamHandlerProxy(Object service, SecureAction action)
URLHandlersStreamHandlerProxy(String protocol, SecureAction action, URLStreamHandler builtIn, URL builtInURL)

Method Summary

Modifier and Type	Method	Description
protected boolean	equals(URL url1, URL url2)
protected int	getDefaultPort()
protected InetAddress	getHostAddress(URL url)
private Object	getStreamHandlerService()	Private method to retrieve the stream handler service from the framework instance associated with the current call stack.
protected int	hashCode(URL url)
protected boolean	hostsEqual(URL url1, URL url2)
Object	invoke(Object obj, Method method, Object[] params)
protected URLConnection	openConnection(URL url)
protected URLConnection	openConnection(URL url, Proxy proxy)
protected void	parseURL(URL url, String spec, int start, int limit)
private static Method	reflect(SecureAction action, String name, Class<?>... classes)
private static void	rethrowIOException(Exception ex)	Rethrows the given exception if it is an IOException, or the IOException thrown by a stream handler method invoked through reflection, which is wrapped in an InvocationTargetException, so that callers get the same exception as with a direct invocation of the handler.
protected boolean	sameFile(URL url1, URL url2)
void	setURL(URL url, String protocol, String host, int port, String file, String ref)	Deprecated.
void	setURL(URL url, String protocol, String host, int port, String authority, String userInfo, String path, String query, String ref)
protected String	toExternalForm(URL url)
private String	toExternalForm(URL url, Object svc)
(package private) static URLStreamHandler	wrap(String protocol, SecureAction action, URLStreamHandler builtIn, URL builtInURL)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

URL_PROXY_CLASS

private static final Class<?>[] URL_PROXY_CLASS

STRING_TYPES

private static final Class<?>[] STRING_TYPES

EQUALS

private static final Method EQUALS

GET_DEFAULT_PORT

private static final Method GET_DEFAULT_PORT

GET_HOST_ADDRESS

private static final Method GET_HOST_ADDRESS

HASH_CODE

private static final Method HASH_CODE

HOSTS_EQUAL

private static final Method HOSTS_EQUAL

OPEN_CONNECTION

private static final Method OPEN_CONNECTION

OPEN_CONNECTION_PROXY

private static final Method OPEN_CONNECTION_PROXY

SAME_FILE

private static final Method SAME_FILE

TO_EXTERNAL_FORM

private static final Method TO_EXTERNAL_FORM

m_service

private final Object m_service

m_action

private final SecureAction m_action

m_builtIn

private final URLStreamHandler m_builtIn

m_builtInURL

private final URL m_builtInURL

m_protocol

private final String m_protocol

m_loopCheck

private static final ThreadLocal<Thread> m_loopCheck

Constructor Details

URLHandlersStreamHandlerProxy

public URLHandlersStreamHandlerProxy(String protocol,
 SecureAction action,
 URLStreamHandler builtIn,
 URL builtInURL)

URLHandlersStreamHandlerProxy

URLHandlersStreamHandlerProxy(Object service,
 SecureAction action)

Method Details

reflect

private static Method reflect(SecureAction action,
 String name,
 Class<?>... classes)

wrap

static URLStreamHandler wrap(String protocol,
 SecureAction action,
 URLStreamHandler builtIn,
 URL builtInURL)

equals

protected boolean equals(URL url1,
 URL url2)

Overrides:

equals in class URLStreamHandler

getDefaultPort

protected int getDefaultPort()

Overrides:

getDefaultPort in class URLStreamHandler

getHostAddress

protected InetAddress getHostAddress(URL url)

Overrides:

getHostAddress in class URLStreamHandler

hashCode

protected int hashCode(URL url)

Overrides:

hashCode in class URLStreamHandler

hostsEqual

protected boolean hostsEqual(URL url1,
 URL url2)

Overrides:

hostsEqual in class URLStreamHandler

openConnection

protected URLConnection openConnection(URL url)
                                throws IOException

Specified by:

openConnection in class URLStreamHandler

Throws:

IOException

openConnection

protected URLConnection openConnection(URL url,
 Proxy proxy)
                                throws IOException

Overrides:

openConnection in class URLStreamHandler

Throws:

IOException

rethrowIOException

private static void rethrowIOException(Exception ex)
                                throws IOException

Rethrows the given exception if it is an IOException, or the IOException thrown by a stream handler method invoked through reflection, which is wrapped in an InvocationTargetException, so that callers get the same exception as with a direct invocation of the handler.

Parameters:

ex - the exception caught while invoking a stream handler method

Throws:

IOException - the exception itself or the cause of the invocation exception

parseURL

protected void parseURL(URL url,
 String spec,
 int start,
 int limit)

Overrides:

parseURL in class URLStreamHandler

sameFile

protected boolean sameFile(URL url1,
 URL url2)

Overrides:

sameFile in class URLStreamHandler

setURL

public void setURL(URL url,
 String protocol,
 String host,
 int port,
 String authority,
 String userInfo,
 String path,
 String query,
 String ref)

Specified by:

setURL in interface URLStreamHandlerSetter

Overrides:

setURL in class URLStreamHandler

See Also:

• "java.net.URLStreamHandler.setURL(URL,String,String,int,String,String,String,String)"

setURL

@Deprecated
public void setURL(URL url,
 String protocol,
 String host,
 int port,
 String file,
 String ref)

Deprecated.

Specified by:

setURL in interface URLStreamHandlerSetter

Overrides:

setURL in class URLStreamHandler

See Also:

• "java.net.URLStreamHandler.setURL(URL,String,String,int,String,String)"

toExternalForm

protected String toExternalForm(URL url)

Overrides:

toExternalForm in class URLStreamHandler

toExternalForm

private String toExternalForm(URL url,
 Object svc)

getStreamHandlerService

private Object getStreamHandlerService()

Private method to retrieve the stream handler service from the framework instance associated with the current call stack. A simple service tracker is created and cached for the associated framework instance when this method is called.

Returns:

the stream handler service from the framework instance associated with the current call stack or null is no service is available.

invoke

public Object invoke(Object obj,
 Method method,
 Object[] params)
              throws Throwable

Specified by:

invoke in interface InvocationHandler

Throws:

Throwable