Package io.milton.httpclient

Class Host

java.lang.Object

io.milton.httpclient.Resource

io.milton.httpclient.Folder

io.milton.httpclient.Host

public class Host
extends Folder

Author:

mcevoyb

Field Summary

Fields

Modifier and Type	Field	Description
static final List<QName>	defaultFields
final String	password
final Integer	port
final String	rootPath
final String	server
final String	user

Fields inherited from class io.milton.httpclient.Folder

cache

Fields inherited from class io.milton.httpclient.Resource

displayName, name, parent

Constructor Summary

Constructors

Constructor	Description
Host(String server, Integer port, String user, String password, ProxyDetails proxyDetails)
Host(String server, Integer port, String user, String password, ProxyDetails proxyDetails, Map<Folder,List<Resource>> cache)
Host(String server, String rootPath, Integer port, String user, String password, ProxyDetails proxyDetails, int timeoutMillis, Map<Folder,List<Resource>> cache, FileSyncer fileSyncer)
Host(String server, String rootPath, Integer port, String user, String password, ProxyDetails proxyDetails, Map<Folder,List<Resource>> cache)

Method Summary

Modifier and Type	Method	Description
List<PropFindResponse>	_doPropFind(String url, int depth, List<QName> fields)
static Resource	_find(Folder parent, String[] arr, int i, boolean invalidateCache)
void	addConnectionListener(ConnectionListener e)
void	addCookie(String name, String value)
String	baseHref()
String	buildEncodedUrl(Path path)
void	buildResponses(org.jdom2.Document document, Date serverDate, List<PropFindResponse> responses, int depth)
int	doCopy(String from, String newUri)
int	doDelete(Path path)	Deletes the item at the given path, relative to the root path of this host
int	doDelete(String url)
byte[]	doGet(Path path)
void	doGet(Path path, File file, ProgressListener listener)
void	doGet(Path path, OutputStream out, Map<String,String> queryParams)
byte[]	doGet(Path path, Map<String,String> queryParams)
void	doGet(String url, StreamReceiver receiver, List<Range> rangeList, ProgressListener listener)
String	doLock(String uri)	Attempts to lock a resource with infinite timeout and returns the lock token, which must be retained to unlock the resource
String	doLock(String uri, int timeout)	Attempts to lock a resource with the specified timeout and returns the lock token, which must be retained to unlock the resource
int	doMkCol(Path newUri)	Create a collection at the given absolute path.
int	doMkCol(String newUri)
int	doMove(String sourceUrl, String newUri)
void	doOptions(Path path)
String	doPost(String url, Map<String,String> params)	POSTs the variables and returns the body
HttpResult	doPut(Path path, byte[] data, String contentType)
HttpResult	doPut(Path remotePath, File file, IfMatchCheck matchCheck, ProgressListener listener)
HttpResult	doPut(Path path, InputStream content, Long contentLength, String contentType, IfMatchCheck matchCheck)
HttpResult	doPut(String newUri, InputStream content, Long contentLength, String contentType, IfMatchCheck matchCheck, ProgressListener listener)	Uploads the data.
int	doUnLock(String uri, String lockToken)
String	encodedUrl()
Resource	find(String path)	Finds the resource by iterating through the path parts resolving collections as it goes.
Resource	find(String path, boolean invalidateCache)
byte[]	get(Path path)	GET the contents of the given path.
byte[]	get(String path)	Retrieve the bytes at the specified path.
org.apache.http.client.HttpClient	getClient()
Map<String,String>	getCookies()
Folder	getFolder(String path)	Find a folder at the given path.
String	getHref(Path path)	Returns the fully qualified URL for the given path
static org.jdom2.Document	getJDomDocument(InputStream in)
Folder	getOrCreateFolder(Path remoteParentPath, boolean create)
org.jdom2.Document	getResponseAsDocument(InputStream in)
int	getTimeout()
Host	host()
String	href()	Returns the UN-encoded url
boolean	isSecure()
boolean	isUseDigestForPreemptiveAuth()
boolean	isUsePreemptiveAuth()
protected org.apache.http.protocol.HttpContext	newContext()
void	options(String path)
List<PropFindResponse>	propFind(Path path, int depth, List<QName> fields)
List<PropFindResponse>	propFind(Path path, int depth, QName... fields)
List<PropFindResponse>	propFind(String path, int depth, QName... fields)
void	setSecure(boolean secure)
void	setTimeout(int timeout)
void	setUseDigestForPreemptiveAuth(boolean useDigestForPreemptiveAuth)
void	setUsePreemptiveAuth(boolean usePreemptiveAuth)

Methods inherited from class io.milton.httpclient.Folder

addListener, child, children, createFolder, downloadTo, flush, getChild, hasChildren, numChildren, post, removeListener, toString, upload, upload, upload, upload, upload, uploadFile, uploadFile, uploadFile, uploadFolder

Methods inherited from class io.milton.httpclient.Resource

addListener, copyTo, copyTo, decodePath, delete, encodedName, finalize, getCount, getCreatedDate, getLockOwner, getLockToken, getModifiedDate, lock, lock, moveTo, moveTo, path, post, removeListener, rename, unlock

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

defaultFields

public static final List<QName> defaultFields

server

public final String server

port

public final Integer port

user

public final String user

password

public final String password

rootPath

public final String rootPath

Constructor Details

Host

public Host(String server,
 Integer port,
 String user,
 String password,
 ProxyDetails proxyDetails)

Host

public Host(String server,
 Integer port,
 String user,
 String password,
 ProxyDetails proxyDetails,
 Map<Folder,List<Resource>> cache)

Host

public Host(String server,
 String rootPath,
 Integer port,
 String user,
 String password,
 ProxyDetails proxyDetails,
 Map<Folder,List<Resource>> cache)

Host

public Host(String server,
 String rootPath,
 Integer port,
 String user,
 String password,
 ProxyDetails proxyDetails,
 int timeoutMillis,
 Map<Folder,List<Resource>> cache,
 FileSyncer fileSyncer)

Method Details

getJDomDocument

public static org.jdom2.Document getJDomDocument(InputStream in)
                                          throws org.jdom2.JDOMException

Throws:

org.jdom2.JDOMException

find

public Resource find(String path)
              throws IOException,
HttpException,
NotAuthorizedException,
BadRequestException

Finds the resource by iterating through the path parts resolving collections as it goes. If any path component is not founfd returns null

Parameters:

path -

Returns:

Throws:

IOException

HttpException

NotAuthorizedException

BadRequestException

find

public Resource find(String path,
 boolean invalidateCache)
              throws IOException,
HttpException,
NotAuthorizedException,
BadRequestException

Throws:

IOException

HttpException

NotAuthorizedException

BadRequestException

_find

public static Resource _find(Folder parent,
 String[] arr,
 int i,
 boolean invalidateCache)
                      throws IOException,
HttpException,
NotAuthorizedException,
BadRequestException

Throws:

IOException

HttpException

NotAuthorizedException

BadRequestException

getFolder

public Folder getFolder(String path)
                 throws IOException,
HttpException,
NotAuthorizedException,
BadRequestException

Find a folder at the given path. Is much the same as find(path), except that it throws an exception if the resource is not a folder

Parameters:

path -

Returns:

Throws:

IOException

HttpException

NotAuthorizedException

BadRequestException

doMkCol

public int doMkCol(Path newUri)
            throws HttpException,
NotAuthorizedException,
ConflictException,
BadRequestException,
NotFoundException,
URISyntaxException

Create a collection at the given absolute path. This path is NOT relative to the host's base path

Parameters:

newUri -

Returns:

Throws:

HttpException

NotAuthorizedException

ConflictException

BadRequestException

NotFoundException

URISyntaxException

doMkCol

public int doMkCol(String newUri)
            throws HttpException,
NotAuthorizedException,
ConflictException,
BadRequestException,
NotFoundException,
URISyntaxException

Parameters:

newUri - - must be fully qualified and correctly encoded

Returns:

Throws:

HttpException

NotAuthorizedException

ConflictException

BadRequestException

NotFoundException

URISyntaxException

doLock

public String doLock(String uri)
              throws HttpException,
NotAuthorizedException,
ConflictException,
BadRequestException,
NotFoundException,
URISyntaxException

Attempts to lock a resource with infinite timeout and returns the lock token, which must be retained to unlock the resource

Parameters:

uri - - must be encoded

Returns:

Throws:

HttpException

NotAuthorizedException

ConflictException

BadRequestException

NotFoundException

URISyntaxException

doLock

public String doLock(String uri,
 int timeout)
              throws HttpException,
NotAuthorizedException,
ConflictException,
BadRequestException,
NotFoundException,
URISyntaxException

Attempts to lock a resource with the specified timeout and returns the lock token, which must be retained to unlock the resource

Parameters:

uri - - must be encoded

timeout - lock timeout in seconds, or -1 if infinite

Returns:

Throws:

HttpException

NotAuthorizedException

ConflictException

BadRequestException

NotFoundException

URISyntaxException

doUnLock

public int doUnLock(String uri,
 String lockToken)
             throws HttpException,
NotAuthorizedException,
ConflictException,
BadRequestException,
NotFoundException,
URISyntaxException

Parameters:

uri - - must be encoded

lockToken -

Returns:

Throws:

HttpException

NotAuthorizedException

ConflictException

BadRequestException

NotFoundException

URISyntaxException

doPut

public HttpResult doPut(Path path,
 InputStream content,
 Long contentLength,
 String contentType,
 IfMatchCheck matchCheck)

Parameters:

path - - an Un-encoded path. Eg /a/b c/ = /a/b%20c/

content -

contentLength -

contentType -

Returns:

doPut

public HttpResult doPut(Path path,
 byte[] data,
 String contentType)

doPut

public HttpResult doPut(Path remotePath,
 File file,
 IfMatchCheck matchCheck,
 ProgressListener listener)
                 throws FileNotFoundException,
HttpException,
Utils.CancelledException,
NotAuthorizedException,
ConflictException

Parameters:

remotePath -

file -

listener -

Returns:

- the result code

Throws:

FileNotFoundException

HttpException

Utils.CancelledException

NotAuthorizedException

ConflictException

doPut

public HttpResult doPut(String newUri,
 InputStream content,
 Long contentLength,
 String contentType,
 IfMatchCheck matchCheck,
 ProgressListener listener)

Uploads the data. Does not do any file syncronisation

Parameters:

newUri - - encoded full URL

content -

contentLength -

contentType -

Returns:

- the result code

doCopy

public int doCopy(String from,
 String newUri)
           throws HttpException,
NotAuthorizedException,
ConflictException,
BadRequestException,
NotFoundException,
URISyntaxException

Parameters:

from - - encoded source url

newUri - - encoded destination

Returns:

Throws:

HttpException

NotAuthorizedException

ConflictException

BadRequestException

NotFoundException

URISyntaxException

doDelete

public int doDelete(Path path)
             throws IOException,
HttpException,
NotAuthorizedException,
ConflictException,
BadRequestException,
NotFoundException

Deletes the item at the given path, relative to the root path of this host

Parameters:

path - - unencoded and relative to Host's rootPath

Returns:

Throws:

IOException

HttpException

NotAuthorizedException

ConflictException

BadRequestException

NotFoundException

doDelete

public int doDelete(String url)
             throws IOException,
HttpException,
NotAuthorizedException,
ConflictException,
BadRequestException,
NotFoundException

Parameters:

url - - encoded url

Returns:

Throws:

IOException

HttpException

NotAuthorizedException

ConflictException

BadRequestException

NotFoundException

doMove

public int doMove(String sourceUrl,
 String newUri)
           throws IOException,
HttpException,
NotAuthorizedException,
ConflictException,
BadRequestException,
NotFoundException,
URISyntaxException

Parameters:

sourceUrl - - encoded source url

newUri - - encoded destination url

Returns:

Throws:

IOException

HttpException

NotAuthorizedException

ConflictException

BadRequestException

NotFoundException

URISyntaxException

propFind

public List<PropFindResponse> propFind(Path path,
 int depth,
 QName... fields)
                                throws IOException,
HttpException,
NotAuthorizedException,
BadRequestException

Throws:

IOException

HttpException

NotAuthorizedException

BadRequestException

propFind

public List<PropFindResponse> propFind(String path,
 int depth,
 QName... fields)
                                throws IOException,
HttpException,
NotAuthorizedException,
BadRequestException

Throws:

IOException

HttpException

NotAuthorizedException

BadRequestException

propFind

public List<PropFindResponse> propFind(Path path,
 int depth,
 List<QName> fields)
                                throws IOException,
HttpException,
NotAuthorizedException,
BadRequestException

Parameters:

path - - unencoded path, which will be evaluated relative to this Host's basePath

depth - - 1 is to find immediate children, 2 includes their children, etc

fields - - the list of fields to get, or null to use default fields

Returns:

Throws:

IOException

HttpException

NotAuthorizedException

BadRequestException

_doPropFind

public List<PropFindResponse> _doPropFind(String url,
 int depth,
 List<QName> fields)
                                   throws IOException,
HttpException,
NotAuthorizedException,
BadRequestException

Parameters:

url - - the encoded absolute URL to query. This method does not apply basePath

depth - - depth to generate responses for. Zero means only the specified url, 1 means it and its direct children, etc

Returns:

Throws:

IOException

HttpException

NotAuthorizedException

BadRequestException

buildResponses

public void buildResponses(org.jdom2.Document document,
 Date serverDate,
 List<PropFindResponse> responses,
 int depth)

getResponseAsDocument

public org.jdom2.Document getResponseAsDocument(InputStream in)
                                         throws IOException

Throws:

IOException

doGet

public void doGet(String url,
 StreamReceiver receiver,
 List<Range> rangeList,
 ProgressListener listener)
           throws HttpException,
Utils.CancelledException,
NotAuthorizedException,
BadRequestException,
ConflictException,
NotFoundException

Parameters:

url - - fully qualified and encoded URL

receiver -

rangeList - - if null does a normal GET request

Throws:

HttpException

Utils.CancelledException

NotAuthorizedException

BadRequestException

ConflictException

NotFoundException

doGet

public void doGet(Path path,
 File file,
 ProgressListener listener)
           throws IOException,
NotFoundException,
HttpException,
Utils.CancelledException,
NotAuthorizedException,
BadRequestException,
ConflictException

Parameters:

path - - the path to get, relative to the base path of the host

file - - the file to write content to

listener -

Throws:

IOException

NotFoundException

HttpException

Utils.CancelledException

NotAuthorizedException

BadRequestException

ConflictException

doGet

public byte[] doGet(Path path)
             throws IOException,
NotFoundException,
HttpException,
NotAuthorizedException,
BadRequestException,
ConflictException

Throws:

IOException

NotFoundException

HttpException

NotAuthorizedException

BadRequestException

ConflictException

doGet

public byte[] doGet(Path path,
 Map<String,String> queryParams)
             throws IOException,
NotFoundException,
HttpException,
NotAuthorizedException,
BadRequestException,
ConflictException

Throws:

IOException

NotFoundException

HttpException

NotAuthorizedException

BadRequestException

ConflictException

doGet

public void doGet(Path path,
 OutputStream out,
 Map<String,String> queryParams)
           throws IOException,
NotFoundException,
HttpException,
NotAuthorizedException,
BadRequestException,
ConflictException

Throws:

IOException

NotFoundException

HttpException

NotAuthorizedException

BadRequestException

ConflictException

options

public void options(String path)
             throws ConnectException,
NotAuthorizedException,
UnknownHostException,
SocketTimeoutException,
IOException,
HttpException,
NotFoundException

Parameters:

path - - encoded path, but not fully qualified. Must not be prefixed with a slash, as it will be appended to the host's URL

Throws:

ConnectException

NotAuthorizedException

UnknownHostException

SocketTimeoutException

IOException

HttpException

NotFoundException

doOptions

public void doOptions(Path path)
               throws NotFoundException,
NotAuthorizedException,
IOException,
HttpException

Throws:

NotFoundException

NotAuthorizedException

IOException

HttpException

get

public byte[] get(Path path)
           throws HttpException,
NotAuthorizedException,
BadRequestException,
ConflictException,
NotFoundException

GET the contents of the given path. The path is non-encoded, and it relative to the host's root.

Parameters:

path -

Returns:

Throws:

HttpException

NotAuthorizedException

BadRequestException

ConflictException

NotFoundException

get

public byte[] get(String path)
           throws HttpException,
NotAuthorizedException,
BadRequestException,
ConflictException,
NotFoundException

Retrieve the bytes at the specified path.

Parameters:

path - - encoded and relative to host's rootPath. Must NOT be slash prefixed as it will be appended to the host's url

Returns:

Throws:

HttpException

NotAuthorizedException

BadRequestException

ConflictException

NotFoundException

doPost

public String doPost(String url,
 Map<String,String> params)
              throws HttpException,
NotAuthorizedException,
ConflictException,
BadRequestException,
NotFoundException

POSTs the variables and returns the body

Parameters:

url - - fully qualified and encoded URL to post to

params -

Returns:

- the body of the response

Throws:

HttpException

NotAuthorizedException

ConflictException

BadRequestException

NotFoundException

host

public Host host()

Overrides:

host in class Resource

href

public String href()

Description copied from class: Resource

Returns the UN-encoded url

Overrides:

href in class Folder

Returns:

baseHref

public String baseHref()

getHref

public String getHref(Path path)

Returns the fully qualified URL for the given path

Parameters:

path -

Returns:

encodedUrl

public String encodedUrl()

Overrides:

encodedUrl in class Folder

getOrCreateFolder

public Folder getOrCreateFolder(Path remoteParentPath,
 boolean create)
                         throws HttpException,
IOException,
NotAuthorizedException,
ConflictException,
BadRequestException,
NotFoundException

Throws:

HttpException

IOException

NotAuthorizedException

ConflictException

BadRequestException

NotFoundException

getTimeout

public int getTimeout()

Returns:

the timeout

setTimeout

public void setTimeout(int timeout)

Parameters:

timeout - the timeout to set

getCookies

public Map<String,String> getCookies()

addCookie

public void addCookie(String name,
 String value)

addConnectionListener

public void addConnectionListener(ConnectionListener e)

buildEncodedUrl

public String buildEncodedUrl(Path path)

isSecure

public boolean isSecure()

setSecure

public void setSecure(boolean secure)

getClient

public org.apache.http.client.HttpClient getClient()

isUseDigestForPreemptiveAuth

public boolean isUseDigestForPreemptiveAuth()

setUseDigestForPreemptiveAuth

public void setUseDigestForPreemptiveAuth(boolean useDigestForPreemptiveAuth)

isUsePreemptiveAuth

public boolean isUsePreemptiveAuth()

setUsePreemptiveAuth

public void setUsePreemptiveAuth(boolean usePreemptiveAuth)

newContext

protected org.apache.http.protocol.HttpContext newContext()