Sardine.put on a locked resource

[lasselindqvist]

It would be useful if Sardine could do a put call on a locked resource.
Now there is no way to pass the lockToken to the put call and this the user flow of

1. sardine.lock
2. sardine.put // perhaps multiple calls
3. sardine.unlock

is not possible.

Sardine.put has many overloads and many methods that take Strings as input.
Might be worth considering turning the Sardine.lock method into a method that returns a Lock-object. (new interface). It could have a now just a one method, getToken(), but could also support getExpiration etc. methods in future. (There is of course the XML class Lockinfo which we might not want to directly expose for the client)

Then we could add Sardine.put(String url, Lock lock) method for calling put with a lock.

[dkocher]

This is possible as of 73ccb7e which allows to pass any additional headers.

[lasselindqvist]

Yes but it is not very easy for a user to use. They would need to manually add the lock metadata there.

[lookfirst]

Hi @lasselindqvist, as David says, Sardine allows this pretty easily by allowing you to pass in whatever headers you need. If you'd like an easier interface, you're welcome to wrap yours around the core library. Adding more methods and overloads for this one feature doesn't seem applicable, but I'm open to further discussion on reasoning.

[lasselindqvist]

If the vision is to stay quite low level I think that is fine, and maybe then what could be is to add lock usage to the examples.
There are some examples in the specification (http://www.webdav.org/specs/rfc4918.html#rfc.section.7.5.1) but would be good to show usage with this library.

Somewhat related to this, I did think about AutoCloseable and Sardine. Sardine uses Apache HttpClient which is thread-safe and Sardine object should be mostly too then I guess. Although it has HttpClientContext field which is not totally thread safe.
Internally Sardine keeps CloseableHttpClient and has public being() method. It feels like Sardine could/should be AutoCloseable but is not. Should it be?

If it was AutoCloseable, or had AutoCloseable locks, something like

try (Sardine sardine = SardineFactory..begin();) {
 // do things
}

or

try (Sardine sardine = SardineFactory..begin();) {
  DavResource resource sardine.getResource();
  ....
   try (Lock lock = sardine.withLock(resource);) {
   // do things and autorelease the lock
   // lock could automatically attach the lock to the sardine context, but would make it surely non-thread safe.
  }
}

would be possible.

AutoCloseable and/or some kind of context keeping would make things like these possible. But then again, maybe it is not intended for this library, but for some higher-level one.