NetscapeCookieFile: Javadoc fixes
Downstream analyzers reported empty fields in the javadoc. I corrected few more details: * Fill empty javadoc fields. * Use <p> to separate description paragraphs. * End description paragraphs with a period. * Remove period at the end of field descriptions. Change-Id: I749e4b821fc855999caddc442ac788fa514386ea Signed-off-by: Ivan Frade <ifrade@google.com>
This commit is contained in:
Ivan Frade
Matthias Sohn
parent
96bd5ad8a3
commit
83b0efbae6
|
|
@ -78,7 +78,7 @@
|
|||
* Wraps all cookies persisted in a <strong>Netscape Cookie File Format</strong>
|
||||
* being referenced via the git config <a href=
|
||||
* "https://git-scm.com/docs/git-config#git-config-httpcookieFile">http.cookieFile</a>.
|
||||
*
|
||||
* <p>
|
||||
* It will only load the cookies lazily, i.e. before calling
|
||||
* {@link #getCookies(boolean)} the file is not evaluated. This class also
|
||||
* allows persisting cookies in that file format.
|
||||
|
|
@ -134,6 +134,7 @@ public final class NetscapeCookieFile {
|
|||
|
||||
/**
|
||||
* @param path
|
||||
* where to find the cookie file
|
||||
*/
|
||||
public NetscapeCookieFile(Path path) {
|
||||
this(path, new Date());
|
||||
|
|
@ -146,13 +147,17 @@ public NetscapeCookieFile(Path path) {
|
|||
}
|
||||
|
||||
/**
|
||||
* @return the path to the underlying cookie file
|
||||
* Path to the underlying cookie file.
|
||||
*
|
||||
* @return the path
|
||||
*/
|
||||
public Path getPath() {
|
||||
return path;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return all cookies from the underlying cookie file.
|
||||
*
|
||||
* @param refresh
|
||||
* if {@code true} updates the list from the underlying cookie
|
||||
* file if it has been modified since the last read otherwise
|
||||
|
|
@ -205,7 +210,7 @@ public Set<HttpCookie> getCookies(boolean refresh) {
|
|||
* @throws IOException
|
||||
* if the given file could not be read for some reason
|
||||
* @throws IllegalArgumentException
|
||||
* if the given file does not have a proper format.
|
||||
* if the given file does not have a proper format
|
||||
*/
|
||||
private static Set<HttpCookie> parseCookieFile(@NonNull byte[] input,
|
||||
@NonNull Date creationDate)
|
||||
|
|
@ -275,23 +280,25 @@ private static HttpCookie parseLine(@NonNull String line,
|
|||
/**
|
||||
* Writes all the cookies being maintained in the set being returned by
|
||||
* {@link #getCookies(boolean)} to the underlying file.
|
||||
*
|
||||
* <p>
|
||||
* Session-cookies will not be persisted.
|
||||
*
|
||||
* @param url
|
||||
* url for which to write the cookies (important to derive
|
||||
* default values for non-explicitly set attributes)
|
||||
* @throws IOException
|
||||
* @throws IllegalArgumentException
|
||||
* if the underlying cookie file could not be read or written or
|
||||
* a problem with the lock file
|
||||
* @throws InterruptedException
|
||||
* if the thread is interrupted while waiting for the lock
|
||||
*/
|
||||
public void write(URL url)
|
||||
throws IllegalArgumentException, IOException, InterruptedException {
|
||||
public void write(URL url) throws IOException, InterruptedException {
|
||||
try {
|
||||
byte[] cookieFileContent = getFileContentIfModified();
|
||||
if (cookieFileContent != null) {
|
||||
LOG.debug(
|
||||
"Reading the underlying cookie file '{}' as it has been modified since the last access", //$NON-NLS-1$
|
||||
LOG.debug("Reading the underlying cookie file '{}' " //$NON-NLS-1$
|
||||
+ "as it has been modified since " //$NON-NLS-1$
|
||||
+ "the last access", //$NON-NLS-1$
|
||||
path);
|
||||
// reread new changes if necessary
|
||||
Set<HttpCookie> cookiesFromFile = NetscapeCookieFile
|
||||
|
|
@ -326,19 +333,21 @@ public void write(URL url)
|
|||
}
|
||||
throw new IOException(
|
||||
MessageFormat.format(JGitText.get().cannotLock, lockFile));
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Read the underying file and return its content but only in case it has
|
||||
* been modified since the last access. Internally calculates the hash and
|
||||
* maintains {@link FileSnapshot}s to prevent issues described as <a href=
|
||||
* been modified since the last access.
|
||||
* <p>
|
||||
* Internally calculates the hash and maintains {@link FileSnapshot}s to
|
||||
* prevent issues described as <a href=
|
||||
* "https://github.com/git/git/blob/master/Documentation/technical/racy-git.txt">"Racy
|
||||
* Git problem"</a>. Inspired by {@link FileBasedConfig#load()}.
|
||||
*
|
||||
* @return the file contents in case the file has been modified since the
|
||||
* last access, otherwise {@code null}
|
||||
* @throws IOException
|
||||
* if the file is not found or cannot be read
|
||||
*/
|
||||
private byte[] getFileContentIfModified() throws IOException {
|
||||
final int maxStaleRetries = 5;
|
||||
|
|
@ -392,10 +401,10 @@ private byte[] hash(final byte[] in) {
|
|||
|
||||
/**
|
||||
* Writes the given cookies to the file in the Netscape Cookie File Format
|
||||
* (also used by curl)
|
||||
* (also used by curl).
|
||||
*
|
||||
* @param writer
|
||||
* the writer to use to persist the cookies.
|
||||
* the writer to use to persist the cookies
|
||||
* @param cookies
|
||||
* the cookies to write into the file
|
||||
* @param url
|
||||
|
|
@ -404,8 +413,9 @@ private byte[] hash(final byte[] in) {
|
|||
* @param creationDate
|
||||
* the date when the cookie has been created. Important for
|
||||
* calculation the cookie expiration time (calculated from
|
||||
* cookie's maxAge and this creation time).
|
||||
* cookie's maxAge and this creation time)
|
||||
* @throws IOException
|
||||
* if an I/O error occurs
|
||||
*/
|
||||
static void write(@NonNull Writer writer,
|
||||
@NonNull Collection<HttpCookie> cookies, @NonNull URL url,
|
||||
|
|
@ -461,7 +471,9 @@ private static void writeCookie(@NonNull Writer writer,
|
|||
* the entry from set {@code cookies1} ends up in the resulting set.
|
||||
*
|
||||
* @param cookies1
|
||||
* first set of cookies
|
||||
* @param cookies2
|
||||
* second set of cookies
|
||||
*
|
||||
* @return the merged cookies
|
||||
*/
|
||||
|
|
|
|||
Loading…
Reference in New Issue