|
Oracle® Collaboration Suite Workspaces API Reference 10g (10.1.1.0.2) Part No. B16233-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.workspaces.CwService
Singleton class which represents the entry point for all Collaborative Workspaces operations. To use the Collaborative Workspaces API, first call CwService.init()
.
Constructor Summary | |
CwService() |
Method Summary | |
void |
closeSession(CwSession session) Close the session for a user to release all the resource-related stuffs in the session. |
static void |
destroy() Tear down the CwService and its internal references. |
CwIdentity |
getIdentityById(java.lang.String id) Get the CwIdentity by id |
static CwService |
getInstance() Returns the singleton instance of this class. |
CwUser |
getUserByDn(java.lang.String szUserDn) Return the user based on its distinguished name (DN). |
CwUser |
getUserByEmail(java.lang.String szEmail) Return the user based on its email. |
CwUser |
getUserByName(java.lang.String szUserName) Return the user based on its name. |
CwUser |
getUserByNickname(java.lang.String szUserNickname) Return the user based on its name. |
static void |
init() Initialize the CwService. |
static void |
initResourceManagers() Initialize the CwService with just the CW Managers. |
static void |
initWorkspaceManagers() Initialize the CwService with just the CW Managers. |
CwSession |
openSession(CwUser user) open a session for the give user with default locale |
CwSession |
openSession(CwUser user, java.util.Locale locale) Return a new session for a user. |
void |
verifyInitialized(CwResourceType rsrcType) Given a resource type, verify if it has been properly initialized |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public CwService()
Method Detail |
public void closeSession(CwSession session) throws CwException
CwException
public static void destroy() throws CwException
CwException
public CwIdentity getIdentityById(java.lang.String id) throws CwException
id
- the ID of the user/groupthe
- requested user/group does not exist.CwException
public static CwService getInstance() throws CwException
CwException
public CwUser getUserByDn(java.lang.String szUserDn) throws CwException
oracle.workspaces.authentication.CwUser#getDN
returns.CwException
- requested user does not exist.public CwUser getUserByEmail(java.lang.String szEmail) throws CwException
oracle.workspaces.authentication.CwUser#getEmailAddress
returns.CwException
- requested user does not exist.public CwUser getUserByName(java.lang.String szUserName) throws CwException
oracle.workspaces.authentication.CwUser#getName
returns. We can not get the group based on its name since group name is not unipue in OID.szUserName
- the name of the userCwException
- requested user does not exist.public CwUser getUserByNickname(java.lang.String szUserNickname) throws CwException
oracle.workspaces.authentication.CwUser#getNickname
returns. We can not get the group based on its name since group name is not unipue in OID.szUserNickname
- the nickname of the userCwException
- requested user does not exist.public static void init() throws CwException
getInstance()
or performing any other Collaborative Workspaces operations. To initialize the Workpsaces server, either the init() method can be called or the initWorkpaceManagers(0 followed by the initResourceManagers() method can called in that order. These two paths are equivalent and have been provided only to allow the calling application to initialize the workspace managers and the resource managers at different execution points.CwException
public static void initResourceManagers() throws CwException
getInstance()
or performing any other Collaborative Workspaces operations. This method just initializes all the Resource managers. This method cannot be called before the init() or the initWorkspaceManagers() method has been invoked.CwException
public static void initWorkspaceManagers() throws CwException
getInstance()
or performing any other Collaborative Workspaces operations. This method just initializes all the Workspace managers but NOT the resource managers. The initResourceManagers method has to be called before any resource specific APIs can be used. The two initialization methods have been split to allow them to be called separately at different points in the execution (for instance, invoke the initWorkspaceManagers at system startup and initialize the resource managers at the first request).CwException
public CwSession openSession(CwUser user) throws CwException
user
- the user object for which session needs to be createdCwException
openSession(CwUser user, Locale locale)
public CwSession openSession(CwUser user, java.util.Locale locale) throws CwException
CwException
- if user is a deleted userpublic void verifyInitialized(CwResourceType rsrcType) throws CwException
CwException
- if not properly initialized
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |