Overview Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
com.ibm.workplace.wcm.api
Interface Repository
public interface RepositoryThe entry point into the WCM repository.
This interface provides methods for obtaining a Workspace. A Workspace represents a view of the repository for the specified user.
Method Summary void endWorkspace()
Performs a logout from the currently associated Workspace and unregisters the current thread from its session.Workspace getAnonymousWorkspace()
Returns a Workspace object representing a view of the repository for the Anonymous user.Workspace getSystemWorkspace()
Returns a Workspace object representing a sytem view of the repository.Workspace getWorkspace()
Returns a Workspace object representing a view of the repository for the current User accessing the system.Workspace getWorkspace(java.security.Principal principal)
Returns a Workspace object representing a view of the repository for the specified Principal.Workspace getWorkspace(java.lang.String username, java.lang.String password)
Returns a Workspace object that represents a view of the repository for a user with the specified credentials.
Method Detail getWorkspace
Workspace getWorkspace(java.lang.String username, java.lang.String password) throws ServiceNotAvailableException, OperationFailedException
- Returns a Workspace object that represents a view of the repository for a user with the specified credentials.
- Parameters:
- username - the username of the user to get a Workspace for
- password - the user's password
- Returns:
- a Workspace for the specified user; returns an Anonymous Workspace if the user could not be authenticated.
- Throws:
- ServiceNotAvailableException - if the WCM service is not available
- OperationFailedException - if a Workspace could not be created for this user
- java.lang.NullPointerException - if either of the arguments to this method is null
getAnonymousWorkspace
Workspace getAnonymousWorkspace() throws ServiceNotAvailableException, OperationFailedException
- Returns a Workspace object representing a view of the repository for the Anonymous user.
- Returns:
- Workspace for the Anonymous user
- Throws:
- ServiceNotAvailableException - if the WCM service is not available
- OperationFailedException - if a workspace could not be created for this user
getWorkspace
Workspace getWorkspace(java.security.Principal principal) throws ServiceNotAvailableException, OperationFailedException
- Returns a Workspace object representing a view of the repository for the specified Principal.
- Parameters:
- principal - The java.security.Principal to retrieve a Workspace for.
- Returns:
- Workspace for the specified Principal
- Throws:
- ServiceNotAvailableException - if the WCM service is not available
- OperationFailedException - if a workspace could not be created for the specified Principal
- java.lang.NullPointerException - if the argument to this method is null
getWorkspace
Workspace getWorkspace() throws ServiceNotAvailableException, OperationFailedException
- Returns a Workspace object representing a view of the repository for the current User accessing the system. If no user is currently logged into the system an anonymous Workspace will be returned
- Returns:
- Workspace for the current User
- Throws:
- ServiceNotAvailableException - if the WCM service is not available
- OperationFailedException - if a workspace could not be created for the current User
- java.lang.NullPointerException - if the argument to this method is null
getSystemWorkspace
Workspace getSystemWorkspace() throws ServiceNotAvailableException, OperationFailedException
- Returns a Workspace object representing a sytem view of the repository.
- Throws:
- ServiceNotAvailableException - if the WCM service is not available
- OperationFailedException - if a workspace could not be created for the specified Principal
- java.lang.NullPointerException - if the argument to this method is null
endWorkspace
void endWorkspace()
- Performs a logout from the currently associated Workspace and unregisters the current thread from its session. N.B. You don't need to call endWorkspace() when using a JSP component as rendering and session management is handled by Web Content Management.
Overview Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD