Portal Express, Version 6.0
Operating systems: i5/OS, Linux, Windows
Use the API
The workspace is the heart of the IBM® Workplace Web Content Management™ API. Items are created, saved, deleted and searched for in the workspace item. A workspace is basically an interface to Web Content Management that is associated with a user. Using a workspace item, the user can perform operations as that user.
To get a workspace item, the user must request one from the repository singleton with the following call:
WCM_API.getRepository().getWorkspace("my username", "my password");
To get a workspace item without specifying a user name and password, use one of the following calls:
- When used in a portlet: Workspace workspace = WCM_API.getRepository().getWorkspace( (Principal) portletRequest.getUser() );
- When not used in a portlet: Workspace workspace = WCM_API.getRepository().getWorkspace((Principal) request.getUserPrincipal() );
If the user is not recognized as a Web Content Management user, or for some other reason could not be authenticated , an "OperationFailedException" will be thrown.
Only Web Content Management users (including external LDAP users if enabled) are recognized. For example, A workspace cannot be retrieved using an LTPA token.
Operations available on the workspace include:
- Searching for items with the provided "findBy" methods.
- Creating new items of available editable types.
- Saving and deleting editable items.
You must call endWorkspace() when finished with the workspace item.
WCM_API.getRepository().endWorkspace();
You don't need to call endWorkspace() when using a JSP component as rendering and session management is handled by Web Content Management.
You use the setCurrentDocumentLibrary method to make calls library-specific. If not specified, the default library specified in the WCMConfigService.properties file is used.