|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.vamsas.client.simpleclient.SimpleClientFactory
creates a session arena in the user home directory under .vamsas. Each session has its own subdirectory.
Constructor Summary | |
SimpleClientFactory()
default constructor - called by CreateClientFactory only. |
|
SimpleClientFactory(java.lang.String path)
Create a client factory that works with sessions at the given path. |
Method Summary | |
java.lang.String[] |
getCurrentSessions()
enumerate the active sessions this IClientFactory instance knows about. |
IClient |
getIClient(ClientHandle applicationHandle)
Create a new Vorba Session |
IClient |
getIClient(ClientHandle applicationHandle,
java.lang.String sessionUrn)
the URN should be something like simpleclient:FILEPATH URL encoded |
IClient |
getIClient(ClientHandle applicationHandle,
UserHandle userId)
New session for application and specific user |
IClient |
getIClient(ClientHandle applicationHandle,
UserHandle userId,
java.lang.String sessionUrn)
returns new vorba for a given session acting as a particular identity |
IClient |
getNewSessionIClient(ClientHandle applicationHandle)
Create a new sesssion for the application with the current user |
IClient |
getNewSessionIClient(ClientHandle applicationHandle,
UserHandle userId)
Create a new session for the application using a particular user identity |
IClient |
openAsNewSessionIClient(ClientHandle applicationHandle,
java.io.File vamsasDocument)
Create a new session and import an existing vamsas document into it. |
IClient |
openAsNewSessionIClient(ClientHandle applicationHandle,
UserHandle userId,
java.io.File vamsasDocument)
Create a new session as a particular user and import an existing vamsas document into it. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public SimpleClientFactory() throws java.io.IOException
public SimpleClientFactory(java.lang.String path) throws java.io.IOException
path
- path to directory called session arena, where will be created
session directories and session files.Method Detail |
public IClient getIClient(ClientHandle applicationHandle) throws NoDefaultSessionException
IClientFactory
getIClient
in interface IClientFactory
applicationHandle
- is the application's VAMSAS handle string
NoDefaultSessionException
- if more than one session exists that the client may connect toCreates a IClient object, using default UserHandle with system
variables:"user.name" or "USERNAME")), "host.name" or "HOSTNAME"
public IClient getIClient(ClientHandle applicationHandle, java.lang.String sessionUrn)
getIClient
in interface IClientFactory
applicationHandle
- sessionUrn
- session to connect to (or null to create a new session)
IClientFactory.getIClient(uk.ac.vamsas.client.ClientHandle,
java.lang.String)
public IClient getIClient(ClientHandle applicationHandle, UserHandle userId, java.lang.String sessionUrn)
IClientFactory
getIClient
in interface IClientFactory
applicationHandle
- userId
- sessionUrn
- session to connect to (or null to create a new session)
IClientFactory.getIClient(uk.ac.vamsas.client.ClientHandle,
uk.ac.vamsas.client.UserHandle, java.lang.String)
public IClient getIClient(ClientHandle applicationHandle, UserHandle userId) throws NoDefaultSessionException
IClientFactory
getIClient
in interface IClientFactory
applicationHandle
- userId
-
NoDefaultSessionException
- if more than one session exists that the client may connect toIClientFactory.getIClient(uk.ac.vamsas.client.ClientHandle,
uk.ac.vamsas.client.UserHandle)
public java.lang.String[] getCurrentSessions()
IClientFactory
getCurrentSessions
in interface IClientFactory
IClientFactory.getCurrentSessions()
public IClient getNewSessionIClient(ClientHandle applicationHandle)
IClientFactory
getNewSessionIClient
in interface IClientFactory
applicationHandle
-
public IClient getNewSessionIClient(ClientHandle applicationHandle, UserHandle userId)
IClientFactory
getNewSessionIClient
in interface IClientFactory
applicationHandle
- userId
-
public IClient openAsNewSessionIClient(ClientHandle applicationHandle, java.io.File vamsasDocument) throws InvalidSessionDocumentException
IClientFactory
openAsNewSessionIClient
in interface IClientFactory
applicationHandle
- vamsasDocument
-
InvalidSessionDocumentException
public IClient openAsNewSessionIClient(ClientHandle applicationHandle, UserHandle userId, java.io.File vamsasDocument) throws InvalidSessionDocumentException
IClientFactory
openAsNewSessionIClient
in interface IClientFactory
applicationHandle
- userId
- vamsasDocument
-
InvalidSessionDocumentException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |