Class ConfigurationSource
java.lang.Object
org.apache.logging.log4j.core.config.ConfigurationSource
Represents the source for the logging configuration.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ConfigurationSourceConfigurationSource to use withCompositeConfiguration.private byte[]private static final Stringprivate final longprivate longstatic final ConfigurationSourceConfigurationSource to use with Configurations that do not require a "real" configuration source.private Sourceprivate final InputStream -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivateConfigurationSource(byte[] data, URL url, long lastModified) ConfigurationSource(InputStream stream) Constructs a newConfigurationSourcewith the specified input stream.ConfigurationSource(InputStream stream, File file) Constructs a newConfigurationSourcewith the specified input stream that originated from the specified file.ConfigurationSource(InputStream stream, URL url) Constructs a newConfigurationSourcewith the specified input stream that originated from the specified URL.ConfigurationSource(InputStream stream, URL url, long lastModified) Constructs a newConfigurationSourcewith the specified input stream that originated from the specified URL.ConfigurationSource(InputStream stream, Path path) Constructs a newConfigurationSourcewith the specified input stream that originated from the specified path.ConfigurationSource(Source source, byte[] data, long lastModified) Constructs a newConfigurationSourcewith the specified source. -
Method Summary
Modifier and TypeMethodDescriptionstatic ConfigurationSourcefromResource(String resource, ClassLoader loader) Retrieves the configuration via the ClassLoader.static ConfigurationSourceLoads the configuration from a URI.private static ConfigurationSourcegetFile()Returns the file configuration source, ornullif this configuration source is based on an URL or has neither a file nor an URL.Returns the input stream that this configuration source was constructed with.longReturns the time the resource was last modified or 0 if it is not available.Returns a string describing the configuration source file or URL, ornullif this configuration source has neither a file nor an URL.getURI()Returns a URI representing the configuration resource or null if it cannot be determined.getURL()Returns the configuration source URL, ornullif this configuration source is based on a file or has neither a file nor an URL.private booleanisFile()private booleanprivate booleanisURL()Returns a newConfigurationSourcewhose input stream is reset to the beginning.voidsetData(byte[] data) voidsetModifiedMillis(long modifiedMillis) voidDeprecated.Not used internally, no replacement.private static byte[]toByteArray(InputStream inputStream) Returns the contents of the specifiedInputStreamas a byte array.toString()
-
Field Details
-
NULL_SOURCE
ConfigurationSource to use with Configurations that do not require a "real" configuration source. -
COMPOSITE_SOURCE
ConfigurationSource to use withCompositeConfiguration. -
HTTPS
- See Also:
-
stream
-
data
private volatile byte[] data -
source
-
lastModified
private final long lastModified -
modifiedMillis
private volatile long modifiedMillis
-
-
Constructor Details
-
ConfigurationSource
Constructs a newConfigurationSourcewith the specified input stream that originated from the specified file.- Parameters:
stream- the input stream, the caller is responsible for closing this resource.file- the file where the input stream originated
-
ConfigurationSource
Constructs a newConfigurationSourcewith the specified input stream that originated from the specified path.- Parameters:
stream- the input stream, the caller is responsible for closing this resource.path- the path where the input stream originated.
-
ConfigurationSource
Constructs a newConfigurationSourcewith the specified input stream that originated from the specified URL.- Parameters:
stream- the input stream, the caller is responsible for closing this resource.url- the URL where the input stream originated
-
ConfigurationSource
Constructs a newConfigurationSourcewith the specified input stream that originated from the specified URL.- Parameters:
stream- the input stream, the caller is responsible for closing this resource.url- the URL where the input stream originatedlastModified- when the source was last modified.
-
ConfigurationSource
Constructs a newConfigurationSourcewith the specified input stream. Since the stream is the only source of data, this constructor makes a copy of the stream contents.- Parameters:
stream- the input stream, the caller is responsible for closing this resource.- Throws:
IOException- if an exception occurred reading from the specified stream
-
ConfigurationSource
Constructs a newConfigurationSourcewith the specified source.- Parameters:
source- a Source.data- data from the sourcelastModified- when the source was last modified.
-
ConfigurationSource
-
-
Method Details
-
toByteArray
Returns the contents of the specifiedInputStreamas a byte array.- Parameters:
inputStream- the stream to read- Returns:
- the contents of the specified stream
- Throws:
IOException- if a problem occurred reading from the stream
-
getFile
Returns the file configuration source, ornullif this configuration source is based on an URL or has neither a file nor an URL.- Returns:
- the configuration source file, or
null
-
isFile
private boolean isFile() -
isURL
private boolean isURL() -
isLocation
private boolean isLocation() -
getURL
Returns the configuration source URL, ornullif this configuration source is based on a file or has neither a file nor an URL.- Returns:
- the configuration source URL, or
null
-
setSource
Deprecated.Not used internally, no replacement. TODO remove and make source final. -
setData
public void setData(byte[] data) -
setModifiedMillis
public void setModifiedMillis(long modifiedMillis) -
getURI
Returns a URI representing the configuration resource or null if it cannot be determined.- Returns:
- The URI.
-
getLastModified
public long getLastModified()Returns the time the resource was last modified or 0 if it is not available.- Returns:
- the last modified time of the resource.
-
getLocation
Returns a string describing the configuration source file or URL, ornullif this configuration source has neither a file nor an URL.- Returns:
- a string describing the configuration source file or URL, or
null
-
getInputStream
Returns the input stream that this configuration source was constructed with.- Returns:
- the input stream that this configuration source was constructed with.
-
resetInputStream
Returns a newConfigurationSourcewhose input stream is reset to the beginning.- Returns:
- a new
ConfigurationSource - Throws:
IOException- if a problem occurred while opening the new input stream
-
toString
-
fromUri
Loads the configuration from a URI.- Parameters:
configLocation- A URI representing the location of the configuration.- Returns:
- The ConfigurationSource for the configuration.
-
fromResource
Retrieves the configuration via the ClassLoader.- Parameters:
resource- The resource to load.loader- The default ClassLoader to use.- Returns:
- The ConfigurationSource for the configuration.
-
getConfigurationSource
-