WildFly Client Configuration 1.0.1.Final · org.wildfly.client.config.ClientConfiguration

Modifier and Type	Field and Description
private final URI	configurationUri
private final ExceptionSupplier<InputStream, IOException>	streamSupplier
private static final String	WILDFLY_CLIENT_1_0
private final XMLInputFactory	xmlInputFactory

Access	Constructor and Description
pack-priv	ClientConfiguration(final XMLInputFactory xmlInputFactory, final URI configurationUri, final ExceptionSupplier<InputStream, IOException> streamSupplier)
pack-priv	ClientConfiguration(final XMLInputFactory xmlInputFactory, final URI configurationUri)

Method Summary

Modifier and Type	Method and Description
private static XMLInputFactory	createXmlInputFactory()
public URI	Returns: the URI from which the configuration is being read getConfigurationUri() Get the URI from which the configuration is being read.
private static ClassLoader	getContextClassLoader()
public static ClientConfiguration	Returns: the client configuration instance getInstance(URI the configuration URI configurationUri) Get a client configuration instance for a certain URI.
public static ClientConfiguration	Returns: the client configuration instance getInstance(URI the configuration URI configurationUri, ExceptionSupplier<InputStream, IOException> streamSupplier) Get a client configuration instance for a certain URI, with streams provided by the given supplier.
public static ClientConfiguration	Returns: the client configuration instance, or `null` if no configuration is found getInstance() Get a client configuration instance from the current environment.
public static ClientConfiguration	Returns: the client configuration instance, or `null` if no configuration is found getInstance(ClassLoader the class loader from which to load the configuration resource classLoader) Get a client configuration instance loaded from a file called `wildfly-config.xml`, either from the root of the specified class loader or within the `META-INF` folder.
pack-priv XMLInputFactory	getXmlInputFactory()
pack-priv static ConfigurationXMLStreamReader	openUri(final URI uri, final XMLInputFactory xmlInputFactory)
pack-priv static ConfigurationXMLStreamReader	openUri(final URI uri, final XMLInputFactory xmlInputFactory, final InputStream inputStream)
pack-priv static URI	propertyUrlToUri(String wildFlyConfig)
public ConfigurationXMLStreamReader	Returns: a reader which returns the first matching element readConfiguration(Set<String> the recognized namespaces recognizedNamespaces) Get a stream reader over a configuration.
private InputStream	streamOpener()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

configurationUri	back to summary
private final URI configurationUri

streamSupplier	back to summary
private final ExceptionSupplier<InputStream, IOException> streamSupplier

WILDFLY_CLIENT_1_0	back to summary
private static final String WILDFLY_CLIENT_1_0

xmlInputFactory	back to summary
private final XMLInputFactory xmlInputFactory

ClientConfiguration	back to summary
pack-priv ClientConfiguration(final XMLInputFactory xmlInputFactory, final URI configurationUri, final ExceptionSupplier<InputStream, IOException> streamSupplier)

ClientConfiguration	back to summary
pack-priv ClientConfiguration(final XMLInputFactory xmlInputFactory, final URI configurationUri)

Method Detail

createXmlInputFactory	back to summary
private static XMLInputFactory createXmlInputFactory()

getConfigurationUri	back to summary
public URI getConfigurationUri() Get the URI from which the configuration is being read. Returns:URI the URI from which the configuration is being read

getConfigurationUri

back to summary

public URI getConfigurationUri()

Get the URI from which the configuration is being read.

Returns:URI: the URI from which the configuration is being read

getContextClassLoader	back to summary
private static ClassLoader getContextClassLoader()

getInstance	back to summary
public static ClientConfiguration getInstance(URI configurationUri) Get a client configuration instance for a certain URI. Parameters configurationUri:URI the configuration URI Returns:ClientConfiguration the client configuration instance

getInstance

back to summary

public static ClientConfiguration getInstance(URI configurationUri)

Get a client configuration instance for a certain URI.

Parameters

configurationUri:URI: the configuration URI

Returns:ClientConfiguration

the client configuration instance

getInstance	back to summary
public static ClientConfiguration getInstance(URI configurationUri, ExceptionSupplier<InputStream, IOException> streamSupplier) Get a client configuration instance for a certain URI, with streams provided by the given supplier. Parameters configurationUri:URI the configuration URI Returns:ClientConfiguration the client configuration instance

getInstance

back to summary

public static ClientConfiguration getInstance(URI configurationUri, ExceptionSupplier<InputStream, IOException> streamSupplier)

Get a client configuration instance for a certain URI, with streams provided by the given supplier.

Parameters

configurationUri:URI: the configuration URI

Returns:ClientConfiguration

the client configuration instance

getInstance back to summary

getInstance	back to summary
public static ClientConfiguration getInstance() Get a client configuration instance from the current environment. First, the system property `wildfly.config.url` is checked. If present, the configuration file is taken from that URL (which is resolved against the current working directory if it is a relative URL or a bare path). If the property is not given, the current thread's context class loader is consulted for a file called `wildfly-config.xml`, either in the root of the class loader or within the `META-INF` folder. If no such resource is found, the same search is done against the class loader of this library. Finally, if no configurations are found or are loadable, `null` is returned. Returns:ClientConfiguration the client configuration instance, or `null` if no configuration is found

public static ClientConfiguration getInstance()

Get a client configuration instance from the current environment. First, the system property wildfly.config.url is checked. If present, the configuration file is taken from that URL (which is resolved against the current working directory if it is a relative URL or a bare path). If the property is not given, the current thread's context class loader is consulted for a file called wildfly-config.xml, either in the root of the class loader or within the META-INF folder. If no such resource is found, the same search is done against the class loader of this library. Finally, if no configurations are found or are loadable, null is returned.

Returns:ClientConfiguration: the client configuration instance, or null if no configuration is found

getInstance back to summary

getInstance	back to summary
public static ClientConfiguration getInstance(ClassLoader classLoader) Get a client configuration instance loaded from a file called `wildfly-config.xml`, either from the root of the specified class loader or within the `META-INF` folder. If no configurations are found or are loadable, `null` is returned. Parameters classLoader:ClassLoader the class loader from which to load the configuration resource Returns:ClientConfiguration the client configuration instance, or `null` if no configuration is found

public static ClientConfiguration getInstance(ClassLoader classLoader)

Get a client configuration instance loaded from a file called wildfly-config.xml, either from the root of the specified class loader or within the META-INF folder. If no configurations are found or are loadable, null is returned.

Parameters

classLoader:ClassLoader: the class loader from which to load the configuration resource

Returns:ClientConfiguration

the client configuration instance, or null if no configuration is found

getXmlInputFactory	back to summary
pack-priv XMLInputFactory getXmlInputFactory()

openUri	back to summary
pack-priv static ConfigurationXMLStreamReader openUri(final URI uri, final XMLInputFactory xmlInputFactory) throws ConfigXMLParseException

openUri	back to summary
pack-priv static ConfigurationXMLStreamReader openUri(final URI uri, final XMLInputFactory xmlInputFactory, final InputStream inputStream) throws ConfigXMLParseException

propertyUrlToUri	back to summary
pack-priv static URI propertyUrlToUri(String wildFlyConfig)

readConfiguration back to summary

readConfiguration	back to summary
public ConfigurationXMLStreamReader readConfiguration(Set<String> recognizedNamespaces) throws ConfigXMLParseException Get a stream reader over a configuration. The configuration returned will be the first element within the root `configuration` element which has a namespace corresponding to one of the given namespaces. Parameters recognizedNamespaces:Set<String> the recognized namespaces Returns:ConfigurationXMLStreamReader a reader which returns the first matching element Exceptions ConfigXMLParseException: if a read error occurs

public ConfigurationXMLStreamReader readConfiguration(Set<String> recognizedNamespaces) throws ConfigXMLParseException

Get a stream reader over a configuration. The configuration returned will be the first element within the root configuration element which has a namespace corresponding to one of the given namespaces.

Parameters

recognizedNamespaces:Set<String>: the recognized namespaces

Returns:ConfigurationXMLStreamReader

a reader which returns the first matching element

Exceptions

ConfigXMLParseException:: if a read error occurs

streamOpener	back to summary
private InputStream streamOpener() throws IOException

public Class ClientConfiguration

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail