ipworks
Class Webdav

java.lang.Object
  |
  +--ipworks.Webdav

public class Webdav

extends java.lang.Object

The WebDAV bean implements an easy-to-use interface to the Web Distributed Authoring and Versioning protocol (WebDAV).

The bean allows remote management of resource properties and collections, including creation, deletion, listing, copying, and moving. Resource locking is also supported.

The ListDirectory and FindProperties methods will list the properties of a resource collection or resource, and a DirList or ResourceProperties event will be fired for each matching resource.

Depth is used to determine which resources or properties are retrieved from the server. A depth of ResourceOnly will return only the resource associated with ResourceURI , or its properties. A depth of Infinity will return all resources contained within hierarchy, or their collective properties.

A number of operations can be performed on resources by using the various methods of the bean. Please refer to the individual methods for more information.

WebDAV allows non-standard properties to be specified through XML namespaces.

The namespaces are provided in the Namespaces collection. The collection is filled automatically when retrieving DAV responses, but must be filled manually when requesting non-standard properties.

Field Summary

static int	authBasic
static int	authDigest
static int	authNone
static int	authNtlm
static int	authProprietary
static int	dpImmediateChildren
static int	dpInfinity
static int	dpResourceOnly
static int	dpUnspecified
static int	frAlways
static int	frNever
static int	frSameScheme

Constructor Summary

Webdav()

Method Summary

void	addCookie(java.lang.String cookieName, java.lang.String cookieValue) Sets a cookie and the corresponding value.
void	addNamespace(java.lang.String prefix, java.lang.String namespaceURI) Adds a namespace to the Namespaces collection.
void	addWebdavEventListener(ipworks.WebdavEventListener l)
java.lang.String	config(java.lang.String configurationString) Sets or retrieves a beanconfiguration setting.
void	copyResource(java.lang.String sourceResourceURI, java.lang.String destinationResourceURI) Copy a resource to a new location.
void	deleteResource(java.lang.String resourceURI) Delete a resource.
void	doEvents() Processes events from the internal message queue.
void	findProperties(java.lang.String resourceURI) Get resource property values from the server.
void	findPropertyNames(java.lang.String resourceURI) Get resource property names from the server.
java.lang.String	getAccept() A list of acceptable MIME types for the request.
int	getAuthScheme() The authorization scheme to be used when server authorization is to be performed.
HTTPCookieList	getCookies() Collection of cookies.
int	getDepth() The depth associated with the current operation.
ipworks.Firewall	getFirewall() A set of properties related to firewall access.
int	getFollowRedirects() Determines what happens when the server issues a redirect.
java.lang.String	getLocalFile() The path to a local file used for DAV operations.
java.lang.String	getLockOwner() The principle that owns the current resource lock.
java.lang.String	getLockScope() The scope of the current resource lock.
int	getLockTimeout() The time to live for the current resource lock.
java.lang.String	getLockTokens() The lock string to be used when submitting operations on a locked resource.
java.lang.String	getLockType() The type of the current resource lock.
XMLNamespaceList	getNamespaces() Collection of namespaces in the current stack.
java.lang.String	getOtherHeaders() Other headers as determined by the user (optional).
HeaderList	getParsedHeaders() Collection of headers returned from the last retrieval.
java.lang.String	getPassword() A password if authentication is to be used.
DAVPropertyList	getProperties() A collection of WebDAV properties.
java.lang.String	getProperty(java.lang.String propertyName) Get the value for a particular property.
ipworks.Proxy	getProxy() A set of properties related to proxy access.
java.lang.String	getReferer() Referer URL/document (optional).
void	getResource(java.lang.String resourceURI) Get a resource using the WebDAV GET method.
DAVResourceList	getResources() Collection of resources resulting from the last directory listing.
java.lang.String	getStatusLine() The first line of the last server response.
int	getTimeout() A timeout for the bean.
byte[]	getTransferredData() The contents of the last transfer.
long	getTransferredDataLimit() The maximum of data to be transferred.
java.lang.String	getTransferredHeaders() The full set of headers as received from the server.
java.lang.String	getUser() A user name if authentication is to be used.
void	interrupt() Interrupt the current method.
boolean	isConnected() Shows whether the bean is connected.
boolean	isIdle() The current status of the component.
void	listDirectory(java.lang.String resourceURI) List the files and subdirectories of the ResourceURI .
void	lockResource(java.lang.String resourceURI) Obtain a lock for a specified resource.
void	makeDirectory(java.lang.String resourceURI) Make a new directory.
void	moveResource(java.lang.String sourceResourceURI, java.lang.String destinationResourceURI) Moves one resource to a new location.
void	patchProperties(java.lang.String resourceURI) Update the current set of properties on the server.
void	postToResource(java.lang.String resourceURI, byte[] postData) Posts data to a resource using the WebDAV POST method.
void	putResource(java.lang.String resourceURI) Send data to the server using the PUT method.
void	removeWebdavEventListener(ipworks.WebdavEventListener l)
void	reset() Reset the bean.
void	setAccept(java.lang.String accept) A list of acceptable MIME types for the request.
void	setAuthScheme(int authScheme) The authorization scheme to be used when server authorization is to be performed.
void	setConnected(boolean connected) Shows whether the bean is connected.
void	setCookies(HTTPCookieList cookies) Collection of cookies.
void	setDepth(int depth) The depth associated with the current operation.
void	setDownloadStream(java.io.OutputStream downloadStream) Sets the stream to which the downloaded data from the server will be written.
void	setFirewall(ipworks.Firewall firewall) A set of properties related to firewall access.
void	setFollowRedirects(int followRedirects) Determines what happens when the server issues a redirect.
void	setLocalFile(java.lang.String localFile) The path to a local file used for DAV operations.
void	setLockOwner(java.lang.String lockOwner) The principle that owns the current resource lock.
void	setLockScope(java.lang.String lockScope) The scope of the current resource lock.
void	setLockTimeout(int lockTimeout) The time to live for the current resource lock.
void	setLockTokens(java.lang.String lockTokens) The lock string to be used when submitting operations on a locked resource.
void	setLockType(java.lang.String lockType) The type of the current resource lock.
void	setNamespaces(XMLNamespaceList namespaces) Collection of namespaces in the current stack.
void	setOtherHeaders(java.lang.String otherHeaders) Other headers as determined by the user (optional).
void	setPassword(java.lang.String password) A password if authentication is to be used.
void	setProperties(DAVPropertyList properties) A collection of WebDAV properties.
void	setProperty(java.lang.String propertyName, java.lang.String propertyValue) Set the value of a property.
void	setProxy(ipworks.Proxy proxy) A set of properties related to proxy access.
void	setReferer(java.lang.String referer) Referer URL/document (optional).
void	setTimeout(int timeout) A timeout for the bean.
void	setTransferredDataLimit(long transferredDataLimit) The maximum of data to be transferred.
void	setUploadStream(java.io.InputStream uploadStream) Sets the stream to be uploaded to the server.
void	setUser(java.lang.String user) A user name if authentication is to be used.
void	unLockResource(java.lang.String resourceURI) Unlocks a resource.

Methods inherited from class java.lang.Object

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

Field Detail

authBasic

public static final int authBasic

See Also:

Constant Field Values

authDigest

public static final int authDigest

See Also:

Constant Field Values

authProprietary

public static final int authProprietary

See Also:

Constant Field Values

authNone

public static final int authNone

See Also:

Constant Field Values

authNtlm

public static final int authNtlm

See Also:

Constant Field Values

dpUnspecified

public static final int dpUnspecified

See Also:

Constant Field Values

dpResourceOnly

public static final int dpResourceOnly

See Also:

Constant Field Values

dpImmediateChildren

public static final int dpImmediateChildren

See Also:

Constant Field Values

dpInfinity

public static final int dpInfinity

See Also:

Constant Field Values

frNever

public static final int frNever

See Also:

Constant Field Values

frAlways

public static final int frAlways

See Also:

Constant Field Values

frSameScheme

public static final int frSameScheme

See Also:

Constant Field Values

Constructor Detail

Webdav

public Webdav()

Method Detail

getAccept

public java.lang.String getAccept()

A list of acceptable MIME types for the request.

If the Accept property contains a non-empty string, an HTTP Accept header is added to the request.

The Accept header is used for content negotiation. It consists of a comma-separated list of acceptable MIME types.

setAccept

public void setAccept(java.lang.String accept)
               throws IPWorksException

A list of acceptable MIME types for the request.

If the Accept property contains a non-empty string, an HTTP Accept header is added to the request.

The Accept header is used for content negotiation. It consists of a comma-separated list of acceptable MIME types.

IPWorksException

getAuthScheme

public int getAuthScheme()

The authorization scheme to be used when server authorization is to be performed.

Use the AuthScheme property to tell the bean which type of authorization to perform when the User and Password properties are set.

AuthScheme should be set to authNone (3) when no authentication is expected.

By default, AuthScheme is authBasic (0), and if the User and Password properties are set, the bean will attempt basic authentication. If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If AuthScheme is set to authProprietary (2) then the authorization token must be supplied through Authorization property. Note that, if you set the Authorization property, the AuthScheme will be set automatically to authProprietary (2) by the control.

If AuthScheme is set to authNtlm (4) NTLM authentication will be used. This option is only available in the SSL package.

For security reasons, setting this property will clear the values of User and Password .

setAuthScheme

public void setAuthScheme(int authScheme)
                   throws IPWorksException

The authorization scheme to be used when server authorization is to be performed.

Use the AuthScheme property to tell the bean which type of authorization to perform when the User and Password properties are set.

AuthScheme should be set to authNone (3) when no authentication is expected.

By default, AuthScheme is authBasic (0), and if the User and Password properties are set, the bean will attempt basic authentication. If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If AuthScheme is set to authProprietary (2) then the authorization token must be supplied through Authorization property. Note that, if you set the Authorization property, the AuthScheme will be set automatically to authProprietary (2) by the control.

If AuthScheme is set to authNtlm (4) NTLM authentication will be used. This option is only available in the SSL package.

For security reasons, setting this property will clear the values of User and Password .

IPWorksException

isConnected

public boolean isConnected()

Shows whether the bean is connected.

Use this property to determine whether the bean is connected to the remote host or not.

setConnected

public void setConnected(boolean connected)
                  throws IPWorksException

Shows whether the bean is connected.

Use this property to determine whether the bean is connected to the remote host or not.

IPWorksException

getCookies

public HTTPCookieList getCookies()

Collection of cookies.

All HTTPCOOKIE specified in the collection are added to the outgoing HTTP request.

The SetCookie event displays the cookies and their properties as set by the server, and those cookies are also maintained in the Cookies property.

MaxHTTPCookiescan be used to control the number of cookies saved.

This collection is indexed from 0 to Count - 1.

setCookies

public void setCookies(HTTPCookieList cookies)
                throws IPWorksException

Collection of cookies.

All HTTPCOOKIE specified in the collection are added to the outgoing HTTP request.

The SetCookie event displays the cookies and their properties as set by the server, and those cookies are also maintained in the Cookies property.

MaxHTTPCookiescan be used to control the number of cookies saved.

This collection is indexed from 0 to Count - 1.

IPWorksException

getDepth

public int getDepth()

The depth associated with the current operation.

When performing certain operations on resource collections, the bean will use Depth to instruct the server on how deep to operate within the collection. Depth is an enumerated type with the following possible values:

dpUnspecified (0)

The server will use the protocol default depth for the operation (this is normally "infinity").

dpResourceOnly (1)

The server will operate only on the collection resource URI, and not on any of its internal member resources.

dpImmediateChildren (2)

The server will operate on the collection resource URI and all of its immediate member resources (but on none of their member resources).

dpInfinity (3)

The server will recursively operate on the target resource URI and all of its internal member URIs through all levels of the collection hierarchy.

Depth is used when performing the following operations: LockResource , MoveResource CopyResource , FindProperties , PatchProperties , and ListDirectory .

setDepth

public void setDepth(int depth)
              throws IPWorksException

The depth associated with the current operation.

When performing certain operations on resource collections, the bean will use Depth to instruct the server on how deep to operate within the collection. Depth is an enumerated type with the following possible values:

dpUnspecified (0)

The server will use the protocol default depth for the operation (this is normally "infinity").

dpResourceOnly (1)

The server will operate only on the collection resource URI, and not on any of its internal member resources.

dpImmediateChildren (2)

The server will operate on the collection resource URI and all of its immediate member resources (but on none of their member resources).

dpInfinity (3)

The server will recursively operate on the target resource URI and all of its internal member URIs through all levels of the collection hierarchy.

Depth is used when performing the following operations: LockResource , MoveResource CopyResource , FindProperties , PatchProperties , and ListDirectory .

IPWorksException

getFirewall

public ipworks.Firewall getFirewall()

A set of properties related to firewall access.

This is a FIREWALL type property which contains fields describing the firewall through which the bean will attempt to connect.

setFirewall

public void setFirewall(ipworks.Firewall firewall)
                 throws IPWorksException

A set of properties related to firewall access.

This is a FIREWALL type property which contains fields describing the firewall through which the bean will attempt to connect.

IPWorksException

getFollowRedirects

public int getFollowRedirects()

Determines what happens when the server issues a redirect.

Normally, the bean returns an error if the server responds with an "Object Moved" message. If FollowRedirects is set to frAlways (1) the new URL for the object is retrieved automatically every time.

If FollowRedirects is set to frSameScheme (2), the new URL is retrieved automatically only if the URLScheme is the same, otherwise the bean throws an IPWorksException raises an IPWorksException exception .

Note that following the HTTP specification, unless FollowRedirects is set to frAlways (1), automatic redirects will be performed only for 'GET' or 'HEAD' requests. Other methods could potentially change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server and port are different than the existing one, User and Password are also reset to empty, unless FollowRedirects is set to frAlways (1), in which case the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g. new authentication parameters).

The default value is frNever (0). In this case, redirects are never followed, and a runtime error is generated instead.

setFollowRedirects

public void setFollowRedirects(int followRedirects)
                        throws IPWorksException

Determines what happens when the server issues a redirect.

Normally, the bean returns an error if the server responds with an "Object Moved" message. If FollowRedirects is set to frAlways (1) the new URL for the object is retrieved automatically every time.

If FollowRedirects is set to frSameScheme (2), the new URL is retrieved automatically only if the URLScheme is the same, otherwise the bean throws an IPWorksException raises an IPWorksException exception .

Note that following the HTTP specification, unless FollowRedirects is set to frAlways (1), automatic redirects will be performed only for 'GET' or 'HEAD' requests. Other methods could potentially change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server and port are different than the existing one, User and Password are also reset to empty, unless FollowRedirects is set to frAlways (1), in which case the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g. new authentication parameters).

The default value is frNever (0). In this case, redirects are never followed, and a runtime error is generated instead.

IPWorksException

isIdle

public boolean isIdle()

The current status of the component.

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

getLocalFile

public java.lang.String getLocalFile()

The path to a local file used for DAV operations.

After a GetResource operation, LocalFile will contain the contents of the resource.

For a PutResource operation, LocalFile contains the data that will be uploaded to the server.

If LocalFile is empty then the received data is provided through the Transfer event.

setLocalFile

public void setLocalFile(java.lang.String localFile)
                  throws IPWorksException

The path to a local file used for DAV operations.

After a GetResource operation, LocalFile will contain the contents of the resource.

For a PutResource operation, LocalFile contains the data that will be uploaded to the server.

If LocalFile is empty then the received data is provided through the Transfer event.

IPWorksException

getLockOwner

public java.lang.String getLockOwner()

The principle that owns the current resource lock.

Before a call to the LockResource method, LockOwner may be set to the name of a principle or group of principles that will own the lock. If no owner is specified, the server will automatically associate the lock with the requesting principle. After a successful LockResource operation, the bean will set the LockOwner property to the correct value returned in the server's response.

setLockOwner

public void setLockOwner(java.lang.String lockOwner)
                  throws IPWorksException

The principle that owns the current resource lock.

Before a call to the LockResource method, LockOwner may be set to the name of a principle or group of principles that will own the lock. If no owner is specified, the server will automatically associate the lock with the requesting principle. After a successful LockResource operation, the bean will set the LockOwner property to the correct value returned in the server's response.

IPWorksException

getLockScope

public java.lang.String getLockScope()

The scope of the current resource lock.

Before a call to the LockResource method, LockScope may be set to the type of scope needed for the lock. Currently the bean will only allow two types of scopes to be requested:

"exclusive"

The lock belongs exclusively to the requesting principle. No other principle may modify the locked resource URI.

"shared"

The locked resource may not be modified by non-trusted principles. Users who have access rights, however, may request a shared lock which they can then use to modify or operate on the resource.

If no scope is specified, the protocol default scope, "exclusive", will be requested. After a successful LockResource operation, the bean will set the LockScope property to the correct value returned in the server's response.

setLockScope

public void setLockScope(java.lang.String lockScope)
                  throws IPWorksException

The scope of the current resource lock.

Before a call to the LockResource method, LockScope may be set to the type of scope needed for the lock. Currently the bean will only allow two types of scopes to be requested:

"exclusive"

The lock belongs exclusively to the requesting principle. No other principle may modify the locked resource URI.

"shared"

The locked resource may not be modified by non-trusted principles. Users who have access rights, however, may request a shared lock which they can then use to modify or operate on the resource.

If no scope is specified, the protocol default scope, "exclusive", will be requested. After a successful LockResource operation, the bean will set the LockScope property to the correct value returned in the server's response.

IPWorksException

getLockTimeout

public int getLockTimeout()

The time to live for the current resource lock.

Before a call to the LockResource method, LockTimeout may be set to a specific amount of time needed for the locked operation to take place. The timeout is used to determine how long the lock may exist before the server automatically unlocks the resource URI. If Timeout of 0 is specified, the server will use a default timeout. After a successful LockResource operation, the bean will set the LockTimeout property to the correct value returned in the server's response.

setLockTimeout

public void setLockTimeout(int lockTimeout)
                    throws IPWorksException

The time to live for the current resource lock.

Before a call to the LockResource method, LockTimeout may be set to a specific amount of time needed for the locked operation to take place. The timeout is used to determine how long the lock may exist before the server automatically unlocks the resource URI. If Timeout of 0 is specified, the server will use a default timeout. After a successful LockResource operation, the bean will set the LockTimeout property to the correct value returned in the server's response.

IPWorksException

getLockTokens

public java.lang.String getLockTokens()

The lock string to be used when submitting operations on a locked resource.

Before a call to the LockResource method, LockTokens may be set to the tokens returned by a previous lock operation. This is useful when renewing a timeout. The server will respond with a new timeout value, which will be stored in LockTimeout . If the lock request is not a lock refresh, LockTokens must be empty, and will be parsed out of the server response after a successful call to the LockResource method.

setLockTokens

public void setLockTokens(java.lang.String lockTokens)
                   throws IPWorksException

The lock string to be used when submitting operations on a locked resource.

Before a call to the LockResource method, LockTokens may be set to the tokens returned by a previous lock operation. This is useful when renewing a timeout. The server will respond with a new timeout value, which will be stored in LockTimeout . If the lock request is not a lock refresh, LockTokens must be empty, and will be parsed out of the server response after a successful call to the LockResource method.

IPWorksException

getLockType

public java.lang.String getLockType()

The type of the current resource lock.

Before a call to the LockResource method, LockType may be set to the type of lock being requested. Currently, the bean only supports requesting locks of type "write", although the protocol defines an optional "read" lock. After a successful LockResource operation, the bean will set the LockType property to the correct value returned in the erver's response.

setLockType

public void setLockType(java.lang.String lockType)
                 throws IPWorksException

The type of the current resource lock.

Before a call to the LockResource method, LockType may be set to the type of lock being requested. Currently, the bean only supports requesting locks of type "write", although the protocol defines an optional "read" lock. After a successful LockResource operation, the bean will set the LockType property to the correct value returned in the erver's response.

IPWorksException

getNamespaces

public XMLNamespaceList getNamespaces()

Collection of namespaces in the current stack.

WebDAV allows non-standard properties to be specified through XML namespaces.

The collection is filled automatically when retrieving DAV responses, but must be filled manually when requesting non-standard properties.

If the DAV uri is not found in the namespaces collection, it will be added as the default namespace when generating a request. The DAV namespace uri is "DAV:".

This collection is indexed from 0 to Count - 1.

setNamespaces

public void setNamespaces(XMLNamespaceList namespaces)
                   throws IPWorksException

Collection of namespaces in the current stack.

WebDAV allows non-standard properties to be specified through XML namespaces.

The collection is filled automatically when retrieving DAV responses, but must be filled manually when requesting non-standard properties.

If the DAV uri is not found in the namespaces collection, it will be added as the default namespace when generating a request. The DAV namespace uri is "DAV:".

This collection is indexed from 0 to Count - 1.

IPWorksException

getOtherHeaders

public java.lang.String getOtherHeaders()

Other headers as determined by the user (optional).

The OtherHeaders property contains a string of headers to be appended to the HTTP request headers created from other properties like ContentType , From , etc.

The headers must of the format "header: value" as specified in the HTTP specifications. Header lines should be separated by CRLF ("\\r\\n") .

Use this property with caution. If OtherHeaders contains invalid headers, HTTP requests may fail.

The OtherHeaders property is useful for extending the functionality of the bean beyond what is provided.

setOtherHeaders

public void setOtherHeaders(java.lang.String otherHeaders)
                     throws IPWorksException

Other headers as determined by the user (optional).

The OtherHeaders property contains a string of headers to be appended to the HTTP request headers created from other properties like ContentType , From , etc.

The headers must of the format "header: value" as specified in the HTTP specifications. Header lines should be separated by CRLF ("\\r\\n") .

Use this property with caution. If OtherHeaders contains invalid headers, HTTP requests may fail.

The OtherHeaders property is useful for extending the functionality of the bean beyond what is provided.

IPWorksException

getParsedHeaders

public HeaderList getParsedHeaders()

Collection of headers returned from the last retrieval.

Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each HEADER in this collection contains information describing that header.

MaxHeaderscan be used to control the number of headers saved.

This collection is indexed from 0 to Count - 1.

getPassword

public java.lang.String getPassword()

A password if authentication is to be used.

If AuthScheme is set to HTTP Basic Authentication, The User and Password are Base64 encoded and the result is put in theAuthorizationconfig setting in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

The User and Password properties must be set only after the URL property is set. When the URL property is set, for security reasons, the User and Password properties are immediately cleared.

setPassword

public void setPassword(java.lang.String password)
                 throws IPWorksException

A password if authentication is to be used.

If AuthScheme is set to HTTP Basic Authentication, The User and Password are Base64 encoded and the result is put in theAuthorizationconfig setting in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

The User and Password properties must be set only after the URL property is set. When the URL property is set, for security reasons, the User and Password properties are immediately cleared.

IPWorksException

getProperties

public DAVPropertyList getProperties()

A collection of WebDAV properties.

The property names provided in Properties collection are used by the FindProperties and PatchProperties methods.

After a call to FindProperties , the Properties collection will contain the name, value and status of DAV property returned by the server. The content of the collection change for every matching resource ( ResourceProperties event). After the call completes, the collection will contain the values of the last matching resource.

When a call is made to PatchProperties , the bean will use the operations provided in the Properties collection to tell the server what to do with the properties under the following scheme:

opNone (0)

No operation will be performed on the property.

opSet (1)

The value of Name will be set to Value .

opDelete (2)

The property defined by Name will be removed from its resource.

This collection is indexed from 0 to Count - 1.

setProperties

public void setProperties(DAVPropertyList properties)
                   throws IPWorksException

A collection of WebDAV properties.

The property names provided in Properties collection are used by the FindProperties and PatchProperties methods.

After a call to FindProperties , the Properties collection will contain the name, value and status of DAV property returned by the server. The content of the collection change for every matching resource ( ResourceProperties event). After the call completes, the collection will contain the values of the last matching resource.

When a call is made to PatchProperties , the bean will use the operations provided in the Properties collection to tell the server what to do with the properties under the following scheme:

opNone (0)

No operation will be performed on the property.

opSet (1)

The value of Name will be set to Value .

opDelete (2)

The property defined by Name will be removed from its resource.

This collection is indexed from 0 to Count - 1.

IPWorksException

getProxy

public ipworks.Proxy getProxy()

A set of properties related to proxy access.

This is a PROXY type property which contains fields describing the proxy through which the bean will attempt to connect.

setProxy

public void setProxy(ipworks.Proxy proxy)
              throws IPWorksException

A set of properties related to proxy access.

This is a PROXY type property which contains fields describing the proxy through which the bean will attempt to connect.

IPWorksException

getReferer

public java.lang.String getReferer()

Referer URL/document (optional).

If the Referer property contains a non-empty string, a Referer HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL.

setReferer

public void setReferer(java.lang.String referer)
                throws IPWorksException

Referer URL/document (optional).

If the Referer property contains a non-empty string, a Referer HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL.

IPWorksException

getResources

public DAVResourceList getResources()

Collection of resources resulting from the last directory listing.

This property contains a list of resources listed by the server after a call to the ListDirectory method. To retrieve properties of a particular resource, please refer to the FindProperties method).

MaxResourcescan be used to control the number of resource listings saved.

This collection is indexed from 0 to Count - 1.

getStatusLine

public java.lang.String getStatusLine()

The first line of the last server response.

This value can be used for diagnostic purposes. If an HTTP error is returned when calling a method of the bean, the error string is the same as the StatusLine property.

The HTTP protocol specifies the structure of the StatusLine as: [HTTP version] [Result Code] [Description].

getTimeout

public int getTimeout()

A timeout for the bean.

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion, or an error condition is encountered.

If Timeout is set to a positive value, the bean will wait for the operation to complete before returning control.

The bean will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the bean throws an IPWorksException raises an IPWorksException exception .

Please note that by default, all timeouts are inactivity timeouts , i.e. the timeout period is extended by Timeout seconds when data is successfully sent or received.

Optionally, the behaviour of the bean may be changed to absolute timeouts , i.e. the bean will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.

This behavior is controlled by theAbsoluteTimeoutconfiguration setting.

The default value for the Timeout property is 60 (seconds).

setTimeout

public void setTimeout(int timeout)
                throws IPWorksException

A timeout for the bean.

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion, or an error condition is encountered.

If Timeout is set to a positive value, the bean will wait for the operation to complete before returning control.

The bean will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the bean throws an IPWorksException raises an IPWorksException exception .

Please note that by default, all timeouts are inactivity timeouts , i.e. the timeout period is extended by Timeout seconds when data is successfully sent or received.

Optionally, the behaviour of the bean may be changed to absolute timeouts , i.e. the bean will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.

This behavior is controlled by theAbsoluteTimeoutconfiguration setting.

The default value for the Timeout property is 60 (seconds).

IPWorksException

getTransferredData

public byte[] getTransferredData()

The contents of the last transfer.

If the LocalFile is empty, the data is accumulated in TransferredData . Otherwise, TransferredData returns an empty string.

TheMaxTransferredDataconfiguration setting controls the amount of data accumulated in TransferredData .

getTransferredDataLimit

public long getTransferredDataLimit()

The maximum of data to be transferred.

The default value is 65,536, allowing the bean to accumulate the first 64K of data into the TransferredData buffer.

If TransferredDataLimit is set to 0, no limits are imposed.

setTransferredDataLimit

public void setTransferredDataLimit(long transferredDataLimit)
                             throws IPWorksException

The maximum of data to be transferred.

The default value is 65,536, allowing the bean to accumulate the first 64K of data into the TransferredData buffer.

If TransferredDataLimit is set to 0, no limits are imposed.

IPWorksException

getTransferredHeaders

public java.lang.String getTransferredHeaders()

The full set of headers as received from the server.

This property returns the complete set of raw headers as received from the server.

The Header event shows the individual headers as parsed by the bean.

getUser

public java.lang.String getUser()

A user name if authentication is to be used.

If AuthScheme is set to HTTP Basic Authentication, The User and Password are Base64 encoded and the result is put in theAuthorizationproperty in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

The User and Password properties must be set only after the URL property is set. When the URL property is set, for security reasons, the User and Password properties are immediately cleared.

setUser

public void setUser(java.lang.String user)
             throws IPWorksException

A user name if authentication is to be used.

If AuthScheme is set to HTTP Basic Authentication, The User and Password are Base64 encoded and the result is put in theAuthorizationproperty in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

The User and Password properties must be set only after the URL property is set. When the URL property is set, for security reasons, the User and Password properties are immediately cleared.

IPWorksException

addCookie

public void addCookie(java.lang.String cookieName,
                      java.lang.String cookieValue)
               throws IPWorksException

Sets a cookie and the corresponding value.

Please refer to the Cookies property for more information on cookies and how they are managed.

IPWorksException

addNamespace

public void addNamespace(java.lang.String prefix,
                         java.lang.String namespaceURI)
                  throws IPWorksException

Adds a namespace to the Namespaces collection.

Prefix specifies the namespace prefix, and NamespaceURI specifies the namespace.

IPWorksException

config

public java.lang.String config(java.lang.String configurationString)
                        throws IPWorksException

Sets or retrieves a beanconfiguration setting.

Config is a generic method available in every bean. It is used to set and retrieveconfiguration settingsfor the bean.

Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the bean, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY , you must call Config("PROPERTY=VALUE") , where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY") . The value will be returned as a string.

IPWorksException

copyResource

public void copyResource(java.lang.String sourceResourceURI,
                         java.lang.String destinationResourceURI)
                  throws IPWorksException

Copy a resource to a new location.

The CopyResource method will copy the resource indicated by SourceResourceURI to a new location under the resource indicated by DestinationResourceURI .

This method is associated with the Depth property. If Depth is set to "0", the bean will copy only SourceResourceURI . If Depth is set to "infinity", the bean will copy SourceResourceURI and its entire subtree to locations relative to it.

If the user has acquired a LockResource of infinite depth on either DesintionResourceURI or any collection it is under, SourceResourceURI will be added to that lock.

IPWorksException

deleteResource

public void deleteResource(java.lang.String resourceURI)
                    throws IPWorksException

Delete a resource.

The resource or collection specified by ResourceURI is deleted. The DeleteResource method behaves independently of the Depth property. If ResourceURI denotes a non-collection resource, it is first removed from any collection which contains, then is removed from the server. If ResourceURI denotes a collection, the server behaves as if the command were issued with an infinite depth (ie, all internal member URIs denoting single resources or collections are deleted).

IPWorksException

doEvents

public void doEvents()
              throws IPWorksException

Processes events from the internal message queue.

When DoEvents is called, the bean processes any available events. If no events are available, it waits for a preset period of time, and then returns.

IPWorksException

findProperties

public void findProperties(java.lang.String resourceURI)
                    throws IPWorksException

Get resource property values from the server.

FindProperties will request the values for the names at each item provided in the Properties collection. The matching URIs and property values will be returned through one or more ResourceProperties events (one for each matching resource).

If the Properties collection is empty, then the server will be asked for all the properties of the resource. The properties will be returned via one or more ResourceProperties events.

Depth is used to determine which resources or properties are retrieved from the server. A depth of ResourceOnly will return only the resource associated with ResourceURI , or its properties. A depth of Infinity will return all resources contained within hierarchy, or their collective properties.

IPWorksException

findPropertyNames

public void findPropertyNames(java.lang.String resourceURI)
                       throws IPWorksException

Get resource property names from the server.

FindPropertyNames will request names of all the properties of ResourceURI . The matching URIs will be returned through one or more ResourceProperties events (one for each matching resource), and the property names will be provided through the Properties collection.

Depth is used to determine which resources or properties are retrieved from the server. A depth of ResourceOnly will return only the resource associated with ResourceURI , or its properties. A depth of Infinity will return all resources contained within hierarchy, or their collective properties.

IPWorksException

getProperty

public java.lang.String getProperty(java.lang.String propertyName)
                             throws IPWorksException

Get the value for a particular property.

The bean will search through its internal Properties collection for the property indentified by PropertyName and will return the value associated with it.

PropertyName may also be a partial XPath expression to the retrieved resource XML. This is useful for reading values of composite properties.

IPWorksException

getResource

public void getResource(java.lang.String resourceURI)
                 throws IPWorksException

Get a resource using the WebDAV GET method.

Fetch the resource using the WebDAV GET method. The resource contents are delivered through the Transfer event, and the HTTP response headers through the Header event.

IPWorksException

interrupt

public void interrupt()
               throws IPWorksException

Interrupt the current method.

If there is no method in progress, Interrupt simply returns doing nothing.

IPWorksException

listDirectory

public void listDirectory(java.lang.String resourceURI)
                   throws IPWorksException

List the files and subdirectories of the ResourceURI .

This method will return a list of resources from the specified URI. The results will be returned through one or more DirList events (one for each matching resource).

Depth is used to determine which resources or properties are retrieved from the server. A depth of ResourceOnly will return only the resource associated with ResourceURI , or its properties. A depth of Infinity will return all resources contained within hierarchy, or their collective properties.

IPWorksException

lockResource

public void lockResource(java.lang.String resourceURI)
                  throws IPWorksException

Obtain a lock for a specified resource.

The LockResource method will request a new lock to be placed on ResourceURI in the user's name so that only the user can operate on it. The method is linked to a number of properties that it uses to generate the lock request:

LockOwner

The principle that will own the lock.

LockScope

The scope of the lock. The bean only currently supports locks of scope "exclusive" and "shared".

LockTimeout

The amount of time that the lock is allowed to exist before ResourceURI is automatically unlocked by the server.

LockTokens

The lock itself. If the user sets this before making the request, the timeout on the existing lock will be refreshed (reset to 0). Otherwise, a new set of lock tokens will be returned.

LockType

The type of lock. The bean only currently supports of type "write".

After a successful call to the LockResource method the bean will receive the new lock values, which it will parse and store in the lock properties.

This method is associated with the Depth property. If Depth is set to "0", the bean will lock only ResourceURI and its properties. If Depth is set to "infinity", the bean will lock ResourceURI and its entire subtree.

If MoveResource or CopyResource are used to place a resource or collection in a location under a resource locked with "infinity", the new resource or collection will be added to the lock. Any lock on a collection will prevent non-lock owners from adding resources to that collection.

IPWorksException

makeDirectory

public void makeDirectory(java.lang.String resourceURI)
                   throws IPWorksException

Make a new directory.

A new resource collection is created at the location specified by ResourceURI .

IPWorksException

moveResource

public void moveResource(java.lang.String sourceResourceURI,
                         java.lang.String destinationResourceURI)
                  throws IPWorksException

Moves one resource to a new location.

The MoveResource method will move the resource indicated by SourceResourceURI to a new location under the resource indicated by DestinationResourceURI .

This method is associated with the Depth property. If Depth is set to "0", the bean will move only SourceResourceURI . If Depth is set to "infinity", the bean will move SourceResourceURI and its entire subtree to locations relative to it.

If the user has acquired a LockResource of infinite depth on either DesintionResourceURI or any collection it is under, SourceResourceURI will be added to that lock.

IPWorksException

patchProperties

public void patchProperties(java.lang.String resourceURI)
                     throws IPWorksException

Update the current set of properties on the server.

When the user calls PatchProperties , the bean will send a request to the server to update the existing property list. The method is linked to the Properties property: the bean will use the Operation field to tell the server what to do with the properties.

IPWorksException

postToResource

public void postToResource(java.lang.String resourceURI,
                           byte[] postData)
                    throws IPWorksException

Posts data to a resource using the WebDAV POST method.

Posts data to the resource ResourceURI using the WebDAV POST method. The posted data is taken from PostData . The server response text is received through the Transfer event, and the HTTP response headers through the Header event. If LocalFile is not empty the data (not the headers) is written there as well.

IPWorksException

putResource

public void putResource(java.lang.String resourceURI)
                 throws IPWorksException

Send data to the server using the PUT method.

The data is taken from LocalFile . The server will normally require authentication for this operation, so User and Password must have valid values before the request is made.

IPWorksException

reset

public void reset()
           throws IPWorksException

Reset the bean.

When called, the bean will reset all of its properties to their default values.

IPWorksException

setDownloadStream

public void setDownloadStream(java.io.OutputStream downloadStream)
                       throws IPWorksException

Sets the stream to which the downloaded data from the server will be written.

If a download stream is set before the GetResource method is called, the downloaded data will be written to the stream. The stream should be open and normally set to position 0.

The bean will automatically close this stream ifCloseStreamAfterTransferis true (default). If the stream is closed, you will need to call SetDownloadStream again before calling GetResource again.

The downloaded content will be written starting at the current position in the stream.

IPWorksException

setProperty

public void setProperty(java.lang.String propertyName,
                        java.lang.String propertyValue)
                 throws IPWorksException

Set the value of a property.

This method is used to set a single property to a certain value. The name and new value of the property must be supplied in the parameters for this method.

NOTE: This is the same as calling the PatchProperties on one property where the operation is opSet.

Example

 Control.SetProperty("MyProperty", "MyValue") 

is equivalent to:

 Control.Properties.Add(new DAVProperty())
 Control.Properties[0].Name = "MyProperty"
 Control.Properties[0].Value = "MyValue"
 Control.Properties[0].Operation = DAVPropertyOperations.opSet
 Control.PatchProperties() 

IPWorksException

setUploadStream

public void setUploadStream(java.io.InputStream uploadStream)
                     throws IPWorksException

Sets the stream to be uploaded to the server.

If an upload stream is set before data is to be uploaded to the server, the content of the stream will be read by the bean and uploaded to the server. The stream should be open and normally set to position 0.

The bean will automatically close this stream ifCloseStreamAfterTransferis true (default). If the stream is closed, you will need to call SetUploadStream again before calling the PutResource / PostToResource again.

The content of the stream will be read from the current position all the way to the end and no bytes will be skipped.

IPWorksException

unLockResource

public void unLockResource(java.lang.String resourceURI)
                    throws IPWorksException

Unlocks a resource.

Before calling UnLockResource on a particular resource, the LockTokens property must be set to the lock tokens for ResourceURI ';. The method will remove the lock, allowing other users or non-privileged users to access and operate on the file.

IPWorksException

addWebdavEventListener

public void addWebdavEventListener(ipworks.WebdavEventListener l)
                            throws java.util.TooManyListenersException

java.util.TooManyListenersException

removeWebdavEventListener

public void removeWebdavEventListener(ipworks.WebdavEventListener l)