com.asakusafw.yaess.core

Class ServiceProfile<T extends Service>

java.lang.Object

com.asakusafw.yaess.core.ServiceProfile<T>

Type Parameters:

T - the base service class

public class ServiceProfile<T extends Service>
extends Object

A common service profile format for configurable instances.

<prefix> = <fully qualified class name which extends T>
<prefix>.<key1> = <value1>
<prefix>.<key2> = <value2>
...

Since:

0.2.3

Version:

0.4.0

Constructor Summary

Constructors

Constructor and Description
ServiceProfile(String prefix, Class<? extends T> serviceClass, Map<String,String> configuration, ProfileContext context) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
ClassLoader	getClassLoader() Deprecated. use getContext() instead
Map<String,String>	getConfiguration() Return the optional configuration for the service.
String	getConfiguration(String key, boolean mandatory, boolean resolve) Returns the target configuration.
ProfileContext	getContext() Returns the current profile context.
String	getPrefix() Returns the key prefix of this profile.
Class<? extends T>	getServiceClass() Returns the service class.
static <T extends Service> ServiceProfile<T>	load(Properties properties, String prefix, Class<T> serviceBaseClass, ClassLoader classLoader) Deprecated. use load(Properties, String, Class, ProfileContext) instead
static <T extends Service> ServiceProfile<T>	load(Properties properties, String prefix, Class<T> serviceBaseClass, ProfileContext context) Loads a service profile with the specified key prefix.
T	newInstance() Creates a new instance using context parameters.
T	newInstance(VariableResolver variables) Deprecated. use newInstance() instead
String	normalize(String key, String value, boolean mandatory, boolean resolve) Normalizes the configuration value.
void	storeTo(Properties properties) Merges this profile into the specified properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceProfile

public ServiceProfile(String prefix,
                      Class<? extends T> serviceClass,
                      Map<String,String> configuration,
                      ProfileContext context)

Creates a new instance.

Parameters:

prefix - the key prefix of this profile

serviceClass - the service class

configuration - configuration for service class

context - the current profile context

Throws:

IllegalArgumentException - if some parameters were null

Method Detail

getPrefix

public String getPrefix()

Returns the key prefix of this profile.

Returns:

the prefix

getServiceClass

public Class<? extends T> getServiceClass()

Returns the service class.

Returns:

the service class

getConfiguration

public Map<String,String> getConfiguration()

Return the optional configuration for the service.

Returns:

the configuration

getConfiguration

public String getConfiguration(String key,
                               boolean mandatory,
                               boolean resolve)

Returns the target configuration.

Parameters:

key - the configuration key

mandatory - whether the configuration is mandatory

resolve - whether resolves the configuration

Returns:

the corresponded configuration, or null if is not defined/empty

Throws:

IllegalArgumentException - if some parameters were null

Since:

0.4.0

normalize

public String normalize(String key,
                        String value,
                        boolean mandatory,
                        boolean resolve)

Normalizes the configuration value.

Parameters:

key - the configuration key

value - the configuration value (nullable if only is not mandatory)

mandatory - whether the configuration is mandatory

resolve - whether resolves the configuration

Returns:

the normalized value, or null if is not defined/empty

Throws:

IllegalArgumentException - if some parameters were null, or failed to normalize

Since:

0.4.0

getContext

public ProfileContext getContext()

Returns the current profile context.

Returns:

the current profile context

getClassLoader

@Deprecated
public ClassLoader getClassLoader()

Deprecated. use getContext() instead

Returns the class loader which loaded this service class.

Returns:

the class loader

newInstance

public T newInstance()
              throws InterruptedException,
                     IOException

Creates a new instance using context parameters. The created service will automatically configured by using this profile.

Returns:

the created instance.

Throws:

InterruptedException - if interrupted in configuring the target service

IOException - if failed to create or configure the service

Since:

0.2.4

newInstance

@Deprecated
public T newInstance(VariableResolver variables)
                          throws InterruptedException,
                                 IOException

Deprecated. use newInstance() instead

Creates a new instance. The created service will automatically configured by using this profile.

Parameters:

variables - the variable resolver

Returns:

the created instance.

Throws:

InterruptedException - if interrupted in configuring the target service

IOException - if failed to create or configure the service

load

@Deprecated
public static <T extends Service> ServiceProfile<T> load(Properties properties,
                                                                     String prefix,
                                                                     Class<T> serviceBaseClass,
                                                                     ClassLoader classLoader)

Deprecated. use load(Properties, String, Class, ProfileContext) instead

Loads a service profile with the specified key prefix.

Type Parameters:

T - the base class of target class

Parameters:

properties - source properties

prefix - the key prefix

serviceBaseClass - the base class of service class

classLoader - the class loader to load the service class

Returns:

the loaded profile

Throws:

IllegalArgumentException - if the target profile is invalid, or parameters contain null

load

public static <T extends Service> ServiceProfile<T> load(Properties properties,
                                                         String prefix,
                                                         Class<T> serviceBaseClass,
                                                         ProfileContext context)

Loads a service profile with the specified key prefix.

Type Parameters:

T - the base class of target class

Parameters:

properties - source properties

prefix - the key prefix

serviceBaseClass - the base class of service class

context - the current profile context

Returns:

the loaded profile

Throws:

IllegalArgumentException - if the target profile is invalid, or parameters contain null

Since:

0.2.4

storeTo

public void storeTo(Properties properties)

Merges this profile into the specified properties. If properties already contains entries related to this profile, then this method will overwrite them.

Parameters:

properties - target properties

Throws:

IllegalArgumentException - if some parameters were null