Module org.apache.santuario.xmlsec

Package org.apache.xml.security.utils.resolver.implementations

Class ResolverDirectHTTP

java.lang.Object

org.apache.xml.security.utils.resolver.ResourceResolverSpi

org.apache.xml.security.utils.resolver.implementations.ResolverDirectHTTP

public class ResolverDirectHTTP
extends ResourceResolverSpi

A simple ResourceResolver for HTTP requests. This class handles only 'pure' HTTP URIs which means without a fragment. The Fragment handling is done by the ResolverFragment class.
If the user has a corporate HTTP proxy which is to be used, the usage can be switched on by setting properties for the resolver:

 resourceResolver.setProperty("http.proxy.host", "proxy.company.com");
 resourceResolver.setProperty("http.proxy.port", "8080");

 // if we need a password for the proxy
 resourceResolver.setProperty("http.proxy.username", "proxyuser3");
 resourceResolver.setProperty("http.proxy.password", "secretca");
 

See Also:

• Java Tip 42: Write Java apps that work with proxy-based firewalls
• JDK docs for network properties
• The JAVA FAQ Question 9.5: How do I make Java work with a proxy server?

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	HttpBasicPass	Field HttpProxyPass
private static final int	HttpBasicUser	Field HttpProxyUser
private static final int	HttpProxyHost	Field HttpProxyHost
private static final int	HttpProxyPass	Field HttpProxyPass
private static final int	HttpProxyPort	Field HttpProxyPort
private static final int	HttpProxyUser	Field HttpProxyUser
private static final System.Logger	LOG
private static final String[]	properties	Field properties[]
private final Map<String,String>	resolverProperties

Constructor Summary

Constructors

Constructor	Description
ResolverDirectHTTP()
ResolverDirectHTTP(Map<String,String> resolverProperties)

Method Summary

Modifier and Type	Method	Description
boolean	engineCanResolveURI(ResourceResolverContext context)	We resolve http URIs without fragment...
XMLSignatureInput	engineResolveURI(ResourceResolverContext context)	This is the workhorse method used to resolve resources.
private static URI	getNewURI(String uri, String baseURI)
private String	getProperty(ResourceResolverContext context, String propertyName)
private URLConnection	openConnection(URL url, ResourceResolverContext context)

Methods inherited from class java.lang.Object

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

Field Details

LOG

private static final System.Logger LOG

properties

private static final String[] properties

Field properties[]

HttpProxyHost

private static final int HttpProxyHost

Field HttpProxyHost

See Also:

• Constant Field Values

HttpProxyPort

private static final int HttpProxyPort

Field HttpProxyPort

See Also:

• Constant Field Values

HttpProxyUser

private static final int HttpProxyUser

Field HttpProxyUser

See Also:

• Constant Field Values

HttpProxyPass

private static final int HttpProxyPass

Field HttpProxyPass

See Also:

• Constant Field Values

HttpBasicUser

private static final int HttpBasicUser

Field HttpProxyUser

See Also:

• Constant Field Values

HttpBasicPass

private static final int HttpBasicPass

Field HttpProxyPass

See Also:

• Constant Field Values

resolverProperties

private final Map<String,String> resolverProperties

Constructor Details

ResolverDirectHTTP

public ResolverDirectHTTP()

ResolverDirectHTTP

public ResolverDirectHTTP(Map<String,String> resolverProperties)

Method Details

engineResolveURI

public XMLSignatureInput engineResolveURI(ResourceResolverContext context)
                                   throws ResourceResolverException

This is the workhorse method used to resolve resources.

Specified by:

engineResolveURI in class ResourceResolverSpi

Parameters:

context - Context to use to resolve resources.

Returns:

the resource wrapped around a XMLSignatureInput

Throws:

ResourceResolverException

openConnection

private URLConnection openConnection(URL url,
 ResourceResolverContext context)
                              throws IOException

Throws:

IOException

engineCanResolveURI

public boolean engineCanResolveURI(ResourceResolverContext context)

We resolve http URIs without fragment...

Specified by:

engineCanResolveURI in class ResourceResolverSpi

Parameters:

context -

Returns:

true if can be resolved

getNewURI

private static URI getNewURI(String uri,
 String baseURI)
                      throws URISyntaxException

Throws:

URISyntaxException

getProperty

private String getProperty(ResourceResolverContext context,
 String propertyName)