ca.nrc.cadc.reg.client

Class RegistryClient

java.lang.Object

ca.nrc.cadc.reg.client.RegistryClient

public class RegistryClient
extends java.lang.Object

A very simple caching IVOA Registry client. All the lookups done by this client use properties files served from a well-known URL.

Deployers can set a java system property to force this class to replace the hostname in the resulting URL with an arbitrary hostname. This is useful for testing a specific remote server:

 ca.nrc.cadc.reg.client.RegistryClient.host=www.example.com
 

The ca.nrc.cadc.reg.client.RegistryClient.host property replaces the entire fully-qualified host name with the specified value.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegistryClient.Query

Constructor Summary

Constructors

Constructor and Description
RegistryClient()

Method Summary

Modifier and Type	Method and Description
java.net.URL	getAccessURL(RegistryClient.Query queryName, java.net.URI uri) Get the accessURL for the resourceID or standardID from the specified query.
java.net.URL	getAccessURL(java.net.URI resourceID) Backwards compatibility/convenience: get the capabilities URL for the specified service.
Capabilities	getCapabilities(java.net.URI resourceID) Get the capabilities object for the resource identified by resourceID.
static java.lang.String	getDomain(java.lang.String hostname)
java.net.URL	getServiceURL(java.net.URI resourceIdentifier, java.net.URI standardID, ca.nrc.cadc.auth.AuthMethod authMethod) Find the service URL for the service registered under the specified base resource identifier and using the specified authentication method.
java.net.URL	getServiceURL(java.net.URI resourceID, java.net.URI standardID, ca.nrc.cadc.auth.AuthMethod authMethod, java.net.URI interfaceType) Find the service URL for the service registered under the specified base resource identifier and using the specified authentication method.
boolean	isRegistryLookupOverride() Find out if registry lookup URL was modified by a system property.
java.net.URL	mangleHostname(java.net.URL url)

Methods inherited from class java.lang.Object

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

Constructor Detail

RegistryClient

public RegistryClient()

Method Detail

isRegistryLookupOverride

public boolean isRegistryLookupOverride()

Find out if registry lookup URL was modified by a system property. This typically indicates that the code is running in a development/test environment.

Returns:

true if lookup is modified, false if default (production)

getAccessURL

public java.net.URL getAccessURL(java.net.URI resourceID)
                          throws java.io.IOException,
                                 ca.nrc.cadc.net.ResourceNotFoundException

Backwards compatibility/convenience: get the capabilities URL for the specified service.

Parameters:

resourceID - of a service that implements VOSI-capabilities

Returns:

capabilities URL

Throws:

java.io.IOException - local cache file(s) cannot be read or written

ca.nrc.cadc.net.ResourceNotFoundException - if the resourceID cannot be found in the registry

getAccessURL

public java.net.URL getAccessURL(RegistryClient.Query queryName,
                                 java.net.URI uri)
                          throws java.io.IOException,
                                 ca.nrc.cadc.net.ResourceNotFoundException

Get the accessURL for the resourceID or standardID from the specified query.

Parameters:

queryName - name of the canned query: QUERY_CAPABILITIES or QUERY_APPLICATIONS

uri - a resourceID (for QUERY_CAPABILITIES) or a standardID (for QUERY_APPLICATIONS)

Returns:

URL Location of the resource

Throws:

java.io.IOException - If the cache file cannot be read

ca.nrc.cadc.net.ResourceNotFoundException - if the resourceID cannot be found in the registry

getCapabilities

public Capabilities getCapabilities(java.net.URI resourceID)
                             throws java.io.IOException,
                                    ca.nrc.cadc.net.ResourceNotFoundException

Get the capabilities object for the resource identified by resourceID.

Parameters:

resourceID - Identifies the resource.

Returns:

The associated capabilities object.

Throws:

java.io.IOException - If the capabilities could not be determined.

ca.nrc.cadc.net.ResourceNotFoundException - if the resourceID cannot be found in the registry

getServiceURL

public java.net.URL getServiceURL(java.net.URI resourceIdentifier,
                                  java.net.URI standardID,
                                  ca.nrc.cadc.auth.AuthMethod authMethod)

Find the service URL for the service registered under the specified base resource identifier and using the specified authentication method. The identifier must be an IVOA identifier (e.g. with URI scheme "ivo"). This method uses the default interface type ParamHTTP defined in VOResource and returns the first matching interface.

Parameters:

resourceIdentifier - resource identifier, e.g. ivo://cadc.nrc.ca/tap

standardID - IVOA standard identifier, e.g. ivo://ivo.net/std/TAP

authMethod - authentication method to be used

Returns:

service URL or null if a matching interface was not found

getServiceURL

public java.net.URL getServiceURL(java.net.URI resourceID,
                                  java.net.URI standardID,
                                  ca.nrc.cadc.auth.AuthMethod authMethod,
                                  java.net.URI interfaceType)

Find the service URL for the service registered under the specified base resource identifier and using the specified authentication method. The identifier must be an IVOA identifier (e.g. with URI scheme "ivo"). This method returns the first matching interface.

Parameters:

resourceID - ID of the resource to lookup.

standardID - The standard ID of the resource to look up. Indicates the specific purpose of the resource to get a URL for.

authMethod - What Authentication method to use (certificate, cookie, etc.)

interfaceType - Interface type indicating how to access the resource (e.g. HTTP). See IVOA resource identifiers

Returns:

service URL or null if a matching interface was not found

mangleHostname

public java.net.URL mangleHostname(java.net.URL url)
                            throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

getDomain

public static java.lang.String getDomain(java.lang.String hostname)