Part of lp.code.interfaces.codehosting View In Hierarchy
Known implementations: lp.code.xmlrpc.codehosting.BranchFileSystem
Published at branchfilesystem.
The code hosting service uses this to register branches, to retrieve information about a user's branches, and to update their status.
| Method | createBranch | Register a new hosted branch in Launchpad. |
| Method | requestMirror | Mark a branch as needing to be mirrored. |
| Method | translatePath | Translate 'path' so that the codehosting transport can access it. |
This is called by the bazaar.launchpad.net server when a user pushes a new branch to it. See also https://launchpad.canonical.com/SupermirrorFilesystemHierarchy.
| Parameters | login_id | the person ID of the user creating the branch. |
| branch_path | the path of the branch to be created. This should be a URL-escaped string representing an absolute path. | |
| Returns | the ID for the new branch or a Fault if the branch cannot be created. | |
| Parameters | loginID | the person ID of the user requesting the mirror. |
| branchID | a branch ID. |
| Parameters | requester_id | the database ID of the person requesting the path translation. |
| path | the path being translated. This should be a URL escaped string representing an absolute path. | |
| Returns | (transport_type, transport_parameters, path_in_transport) where 'transport_type' is one of BRANCH_TRANSPORT or CONTROL_TRANSPORT, 'transport_parameters' is a dict of data that the client can use to construct the transport and 'path_in_transport' is a path relative to that transport. e.g. (BRANCH_TRANSPORT, {'id': 3, 'writable': False}, '.bzr/README'). | |
| Raises | PathTranslationError | if 'path' cannot be translated. |
| InvalidPath | if 'path' is known to be invalid. | |
| PermissionDenied | if the requester cannot see the branch. | |