org.knopflerfish.service.console
public interface Session
ConsoleService| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
PROPERTY_AUTHORIZATION
Constant for the session property that is the session's Authorization
object.
|
static java.lang.String |
PROPERTY_EXIT_ON_LOGOUT
Constant for the session property that indicates that the session should
be closed if the user logs out.
|
static java.lang.String |
PROPERTY_TCP
Constant for the session property that indicates that the session is a
TCP session.
|
| Modifier and Type | Method and Description |
|---|---|
void |
abortCommand()
Abort current command in session.
|
void |
addSessionListener(SessionListener l)
Add session event listener.
|
void |
close()
Close session.
|
char |
getEscapeChar()
Get escape character.
|
java.lang.String |
getInterruptString()
Get interrupt string.
|
java.lang.String |
getName()
Get session name.
|
java.util.Dictionary<java.lang.String,java.lang.Object> |
getProperties()
Returns the property information tied to this session.
|
void |
removeSessionListener(SessionListener l)
Remove session event listener.
|
void |
setEscapeChar(char ch)
Set escape character.
|
void |
setInterruptString(java.lang.String str)
Set interrupt string.
|
static final java.lang.String PROPERTY_AUTHORIZATION
static final java.lang.String PROPERTY_TCP
static final java.lang.String PROPERTY_EXIT_ON_LOGOUT
void abortCommand()
java.lang.IllegalStateException - If this session is closed.char getEscapeChar()
java.lang.IllegalStateException - If this session is closed.setEscapeChar(char)void setEscapeChar(char ch)
ch - new escape characterjava.lang.IllegalStateException - If this session is closed.java.lang.String getInterruptString()
java.lang.IllegalStateException - If this session is closed.setInterruptString(java.lang.String)void setInterruptString(java.lang.String str)
abortCommand() for this session.str - new interrupt stringjava.lang.IllegalStateException - If this session is closed.java.lang.String getName()
void close()
void addSessionListener(SessionListener l)
l - session listenerjava.lang.IllegalStateException - If this session is closed.void removeSessionListener(SessionListener l)
l - session listenerjava.lang.IllegalStateException - If this session is closed.addSessionListener(org.knopflerfish.service.console.SessionListener)java.util.Dictionary<java.lang.String,java.lang.Object> getProperties()