Part of lp.services.librarian.client View In Hierarchy
Known subclasses: lp.services.librarian.client.LibrarianClient
Method | getURLForAlias | Returns the url for talking to the librarian about the given |
Method | getURLForAliasObject | Return the download URL for a LibraryFileAlias . |
Method | getFileByAlias | See IFileDownloadClient . |
Method | _getAlias | Retrieve the LibraryFileAlias with the given id. |
Method | _checkAliasAccess | Verify that alias can be accessed. |
Method | _getPathForAlias | Returns the path inside the librarian to talk about the given |
Method | _getPathForAliasObject | Returns the Librarian path for a LibraryFileAlias . |
Method | _getBaseURL | Get the base URL to use for alias . |
Method | _getURLForDownload | Returns the internal librarian URL for the alias. |
Method | _connect_read | Helper for getFileByAlias. |
LibraryFileAlias
with the given id.Parameters | aliasID | A unique ID for the alias. |
secure | Controls the behaviour when looking up restricted
files. If False restricted files are only permitted when
self.restricted is True. See getURLForAlias . | |
Returns | A LibraryFileAlias . | |
Raises | DownloadFailed if the alias is invalid or
inaccessible. |
alias
can be accessed.Parameters | alias | A LibraryFileAlias . |
secure | Controls the behaviour when looking up restricted
files. If False restricted files are only permitted when
self.restricted is True. See getURLForAlias . | |
Raises | DownloadFailed if access is not allowed. |
Parameters | aliasID | A unique ID for the alias |
secure | Controls the behaviour when looking up restricted
files. If False restricted files are only permitted when
self.restricted is True. See getURLForAlias . | |
Returns | String path, url-escaped. Unicode is UTF-8 encoded before url-escaping, as described in section 2.2.5 of RFC 2718. None if the file has been deleted. | |
Raises | DownloadFailed if the alias is invalid |
alias
.Parameters | secure | If true generate https urls on unique domains for security. |
Parameters | aliasID | A unique ID for the alias |
secure | If true generate https urls on unique domains for security. | |
Returns | String URL, or None if the file has expired and been deleted. |
LibraryFileAlias
.
There is a separate getURLForAlias
that takes an alias ID. If
you're not sure whether it's safe for the client to access your
alias
, use getURLForAlias
which will retrieve its own copy.
Parameters | alias | A LibraryFileAlias whose URL you want. |
secure | If true generate https urls on unique domains for security. | |
Returns | String URL, or None if the file has expired and been deleted. |
Parameters | aliasID | A unique ID for the alias |
Returns | String URL, or None if the file has expired and been deleted. |