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 how the properties are retrieved. A depth of "0" will return only the properties associated with ResourceURI . A depth of "1" will return those properties, plus those of the member URIs. A depth of "infinity" (default) will return all properties of all the resources in the hierarchy.

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.

Field Summary

static int	authBasic
static int	authDigest
static int	dpImmediateChildren
static int	dpInfinity
static int	dpResourceOnly
static int	dpUnspecified
static int	frAlways
static int	frNever
static int	frSameScheme
static int	fwNone
static int	fwSOCKS4
static int	fwSOCKS5
static int	fwTunnel
static int	opDelete
static int	opGet
static int	opSet

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 array.
void	addWebdavEventListener(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.
int	getCookieCount() Number of cookies in the current request.
java.lang.String	getCookieName(int cookieIndex) Array of cookie names.
java.lang.String	getCookieValue(int cookieIndex) Array of cookie values.
int	getDepth() The depth associated with the current operation.
java.lang.String	getFirewallHost() Name or IP address of firewall (optional).
java.lang.String	getFirewallPassword() A password if authentication is to be used when connecting through the firewall.
int	getFirewallPort() Port of the firewall to connect to.
int	getFirewallType() Determines the type of firewall to connect through.
java.lang.String	getFirewallUser() A user name if authentication is to be used connecting through a firewall.
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.
int	getNamespaceCount() The number of currently-defined namespaces channel.
java.lang.String	getNamespacePrefixes(int namespaceIndex) The namespace prefixes associated with Namespaces .
java.lang.String	getNamespaces(int namespaceIndex) The name or XML prefix associated with NamespacePrefixes .
java.lang.String	getOtherHeaders() Other headers as determined by the user (optional).
java.lang.String	getPassword() A password if authentication is to be used.
java.lang.String	getProperty(java.lang.String propertyName) Get the value for a particular property.
int	getPropertyCount() The number of properties in property arrays such as PropertyName and PropertyValue .
java.lang.String	getPropertyName(int propertyIndex) Array containing the names of WebDAV properties.
int	getPropertyOperation(int propertyIndex) Array containing the operation to be associated with each property during a call to PatchProperties .
java.lang.String	getPropertyStatus(int propertyIndex) Array containing the status of retrieved properties.
java.lang.String	getPropertyValue(int propertyIndex) Array containing values of WebDAV properties.
void	getResource(java.lang.String resourceURI) Get a resource using the WebDAV GET method.
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.
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	isIdle() The current status of the component.
void	listDirectory(java.lang.String resourceURI) List the properties for a resource collection.
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(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	setCookieCount(int cookieCount) Number of cookies in the current request.
void	setCookieName(int cookieIndex, java.lang.String cookieName) Array of cookie names.
void	setCookieValue(int cookieIndex, java.lang.String cookieValue) Array of cookie values.
void	setDepth(int depth) The depth associated with the current operation.
void	setFirewallHost(java.lang.String firewallHost) Name or IP address of firewall (optional).
void	setFirewallPassword(java.lang.String firewallPassword) A password if authentication is to be used when connecting through the firewall.
void	setFirewallPort(int firewallPort) Port of the firewall to connect to.
void	setFirewallType(int firewallType) Determines the type of firewall to connect through.
void	setFirewallUser(java.lang.String firewallUser) A user name if authentication is to be used connecting through a firewall.
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	setNamespaceCount(int namespaceCount) The number of currently-defined namespaces channel.
void	setNamespacePrefixes(int namespaceIndex, java.lang.String namespacePrefixes) The namespace prefixes associated with Namespaces .
void	setNamespaces(int namespaceIndex, java.lang.String namespaces) The name or XML prefix associated with NamespacePrefixes .
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	setProperty(java.lang.String propertyName, java.lang.String propertyValue) Set the value of a property.
void	setPropertyCount(int propertyCount) The number of properties in property arrays such as PropertyName and PropertyValue .
void	setPropertyName(int propertyIndex, java.lang.String propertyName) Array containing the names of WebDAV properties.
void	setPropertyOperation(int propertyIndex, int propertyOperation) Array containing the operation to be associated with each property during a call to PatchProperties .
void	setPropertyValue(int propertyIndex, java.lang.String propertyValue) Array containing values of WebDAV properties.
void	setTimeout(int timeout) A timeout for the bean.
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

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

fwNone

public static final int fwNone

See Also:

Constant Field Values

fwTunnel

public static final int fwTunnel

See Also:

Constant Field Values

fwSOCKS4

public static final int fwSOCKS4

See Also:

Constant Field Values

fwSOCKS5

public static final int fwSOCKS5

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

opGet

public static final int opGet

See Also:

Constant Field Values

opSet

public static final int opSet

See Also:

Constant Field Values

opDelete

public static final int opDelete

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.

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.

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.

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.

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

IPWorksException

getCookieCount

public int getCookieCount()

Number of cookies in the current request.

The cookie arrays CookieName and CookieValue store the cookies that are to be sent to the server.

The SetCookie event displays the cookies set by the server and their properties.

setCookieCount

public void setCookieCount(int cookieCount)
                    throws IPWorksException

Number of cookies in the current request.

The cookie arrays CookieName and CookieValue store the cookies that are to be sent to the server.

The SetCookie event displays the cookies set by the server and their properties.

IPWorksException

getCookieName

public java.lang.String getCookieName(int cookieIndex)
                               throws IPWorksException

Array of cookie names.

The size of the array is determined by the CookieCount property. Element indexes start at 1.

All cookies specified in the array are sent to URLServer when the URL is submitted.

The cookie arrays CookieName and CookieValue store the cookies that are to be sent to the server. The SetCookie event displays the cookies set by the server and their properties.

IPWorksException

setCookieName

public void setCookieName(int cookieIndex,
                          java.lang.String cookieName)
                   throws IPWorksException

Array of cookie names.

The size of the array is determined by the CookieCount property. Element indexes start at 1.

All cookies specified in the array are sent to URLServer when the URL is submitted.

The cookie arrays CookieName and CookieValue store the cookies that are to be sent to the server. The SetCookie event displays the cookies set by the server and their properties.

IPWorksException

getCookieValue

public java.lang.String getCookieValue(int cookieIndex)
                                throws IPWorksException

Array of cookie values.

The size of the array is determined by the CookieCount property. Element indexes start at 1.

All cookies specified in the array are sent to URLServer when the URL is submitted.

The cookie arrays CookieName and CookieValue store the cookies that are to be sent to the server. The SetCookie event displays the cookies set by the server and their properties.

IPWorksException

setCookieValue

public void setCookieValue(int cookieIndex,
                           java.lang.String cookieValue)
                    throws IPWorksException

Array of cookie values.

The size of the array is determined by the CookieCount property. Element indexes start at 1.

All cookies specified in the array are sent to URLServer when the URL is submitted.

The cookie arrays CookieName and CookieValue store the cookies that are to be sent to the server. The SetCookie event displays the cookies set by the server and their properties.

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

getFirewallHost

public java.lang.String getFirewallHost()

Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost property is set to the corresponding address. If the search is not successful, an error is returned.

setFirewallHost

public void setFirewallHost(java.lang.String firewallHost)
                     throws IPWorksException

Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost property is set to the corresponding address. If the search is not successful, an error is returned.

IPWorksException

getFirewallPassword

public java.lang.String getFirewallPassword()

A password if authentication is to be used when connecting through the firewall.

if FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.

setFirewallPassword

public void setFirewallPassword(java.lang.String firewallPassword)
                         throws IPWorksException

A password if authentication is to be used when connecting through the firewall.

if FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.

IPWorksException

getFirewallPort

public int getFirewallPort()

Port of the firewall to connect to.

The TCP port for the FirewallHost . See the description of the FirewallHost property for details.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

setFirewallPort

public void setFirewallPort(int firewallPort)
                     throws IPWorksException

Port of the firewall to connect to.

The TCP port for the FirewallHost . See the description of the FirewallHost property for details.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

IPWorksException

getFirewallType

public int getFirewallType()

Determines the type of firewall to connect through.

The applicable values are the following:

fwNone (0)

No firewall (default setting).

fwTunnel (1)

Connect through a tunneling proxy. FirewallPort is set to 80.

fwSOCKS4 (2)

Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.

fwSOCKS5 (3)

Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.

setFirewallType

public void setFirewallType(int firewallType)
                     throws IPWorksException

Determines the type of firewall to connect through.

The applicable values are the following:

fwNone (0)

No firewall (default setting).

fwTunnel (1)

Connect through a tunneling proxy. FirewallPort is set to 80.

fwSOCKS4 (2)

Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.

fwSOCKS5 (3)

Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.

IPWorksException

getFirewallUser

public java.lang.String getFirewallUser()

A user name if authentication is to be used connecting through a firewall.

if FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.

setFirewallUser

public void setFirewallUser(java.lang.String firewallUser)
                     throws IPWorksException

A user name if authentication is to be used connecting through a firewall.

if FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.

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 server'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 server's response.

IPWorksException

getNamespaceCount

public int getNamespaceCount()

The number of currently-defined namespaces channel.

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

The following properties will be filled automatically when retrieving DAV responses but must be filled manually when requesting non-standard properties:

NamespaceCount

This is the total number of top-level XML namespaces defined in the current DAV request or response.

NamespacePrefixes

The list of XML prefixes associated with each namespace. Namespaces are defined in Namespaces .

Namespaces

Namespace URIs associated with the prefixes in NamespacePrefixes . This is usually a URL pointing to the XML schema for the namespace.

setNamespaceCount

public void setNamespaceCount(int namespaceCount)
                       throws IPWorksException

The number of currently-defined namespaces channel.

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

The following properties will be filled automatically when retrieving DAV responses but must be filled manually when requesting non-standard properties:

NamespaceCount

This is the total number of top-level XML namespaces defined in the current DAV request or response.

NamespacePrefixes

The list of XML prefixes associated with each namespace. Namespaces are defined in Namespaces .

Namespaces

Namespace URIs associated with the prefixes in NamespacePrefixes . This is usually a URL pointing to the XML schema for the namespace.

IPWorksException

getNamespacePrefixes

public java.lang.String getNamespacePrefixes(int namespaceIndex)
                                      throws IPWorksException

The namespace prefixes associated with Namespaces .

The list of XML prefixes associated with each namespace. Namespaces are defined in Namespaces . When getting and setting non-standard properties using the GetProperty and SetProperty methods, the property name must be prefixed with an existing value in NamespacePrefixes .

IPWorksException

setNamespacePrefixes

public void setNamespacePrefixes(int namespaceIndex,
                                 java.lang.String namespacePrefixes)
                          throws IPWorksException

The namespace prefixes associated with Namespaces .

The list of XML prefixes associated with each namespace. Namespaces are defined in Namespaces . When getting and setting non-standard properties using the GetProperty and SetProperty methods, the property name must be prefixed with an existing value in NamespacePrefixes .

IPWorksException

getNamespaces

public java.lang.String getNamespaces(int namespaceIndex)
                               throws IPWorksException

The name or XML prefix associated with NamespacePrefixes .

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

The following properties will be filled automatically when retrieving DAV responses but must be filled manually when requesting non-standard properties:

NamespaceCount

This is the total number of top-level XML namespaces defined in the current DAV request or response.

NamespacePrefixes

The list of XML prefixes associated with each namespace. Namespaces are defined in Namespaces .

Namespaces

Namespace URIs associated with the prefixes in NamespacePrefixes . This is usually a URL pointing to the XML schema for the namespace.

IPWorksException

setNamespaces

public void setNamespaces(int namespaceIndex,
                          java.lang.String namespaces)
                   throws IPWorksException

The name or XML prefix associated with NamespacePrefixes .

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

The following properties will be filled automatically when retrieving DAV responses but must be filled manually when requesting non-standard properties:

NamespaceCount

This is the total number of top-level XML namespaces defined in the current DAV request or response.

NamespacePrefixes

The list of XML prefixes associated with each namespace. Namespaces are defined in Namespaces .

Namespaces

Namespace URIs associated with the prefixes in NamespacePrefixes . This is usually a URL pointing to the XML schema for the namespace.

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

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 the Authorization property 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 the Authorization property 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

getPropertyCount

public int getPropertyCount()

The number of properties in property arrays such as PropertyName and PropertyValue .

The property arrays are used when a call is made to the FindProperties or PatchProperties methods.

After a call to FindProperties , PropertyName , PropertyValue , and PropertyStatus will reflect the properties returned by the server. The contents of the arrays change for every matching resource ( ResourceProperties event). After the call completes, the arrays will contain the values of the last matching resource.

setPropertyCount

public void setPropertyCount(int propertyCount)
                      throws IPWorksException

The number of properties in property arrays such as PropertyName and PropertyValue .

The property arrays are used when a call is made to the FindProperties or PatchProperties methods.

After a call to FindProperties , PropertyName , PropertyValue , and PropertyStatus will reflect the properties returned by the server. The contents of the arrays change for every matching resource ( ResourceProperties event). After the call completes, the arrays will contain the values of the last matching resource.

IPWorksException

getPropertyName

public java.lang.String getPropertyName(int propertyIndex)
                                 throws IPWorksException

Array containing the names of WebDAV properties.

PropertyName is an indexed property that contains names of properties sent or received from the server. The property is indexed from 1 to PropertyCount . The property names are used by the FindProperties and PatchProperties methods.

After a call to FindProperties , PropertyName , PropertyValue , and PropertyStatus will reflect the properties returned by the server. The contents of the arrays change for every matching resource ( ResourceProperties event). After the call completes, the arrays will contain the values of the last matching resource.

IPWorksException

setPropertyName

public void setPropertyName(int propertyIndex,
                            java.lang.String propertyName)
                     throws IPWorksException

Array containing the names of WebDAV properties.

PropertyName is an indexed property that contains names of properties sent or received from the server. The property is indexed from 1 to PropertyCount . The property names are used by the FindProperties and PatchProperties methods.

After a call to FindProperties , PropertyName , PropertyValue , and PropertyStatus will reflect the properties returned by the server. The contents of the arrays change for every matching resource ( ResourceProperties event). After the call completes, the arrays will contain the values of the last matching resource.

IPWorksException

getPropertyOperation

public int getPropertyOperation(int propertyIndex)
                         throws IPWorksException

Array containing the operation to be associated with each property during a call to PatchProperties .

PropertyOperation are used when the bean sends a property patch request to the server. When a call is made to PatchProperties , the bean will use the operations to tell the server what to do with the properties under the following scheme:

opGet (0)

The value of PropertyName at PropertyIndex will be retrieved from the server and can be read from PropertyValue

opSet (1)

The value of PropertyName at PropertyIndex will be set to PropertyValue at PropertyIndex .

opDelete (2)

The property defined by PropertyName at PropertyIndex will be removed from its resource.

IPWorksException

setPropertyOperation

public void setPropertyOperation(int propertyIndex,
                                 int propertyOperation)
                          throws IPWorksException

Array containing the operation to be associated with each property during a call to PatchProperties .

PropertyOperation are used when the bean sends a property patch request to the server. When a call is made to PatchProperties , the bean will use the operations to tell the server what to do with the properties under the following scheme:

opGet (0)

The value of PropertyName at PropertyIndex will be retrieved from the server and can be read from PropertyValue

opSet (1)

The value of PropertyName at PropertyIndex will be set to PropertyValue at PropertyIndex .

opDelete (2)

The property defined by PropertyName at PropertyIndex will be removed from its resource.

IPWorksException

getPropertyStatus

public java.lang.String getPropertyStatus(int propertyIndex)
                                   throws IPWorksException

Array containing the status of retrieved properties.

PropertyValue is an indexed property that contains the status of retrieved resource properties. The property is indexed from 1 to PropertyCount .

If the property is successfully retrieved, PropertyStatus contains the string "OK". Otherwise, it contains the HTTP status and description provided by the server.

After a call to FindProperties , PropertyName , PropertyValue , and PropertyStatus will reflect the properties returned by the server. The contents of the arrays change for every matching resource ( ResourceProperties event). After the call completes, the arrays will contain the values of the last matching resource.

IPWorksException

getPropertyValue

public java.lang.String getPropertyValue(int propertyIndex)
                                  throws IPWorksException

Array containing values of WebDAV properties.

PropertyValue is an indexed property that contains values of properties sent or received from the server. The property is indexed from 1 to PropertyCount .

The values are used by the PatchProperties methods to set or modify properties.

After a call to FindProperties , PropertyName , PropertyValue , and PropertyStatus will reflect the properties returned by the server. The contents of the arrays change for every matching resource ( ResourceProperties event). After the call completes, the arrays will contain the values of the last matching resource.

IPWorksException

setPropertyValue

public void setPropertyValue(int propertyIndex,
                             java.lang.String propertyValue)
                      throws IPWorksException

Array containing values of WebDAV properties.

PropertyValue is an indexed property that contains values of properties sent or received from the server. The property is indexed from 1 to PropertyCount .

The values are used by the PatchProperties methods to set or modify properties.

After a call to FindProperties , PropertyName , PropertyValue , and PropertyStatus will reflect the properties returned by the server. The contents of the arrays change for every matching resource ( ResourceProperties event). After the call completes, the arrays will contain the values of the last matching resource.

IPWorksException

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 behavior 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 behavior 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 .

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 the Authorization property 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 the Authorization property 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

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

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 CookieName and CookieValue properties 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 array.

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

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 index in PropertyName . The matching URIs and property values will be returned through one or more ResourceProperties events (one for each matching resource).

If PropertyCount is 0, 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 how the properties are retrieved. A depth of "0" will return only the properties associated with ResourceURI . A depth of "1" will return those properties, plus those of the member URIs. A depth of "infinity" (default) will return all properties of all the resources in the hierarchy.

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 PropertyName property.

Depth is used to determine how the properties are retrieved. A depth of "0" will return only the properties associated with ResourceURI . A depth of "1" will return those properties, plus those of the member URIs. A depth of "infinity" (default) will return all properties of all the resources in the hierarchy.

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 property array for the property identified by PropertyName and will return the value associated with it. The GetProperty method is equivalent to searching through PropertyName to get the property index, then looking up the value at the index in PropertyValue .

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 properties for a resource collection.

The ListDirectory method will list a subset of known properties that apply to files and folders (to retrieve other properties, or all properties, please refer to the FindProperties method).

The results will be returned through on or more DirList events (one for each matching resource).

Depth is used to determine how the properties are retrieved. A depth of "0" will return only the properties associated with ResourceURI . A depth of "1" will return those properties, plus those of the member URIs. A depth of "infinity" (default) will return all properties of all the resources in the hierarchy.

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 PropertyOperation property: the bean will use the operations to tell the server what to do with the properties under the following scheme:

opGet (0)

The value of PropertyName at PropertyIndex will be retrieved from the server and can be read from PropertyValue

opSet (1)

The value of PropertyName at PropertyIndex will be set to PropertyValue at PropertyIndex .

opDelete (2)

The property defined by PropertyName at PropertyIndex will be removed from its resource.

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

setProperty

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

Set the value of a property.

The bean supports two ways to set the value of a particular property. The first is to iterate through each index of PropertyName to find the index, and then set the value in PropertyValue . If the name is not found, then increment PropertyCount by one, and set the last index of PropertyName to the name, and PropertyValue to the value.

The second way is to use the SetProperty method. This is a shortcut, with the exact same outcome as the method listed above.

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(WebdavEventListener l)
                            throws java.util.TooManyListenersException

java.util.TooManyListenersException

removeWebdavEventListener

public void removeWebdavEventListener(WebdavEventListener l)