|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Defines methods for instantiating Vorba client application agents
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)
returns new Vorba for a given session. |
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. |
Method Detail |
public IClient getIClient(ClientHandle applicationHandle) throws NoDefaultSessionException
applicationHandle
- is the application's VAMSAS handle string
NoDefaultSessionException
- if more than one session exists that the client may connect topublic IClient getIClient(ClientHandle applicationHandle, java.lang.String sessionUrn)
applicationHandle
- sessionUrn
- session to connect to (or null to create a new session)
public IClient getIClient(ClientHandle applicationHandle, UserHandle userId, java.lang.String sessionUrn)
applicationHandle
- userId
- sessionUrn
- session to connect to (or null to create a new session)
public IClient getIClient(ClientHandle applicationHandle, UserHandle userId) throws NoDefaultSessionException
applicationHandle
- userId
-
NoDefaultSessionException
- if more than one session exists that the client may connect topublic IClient getNewSessionIClient(ClientHandle applicationHandle)
applicationHandle
-
public IClient getNewSessionIClient(ClientHandle applicationHandle, UserHandle userId)
applicationHandle
- userId
-
public IClient openAsNewSessionIClient(ClientHandle applicationHandle, java.io.File vamsasDocument) throws InvalidSessionDocumentException
applicationHandle
- vamsasDocument
-
InvalidSessionDocumentException
public IClient openAsNewSessionIClient(ClientHandle applicationHandle, UserHandle userId, java.io.File vamsasDocument) throws InvalidSessionDocumentException
applicationHandle
- userId
- vamsasDocument
-
InvalidSessionDocumentException
public java.lang.String[] getCurrentSessions()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |