com.asakusafw.windgate.core.session

Class SessionProvider

java.lang.Object

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

com.asakusafw.windgate.core.session.SessionProvider

Direct Known Subclasses:

FileSessionProvider

public abstract class SessionProvider
extends BaseProvider<SessionProfile>

An abstract super class of session provider. Clients can inherit this class to provide a session implementation. Each subclass must provide a public constructor with no parameters.

Since:

0.2.2

Constructor Summary

Constructors

Constructor and Description
SessionProvider()

Method Summary

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

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

configure

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionProvider

public SessionProvider()

Method Detail

getCreatedIds

public abstract List<String> getCreatedIds()
                                    throws IOException

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

Returns:

session IDs

Throws:

IOException - if failed to list IDs

create

public abstract SessionMirror create(String id)
                              throws SessionException,
                                     IOException

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

Parameters:

id - target session ID

Returns:

the created session

Throws:

SessionException - if session was invalid state

IOException - if failed to create a new session

IllegalArgumentException - if any parameter is null

open

public abstract SessionMirror open(String id)
                            throws SessionException,
                                   IOException

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

Parameters:

id - target session ID

Returns:

the opened session

Throws:

SessionException - if session was invalid state

IOException - if failed to open the session

IllegalArgumentException - if any parameter is null

delete

public abstract void delete(String id)
                     throws SessionException,
                            IOException

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

Parameters:

id - target session ID

Throws:

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

IOException - if failed to delete the session

IllegalArgumentException - if any parameter is null