com.asakusafw.windgate.file.session

Class FileSessionProvider

java.lang.Object

com.asakusafw.windgate.core.BaseProvider<SessionProfile>

com.asakusafw.windgate.core.session.SessionProvider

com.asakusafw.windgate.file.session.FileSessionProvider

public class FileSessionProvider
extends SessionProvider

An implementation of SessionProvider using the local file system and file lock.

Since:

0.2.2

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_DIRECTORY Profile key name of session storage directory.

Constructor Summary

Constructors

Constructor and Description
FileSessionProvider()

Method Summary

Modifier and Type	Method and Description
protected void	configure(SessionProfile profile) Configures this provider.
SessionMirror	create(String id) Creates a new session and acquires the session with the specified session ID.
void	delete(String id) Deletes a session with the specified session ID.
List<String>	getCreatedIds() Returns session IDs which are created and not completed/aborted.
SessionMirror	open(String id) Opens and acquires a created session with the specified session ID.

Methods inherited from class java.lang.Object

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

Field Detail

KEY_DIRECTORY

public static final String KEY_DIRECTORY

Profile key name of session storage directory. This value can includes environment variables in form of ${VARIABLE-NAME}.

See Also:

Constant Field Values

Constructor Detail

FileSessionProvider

public FileSessionProvider()

Method Detail

configure

protected void configure(SessionProfile profile)
                  throws IOException

Description copied from class: BaseProvider

Configures this provider. This method will be invoked just after this object is created.

Specified by:

configure in class BaseProvider<SessionProfile>

Parameters:

profile - the profile

Throws:

IOException - if failed to configure this

getCreatedIds

public List<String> getCreatedIds()
                           throws IOException

Description copied from class: SessionProvider

Returns session IDs which are created and not completed/aborted. Note that the returned IDs may represent broken sessions.

Specified by:

getCreatedIds in class SessionProvider

Returns:

session IDs

Throws:

IOException - if failed to list IDs

create

public SessionMirror create(String id)
                     throws SessionException,
                            IOException

Description copied from class: SessionProvider

Creates a new session and acquires the session with the specified session ID.

Specified by:

create in class SessionProvider

Parameters:

id - target session ID

Returns:

the created session

Throws:

SessionException - if session was invalid state

IOException - if failed to create a new session

open

public SessionMirror open(String id)
                   throws SessionException,
                          IOException

Description copied from class: SessionProvider

Opens and acquires a created session with the specified session ID.

Specified by:

open in class SessionProvider

Parameters:

id - target session ID

Returns:

the opened session

Throws:

SessionException - if session was invalid state

IOException - if failed to open the session

delete

public void delete(String id)
            throws IOException

Description copied from class: SessionProvider

Deletes a session with the specified session ID. Even if the target session is broken, this will force delete it.

Specified by:

delete in class SessionProvider

Parameters:

id - target session ID

Throws:

SessionException - if session was invalid state, except the session was broken

IOException - if failed to delete the session