com.asakusafw.windgate.core.session

Class SessionMirror

java.lang.Object

com.asakusafw.windgate.core.session.SessionMirror

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

SessionMirror.Null

public abstract class SessionMirror
extends Object
implements Closeable

An abstract superclass of session mirror.

try (SessionMirror session = ...) {
    // do something
    session.complete(); // or session.abort();
}

Since:

0.2.2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SessionMirror.Null A void implementation of SessionMirror.

Constructor Summary

Constructors

Constructor and Description
SessionMirror()

Method Summary

Modifier and Type	Method and Description
abstract void	abort() Aborts and releases this session.
abstract void	close() Closes this session.
abstract void	complete() Completes and releases this session.
abstract String	getId() Returns the current session ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionMirror

public SessionMirror()

Method Detail

getId

public abstract String getId()

Returns the current session ID.

Returns:

the current session ID

complete

public abstract void complete()
                       throws IOException

Completes and releases this session. This session will not be reopened later.

Throws:

IOException - if failed to detach from the specified session

abort

public abstract void abort()
                    throws IOException

Aborts and releases this session. This session will not be reopened later.

Throws:

IOException - if failed to detach from the specified session

close

public abstract void close()
                    throws IOException

Closes this session. If the session was already closed, this has no effects.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - if failed to close this session