Package org.apache.pulsar.common.configuration

Class PulsarConfigurationLoader

java.lang.Object

org.apache.pulsar.common.configuration.PulsarConfigurationLoader

public class PulsarConfigurationLoader
extends Object

Loads ServiceConfiguration with properties.

Constructor Summary

Constructors

Constructor	Description
PulsarConfigurationLoader()

Method Summary

Modifier and Type	Method	Description
static ServiceConfiguration	convertFrom(PulsarConfiguration conf)
static ServiceConfiguration	convertFrom(PulsarConfiguration conf, boolean ignoreNonExistMember)	Converts a PulsarConfiguration object to a ServiceConfiguration object.
static <T extends PulsarConfiguration> T	create(InputStream inStream, Class<? extends PulsarConfiguration> clazz)	Creates PulsarConfiguration and loads it with populated attribute values loaded from provided inputstream property file.
static <T extends PulsarConfiguration> T	create(String configFile, Class<? extends PulsarConfiguration> clazz)	Creates PulsarConfiguration and loads it with populated attribute values loaded from provided property file.
static <T extends PulsarConfiguration> T	create(Properties properties, Class<? extends PulsarConfiguration> clazz)	Creates PulsarConfiguration and loads it with populated attribute values from provided Properties object.
static boolean	isComplete(Object obj)	Validates FieldContext annotation on each field of the class element.

Methods inherited from class java.lang.Object

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

Constructor Details

PulsarConfigurationLoader

public PulsarConfigurationLoader()

Method Details

create

public static <T extends PulsarConfiguration> T create(String configFile,
 Class<? extends PulsarConfiguration> clazz)
                                                throws IOException,
IllegalArgumentException

Creates PulsarConfiguration and loads it with populated attribute values loaded from provided property file.

Parameters:

configFile -

Throws:

IOException

IllegalArgumentException

create

public static <T extends PulsarConfiguration> T create(InputStream inStream,
 Class<? extends PulsarConfiguration> clazz)
                                                throws IOException,
IllegalArgumentException

Creates PulsarConfiguration and loads it with populated attribute values loaded from provided inputstream property file.

Parameters:

inStream -

Throws:

IOException - if an error occurred when reading from the input stream.

IllegalArgumentException - if the input stream contains incorrect value type

create

public static <T extends PulsarConfiguration> T create(Properties properties,
 Class<? extends PulsarConfiguration> clazz)
                                                throws IOException,
IllegalArgumentException

Creates PulsarConfiguration and loads it with populated attribute values from provided Properties object.

Parameters:

properties - The properties to populate the attributed from

Throws:

IOException

IllegalArgumentException

isComplete

public static boolean isComplete(Object obj)
                          throws IllegalArgumentException

Validates FieldContext annotation on each field of the class element. If element is annotated required and value of the element is null or number value is not in a provided (min,max) range then consider as incomplete object and throws exception with incomplete parameters

Parameters:

obj -

Returns:

Throws:

IllegalArgumentException - if object is field values are not completed according to FieldContext constraints.

IllegalAccessException

convertFrom

public static ServiceConfiguration convertFrom(PulsarConfiguration conf,
 boolean ignoreNonExistMember)
                                        throws RuntimeException

Converts a PulsarConfiguration object to a ServiceConfiguration object.

Parameters:

conf -

ignoreNonExistMember -

Returns:

Throws:

IllegalArgumentException - if conf has the field whose name is not contained in ServiceConfiguration and ignoreNonExistMember is false.

RuntimeException

convertFrom

public static ServiceConfiguration convertFrom(PulsarConfiguration conf)
                                        throws RuntimeException

Throws:

RuntimeException