|
IP*Works! V9 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectipworks.Webdav
public class Webdav
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 collection , 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.
Note: Some servers (such as IIS 7.5) may not support a depth of Infinity by default and may return a HTTP 403 Forbidden response.
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
, which 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 |
authNegotiate
|
static int |
authNone
|
static int |
authNtlm
|
static int |
authOAuth
|
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()
Creates an instance of Webdav Bean. |
|
Webdav(java.lang.String runtimeLicense)
Creates an instance of Webdav Bean with specified run-time license. |
Method Summary | |
---|---|
void |
addCookie(java.lang.String cookieName,
java.lang.String cookieValue)
Adds a cookie and the corresponding value to the outgoing request headers. |
void |
addNamespace(java.lang.String prefix,
java.lang.String namespaceURI)
Adds a namespace to the Namespaces collection
. |
void |
addWebdavEventListener(WebdavEventListener l)
|
java.lang.String |
config(java.lang.String configurationString)
Sets or retrieves a configuration 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. |
java.lang.String |
getAuthorization()
The Authorization string to be sent to the server. |
int |
getAuthScheme()
The authentication scheme to use when server authorization is required. |
HTTPCookieList |
getCookies()
Collection of cookies. |
int |
getDepth()
The depth associated with the current operation. |
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 |
getLocalHost()
The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
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 request. |
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. |
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 response from the server. |
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(WebdavEventListener l)
|
void |
reset()
Reset the bean. |
void |
setAccept(java.lang.String accept)
A list of acceptable MIME types for the request. |
void |
setAuthorization(java.lang.String authorization)
The Authorization string to be sent to the server. |
void |
setAuthScheme(int authScheme)
The authentication scheme to use when server authorization is required. |
void |
setConnected(boolean connected)
Shows whether the bean is connected. |
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(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 |
setLocalHost(java.lang.String localHost)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
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 |
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 |
setProxy(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 |
---|
public static final int authBasic
public static final int authDigest
public static final int authProprietary
public static final int authNone
public static final int authNtlm
public static final int authNegotiate
public static final int authOAuth
public static final int dpUnspecified
public static final int dpResourceOnly
public static final int dpImmediateChildren
public static final int dpInfinity
public static final int frNever
public static final int frAlways
public static final int frSameScheme
Constructor Detail |
---|
public Webdav()
public Webdav(java.lang.String runtimeLicense)
Method Detail |
---|
public java.lang.String getAccept()
If this property contains a non-empty string, an HTTP Accept header is added to the request.
The Accept header is used for content negotiation. It provides the server with a comma-separated list of MIME types that are acceptable for its response.
public void setAccept(java.lang.String accept) throws IPWorksException
If this property contains a non-empty string, an HTTP Accept header is added to the request.
The Accept header is used for content negotiation. It provides the server with a comma-separated list of MIME types that are acceptable for its response.
IPWorksException
public java.lang.String getAuthorization()
If the Authorization
property contains a non-empty string,
an Authorization HTTP request header is added to the
request. This header conveys Authorization information to the
server.
A common use for this property is to specify OAuth authorization string.
This property is provided so that the HTTP bean can be extended with other security schemes in addition to the authorization schemes already implemented by the bean.
The AuthScheme
property defines the authentication scheme used.
In the case of HTTP Basic Authentication (default), every time User
and Password
are set, they are Base64 encoded,
and the result is put in the Authorization property
in the form "Basic [encoded-user-password]".
public void setAuthorization(java.lang.String authorization) throws IPWorksException
If the Authorization
property contains a non-empty string,
an Authorization HTTP request header is added to the
request. This header conveys Authorization information to the
server.
A common use for this property is to specify OAuth authorization string.
This property is provided so that the HTTP bean can be extended with other security schemes in addition to the authorization schemes already implemented by the bean.
The AuthScheme
property defines the authentication scheme used.
In the case of HTTP Basic Authentication (default), every time User
and Password
are set, they are Base64 encoded,
and the result is put in the Authorization property
in the form "Basic [encoded-user-password]".
IPWorksException
public int getAuthScheme()
This property will tell the bean which type of authorization to perform when the User
and Password
properties are set.
This property should be set to authNone (3) when no authentication is to be performed.
By default, this property 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), authNtlm (4) or authNegotiate (5), digest, NTLM or Negotiate authentication will be attempted instead.
If AuthScheme is set to authProprietary (2) then the authorization token must be supplied through Authorization
property.
If AuthScheme is set to authOAuth (6) then the authorization string must be supplied through Authorization
property.
Note that, if you set the Authorization
property and AuthScheme is not authProprietary or authOAuth, the AuthScheme will be set automatically to authProprietary (2) by the control.
For security purposes, changing the value of this property will cause the bean to clear the values of User
, Password
and Authorization
.
public void setAuthScheme(int authScheme) throws IPWorksException
This property will tell the bean which type of authorization to perform when the User
and Password
properties are set.
This property should be set to authNone (3) when no authentication is to be performed.
By default, this property 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), authNtlm (4) or authNegotiate (5), digest, NTLM or Negotiate authentication will be attempted instead.
If AuthScheme is set to authProprietary (2) then the authorization token must be supplied through Authorization
property.
If AuthScheme is set to authOAuth (6) then the authorization string must be supplied through Authorization
property.
Note that, if you set the Authorization
property and AuthScheme is not authProprietary or authOAuth, the AuthScheme will be set automatically to authProprietary (2) by the control.
For security purposes, changing the value of this property will cause the bean to clear the values of User
, Password
and Authorization
.
IPWorksException
public boolean isConnected()
This property is used to determine whether or not the bean is connected to the remote host.
public void setConnected(boolean connected) throws IPWorksException
This property is used to determine whether or not the bean is connected to the remote host.
IPWorksException
public HTTPCookieList getCookies()
This property contains a collection of cookies. To add cookies to outgoing HTTP requests, add cookies (of type httpcookie
) to this collection.
To see cookies that are set by the server, use the SetCookie
event, which displays the cookies and their properties as set by the server.
Those cookies are also added to Cookies
.
MaxHTTPCookies
can be used to control the maximum number of cookies saved.
This collection is indexed from 0 to size - 1.
public int getDepth()
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:
Depth
is used when performing the following operations: LockResource
, MoveResource
CopyResource
, FindProperties
, PatchProperties
, and ListDirectory
.
public void setDepth(int depth) throws IPWorksException
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:
Depth
is used when performing the following operations: LockResource
, MoveResource
CopyResource
, FindProperties
, PatchProperties
, and ListDirectory
.
IPWorksException
public Firewall getFirewall()
This is a Firewall
type property which
contains fields describing the firewall
through which the bean will attempt to connect.
public void setFirewall(Firewall firewall) throws IPWorksException
This is a Firewall
type property which
contains fields describing the firewall
through which the bean will attempt to connect.
IPWorksException
public int getFollowRedirects()
This property 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 this property is set to frAlways (1), the new URL
for the object is retrieved automatically every time.
If this property is set to frSameScheme (2), the new URL
is
retrieved automatically only if the URLScheme
is the same, otherwise
the bean throws an exception.
Note that following the HTTP specification, unless this property 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 this property 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 the bean throws an exception instead.
public void setFollowRedirects(int followRedirects) throws IPWorksException
This property 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 this property is set to frAlways (1), the new URL
for the object is retrieved automatically every time.
If this property is set to frSameScheme (2), the new URL
is
retrieved automatically only if the URLScheme
is the same, otherwise
the bean throws an exception.
Note that following the HTTP specification, unless this property 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 this property 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 the bean throws an exception instead.
IPWorksException
public boolean isIdle()
Idle
will be False if the component is currently busy (communicating
and/or waiting for an answer), and True at all other times.
public java.lang.String getLocalFile()
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.
public void setLocalFile(java.lang.String localFile) throws IPWorksException
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
public java.lang.String getLocalHost()
The LocalHost
property contains the name of the local host
as obtained by the gethostname() system call, or if the
user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.
If the bean is connected, the LocalHost
property shows
the IP address of the interface through which the connection
is made in internet dotted format (aaa.bbb.ccc.ddd). In most
cases, this is the address of the local host, except for multi-homed
hosts (machines with more than one IP interface).
NOTE: LocalHost
is not persistent. You must always set it in
code, and never in the property window.
public void setLocalHost(java.lang.String localHost) throws IPWorksException
The LocalHost
property contains the name of the local host
as obtained by the gethostname() system call, or if the
user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.
If the bean is connected, the LocalHost
property shows
the IP address of the interface through which the connection
is made in internet dotted format (aaa.bbb.ccc.ddd). In most
cases, this is the address of the local host, except for multi-homed
hosts (machines with more than one IP interface).
NOTE: LocalHost
is not persistent. You must always set it in
code, and never in the property window.
IPWorksException
public java.lang.String getLockOwner()
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.
public void setLockOwner(java.lang.String lockOwner) throws IPWorksException
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
public java.lang.String getLockScope()
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:
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.
public void setLockScope(java.lang.String lockScope) throws IPWorksException
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:
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
public int getLockTimeout()
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.
public void setLockTimeout(int lockTimeout) throws IPWorksException
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
public java.lang.String getLockTokens()
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.
public void setLockTokens(java.lang.String lockTokens) throws IPWorksException
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
public java.lang.String getLockType()
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.
public void setLockType(java.lang.String lockType) throws IPWorksException
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
public XMLNamespaceList getNamespaces()
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 size - 1.
public java.lang.String getOtherHeaders()
This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType
, From
, etc.
The headers must be of the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\\r\\n") .
Use this property with caution. If this property contains invalid headers, HTTP requests may fail.
This property is useful for extending the functionality of the bean beyond what is provided.
public void setOtherHeaders(java.lang.String otherHeaders) throws IPWorksException
This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType
, From
, etc.
The headers must be of the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\\r\\n") .
Use this property with caution. If this property contains invalid headers, HTTP requests may fail.
This property is useful for extending the functionality of the bean beyond what is provided.
IPWorksException
public HeaderList getParsedHeaders()
This property contains a collection of headers returned from the last request. 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.
MaxHeaders
can be used to control the maximum number of headers saved.
This collection is indexed from 0 to size - 1.
public java.lang.String getPassword()
This property contains 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
config 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.
If AuthScheme
is set to NTLM, NTLM authentication will be attempted. If AuthScheme
is set to NTLM and User
and Password
are empty, the bean will attempt to authenticate using the current user's credentials.
public void setPassword(java.lang.String password) throws IPWorksException
This property contains 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
config 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.
If AuthScheme
is set to NTLM, NTLM authentication will be attempted. If AuthScheme
is set to NTLM and User
and Password
are empty, the bean will attempt to authenticate using the current user's credentials.
IPWorksException
public DAVPropertyList getProperties()
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 contents of the collection
changes 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:
Name
will be set to Value
.
Name
will be removed from its resource.
This collection is indexed from 0 to size - 1.
public Proxy getProxy()
This property contains fields describing the proxy through which the bean will attempt to connect.
public void setProxy(Proxy proxy) throws IPWorksException
This property contains fields describing the proxy through which the bean will attempt to connect.
IPWorksException
public java.lang.String getReferer()
If this 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.
public void setReferer(java.lang.String referer) throws IPWorksException
If this 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
public DAVResourceList getResources()
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).
MaxResources
can be used to control the number of resource listings saved.
This collection is indexed from 0 to size - 1.
public java.lang.String getStatusLine()
This property contains 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].
public int getTimeout()
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 exception.
Please note that by default, all timeouts are inactivity timeouts ,
i.e. the timeout period is extended by Timeout
seconds when
any amount of 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 the AbsoluteTimeout
configuration setting.
The default value for the Timeout
property is 60 (seconds).
public void setTimeout(int timeout) throws IPWorksException
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 exception.
Please note that by default, all timeouts are inactivity timeouts ,
i.e. the timeout period is extended by Timeout
seconds when
any amount of 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 the AbsoluteTimeout
configuration setting.
The default value for the Timeout
property is 60 (seconds).
IPWorksException
public byte[] getTransferredData()
This property contains the contents of the last response from the server. If the LocalFile
is empty, the data is accumulated in TransferredData , and can also be received in the Transfer
event. Otherwise, this property returns an empty string.
TransferredDataLimit
controls the maximum amount of data accumulated in TransferredData
(by default there is no limit).
public long getTransferredDataLimit()
This property contains the maximum of data to be transferred. The default value is 0, which will not impose any limits on the amount of data accumulated in the TransferredData
property.
public void setTransferredDataLimit(long transferredDataLimit) throws IPWorksException
This property contains the maximum of data to be transferred. The default value is 0, which will not impose any limits on the amount of data accumulated in the TransferredData
property.
IPWorksException
public java.lang.String getTransferredHeaders()
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.
public java.lang.String getUser()
This property contains 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.
If AuthScheme
is set to NTLM, NTLM authentication will be attempted. If AuthScheme
is set to NTLM and User
and Password
are empty, the bean will attempt to authenticate using the current user's credentials.
public void setUser(java.lang.String user) throws IPWorksException
This property contains 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.
If AuthScheme
is set to NTLM, NTLM authentication will be attempted. If AuthScheme
is set to NTLM and User
and Password
are empty, the bean will attempt to authenticate using the current user's credentials.
IPWorksException
public void addCookie(java.lang.String cookieName, java.lang.String cookieValue) throws IPWorksException
This property adds a cookie and the corresponding value to the outgoing request headers.
Please refer to the Cookies
property for more information on cookies and how they are managed.
IPWorksException
public void addNamespace(java.lang.String prefix, java.lang.String namespaceURI) throws IPWorksException
Namespaces
collection
.
Prefix specifies the namespace prefix, and NamespaceURI specifies the namespace.
IPWorksException
public java.lang.String config(java.lang.String configurationString) throws IPWorksException
Config
is a generic method available in every bean.
It is used to set and retrieve configuration settings
for 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.
The bean accepts one or more of the following configuration settings .
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.
Resources
collection
will be populated
after a call to ListDirectory
. This value
represents the number of resources that are to be saved in the collection
.To save all items to the collection
, set this config to -1. If no
items are wanted, set this to 0, which will not save any to the
collection
. The default for this config is -1, so all items will
be included in the collection
.
NOTE: This functionality is only available in Java and .NET.
AllowHTTPCompression
is true, the bean adds an "Accept-Encoding: " header to the request
being sent to the server. By default, this header's value is "gzip, deflate". This config allows you
to change the value of the "Accept-Encoding" header.
NOTE: The bean only supports gzip and deflate decompression algorithms.AllowHTTPCompression
property. This setting is exposed here
for use by beans that inherit from HTTP.Authorization
property contains a non-empty string,
an Authorization HTTP request header is added to the
request. This header conveys Authorization information to the
server.This property is provided so that the HTTP bean can be
extended with other security schemes in addition to the
authorization schemes already implemented by the bean.
The AuthScheme
property defines the authentication scheme used.
In the case of HTTP Basic Authentication (default), every time User
and Password
are set, they are Base64 encoded,
and the result is put in the Authorization property
in the form "Basic [encoded-user-password]".
Transfer
event, by BytesTransferred .IfModifiedSince
property. This setting is exposed here for use by beans that inherit from HTTP.OtherHeaders
to 'Connection: Keep-Alive'.
If false, the connection will be closed immediately after the server response is received.The default value for KeepAlive
is false.
TransferredHeaders
collection is to be populated
when a Header
event has been fired. This value
represents the number of headers that are to be saved in the collection.To save all items to the collection
, set this config to -1. If no
items are wanted, set this to 0, which will not save any to the
collection
. The default for this config is -1, so all items will
be included in the collection
.
NOTE: This functionality is only available in Java and .NET.
Cookies
collection
as a result of an HTTP request. This value represents the number of
cookies that are to be saved in the collection
.To save all items to the collection
, set this config to -1. If no
items are wanted, set this to 0, which will not save any to the
collection
. The default for this config is -1, so all items will
be included in the collection
.
NOTE: This functionality is only available in Java and .NET.
FollowRedirects
is set to any value besides frNever the bean will follow redirects until
this maximum number of redirect attempts are made. The default value is 20.
\011Authorization
config, but for proxy authorization. If this
config contains a non-empty string, a Proxy-Authorization HTTP request header is added
to the request. This header conveys proxy authorization information to the server. If User and Password are specified, this value is calculated using the algorithm specified
by AuthScheme .TransferredData
buffer.If TransferredDataLimit
is set to 0, no limits are imposed.
UseChunkedEncoding
is true. This setting specifies the
chunk size in bytes to be used when posting data. The default value is 16384.
FirewallHost
is given, requested connections will be authenticated through the specified firewall
when connecting.If the FirewallHost
setting is set to a Domain Name, a DNS request is initiated. Upon successful termination
of the request, the FirewallHost
setting is set to the corresponding address. If the search is not successful,
an error is returned.
NOTE: This is the same as Host . This setting is provided for use by beans that do not directly expose Firewall properties.
RemoteHost
and RemotePort
are used to tell the SOCKS firewall
in which address and port to listen to. The firewall rules may ignore RemoteHost
, and it is recommended that RemoteHost
be set to empty string in this case.
RemotePort
is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The
binding (address and port) is provided through the ConnectionStatus
event.
The connection to the firewall is made by calling the Connect
method.
FirewallHost
is specified, the FirewallUser
and FirewallPassword
settings
are used to connect and authenticate to the given firewall. If the authentication fails, the bean throws an exception.NOTE: This is the same as Password . This setting is provided for use by beans that do not directly expose Firewall properties.
FirewallPort
is set automatically when FirewallType
is set to a valid value.NOTE: This is the same as Port . This setting is provided for use by beans that do not directly expose Firewall properties.
FirewallPort
is set to 80.
FirewallPort
is set to 1080.
FirewallPort
is set to 1080.
FirewallHost
is specified, the FirewallUser
and FirewallPassword
settings are used to connect and authenticate to the Firewall. If the authentication fails, the bean throws an exception.NOTE: This is the same as User . This setting is provided for use by beans that do not directly expose Firewall properties.
TCPKeepAlive
will automatically be set to true.
By default the operating system will determine the
time a connection is idle before a TCP keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many
cases a shorter interval is more useful. Set this value to the desired interval in milliseconds.Note: This value is not applicable in Java.
TCPKeepAlive
will automatically be set to true.
A TCP keep-alive packet will be sent after a period of inactivity as
defined by KeepAliveTime
. If no acknowledgement is received from the remote host the keep-alive packet
will be re-sent. This setting specifies the interval at which the successive keep-alive packets are sent in milliseconds.
This system default if this value is not specified here is 1 second.Note: This value is not applicable in Java or MAC.
LingerTime
is 0 (default), the
system will attempt to send pending data for a connection until the default
IP protocol timeout expires.
In the second scenario, LingerTime
is a positive value, the system will
attempt to send pending data until the specified LingerTime
is reached.
If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the bean returns control immediately, the system could hold system resources until all pending data is sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action.
LocalHost
setting contains the name of the local host
as obtained by the gethostname() system call, or if the
user has assigned an IP address, the value of that address.In multi-homed hosts (machines with more than one IP interface)
setting LocalHost to the value of an interface will make the
bean initiate connections (or accept in the case of server
beans) only through that interface.
If the bean is connected, the LocalHost
setting shows
the IP address of the interface through which the connection
is made in internet dotted format (aaa.bbb.ccc.ddd). In most
cases, this is the address of the local host, except for multi-homed
hosts (machines with more than one IP interface).
LocalPort
after the connection is established.
LocalPort
cannot be changed once a connection is made.
Any attempt to set this when a connection is active will
generate an error.
This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.
MaxLineLength
is the size of an internal buffer, which holds received data while waiting for an EOL
string.If an EOL
string is found in the input stream before MaxLineLength
bytes are received, the DataIn
event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL
is found, and MaxLineLength
bytes are accumulated in the buffer, the DataIn
event is
fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength
is 256 bytes. The default value is 2048 bytes. The maximum value is 65536 bytes.
KeepAliveTime
and KeepAliveInterval
to
configure the timing of the keep-alive packets.Note: This value is not applicable in Java.
IPWorksException
public void copyResource(java.lang.String sourceResourceURI, java.lang.String destinationResourceURI) throws IPWorksException
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 DestinationResourceURI or any collection it is under, SourceResourceURI will be added to that lock.
IPWorksException
public void deleteResource(java.lang.String resourceURI) throws IPWorksException
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
public void doEvents() throws IPWorksException
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
public void findProperties(java.lang.String resourceURI) throws IPWorksException
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 there are no Properties
set, 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.
Note: Some servers (such as IIS 7.5) may not support a depth of Infinity by default and may return a HTTP 403 Forbidden response.
IPWorksException
public void findPropertyNames(java.lang.String resourceURI) throws IPWorksException
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.
Note: Some servers (such as IIS 7.5) may not support a depth of Infinity by default and may return a HTTP 403 Forbidden response.
IPWorksException
public java.lang.String getProperty(java.lang.String propertyName) throws IPWorksException
The bean will search through its internal Properties
collection
for the property identified 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
public void getResource(java.lang.String resourceURI) throws IPWorksException
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
public void interrupt() throws IPWorksException
If there is no method in progress, Interrupt
simply returns, doing nothing.
IPWorksException
public void listDirectory(java.lang.String resourceURI) throws IPWorksException
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.
Note: Some servers (such as IIS 7.5) may not support a depth of Infinity by default and may return a HTTP 403 Forbidden response.
IPWorksException
public void lockResource(java.lang.String resourceURI) throws IPWorksException
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
LockScope
LockTimeout
LockTokens
LockType
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
public void makeDirectory(java.lang.String resourceURI) throws IPWorksException
A new resource collection is created at the location specified by ResourceURI .
IPWorksException
public void moveResource(java.lang.String sourceResourceURI, java.lang.String destinationResourceURI) throws IPWorksException
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 DestinationResourceURI or any collection it is under, SourceResourceURI will be added to that lock.
IPWorksException
public void patchProperties(java.lang.String resourceURI) throws IPWorksException
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
public void postToResource(java.lang.String resourceURI, byte[] postData) throws IPWorksException
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
public void putResource(java.lang.String resourceURI) throws IPWorksException
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
public void reset() throws IPWorksException
When called, the bean will reset all of its properties to their default values.
IPWorksException
public void setDownloadStream(java.io.OutputStream downloadStream) throws IPWorksException
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 if CloseStreamAfterTransfer
is 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
public void setProperty(java.lang.String propertyName, java.lang.String propertyValue) throws IPWorksException
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
public void setUploadStream(java.io.InputStream uploadStream) throws IPWorksException
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 if CloseStreamAfterTransfer
is 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
public void unLockResource(java.lang.String resourceURI) throws IPWorksException
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
public void addWebdavEventListener(WebdavEventListener l) throws java.util.TooManyListenersException
java.util.TooManyListenersException
public void removeWebdavEventListener(WebdavEventListener l)
|
IP*Works! V9 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |