com.infoengine.au
Class NamingService

java.lang.Object
  com.infoengine.au.NamingService

All Implemented Interfaces:

com.infoengine.au.PropertyListener

public class NamingService
extends java.lang.Object
implements com.infoengine.au.PropertyListener

This class provides a registry that associates Info*Engine services with their network addresses and/or implementation classes. It obtains information from static property files and/or network resources accessed via HTTP or LDAP. Standalone applications should use one of its static factory methods at startup time to initialize the registry.

Method Summary

static void	addService(java.lang.String serviceName, com.infoengine.object.ObjectDestination dest) Adds an entry to the service registry.
static java.util.Enumeration	getAllAddresses(java.lang.String serviceName) Return all of the registry entries associated with a named service.
static java.net.Socket	getConnection(java.lang.String serviceName) Returns a socket connected to a named service.
static java.lang.String	getDirectoryProvider() Returns the URI of the directory service provider currently being used by the naming service.
static java.lang.String	getDomainBase() Returns the directory service domain base currently being used by the naming service.
static com.infoengine.au.IEProperties	getIEProperties() Obtain, and create if necessary, the IEProperties object used by this JVM.
static NamingService	getInstance() Return the naming service instance most recently created by one of the static factory methods.
static java.lang.String	getLocalServiceDN(java.lang.String serviceName) Returns the distinguished name of the directory entry registered for a local service.
java.util.Properties	getProperties() Returns the properties object currently being used by the NamingService instance.
static java.lang.String	getPropertySource() Returns the URI specifying the source of the configuration properties currently being used by the naming service.
static java.lang.String	getSearchBase() Returns the directory service search base currently being used by the naming service.
static com.infoengine.object.ObjectDestination	getService(java.lang.String serviceName) Return one of the registry entries associated with a named service.
static com.infoengine.object.ObjectServiceCache	getServiceCache()
static int	getServiceCacheTimeToLive()
static java.lang.String	getServiceName() Returns the name of the NamingService service.
static java.util.Enumeration	getServicePropertyNames(java.lang.String serviceName) Returns an enumeration of the service-specific property names defined for a specific service.
static java.lang.String	getVMName() Returns the name currently set for this virtual machine.
static boolean	isLocalService(java.lang.String dn) Determines whether a specific directory distinguished name references a service registered in this virtual machine.
static void	main(java.lang.String[] args) When initiated via command line, the naming service operates as a utility that can initiate other programs defined by naming service launch properties.
static NamingService	newInstance() Return a naming service instance with an uninitialized registry.
static NamingService	newInstance(java.lang.String resource) Return a naming service instance providing access to a registry that is initialized from a static properties file and/or a network resource obtained using HTTP or LDAP.
static NamingService	newInstance(java.lang.String serviceName, java.util.Properties props) Deprecated.
static NamingService	newInstance(java.lang.String serviceName, java.lang.String resource) Return a naming service instance providing access to a registry that is initialized from a static properties file and/or a network resource obtained using HTTP or LDAP.
static NamingService	newInstance(java.lang.String serviceName, java.lang.String resource, java.lang.String[] args) Return a naming service instance providing access to a registry that is initialized from a static properties file and/or a network resource obtained using HTTP or LDAP.
void	refreshProperties()
static void	registerLocalService(java.lang.String serviceName, java.lang.String dn) Registers a service name and the distinguished name of its directory entry as a local service.
void	reinitialize()
static void	setGlobalProperties() Sets global properties for the VM based upon the VM name.
static void	setGlobalProperties(java.lang.String propPrefix) Deprecated.
static void	setServiceCacheTimeToLive(int minutes)
static void	setVMName(java.lang.String name) Set the name of this virtual machine.

Methods inherited from class java.lang.Object

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

Method Detail

newInstance

public static NamingService newInstance()

Return a naming service instance with an uninitialized registry.

Returns:

A naming service instance.

newInstance

public static NamingService newInstance(java.lang.String resource)
                                 throws java.io.IOException,
                                        java.io.FileNotFoundException,
                                        java.net.MalformedURLException,
                                        com.infoengine.au.NamingServiceException

Return a naming service instance providing access to a registry that is initialized from a static properties file and/or a network resource obtained using HTTP or LDAP.

Parameters:

resource - A file pathname or file URL referencing a property file in the local file system, or an HTTP or LDAP URL referencing a network resource containing property definitions.

Returns:

A naming service instance.

Throws:

java.io.IOException - if an I/O error prevents properties from being accessed or read.

java.io.FileNotFoundException - if a specified property file or network resource does not exist.

java.net.MalformedURLException - if an HTTP or LDAP URL has incorrect syntax.

com.infoengine.au.NamingServiceException - if no service-specific properties are defined.

newInstance

public static NamingService newInstance(java.lang.String serviceName,
                                        java.lang.String resource)
                                 throws java.io.IOException,
                                        java.io.FileNotFoundException,
                                        java.net.MalformedURLException,
                                        com.infoengine.au.NamingServiceException

Return a naming service instance providing access to a registry that is initialized from a static properties file and/or a network resource obtained using HTTP or LDAP.

Parameters:

serviceName - The name of the naming service itself. This name is used as the prefix of property names defined in a property file or network property resource.

resource - A file pathname or file URL referencing a property file in the local file system, or an HTTP or LDAP URL referencing a network resource containing property definitions.

Returns:

A naming service instance.

Throws:

java.io.IOException - if an I/O error prevents properties from being accessed or read.

java.io.FileNotFoundException - if a specified property file or network resource does not exist.

java.net.MalformedURLException - if an HTTP or LDAP URL has incorrect syntax.

com.infoengine.au.NamingServiceException - if no service-specific properties are defined.

newInstance

public static NamingService newInstance(java.lang.String serviceName,
                                        java.lang.String resource,
                                        java.lang.String[] args)
                                 throws java.io.IOException,
                                        java.io.FileNotFoundException,
                                        java.net.MalformedURLException,
                                        com.infoengine.au.NamingServiceException

Return a naming service instance providing access to a registry that is initialized from a static properties file and/or a network resource obtained using HTTP or LDAP.

Parameters:

serviceName - The name of the naming service itself. This name is used as the prefix of property names defined in a property file or network property resource.

resource - A file pathname or file URL referencing a property file in the local file system, or an HTTP or LDAP URL referencing a network resource containing property definitions.

args - An array of String arguments, usually passed from a command line to the main method of a program.

Returns:

A naming service instance.

Throws:

java.io.IOException - if an I/O error prevents properties from being accessed or read.

java.io.FileNotFoundException - if a specified property file or network resource does not exist.

java.net.MalformedURLException - if an HTTP or LDAP URL has incorrect syntax.

com.infoengine.au.NamingServiceException - if no service-specific properties are defined.

newInstance

public static NamingService newInstance(java.lang.String serviceName,
                                        java.util.Properties props)
                                 throws com.infoengine.au.NamingServiceException

Deprecated.

Return a naming service instance providing access to a registry that is initialized from a Properties object.

Parameters:

serviceName - The name of the naming service itself. This name is used as the prefix of property names defined in a Properties object.

props - The Properties object from which to initialize the registry.

Returns:

A naming service instance.

Throws:

com.infoengine.au.NamingServiceException - if no service-specific properties are defined.

setVMName

public static void setVMName(java.lang.String name)

Set the name of this virtual machine. The virtual machine name is used as a key to search the registry for the distinguished name associated with this virtual machine. The distinguished name is used in determining whether services are configured to run in-process or out-of-process. This is accomplished by comparing the distinguished name of the virtual machine against the ptcCoresidentService attribute values registered for a service. If a match is found, the service is configured to run in-process.

Parameters:

name - The new name to set for the virtual machine.

getVMName

public static java.lang.String getVMName()

Returns the name currently set for this virtual machine.

Returns:

The current name of the virtual machine, or null if a name has not been set.

getInstance

public static NamingService getInstance()

Return the naming service instance most recently created by one of the static factory methods.

Returns:

The most recently created naming service instance.

getDirectoryProvider

public static java.lang.String getDirectoryProvider()

Returns the URI of the directory service provider currently being used by the naming service. This is usually a URI with a format such as: ldap://hostname

Returns:

The URI of the current directory service provider, or null if a directory service provider is not currently being used.

getSearchBase

public static java.lang.String getSearchBase()

Returns the directory service search base currently being used by the naming service. This is usually the distinguished name of a directory entry that establishes the root of a subtree containing Info*Engine service entries such as entries describing adapters and task processors.

Returns:

The current directory service search base.

getServiceName

public static java.lang.String getServiceName()

Returns the name of the NamingService service.

Returns:

The current name of this service.

getDomainBase

public static java.lang.String getDomainBase()

Returns the directory service domain base currently being used by the naming service. This is usually the distinguished name of a directory entry that establishes the root of a subtree containing Info*Engine service entries such as entries describing adapters and task processors. This subtree is comprised of domain entries that use dc (domain component) as their naming attribute.

Returns:

The current directory service domain base.

getPropertySource

public static java.lang.String getPropertySource()

Returns the URI specifying the source of the configuration properties currently being used by the naming service.

Returns:

The URI of the current configuration properties source.

getServicePropertyNames

public static java.util.Enumeration getServicePropertyNames(java.lang.String serviceName)

Returns an enumeration of the service-specific property names defined for a specific service.

Parameters:

serviceName - The name of the service for which to return property names

Returns:

The enumeration of property names

getService

public static com.infoengine.object.ObjectDestination getService(java.lang.String serviceName)
                                                          throws com.infoengine.au.NamingServiceException

Return one of the registry entries associated with a named service. If a service has more than one registry entry, one is picked at random and returned.

Parameters:

serviceName - The name of the service.

Returns:

The registry entry of the service.

Throws:

com.infoengine.au.NamingServiceException - if the service is unknown or some other exception prevents it from being looked up.

registerLocalService

public static void registerLocalService(java.lang.String serviceName,
                                        java.lang.String dn)

Registers a service name and the distinguished name of its directory entry as a local service. A local service is a service that is running in this JVM.

Parameters:

serviceName - The name of the local service.

dn - The distinguished name of the directory entry that describes the service.

getLocalServiceDN

public static java.lang.String getLocalServiceDN(java.lang.String serviceName)

Returns the distinguished name of the directory entry registered for a local service.

Parameters:

serviceName - The name of the local service.

Returns:

The distinguished name of the directory entry that describes the service, or null if the service is not registered as a local service.

isLocalService

public static boolean isLocalService(java.lang.String dn)
                              throws com.infoengine.au.NamingServiceException

Determines whether a specific directory distinguished name references a service registered in this virtual machine.

Parameters:

dn - The distinguished name to test.

Returns:

true if the distinguished references a service registered in this virtual machine.

Throws:

com.infoengine.au.NamingServiceException - if it can not be determined whether or not a distinguished name matches a locally registered service.

getAllAddresses

public static java.util.Enumeration getAllAddresses(java.lang.String serviceName)
                                             throws com.infoengine.au.NamingServiceException

Return all of the registry entries associated with a named service.

Parameters:

serviceName - The name of the service for which to return all registry entries.

Returns:

The enumeration of the service's registry entries.

Throws:

com.infoengine.au.NamingServiceException - if the service is unknown or some other exception prevents it from being looked up.

getConnection

public static java.net.Socket getConnection(java.lang.String serviceName)
                                     throws com.infoengine.au.NamingServiceException

Returns a socket connected to a named service.

Parameters:

serviceName - The name of the service to which a network connection is requested.

Returns:

A socket that is connected to the named service.

Throws:

com.infoengine.au.NamingServiceException - if the specified service name is unknown or a network connection can not be established to the service.

addService

public static void addService(java.lang.String serviceName,
                              com.infoengine.object.ObjectDestination dest)

Adds an entry to the service registry.

Parameters:

serviceName - The name of the service for which to add a registry entry.

dest - The registry entry.

setGlobalProperties

public static void setGlobalProperties()

Sets global properties for the VM based upon the VM name.

setGlobalProperties

public static void setGlobalProperties(java.lang.String propPrefix)

Deprecated.

Sets global properties for the VM based upon a service-specific property name prefix.

Parameters:

propPrefix - The property name prefix of service-specific properties.

reinitialize

public void reinitialize()
                  throws com.infoengine.au.NamingServiceException

Throws:

com.infoengine.au.NamingServiceException

getProperties

public java.util.Properties getProperties()

Returns the properties object currently being used by the NamingService instance.

Returns:

The properties object.

getIEProperties

public static com.infoengine.au.IEProperties getIEProperties()

Obtain, and create if necessary, the IEProperties object used by this JVM.

Returns:

The current IEProperties object

main

public static void main(java.lang.String[] args)

When initiated via command line, the naming service operates as a utility that can initiate other programs defined by naming service launch properties.

refreshProperties

public void refreshProperties()

Specified by:

refreshProperties in interface com.infoengine.au.PropertyListener

setServiceCacheTimeToLive

public static void setServiceCacheTimeToLive(int minutes)

getServiceCacheTimeToLive

public static int getServiceCacheTimeToLive()

getServiceCache

public static com.infoengine.object.ObjectServiceCache getServiceCache()