phpcr/src/PHPCR/RepositoryManagerInterface.php
inheritedCopyright 2008-2011 Karsten Dambekalns karsten@typo3.org
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
\PHPCR\RepositoryManagerInterface
This is useful for applications that embed a JCR repository and need a way to manage the lifecycle of that Repository instance. Each RepositoryManager object is associated one-to-one with a Session object and is defined by the authorization settings of that session object.
The RepositoryManager object can be acquired using a Session by calling $session->getWorkspace()->getRepositoryManager()< on a session object. Likewise, the repository being managed can be found for a given RepositoryManager object by calling $mgr->getWorkspace()->getSession()->getRepository().
- Since
- JCR 2.1
Methods
closeRepository(boolean $closeSessionsImmediately) : voidCloses the repository by preventing the creation of new sessions and freeing all resources.
The $closeSessionsImmediately parameter dictates whether existing sessions should be closed immediately or allowed to close naturally.
Either way, this method always blocks until all sessions are closed and the repository has completely terminated.
Some repository implementations may not allow repositories to be closed, while other implementations might allow closing only for certain configurations (e.g., repositories embedded within an application). An implementation will throw an UnsupportedRepositoryOperationException if the particular repository cannot be closed, or an AccessDeniedException when the repository can be closed but the session does not have the authority to do so.
| Name | Type | Description |
|---|---|---|
| $closeSessionsImmediately | boolean | true if all existing sessions should be closed immediately, or false if they are to be allowed to close naturally. |
| Exception | Description |
|---|---|
| \PHPCR\AccessDeniedException | if the caller does not have authorization to close the repository. |
| \PHPCR\UnsupportedRepositoryOperationException | if the repository implementation does not support or allow the repository to be closed. |
| \PHPCR\RepositoryException | if an error occurred while shutting down the repository. |
getWorkspace() : \PHPCR\WorkspaceInterfaceReturn the Workspace object through which this repository manager was created.
| Type | Description |
|---|---|
| \PHPCR\WorkspaceInterface |