org.apache.juddi.v3.client.config

Class ClientConfig

java.lang.Object

org.apache.juddi.v3.client.config.ClientConfig

public class ClientConfig
extends Object

Handles the client configuration of the uddi-client. By default it first looks at system properties. Then loads from the config file from the system property "uddi.client.xml", next the user specified file, finally, "META-INF/uddi.xml"

Author:

Kurt T Stam, Alex O'Ree

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_UDDI_CONFIG
static String	UDDI_CONFIG_FILENAME_PROPERTY

Constructor Summary

Constructors

Constructor and Description
ClientConfig(String configurationFile) Constructor (note Singleton pattern).
ClientConfig(String configurationFile, Properties properties) Constructor (note Singleton pattern).

Method Summary

Modifier and Type	Method and Description
void	addUDDINode(UDDINode node) adds a new node to the client configuration section.
String	getClientCallbackUrl() Deprecated.
String	getClientName()
org.apache.commons.configuration.Configuration	getConfiguration()
String	getConfigurationFile()
Properties	getDigitalSignatureConfiguration() Fetches all digital signature related properties for the digital signature utility.
UDDINode	getHomeNode()
Map<String,UDDIClerk>	getUDDIClerks()
UDDINode	getUDDINode(String nodeName) returns the named uddi node from config or throws if one is not found
List<org.apache.juddi.api_v3.Node>	getUDDINodeList() gets the current configuration's node list Only a copy of these values are returned
protected Map<String,UDDINode>	getUDDINodes()
Set<XRegistration>	getXBusinessRegistrations()
Set<XRegistration>	getXServiceBindingRegistrations()
boolean	isRegisterOnStartup() signals that the specified classes/wsdls are registered with the UDDI server when UDDIClient.start() is called client.clerks[@registerOnStartup]
boolean	isX_To_Wsdl_Ignore_SSL_Errors() Used for WADL/WSDL to WSDL
protected void	readConfig(Properties properties)
void	removeUDDINode(String name) removes the named node from the client configuration section.
void	saveConfig() Attempts to save any changes made to the configuration back to disk Revised in 3.2.1 to reconstruct the file from the in memory data structure, enable you to programmatically add nodes.
void	saveConfigRaw() Use this method to attempt to save the jUDDI configuration file after you've modified it using the Apache Commons Configuration settings.

Methods inherited from class java.lang.Object

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

Field Detail

UDDI_CONFIG_FILENAME_PROPERTY

public static final String UDDI_CONFIG_FILENAME_PROPERTY

See Also:

Constant Field Values

DEFAULT_UDDI_CONFIG

public static final String DEFAULT_UDDI_CONFIG

See Also:

Constant Field Values

Constructor Detail

ClientConfig

public ClientConfig(String configurationFile)
             throws org.apache.commons.configuration.ConfigurationException

Constructor (note Singleton pattern).

Throws:

org.apache.commons.configuration.ConfigurationException

ClientConfig

public ClientConfig(String configurationFile,
                    Properties properties)
             throws org.apache.commons.configuration.ConfigurationException

Constructor (note Singleton pattern).

Throws:

org.apache.commons.configuration.ConfigurationException

Method Detail

saveConfig

public void saveConfig()
                throws org.apache.commons.configuration.ConfigurationException

Attempts to save any changes made to the configuration back to disk Revised in 3.2.1 to reconstruct the file from the in memory data structure, enable you to programmatically add nodes.

For previous functionality see, saveConfigRaw()

Throws:

org.apache.commons.configuration.ConfigurationException

saveConfigRaw

public void saveConfigRaw()
                   throws org.apache.commons.configuration.ConfigurationException

Use this method to attempt to save the jUDDI configuration file after you've modified it using the Apache Commons Configuration settings. This is especially useful if you've constructed a user interface for manipulating the configuration like a properties sheet and is used by the juddi-gui (web ui)

Throws:

org.apache.commons.configuration.ConfigurationException

Since:

3.2.1

readConfig

protected void readConfig(Properties properties)
                   throws org.apache.commons.configuration.ConfigurationException

Throws:

org.apache.commons.configuration.ConfigurationException

isRegisterOnStartup

public boolean isRegisterOnStartup()

signals that the specified classes/wsdls are registered with the UDDI server when UDDIClient.start() is called client.clerks[@registerOnStartup]

Returns:

true/false

getUDDINodes

protected Map<String,UDDINode> getUDDINodes()

getUDDINodeList

public List<org.apache.juddi.api_v3.Node> getUDDINodeList()

gets the current configuration's node list Only a copy of these values are returned

Returns:

a list of nodes representing the config file as described

Since:

3.3 updated to return all fields, 3.2

getHomeNode

public UDDINode getHomeNode()
                     throws org.apache.commons.configuration.ConfigurationException

Throws:

org.apache.commons.configuration.ConfigurationException

getUDDINode

public UDDINode getUDDINode(String nodeName)
                     throws org.apache.commons.configuration.ConfigurationException

returns the named uddi node from config or throws if one is not found

Parameters:

nodeName -

Returns:

Throws:

org.apache.commons.configuration.ConfigurationException

getUDDIClerks

public Map<String,UDDIClerk> getUDDIClerks()

getXServiceBindingRegistrations

public Set<XRegistration> getXServiceBindingRegistrations()

getXBusinessRegistrations

public Set<XRegistration> getXBusinessRegistrations()

getConfiguration

public org.apache.commons.configuration.Configuration getConfiguration()

getClientName

public String getClientName()

getClientCallbackUrl

@Deprecated
public String getClientCallbackUrl()

Deprecated.

getConfigurationFile

public String getConfigurationFile()

isX_To_Wsdl_Ignore_SSL_Errors

public boolean isX_To_Wsdl_Ignore_SSL_Errors()

Used for WADL/WSDL to WSDL

Returns:

true/false

getDigitalSignatureConfiguration

public Properties getDigitalSignatureConfiguration()
                                            throws Exception

Fetches all digital signature related properties for the digital signature utility. warning, this will decrypt all passwords

Returns:

a properties object

Throws:

Exception

See Also:

DigSigUtil, Properties

addUDDINode

public void addUDDINode(UDDINode node)
                 throws org.apache.commons.configuration.ConfigurationException

adds a new node to the client configuration section. Don't forget to call save to persist the changes

Parameters:

node -

Throws:

org.apache.commons.configuration.ConfigurationException

Since:

3.3

removeUDDINode

public void removeUDDINode(String name)
                    throws org.apache.commons.configuration.ConfigurationException

removes the named node from the client configuration section. don't forget to save to persist the changes

Parameters:

name - expecting the Node name, not the "clientName"

Throws:

org.apache.commons.configuration.ConfigurationException