com.asakusafw.windgate.core.session

Class SessionProfile

java.lang.Object

com.asakusafw.windgate.core.BaseProfile<SessionProfile,SessionProvider>

com.asakusafw.windgate.core.session.SessionProfile

public class SessionProfile
extends BaseProfile<SessionProfile,SessionProvider>

A configuration for sessions.

Since:

0.2.2

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_PREFIX Prefix of property keys about session.
static String	KEY_PROVIDER Key name of session provider.

Fields inherited from class com.asakusafw.windgate.core.BaseProfile

QUALIFIER

Constructor Summary

Constructors

Constructor and Description
SessionProfile(Class<? extends SessionProvider> providerClass, ProfileContext context, Map<String,String> configuration) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getConfiguration() Returns the extra configuration of the session.
ProfileContext	getContext() Returns the current profile context.
Class<? extends SessionProvider>	getProviderClass() Returns the class of corresponded provider.
protected SessionProfile	getThis() Returns this object.
static SessionProfile	loadFrom(Properties properties, ClassLoader loader) Deprecated. use loadFrom(Properties, ProfileContext) instead
static SessionProfile	loadFrom(Properties properties, ProfileContext context) Loads a session profile from the properties.
static void	removeCorrespondingKeys(Properties properties) Removes entries corresponding to resource profiles.
void	storeTo(Properties properties) Stores this profile into the specified properties.

Methods inherited from class com.asakusafw.windgate.core.BaseProfile

createProvider, getClassLoader, loadProviderClass

Methods inherited from class java.lang.Object

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

Field Detail

KEY_PROVIDER

public static final String KEY_PROVIDER

Key name of session provider.

See Also:

Constant Field Values

KEY_PREFIX

public static final String KEY_PREFIX

Prefix of property keys about session.

See Also:

Constant Field Values

Constructor Detail

SessionProfile

public SessionProfile(Class<? extends SessionProvider> providerClass,
                      ProfileContext context,
                      Map<String,String> configuration)

Creates a new instance.

Parameters:

providerClass - the class which can provide the session

context - the current profile context

configuration - the extra configuration

Throws:

IllegalArgumentException - if any parameter is null

Method Detail

getProviderClass

public Class<? extends SessionProvider> getProviderClass()

Description copied from class: BaseProfile

Returns the class of corresponded provider.

Specified by:

getProviderClass in class BaseProfile<SessionProfile,SessionProvider>

Returns:

the provider class

getContext

public ProfileContext getContext()

Description copied from class: BaseProfile

Returns the current profile context.

Specified by:

getContext in class BaseProfile<SessionProfile,SessionProvider>

Returns:

the current profile context

getConfiguration

public Map<String,String> getConfiguration()

Returns the extra configuration of the session.

Returns:

the configuration

getThis

protected SessionProfile getThis()

Description copied from class: BaseProfile

Returns this object.

Specified by:

getThis in class BaseProfile<SessionProfile,SessionProvider>

Returns:

this object

loadFrom

@Deprecated
public static SessionProfile loadFrom(Properties properties,
                                                  ClassLoader loader)

Deprecated. use loadFrom(Properties, ProfileContext) instead

Loads a session profile from the properties.

Parameters:

properties - source properties

loader - class loader to load the SessionProvider

Returns:

the loaded profile

Throws:

IllegalArgumentException - if properties are invalid, or if any parameter is null

loadFrom

public static SessionProfile loadFrom(Properties properties,
                                      ProfileContext context)

Loads a session profile from the properties.

Parameters:

properties - source properties

context - the current profile context

Returns:

the loaded profile

Throws:

IllegalArgumentException - if properties are invalid, or if any parameter is null

Since:

0.2.4

storeTo

public void storeTo(Properties properties)

Stores this profile into the specified properties.

Parameters:

properties - target properties object

Throws:

IllegalArgumentException - if target properties already contains keys about this session, or if any parameter is null

removeCorrespondingKeys

public static void removeCorrespondingKeys(Properties properties)

Removes entries corresponding to resource profiles.

Parameters:

properties - target properties

Throws:

IllegalArgumentException - if any parameter is null