Odatas (IP*Works! SSL V9)

Package

Class

Tree

Deprecated

Index

Help

IP*Works! SSL V9

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

ipworksssl
Class Odatas

java.lang.Object
  ipworksssl.Odatas

public class Odatas
extends java.lang.Object
extends java.lang.Object

The ODataS component implements the Open Data Protocol (OData). It can be used to query, parse, and update/modify data contained within an OData service.

The ODataS Bean is the SSL-enabled equivalent of the IP*Works! OData bean. The main difference is the introduction of a set of new configuration settings, properties and events that deal with SSL security. The ipworksssl.Odatas#config and {@link ipworksssl.Odatas#config configuration settings determine which protocols are enabled and at what security level. The {@link ipworksssl.Odatas#getSSLCert SSLCert} property is used to select a client certificate if the server is requesting client authentication. The {@link ipworksssl.Odatas#config configuration setting, together with the {@link ipworksssl.OdatasSSLServerAuthenticationEvent SSLServerAuthentication} event allow you to check the server identity and other security attributes. Finally, the {@link ipworksssl.OdatasSSLStatusEvent SSLStatus} event provides information about the SSL handshake.

The ODataS component allows you to easily query OData services and create, update, and delete entries within a service. To query a service, you can set the {@link ipworksssl.Odatas#getServiceRootURI ServiceRootURI} to the service's root URI and {@link ipworksssl.Odatas#getResourcePath ResourcePath} to the collection within the service that you wish to query. Optionally you can set the Query*** properties to filter the results. {@link ipworksssl.Odatas#queryService QueryService} can then be called to retrieve the results (which can be viewed via the Entry*** properties).

 ODataS1.ServiceRootURI = "http://services.odata.org/OData/OData.svc"
   ODataS1.ResourcePath = "Products"
   ODataS1.QueryService()

To create a new entry, you can set the {@link ipworksssl.Odatas#getServiceRootURI ServiceRootURI} to the service's root URI and {@link ipworksssl.Odatas#getResourcePath ResourcePath} to the collection within the service that you wish to add the entry to. The Entry*** properties can be set to the values you wish to use to create the entry. {@link ipworksssl.Odatas#createEntry CreateEntry} can then be called to create the entry.

 ODataS1.ServiceRootURI = "http://services.odata.org/OData/OData.svc"
   ODataS1.ResourcePath = "Products"
   ODataS1.EntryProperties
   ODataS1.CreateEntry()

If you wish to update an entry, you can set the {@link ipworksssl.Odatas#getServiceRootURI ServiceRootURI} to the service's root URI and {@link ipworksssl.Odatas#getResourcePath ResourcePath} to the specific entry you wish to update. The Entry*** properties can be set to the values you wish to update. {@link ipworksssl.Odatas#updateEntry UpdateEntry} can then be called to update the entry.

 ODataS1.ServiceRootURI = "http://services.odata.org/OData/OData.svc"
   ODataS1.ResourcePath = "Products(1)"
   // Index 1 is the "Name" property.
   ODataS1.EntryProperties[1].Value = "MyNewName"
   ODataS1.UpdateEntry()

Deleting an entry requires that you first set the {@link ipworksssl.Odatas#getServiceRootURI ServiceRootURI} to the service's root URI and {@link ipworksssl.Odatas#getResourcePath ResourcePath} to the specific entry you wish to delete. {@link ipworksssl.Odatas#deleteEntry DeleteEntry} can then be called to delete the entry.

 ODataS1.ServiceRootURI = "http://services.odata.org/OData/OData.svc"
   ODataS1.ResourcePath = "Products(1)"
   ODataS1.DeleteEntry()

In addition to querying a service and manipulating its containing data, the ODataS component also allows you to retrieve the schema (metadata document) to determine the structure of a service. After setting {@link ipworksssl.Odatas#getServiceRootURI ServiceRootURI} to the root URI of the service, {@link ipworksssl.Odatas#getSchema GetSchema} can be called to retrieve the metadata document. The Schema*** properties will be populated upon successful retrieval of the metadata document allowing you to identify the structure of the service.

 ODataS1.ServiceRootURI = "http://services.odata.org/OData/OData.svc"
   ODataS1.GetSchema()

Field Summary
`static int`	`authBasic`
`static int`	`authDigest`
`static int`	`authNegotiate`
`static int`	`authNone`
`static int`	`authNtlm`
`static int`	`authOAuth`
`static int`	`authProprietary`

Constructor Summary
`Odatas()` Creates an instance of Odatas Bean.
`Odatas(java.lang.String runtimeLicense)` Creates an instance of Odatas Bean with specified run-time license.

Method Summary
`void`	`addOdatasEventListener(OdatasEventListener l)`
`java.lang.String`	`config(java.lang.String configurationString)` Sets or retrieves a {@link ipworksssl.Odatas#config configuration setting.
`void`	`createEntry()` Creates a new entry within the specified OData service resource.
`void`	`customRequest(java.lang.String HTTPMethod, java.lang.String URL, java.lang.String postData)` Sends a request to the specified URL using the HTTP Method and Post Data provided.
`void`	`deleteEntry()` Deletes an entry within an OData service resource.
`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.
`AtomChannel`	`getChannel()` The feed elements of a feed.
`HTTPCookieList`	`getCookies()` Collection of cookies.
`java.lang.String`	`getEntryAuthor()` The Author of the current entry in an OData feed.
`int`	`getEntryCount()` The number of entries contained within an OData feed.
`java.lang.String`	`getEntryETag()` The ETag of the current entry in an OData feed.
`java.lang.String`	`getEntryId()` The ID of the current entry in an OData feed.
`int`	`getEntryIndex()` The index of the current entry in an OData feed.
`ODataEntryLinkList`	`getEntryLinks()` A collection of links in the current OData entry.
`ODataEntryPropertyList`	`getEntryProperties()` A collection of elements in the current OData entry.
`java.lang.String`	`getEntryProperty(java.lang.String XPath)` Get an OData entry property.
`java.lang.String`	`getEntrySummary()` The Summary of the current entry in an OData feed.
`java.lang.String`	`getEntryTitle()` The Title of the current entry in an OData feed.
`java.lang.String`	`getEntryUpdated()` The Date-Time when current entry in an OData feed was updated.
`java.lang.String`	`getEntryXML()` The raw XML of the current entry in an OData feed.
`Firewall`	`getFirewall()` A set of properties related to firewall access.
`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`	`getOtherHeaders()` Other headers as determined by the user (optional).
`java.lang.String`	`getOtherQueryOptions()` Additional Query Options to be used when querying a service.
`HeaderList`	`getParsedHeaders()` Collection of headers returned from the last request.
`java.lang.String`	`getPassword()` A password if authentication is to be used.
`Proxy`	`getProxy()` A set of properties related to proxy access.
`java.lang.String`	`getQueryFilter()` Selects only the entries that satisfy the specified filter (expression).
`java.lang.String`	`getQueryOrderBy()` The value used to order entries when querying a service.
`java.lang.String`	`getQuerySelect()` Selects only the specified properties to be returned in an entry when querying a service.
`java.lang.String`	`getQuerySkip()` The number of entries to skip when querying a service.
`java.lang.String`	`getQuerySkipToken()` Token given by an OData server when the last query result collection is too large.
`java.lang.String`	`getQueryTop()` Selects the first N entries when querying a service.
`java.lang.String`	`getResourcePath()` The Resource Path of an OData service.
`void`	`getSchema()` Retrieves the schema for a service.
`ODataSchemaAssociation`	`getSchemaAssociation()` The navigation properties and their corresponding associations contained within an entity of a service schema.
`int`	`getSchemaAssociationCount()` The number of navigation properties contained within an OData schema entity.
`int`	`getSchemaAssociationIndex()` The index of the current navigation property in an OData schema entity.
`ODataSchemaEntity`	`getSchemaEntity()` The entities contained within a service schema.
`int`	`getSchemaEntityCount()` The number of entities contained within an OData schema.
`int`	`getSchemaEntityIndex()` The index of the current entity in an OData schema.
`java.lang.String[]`	`getSchemaKeys()` The keys of a schema entity.
`ODataSchemaProperty`	`getSchemaProperty()` The properties contained within an entity of a service schema.
`int`	`getSchemaPropertyCount()` The number of properties contained within an OData schema entity.
`int`	`getSchemaPropertyIndex()` The index of the current property in an OData schema entity.
`ODataSchemaProperty`	`getSchemaTypeField()` The fields (properties) contained within a complex type.
`int`	`getSchemaTypeFieldCount()` The number of properties contained within an OData schema complex type.
`int`	`getSchemaTypeFieldIndex()` The index of the current field (property) in an OData schema complex type.
`java.lang.String`	`getServiceRootURI()` The root URI of an OData service.
`Certificate`	`getSSLAcceptServerCert()` Instructs the bean to unconditionally accept the server certificate that matches the supplied certificate.
`Certificate`	`getSSLCert()` The certificate to be used during SSL negotiation.
`Certificate`	`getSSLServerCert()` The server certificate for the last established connection.
`int`	`getTimeout()` A timeout for the bean.
`byte[]`	`getTransferredData()` The contents of the last response from the server.
`java.lang.String`	`getUser()` A user name if authentication is to be used.
`XMLAttributeList`	`getXAttributes()` A collection of attributes of the current element.
`XMLElementList`	`getXChildren()` Collection of child elements of the current element.
`java.lang.String`	`getXElement()` The name of the current element.
`java.lang.String`	`getXNamespace()` The namespace of the current element.
`java.lang.String`	`getXParent()` The parent of the current element.
`java.lang.String`	`getXPath()` Provides a way to point to a specific element in the document.
`java.lang.String`	`getXPrefix()` The prefix of the current element.
`java.lang.String`	`getXSubTree()` A snapshot of the current element in the document.
`java.lang.String`	`getXText()` The text of the current element.
`boolean`	`hasXPath(java.lang.String xpath)` Determines whether a specific element exists in the document.
`boolean`	`isIdle()` The current status of the component.
`void`	`queryService()` Queries an OData service using the specified parameters.
`void`	`removeOdatasEventListener(OdatasEventListener l)`
`void`	`reset()` Reset all properties of the bean.
`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`	`setChannel(AtomChannel channel)` The feed elements of a feed.
`void`	`setEntryAuthor(java.lang.String entryAuthor)` The Author of the current entry in an OData feed.
`void`	`setEntryETag(java.lang.String entryETag)` The ETag of the current entry in an OData feed.
`void`	`setEntryId(java.lang.String entryId)` The ID of the current entry in an OData feed.
`void`	`setEntryIndex(int entryIndex)` The index of the current entry in an OData feed.
`void`	`setEntryProperty(java.lang.String XPath, java.lang.String value)` Set an OData entry property.
`void`	`setEntrySummary(java.lang.String entrySummary)` The Summary of the current entry in an OData feed.
`void`	`setEntryTitle(java.lang.String entryTitle)` The Title of the current entry in an OData feed.
`void`	`setEntryXML(java.lang.String entryXML)` The raw XML of the current entry in an OData feed.
`void`	`setFirewall(Firewall firewall)` A set of properties related to firewall access.
`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`	`setOtherHeaders(java.lang.String otherHeaders)` Other headers as determined by the user (optional).
`void`	`setOtherQueryOptions(java.lang.String otherQueryOptions)` Additional Query Options to be used when querying a service.
`void`	`setPassword(java.lang.String password)` A password if authentication is to be used.
`void`	`setProxy(Proxy proxy)` A set of properties related to proxy access.
`void`	`setQueryFilter(java.lang.String queryFilter)` Selects only the entries that satisfy the specified filter (expression).
`void`	`setQueryOrderBy(java.lang.String queryOrderBy)` The value used to order entries when querying a service.
`void`	`setQuerySelect(java.lang.String querySelect)` Selects only the specified properties to be returned in an entry when querying a service.
`void`	`setQuerySkip(java.lang.String querySkip)` The number of entries to skip when querying a service.
`void`	`setQuerySkipToken(java.lang.String querySkipToken)` Token given by an OData server when the last query result collection is too large.
`void`	`setQueryTop(java.lang.String queryTop)` Selects the first N entries when querying a service.
`void`	`setResourcePath(java.lang.String resourcePath)` The Resource Path of an OData service.
`void`	`setSchemaAssociationIndex(int schemaAssociationIndex)` The index of the current navigation property in an OData schema entity.
`void`	`setSchemaEntity(java.lang.String name)` Sets the schema entity.
`void`	`setSchemaEntityIndex(int schemaEntityIndex)` The index of the current entity in an OData schema.
`void`	`setSchemaProperty(java.lang.String name)` Sets the schema property.
`void`	`setSchemaPropertyIndex(int schemaPropertyIndex)` The index of the current property in an OData schema entity.
`void`	`setSchemaType(java.lang.String name)` Sets the schema type.
`void`	`setSchemaTypeFieldIndex(int schemaTypeFieldIndex)` The index of the current field (property) in an OData schema complex type.
`void`	`setServiceRootURI(java.lang.String serviceRootURI)` The root URI of an OData service.
`void`	`setSSLAcceptServerCert(Certificate SSLAcceptServerCert)` Instructs the bean to unconditionally accept the server certificate that matches the supplied certificate.
`void`	`setSSLCert(Certificate SSLCert)` The certificate to be used during SSL negotiation.
`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`	`setXPath(java.lang.String XPath)` Provides a way to point to a specific element in the document.
`void`	`updateEntry()` Update an OData entry.
`void`	`updateProperty(java.lang.String XPath, java.lang.String value)` Update an OData entry property.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

authBasic

public static final int authBasic

See Also:: Constant Field Values

authDigest

public static final int authDigest

See Also:: Constant Field Values

authProprietary

public static final int authProprietary

See Also:: Constant Field Values

authNone

public static final int authNone

See Also:: Constant Field Values

authNtlm

public static final int authNtlm

See Also:: Constant Field Values

authNegotiate

public static final int authNegotiate

See Also:: Constant Field Values

authOAuth

public static final int authOAuth

See Also:: Constant Field Values

Constructor Detail

Odatas

public Odatas()

Creates an instance of Odatas Bean.

Odatas

public Odatas(java.lang.String runtimeLicense)

Creates an instance of Odatas Bean with specified run-time license.

Method Detail

getAuthorization

public java.lang.String getAuthorization()

The Authorization string to be sent to the server.

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]".

setAuthorization

public void setAuthorization(java.lang.String authorization)
                      throws IPWorksSSLException

The Authorization string to be sent to the server.

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.

Throws:: IPWorksSSLException

getAuthScheme

public int getAuthScheme()

The authentication scheme to use when server authorization is required.

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 {@link ipworksssl.Odatas#config .

setAuthScheme

public void setAuthScheme(int authScheme)
                   throws IPWorksSSLException

The authentication scheme to use when server authorization is required.

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.

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 {@link ipworksssl.Odatas#config .

Throws:: IPWorksSSLException

getChannel

public AtomChannel getChannel()

The feed elements of a feed.

This property contains the "feed" elements of an ATOM feed. The Channel property has fields which contain values for sub-elements of the "feed" element.

setChannel

public void setChannel(AtomChannel channel)
                throws IPWorksSSLException

The feed elements of a feed.

This property contains the "feed" elements of an ATOM feed. The Channel property has fields which contain values for sub-elements of the "feed" element.

Throws:: IPWorksSSLException

getCookies

public HTTPCookieList getCookies()

Collection of cookies.

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 .

{@link ipworksssl.Odatas#config can be used to control the maximum number of cookies saved.

This collection is indexed from 0 to size - 1.

getEntryAuthor

public java.lang.String getEntryAuthor()

The Author of the current entry in an OData feed.

This property contains the author of the specified entry within an OData feed. This value will be populated once EntryIndex is set (provided that an author can be found).

setEntryAuthor

public void setEntryAuthor(java.lang.String entryAuthor)
                    throws IPWorksSSLException

The Author of the current entry in an OData feed.

This property contains the author of the specified entry within an OData feed. This value will be populated once EntryIndex is set (provided that an author can be found).

Throws:: IPWorksSSLException

getEntryCount

public int getEntryCount()

The number of entries contained within an OData feed.

This property is updated to reflect the total number of entries returned within a response (whether you are retrieving a feed/entry or making changes to a feed/entry).

getEntryETag

public java.lang.String getEntryETag()

The ETag of the current entry in an OData feed.

This property is used to obtain the ETag of the specified entry within an OData feed and will be populated once EntryIndex is set.

This property is also used when retrieving, updating or deleting an entry. When EntryETag contains a non-empty string, an "If-None-Match" header will be sent with the entered value when QueryService is called. When DeleteEntry or UpdateEntry is called, an "If-Match" header will be sent with the entered value.

setEntryETag

public void setEntryETag(java.lang.String entryETag)
                  throws IPWorksSSLException

The ETag of the current entry in an OData feed.

This property is used to obtain the ETag of the specified entry within an OData feed and will be populated once EntryIndex is set.

Throws:: IPWorksSSLException

getEntryId

public java.lang.String getEntryId()

The ID of the current entry in an OData feed.

This property contains the ID of the specified entry within an OData feed. This value will be populated once EntryIndex is set (provided that an ID can be found).

setEntryId

public void setEntryId(java.lang.String entryId)
                throws IPWorksSSLException

The ID of the current entry in an OData feed.

This property contains the ID of the specified entry within an OData feed. This value will be populated once EntryIndex is set (provided that an ID can be found).

Throws:: IPWorksSSLException

getEntryIndex

public int getEntryIndex()

The index of the current entry in an OData feed.

This property is used to specify an entry within a retrieved OData feed. Once set, EntryAuthor , EntryETag , EntryTitle , EntrySummary , EntryUpdated , EntryLinks , EntryProperties and ResourcePath will be populated with their respective values found within the entry.

This property takes index values from 0 to EntryCount -1.

Setting EntryIndex to -1 will clear the entries contained by the component and will also reset EntryProperties and EntryCount .

setEntryIndex

public void setEntryIndex(int entryIndex)
                   throws IPWorksSSLException

The index of the current entry in an OData feed.

This property takes index values from 0 to EntryCount -1.

Setting EntryIndex to -1 will clear the entries contained by the component and will also reset EntryProperties and EntryCount .

Throws:: IPWorksSSLException

getEntryLinks

public ODataEntryLinkList getEntryLinks()

A collection of links in the current OData entry.

This is a collection of links (referred to as Navigation Properties) in the current OData entry, as specified by EntryIndex . When EntryIndex is set, all of the elements in the entry are stored as ODataEntryLink types in this collection.

getEntryProperties

public ODataEntryPropertyList getEntryProperties()

A collection of elements in the current OData entry.

This is a collection of elements in the current OData entry, as specified by EntryIndex . When EntryIndex is set, all of the elements in the entry are stored as ODataEntryProperty types in this collection.

getEntrySummary

public java.lang.String getEntrySummary()

The Summary of the current entry in an OData feed.

This property contains the Summary of the specified entry within an OData feed. This value will be populated once EntryIndex is set (provided that a Summary can be found).

setEntrySummary

public void setEntrySummary(java.lang.String entrySummary)
                     throws IPWorksSSLException

The Summary of the current entry in an OData feed.

This property contains the Summary of the specified entry within an OData feed. This value will be populated once EntryIndex is set (provided that a Summary can be found).

Throws:: IPWorksSSLException

getEntryTitle

public java.lang.String getEntryTitle()

The Title of the current entry in an OData feed.

This property contains the Title of the specified entry within an OData feed. This value will be populated once EntryIndex is set (provided that a Title can be found).

setEntryTitle

public void setEntryTitle(java.lang.String entryTitle)
                   throws IPWorksSSLException

The Title of the current entry in an OData feed.

This property contains the Title of the specified entry within an OData feed. This value will be populated once EntryIndex is set (provided that a Title can be found).

Throws:: IPWorksSSLException

getEntryUpdated

public java.lang.String getEntryUpdated()

The Date-Time when current entry in an OData feed was updated.

This property contains the Date-Time when the specified entry within an OData feed was updated. This value will be populated once EntryIndex is set (provided that a Title can be found).

getEntryXML

public java.lang.String getEntryXML()

The raw XML of the current entry in an OData feed.

This property contains the raw XML of the specified entry within an OData feed. This value will be populated once EntryIndex is set.

setEntryXML

public void setEntryXML(java.lang.String entryXML)
                 throws IPWorksSSLException

The raw XML of the current entry in an OData feed.

This property contains the raw XML of the specified entry within an OData feed. This value will be populated once EntryIndex is set.

Throws:: IPWorksSSLException

getFirewall

public Firewall getFirewall()

A set of properties related to firewall access.

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

setFirewall

public void setFirewall(Firewall firewall)
                 throws IPWorksSSLException

A set of properties related to firewall access.

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

Throws:: IPWorksSSLException

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.

getLocalHost

public java.lang.String getLocalHost()

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

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.

setLocalHost

public void setLocalHost(java.lang.String localHost)
                  throws IPWorksSSLException

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

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.

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Throws:: IPWorksSSLException

getOtherHeaders

public java.lang.String getOtherHeaders()

Other headers as determined by the user (optional).

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.

setOtherHeaders

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

Other headers as determined by the user (optional).

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.

Throws:: IPWorksSSLException

getOtherQueryOptions

public java.lang.String getOtherQueryOptions()

Additional Query Options to be used when querying a service.

This property allows you to specify additional query options that will be used when accessing a service. Query options consist of name-value pairs and multiple entries should be separated with an '&' (i.e. name1=value1&name2=value2).

Note all specified values will be appended (unaltered) to the end of the URL (generated by the combination of ServiceRootURI , ResourcePath and any Query*** properties specified).

setOtherQueryOptions

public void setOtherQueryOptions(java.lang.String otherQueryOptions)
                          throws IPWorksSSLException

Additional Query Options to be used when querying a service.

Note all specified values will be appended (unaltered) to the end of the URL (generated by the combination of ServiceRootURI , ResourcePath and any Query*** properties specified).

Throws:: IPWorksSSLException

getParsedHeaders

public HeaderList getParsedHeaders()

Collection of headers returned from the last request.

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.

{@link ipworksssl.Odatas#config can be used to control the maximum number of headers saved.

This collection is indexed from 0 to size - 1.

getPassword

public java.lang.String getPassword()

A password if authentication is to be used.

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 ipworksssl.Odatas#config config setting in the form "Basic [encoded-user-password]".

If {@link ipworksssl.Odatas#getAuthScheme AuthScheme} is set to HTTP Digest Authentication, the {@link ipworksssl.Odatas#getUser User} and {@link ipworksssl.Odatas#getPassword Password} properties are used to respond to the HTTP Digest Authentication challenge from the server.

If {@link ipworksssl.Odatas#getAuthScheme AuthScheme} is set to NTLM, NTLM authentication will be attempted. If {@link ipworksssl.Odatas#getAuthScheme AuthScheme} is set to NTLM and {@link ipworksssl.Odatas#getUser User} and {@link ipworksssl.Odatas#getPassword Password} are empty, the bean will attempt to authenticate using the current user's credentials.

setPassword

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

A password if authentication is to be used.

Throws:: IPWorksSSLException

getProxy

public Proxy getProxy()

A set of properties related to proxy access.

This property contains fields describing the proxy through which the bean will attempt to connect.

setProxy

public void setProxy(Proxy proxy)
              throws IPWorksSSLException

A set of properties related to proxy access.

This property contains fields describing the proxy through which the bean will attempt to connect.

Throws:: IPWorksSSLException

getQueryFilter

public java.lang.String getQueryFilter()

Selects only the entries that satisfy the specified filter (expression).

This property allows you to specify a filter (expression) in which only the entries that satisfy it will be returned.

Below are the operators supported in the expression language.

Logical Operators

Operator Description: Example
eqEqual: "City eq 'Durham'"
neNot Equal: "City ne 'North Carolina'"
gtGreater Than: "Price gt 20"
geGreater Than or Equal: "Price ge 10"
ltLess Than: "Price lt 20"
leLess Than Or Equal: "Price le 100"
andLogical And: "Price le 200 and Price gt 3.5 "
orLogical Or: "Price le 3.5 or Price gt 200"
notLogical Not: "not endswith(Description,'milk')"

Arithmetic Operators

Operator Description: Example
addAddition: "Price add 5 gt 10"
subSubtraction: "Price sub 5 gt 10"
mulMultiplication: "Price mul 2 gt 2000"
divDivision: "Price div 2 gt 4"
modModulo: "Price mod 2 eq 0"

Grouping Operators

Operator Description: Example
( )Precedence Grouping: "(Price sub 5) gt 10 "

Below are the functions supported in the expression language.

String Functions

Function: Example
bool substringof(string po, string p1): "substringof('Alfreds', CompanyName) eq true"
bool endswith(string p0, string p1): "endswith(CompanyName, 'Futterkiste') eq true"
bool startswith(string p0, string p1): "startswith(CompanyName, 'Alfr') eq true"
int length(string p0): "length(CompanyName) eq 19"
int indexof(string p0, string p1): "indexof(CompanyName, 'lfreds') eq 1"
string replace(string p0, string find, string replace): "replace(CompanyName, ' ', '') eq 'AlfredsFutterkiste'"
string substring(string p0, int pos): "substring(CompanyName, 1) eq 'lfreds Futterkiste'"
string substring(string p0, int pos, int length): "substring(CompanyName, 1, 2) eq 'lf'"
string tolower(string p0): "tolower(CompanyName) eq 'alfreds futterkiste'"
string toupper(string p0): "toupper(CompanyName) eq 'ALFREDS FUTTERKISTE'"
string trim(string p0): "trim(CompanyName) eq 'Alfreds Futterkiste'"
string concat(string p0, string p1): "concat(concat(City, ', '), Country) eq 'Berlin, Germany'"

Date Functions

Function: Example
int day(DateTime p0): "day(BirthDate) eq 8"
int hour(DateTime p0): "hour(BirthDate) eq 0"
int minute(DateTime p0): "minute(BirthDate) eq 0"
int month(DateTime p0): "month(BirthDate) eq 12"
int second(DateTime p0): "second(BirthDate) eq 0"
int year(DateTime p0): "year(BirthDate) eq 1948"

Math Functions

Function: Example
double round(double p0): "round(Freight) eq 32"
decimal round(decimal p0): "round(Freight) eq 32"
double floor(double p0): "round(Freight) eq 32"
decimal floor(decimal p0): "floor(Freight) eq 32"
double ceiling(double p0): "ceiling(Freight) eq 33"
decimal ceiling(decimal p0): "floor(Freight) eq 33"

Type Functions

Function: Example
bool IsOf(type p0): "isof('NorthwindModel.Order')"
bool IsOf(expression p0, type p1): "isof(ShipCountry, 'Edm.String')"

setQueryFilter

public void setQueryFilter(java.lang.String queryFilter)
                    throws IPWorksSSLException

Selects only the entries that satisfy the specified filter (expression).

This property allows you to specify a filter (expression) in which only the entries that satisfy it will be returned.

Below are the operators supported in the expression language.

Logical Operators

Operator Description: Example
eqEqual: "City eq 'Durham'"
neNot Equal: "City ne 'North Carolina'"
gtGreater Than: "Price gt 20"
geGreater Than or Equal: "Price ge 10"
ltLess Than: "Price lt 20"
leLess Than Or Equal: "Price le 100"
andLogical And: "Price le 200 and Price gt 3.5 "
orLogical Or: "Price le 3.5 or Price gt 200"
notLogical Not: "not endswith(Description,'milk')"

Arithmetic Operators

Operator Description: Example
addAddition: "Price add 5 gt 10"
subSubtraction: "Price sub 5 gt 10"
mulMultiplication: "Price mul 2 gt 2000"
divDivision: "Price div 2 gt 4"
modModulo: "Price mod 2 eq 0"

Grouping Operators

Operator Description: Example
( )Precedence Grouping: "(Price sub 5) gt 10 "

Below are the functions supported in the expression language.

String Functions

Function: Example
bool substringof(string po, string p1): "substringof('Alfreds', CompanyName) eq true"
bool endswith(string p0, string p1): "endswith(CompanyName, 'Futterkiste') eq true"
bool startswith(string p0, string p1): "startswith(CompanyName, 'Alfr') eq true"
int length(string p0): "length(CompanyName) eq 19"
int indexof(string p0, string p1): "indexof(CompanyName, 'lfreds') eq 1"
string replace(string p0, string find, string replace): "replace(CompanyName, ' ', '') eq 'AlfredsFutterkiste'"
string substring(string p0, int pos): "substring(CompanyName, 1) eq 'lfreds Futterkiste'"
string substring(string p0, int pos, int length): "substring(CompanyName, 1, 2) eq 'lf'"
string tolower(string p0): "tolower(CompanyName) eq 'alfreds futterkiste'"
string toupper(string p0): "toupper(CompanyName) eq 'ALFREDS FUTTERKISTE'"
string trim(string p0): "trim(CompanyName) eq 'Alfreds Futterkiste'"
string concat(string p0, string p1): "concat(concat(City, ', '), Country) eq 'Berlin, Germany'"

Date Functions

Function: Example
int day(DateTime p0): "day(BirthDate) eq 8"
int hour(DateTime p0): "hour(BirthDate) eq 0"
int minute(DateTime p0): "minute(BirthDate) eq 0"
int month(DateTime p0): "month(BirthDate) eq 12"
int second(DateTime p0): "second(BirthDate) eq 0"
int year(DateTime p0): "year(BirthDate) eq 1948"

Math Functions

Function: Example
double round(double p0): "round(Freight) eq 32"
decimal round(decimal p0): "round(Freight) eq 32"
double floor(double p0): "round(Freight) eq 32"
decimal floor(decimal p0): "floor(Freight) eq 32"
double ceiling(double p0): "ceiling(Freight) eq 33"
decimal ceiling(decimal p0): "floor(Freight) eq 33"

Type Functions

Function: Example
bool IsOf(type p0): "isof('NorthwindModel.Order')"
bool IsOf(expression p0, type p1): "isof(ShipCountry, 'Edm.String')"

Throws:: IPWorksSSLException

getQueryOrderBy

public java.lang.String getQueryOrderBy()

The value used to order entries when querying a service.

This property allows you to specify a value by which the returned entries will be order after a call to QueryService .

Note: You can specify the order by which the entries are sorted (either ascending or descending) by appending " asc" or " desc" (respectively) to your OrderBy value. For example, if you want to sort the entries by 'Rating' in descending order you would set QueryOrderBy to "Rating desc". If a specific order ('asc' or 'desc') is not specified, the entries will be returned in ascending order.

setQueryOrderBy

public void setQueryOrderBy(java.lang.String queryOrderBy)
                     throws IPWorksSSLException

The value used to order entries when querying a service.

This property allows you to specify a value by which the returned entries will be order after a call to QueryService .

Throws:: IPWorksSSLException

getQuerySelect

public java.lang.String getQuerySelect()

Selects only the specified properties to be returned in an entry when querying a service.

This property allows you to specify the specific properties you want returned within an entry when calling QueryService . The specified value should be a comma-separated list of properties (provided you wish to have more than one property returned). For example, if you wish to only have the 'Name' and 'Price' of each item returned you can set QuerySelect to "Name,Price".

Note the specified values can be a property name, navigation property name ( Title ) or the "*" character (which returns all the properties for each entry).

setQuerySelect

public void setQuerySelect(java.lang.String querySelect)
                    throws IPWorksSSLException

Selects only the specified properties to be returned in an entry when querying a service.

Note the specified values can be a property name, navigation property name ( Title ) or the "*" character (which returns all the properties for each entry).

Throws:: IPWorksSSLException

getQuerySkip

public java.lang.String getQuerySkip()

The number of entries to skip when querying a service.

This property allows you to specify the number of entries to skip (from the top of the list) when calling QueryService . Therefore when this property set, only the remaining entries (starting with entry N+1) will be returned. The specified value should not be a value less than 0.

By default, the service you are querying will sort the entries using a scheme selected by the OData service you are querying. However you can use QueryOrderBy to specify how the entries should be sorted prior to skipping the top N items.

This property can be used in conjunction with QueryOrderBy and QueryTop to select specific entries. For example, if you wanted to select the third and fourth highest rated item you would set QueryOrderBy to "Rating desc" (to order the items by Rating from highest to lowest), set QuerySkip to "2" (to skip the first and second items), and finally set QueryTop to "2" (to only return the third and fourth items).

setQuerySkip

public void setQuerySkip(java.lang.String querySkip)
                  throws IPWorksSSLException

The number of entries to skip when querying a service.

Throws:: IPWorksSSLException

getQuerySkipToken

public java.lang.String getQuerySkipToken()

Token given by an OData server when the last query result collection is too large.

When a returned result collection is very large, it is not uncommon for the results to be broken up into multiple pages. When this occurs a Skip Token is returned in the response and the component will populate QuerySkipToken with the returned value. Calling QueryService again will return the next page of results.

setQuerySkipToken

public void setQuerySkipToken(java.lang.String querySkipToken)
                       throws IPWorksSSLException

Token given by an OData server when the last query result collection is too large.

Throws:: IPWorksSSLException

getQueryTop

public java.lang.String getQueryTop()

Selects the first N entries when querying a service.

This property allows you to specify the number of entries (taken from the top of the list) to be returned when calling QueryService . The specified value should not be a value less than 0.

setQueryTop

public void setQueryTop(java.lang.String queryTop)
                 throws IPWorksSSLException

Selects the first N entries when querying a service.

This property allows you to specify the number of entries (taken from the top of the list) to be returned when calling QueryService . The specified value should not be a value less than 0.

Throws:: IPWorksSSLException

getResourcePath

public java.lang.String getResourcePath()

The Resource Path of an OData service.

This property contains the resource path of an OData service and is used in conjunction with ServiceRootURI ( ServiceRootURI / ResourcePath ) to query feeds and modify entries.

This property will be populated when EntryIndex is set. You can change the value if you wish to send the request to a different Resource Path.

For example, a valid ResourcePath for the OData sample service is: "Products".

setResourcePath

public void setResourcePath(java.lang.String resourcePath)
                     throws IPWorksSSLException

The Resource Path of an OData service.

This property contains the resource path of an OData service and is used in conjunction with ServiceRootURI ( ServiceRootURI / ResourcePath ) to query feeds and modify entries.

This property will be populated when EntryIndex is set. You can change the value if you wish to send the request to a different Resource Path.

For example, a valid ResourcePath for the OData sample service is: "Products".

Throws:: IPWorksSSLException

getSchemaAssociation

public ODataSchemaAssociation getSchemaAssociation()

The navigation properties and their corresponding associations contained within an entity of a service schema.

This property is used to obtain the navigation properties and their corresponding associations contained within an entity (specified by SchemaEntityIndex ) of a service schema. This property is populated after setting SchemaAssociationIndex .

getSchemaAssociationCount

public int getSchemaAssociationCount()

The number of navigation properties contained within an OData schema entity.

This property is updated to reflect the total number of navigation properties within the schema entity specified by SchemaEntityIndex .

getSchemaAssociationIndex

public int getSchemaAssociationIndex()

The index of the current navigation property in an OData schema entity.

This property is used to specify a navigation property within an entity (specified by SchemaEntityIndex ). Once set, SchemaAssociation will be populated.

setSchemaAssociationIndex

public void setSchemaAssociationIndex(int schemaAssociationIndex)
                               throws IPWorksSSLException

The index of the current navigation property in an OData schema entity.

This property is used to specify a navigation property within an entity (specified by SchemaEntityIndex ). Once set, SchemaAssociation will be populated.

Throws:: IPWorksSSLException

getSchemaEntity

public ODataSchemaEntity getSchemaEntity()

The entities contained within a service schema.

This property is used to obtain the entities of a service schema. This property is populated after setting SchemaEntityIndex .

getSchemaEntityCount

public int getSchemaEntityCount()

The number of entities contained within an OData schema.

This property is updated to reflect the total number of entities within a schema (retrieved via GetSchema ).

getSchemaEntityIndex

public int getSchemaEntityIndex()

The index of the current entity in an OData schema.

This property is used to specify an entity within a retrieved OData schema. Once set, SchemaEntity will be populated.

setSchemaEntityIndex

public void setSchemaEntityIndex(int schemaEntityIndex)
                          throws IPWorksSSLException

The index of the current entity in an OData schema.

This property is used to specify an entity within a retrieved OData schema. Once set, SchemaEntity will be populated.

Throws:: IPWorksSSLException

getSchemaKeys

public java.lang.String[] getSchemaKeys()

The keys of a schema entity.

This property is used to obtain the key(s) contained within an entity of a service schema and is populated after setting SchemaEntityIndex .

Note: A Key value maps to a property of the entity, details of which can be retrieved via SchemaProperty .

getSchemaProperty

public ODataSchemaProperty getSchemaProperty()

The properties contained within an entity of a service schema.

This property is used to obtain the properties contained within an entity (specified by SchemaEntityIndex ) of a service schema. This property is populated after setting SchemaPropertyIndex .

Note: In reference to a database structure, a property would be a column.

getSchemaPropertyCount

public int getSchemaPropertyCount()

The number of properties contained within an OData schema entity.

This property is updated to reflect the total number of properties within the schema entity specified by SchemaEntityIndex .

getSchemaPropertyIndex

public int getSchemaPropertyIndex()

The index of the current property in an OData schema entity.

This property is used to specify a property within an entity (specified by SchemaEntityIndex ). Once set, SchemaProperty will be populated.

setSchemaPropertyIndex

public void setSchemaPropertyIndex(int schemaPropertyIndex)
                            throws IPWorksSSLException

The index of the current property in an OData schema entity.

This property is used to specify a property within an entity (specified by SchemaEntityIndex ). Once set, SchemaProperty will be populated.

Throws:: IPWorksSSLException

getSchemaTypeField

public ODataSchemaProperty getSchemaTypeField()

The fields (properties) contained within a complex type.

This property is used to obtain the fields (properties) contained within a complex type.

It is populated when navigating an entity's properties via SchemaPropertyIndex or by explicitly setting the complex type name via SetSchemaType .

getSchemaTypeFieldCount

public int getSchemaTypeFieldCount()

The number of properties contained within an OData schema complex type.

This property is updated to reflect the total number of fields (properties) within the schema complex type of a property. This is populated when navigating an entity's properties via SchemaPropertyIndex or by explicitly setting the type via SetSchemaType .

getSchemaTypeFieldIndex

public int getSchemaTypeFieldIndex()

The index of the current field (property) in an OData schema complex type.

This property is used to specify a field (property) within a complex type. Once set, SchemaTypeField will be populated.

setSchemaTypeFieldIndex

public void setSchemaTypeFieldIndex(int schemaTypeFieldIndex)
                             throws IPWorksSSLException

The index of the current field (property) in an OData schema complex type.

This property is used to specify a field (property) within a complex type. Once set, SchemaTypeField will be populated.

Throws:: IPWorksSSLException

getServiceRootURI

public java.lang.String getServiceRootURI()

The root URI of an OData service.

This property contains the root URI of an OData service. This value is used in conjunction with ResourcePath ( ServiceRootURI / ResourcePath ) to query feeds and modify entries.

For example, the ServiceRootURI of the OData sample service is: "http://services.odata.org/OData/OData.svc/".

setServiceRootURI

public void setServiceRootURI(java.lang.String serviceRootURI)
                       throws IPWorksSSLException

The root URI of an OData service.

This property contains the root URI of an OData service. This value is used in conjunction with ResourcePath ( ServiceRootURI / ResourcePath ) to query feeds and modify entries.

For example, the ServiceRootURI of the OData sample service is: "http://services.odata.org/OData/OData.svc/".

Throws:: IPWorksSSLException

getSSLAcceptServerCert

public Certificate getSSLAcceptServerCert()

Instructs the bean to unconditionally accept the server certificate that matches the supplied certificate.

If it finds any issues with the certificate presented by the server, the bean will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert . If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

setSSLAcceptServerCert

public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert)
                            throws IPWorksSSLException

Instructs the bean to unconditionally accept the server certificate that matches the supplied certificate.

If it finds any issues with the certificate presented by the server, the bean will normally terminate the connection with an error.

Throws:: IPWorksSSLException

getSSLCert

public Certificate getSSLCert()

The certificate to be used during SSL negotiation.

The digital certificate that the bean will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

setSSLCert

public void setSSLCert(Certificate SSLCert)
                throws IPWorksSSLException

The certificate to be used during SSL negotiation.

Throws:: IPWorksSSLException

getSSLServerCert

public Certificate getSSLServerCert()

The server certificate for the last established connection.

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

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 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 ipworksssl.Odatas#config configuration setting.

The default value for the {@link ipworksssl.Odatas#getTimeout Timeout} property is 60 (seconds).

setTimeout

public void setTimeout(int timeout)
                throws IPWorksSSLException

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.

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.

This behavior is controlled by the ipworksssl.Odatas#config configuration setting.

The default value for the {@link ipworksssl.Odatas#getTimeout Timeout} property is 60 (seconds).

Throws:: IPWorksSSLException

getTransferredData

public byte[] getTransferredData()

The contents of the last response from the server.

This property is used to get the data of the last response from the server.

TransferredData will be populated after a successful QueryService or CustomRequest call, provided that LocalFile is not set. If LocalFile is set, the object data will be written to the file specified.

getUser

public java.lang.String getUser()

A user name if authentication is to be used.

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 ipworksssl.Odatas#config property in the form "Basic [encoded-user-password]".

setUser

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

A user name if authentication is to be used.

Throws:: IPWorksSSLException

getXAttributes

public XMLAttributeList getXAttributes()

A collection of attributes of the current element.

This collection consists of all attributes of the current XML element. The component parses each attribute into a collection of xmlattribute types.

This collection is indexed from 0 to size - 1.

getXChildren

public XMLElementList getXChildren()

Collection of child elements of the current element.

The elements are provided in the collection in the same order they are found in the document.

This collection is indexed from 0 to size - 1.

getXElement

public java.lang.String getXElement()

The name of the current element.

The current element is specified via the XPath property.

getXNamespace

public java.lang.String getXNamespace()

The namespace of the current element.

The current element is specified via the XPath property.

getXParent

public java.lang.String getXParent()

The parent of the current element.

The current element is specified via the XPath property.

getXPath

public java.lang.String getXPath()

Provides a way to point to a specific element in the document.

XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML documents.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

The following are possible values for an element accessor:

'name': A particular element name
name[i]: The i-th subelement of the current element with the given name
[i]: The i-th subelement of the current element
[last()]: The last subelement of the current element
[last()-i]: The subelement located at the last location minus i in the current element
name[@attrname="attrvalue"]: The subelement containing a particular value for a given attribute (supports single AND double quotes)
..: The parent of the current element

When XPath is set to a valid path, XElement points to the name of the element, with XParent , XNamespace , XPrefix , XChildren , and XText providing other properties of the element. The attributes of the current element are provided in the XAttributes collection .

Example (Setting XPath)

 
 
 
 Document root 
ODataControl.XPath = "/"
 
Specific Element 
ODataControl.XPath = "/root/SubElement1/SubElement2/"
 
i-th Child 
ODataControl.XPath = "/root/SubElement1[i]"
 
Specific EntryItem 
ODataControl.XPath = ODataControl.EntryItems[i].XPath

setXPath

public void setXPath(java.lang.String XPath)
              throws IPWorksSSLException

Provides a way to point to a specific element in the document.

XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML documents.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

The following are possible values for an element accessor:

'name': A particular element name
name[i]: The i-th subelement of the current element with the given name
[i]: The i-th subelement of the current element
[last()]: The last subelement of the current element
[last()-i]: The subelement located at the last location minus i in the current element
name[@attrname="attrvalue"]: The subelement containing a particular value for a given attribute (supports single AND double quotes)
..: The parent of the current element

Example (Setting XPath)

 
 
 
 Document root 
ODataControl.XPath = "/"
 
Specific Element 
ODataControl.XPath = "/root/SubElement1/SubElement2/"
 
i-th Child 
ODataControl.XPath = "/root/SubElement1[i]"
 
Specific EntryItem 
ODataControl.XPath = ODataControl.EntryItems[i].XPath

Throws:: IPWorksSSLException

getXPrefix

public java.lang.String getXPrefix()

The prefix of the current element.

The current element is specified via the XPath property.

getXSubTree

public java.lang.String getXSubTree()

A snapshot of the current element in the document.

The current element is specified via the XPath property. In order for this property to work you must have the {@link ipworksssl.Odatas#config set to true.

getXText

public java.lang.String getXText()

The text of the current element.

The current element is specified via the XPath property.

config

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

Sets or retrieves a ipworksssl.Odatas#config configuration setting.

{@link ipworksssl.Odatas#config Config} is a generic method available in every bean. It is used to set and retrieve {@link ipworksssl.Odatas#config configuration settingsfor the bean.

These 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 {@link ipworksssl.Odatas#config 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 {@link ipworksssl.Odatas#config 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 {@link ipworksssl.Odatas#config Config} method.

OData Configuration Settings

NameAndEmailFormat: Determines how the data of the name and e-mail properties will be formatted
TransferredHeaders: The full set of headers as received from the server

HTTP Configuration Settings

AcceptEncoding: Used to tell the server which types of content encodings the client supports
AllowHTTPCompression: This property enables HTTP compression for receiving data
Authorization: The Authorization string to be sent to the server
BytesTransferred: Contains the number of bytes transferred in the response data
EncodeURL: If set to true the URL will be encoded by the bean
FollowRedirects: Determines what happens when the server issues a redirect
GetOn302Redirect: If set to true the bean will perform a GET on the new location
HTTPVersion: The version of HTTP used by the bean
IfModifiedSince: A date determining the maximum age of the desired document
KeepAlive: Determines whether the HTTP connection is closed after completion of the request
MaxHeaders: Instructs bean to save the amount of headers specified that are returned by the server after a Header event has been fired
MaxHTTPCookies: Instructs bean to save the amount of cookies specified that are returned by the server when a SetCookie event is fired
MaxRedirectAttempts: Limits the number of redirects that are followed in a request
OtherHeaders: Other headers as determined by the user (optional)
ProxyAuthorization: The authorization string to be sent to the proxy server
ProxyAuthScheme: The authorization scheme to be used for the proxy
ProxyPassword: A password if authentication is to be used for the proxy
ProxyPort: Port for the proxy server (default 80)
ProxyServer: Name or IP address of a proxy server (optional)
ProxyUser: A user name if authentication is to be used for the proxy
TransferredDataLimit: The maximum number of incoming bytes to be stored by the bean
TransferredHeaders: The full set of headers as received from the server
UseChunkedEncoding: Enables or Disables HTTP chunked encoding for transfers
ChunkSize: Specifies the chunk size in bytes when using chunked encoding
UsePlatformHTTPClient: Whether or not to use the platform HTTP client
UserAgent: Information about the user agent (browser)
KerberosSPN: The Service Principal Name for the Kerberos Domain Controller

IPPort Configuration Settings

ConnectionTimeout: Sets a separate timeout value for establishing a connection
FirewallAutoDetect: Tells the bean whether or not to automatically detect and use firewall system settings, if available
FirewallHost: Name or IP address of firewall (optional)
FirewallListener: If true, the component binds to a SOCKS firewall as a server (IPPort only)
FirewallPassword: Password to be used if authentication is to be used when connecting through the firewall
FirewallPort: The TCP port for the FirewallHost;
FirewallType: Determines the type of firewall to connect through
FirewallUser: A user name if authentication is to be used connecting through a firewall
KeepAliveTime: The inactivity time in milliseconds before a TCP keep-alive packet is sent
KeepAliveInterval: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received
Linger: When set to True, connections are terminated gracefully
LingerTime: Time in seconds to have the connection linger
LocalHost: The name of the local host through which connections are initiated or accepted
LocalPort: The TCP port in the local host where the bean binds
MaxLineLength: The maximum amount of data to accumulate when no EOL is found
MaxTransferRate: The transfer rate limit in bytes per second
TCPKeepAlive: Determines whether or not the keep alive socket option is enabled
UseIPv6: Whether or not to use IPv6
CloseStreamAfterTransfer: If true, the component will close the upload or download stream after the transfer
TcpNoDelay: Whether or not to delay when sending packets

SSL Configuration Settings

ReuseSSLSession: Determines if the SSL session is reused
SSLCipherStrength: The minimum cipher strength used for bulk encryption
SSLEnabledProtocols: Used to enable/disable the supported security protocols
SSLProvider: The name of the security provider to use
SSLSecurityFlags: Flags that control certificate verification
SSLContextProtocol: The protocol used when getting an SSLContext instance
SSLTrustManagerFactoryAlgorithm: The algorithm to be used to create a TrustManager through TrustManagerFactory
SSLEnabledCipherSuites: The cipher suite to be used in an SSL negotiation
SSLAlgorithmList: A string that controls the cipher algorithms to be used by SSL

Socket Configuration Settings

AbsoluteTimeout: Determines whether timeouts are inactivity timeouts or absolute timeouts
FirewallData: Used to send extra data to the firewall
InBufferSize: The size in bytes of the incoming queue of the socket
OutBufferSize: The size in bytes of the outgoing queue of the socket

Base Configuration Settings

GUIAvailable: Tells the bean whether or not a message loop is available for processing events
UseDaemonThreads: Whether threads created by the bean are daemon threads

Throws:: IPWorksSSLException

createEntry

public void createEntry()
                 throws IPWorksSSLException

Creates a new entry within the specified OData service resource.

The component will use the items contained within EntryProperties to create a new entry within the feed service resource by ServiceRootURI and ResourcePath ( ServiceRootURI / ResourcePath ).

Upon a successful creation, all previous entries contained by the component, prior to the CreateEntry call, will be cleared and replaced with the response entry data. EntryIndex will then be set to 0 (the first entry within the response), populating the EntryAuthor , EntryETag , EntryTitle , EntrySummary , EntryUpdated , EntryLinks , and EntryProperties properties. OtherHeaders will also be cleared and thus will need to be reset accordingly with each call made.

Throws:: IPWorksSSLException

customRequest

public void customRequest(java.lang.String HTTPMethod,
                          java.lang.String URL,
                          java.lang.String postData)
                   throws IPWorksSSLException

Sends a request to the specified URL using the HTTP Method and Post Data provided.

Sends a custom request to the specified URL. The type of request sent is determined by HTTPMethod (e.g. POST) and the data sent is determined by PostData . If a custom request does not require data to be sent, you can simply set the PostData parameter to an empty string. Note, all values specified are taken as entered.

OtherHeaders can be used to specify any additional headers you would like to be sent in the custom request.

The search results are delivered in the TransferredData property, as well as through the Transfer event. The response headers can be retrieved via the TransferredHeaders property as well as through the Header event.

The bean will then attempt to parse the search results. Upon successfully parsing the response, Channel will be set with their associated feed element values and EntryCount will be populated with the total number of entries contained within the feed. EntryIndex will also be set to 1, thus populating EntryProperties .

Throws:: IPWorksSSLException

deleteEntry

public void deleteEntry()
                 throws IPWorksSSLException

Deletes an entry within an OData service resource.

The component will delete the entry, of an OData service resource, specified by ServiceRootURI and ResourcePath ( ServiceRootURI / ResourcePath ).

An "If-Match" header will be sent in the delete request with the value contained within EntryETag .

Upon a successful entry deletion, all previous entries contained by the component, prior to the DeleteEntry call, will be cleared. OtherHeaders will also be cleared and thus will need to be reset accordingly with each call made.

Throws:: IPWorksSSLException

getEntryProperty

public java.lang.String getEntryProperty(java.lang.String XPath)
                                  throws IPWorksSSLException

Get an OData entry property.

This method is intended for extending functionality of the OData bean and will retrieve the value of the entry property specified by XPath . XPath is the XPath of the element or attribute according to the following convention: entry[x]/element@attribute . The @attribute part is optional. When EntryIndex is set to an index greater than or equal to zero, a relative path can also be used: property or property@attribute . When a relative path is specified, the value of the specified XPath will be returned for the entry identified by EntryIndex .

entry[x] is the feed's xth entry (or any other root level child), where the indexer x starts at 1.

property is any child of the properties element, and attribute can be any attribute of that field. If an attribute is not supplied, the GetEntryProperty method will return the text portion of property . For example:

 ODataControl.GetEntryProperty("entry[5]/content/properties/ID")
        ODataControl.GetEntryProperty("entry[5]/content/properties/ID@type")

Here is an example using a relative path to retrieve properties of the first feed entry:

 ODataControl.EntryIndex = 1
        ODataControl.GetEntryProperty("ID")
        ODataControl.GetEntryProperty("ID@type")
        ODataControl.GetEntryProperty("Address/State")

Throws:: IPWorksSSLException

getSchema

public void getSchema()
               throws IPWorksSSLException

Retrieves the schema for a service.

This method will retrieve the schema (metadata document) of the service specified by ServiceRootURI .

Upon successful retrieval of the schema, you can set SchemaEntityIndex to retrieve the names of the entities contained within the schema along with their keys, properties, and navigation properties.

If you wish to retrieve additional details about the schema, they can be retrieved via XPath .

Throws:: IPWorksSSLException

hasXPath

public boolean hasXPath(java.lang.String xpath)
                 throws IPWorksSSLException

Determines whether a specific element exists in the document.

You can use the HasXPath method to determine if a particular XPath exists before setting it with XPath .

The XPath property implements a subset of the XML XPath specification, allowing you to point to specific elements in the document.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

Setting the XPath property to an XPath that does not exist will cause an error.

Throws:: IPWorksSSLException

queryService

public void queryService()
                  throws IPWorksSSLException

Queries an OData service using the specified parameters.

Queries an OData feed specified by ServiceRootURI and ResourcePath ( ServiceRootURI / ResourcePath ) using the query options specified in the Query*** properties and OtherQueryOptions . To fetch an OData feed, without performing any filtering, you can leave Query*** and OtherQueryOptions empty and call QueryService .

The query results are delivered in the TransferredData property, as well as through the Transfer event. The response headers can be retrieved via the ParsedHeaders property as well as through the Header event.

The bean will then attempt to parse the query results. Upon successfully parsing the response, Channel will be set with their associated feed element values and EntryCount will be populated with the total number of entries contained within the feed. EntryIndex will also be set to 1, thus populating EntryAuthor , EntryETag , EntryTitle , EntrySummary , EntryUpdated , EntryLinks , EntryProperties and ResourcePath .

Throws:: IPWorksSSLException

reset

public void reset()
           throws IPWorksSSLException

Reset all properties of the bean.

The Reset method resets all properties to the bean's default settings. This is an easy way to clear all of the property values before repopulating the OData feed.

Throws:: IPWorksSSLException

setEntryProperty

public void setEntryProperty(java.lang.String XPath,
                             java.lang.String value)
                      throws IPWorksSSLException

Set an OData entry property.

This method is intended for extending functionality of the OData bean and will set the value of the entry property (specified by XPath ) to the specified Value . Therefore the value of the corresponding property will be updated within EntryProperties .

XPath is the XPath of the element or attribute according to the following convention: entry[x]/element . When EntryIndex is set to an index greater than or equal to zero, a relative path can also be used: property . When a relative path is specified, the bean will use the specified EntryIndex along with the property specified to update the EntryProperty value.

entry[x] is the feed's xth entry (or any other root level child), where the indexer x starts at 1.

property is any child of the properties element. For example:

 ODataControl.SetEntryProperty("entry[5]/content/properties/Name", "MyNewName")

Here is an example using a relative path to retrieve properties of the first feed entry:

 ODataControl.EntryIndex = 1
        ODataControl.SetEntryProperty("Name", "MyNewName")
        ODataControl.SetEntryProperty("Address/State", "NC")

Throws:: IPWorksSSLException

setSchemaEntity

public void setSchemaEntity(java.lang.String name)
                     throws IPWorksSSLException

Sets the schema entity.

The bean will set the schema entity to the Name specified. Once set, you can view the keys (via SchemaKeys ), properties (via SchemaProperty ) and navigation properties (via SchemaAssociation ) contained within the specified entity.

Throws:: IPWorksSSLException

setSchemaProperty

public void setSchemaProperty(java.lang.String name)
                       throws IPWorksSSLException

Sets the schema property.

The bean will set the schema property to the Name specified. Once set, you can view the details of the property (via SchemaProperty ) along with the complex type details (via SchemaTypeField ); provided that the property is derived from the complex type.

Throws:: IPWorksSSLException

setSchemaType

public void setSchemaType(java.lang.String name)
                   throws IPWorksSSLException

Sets the schema type.

The bean will set the schema type to the Name specified. Once set, you can view the details of the complex type (via SchemaTypeField ).

Throws:: IPWorksSSLException

updateEntry

public void updateEntry()
                 throws IPWorksSSLException

Update an OData entry.

The bean will update the OData entry specified by ServiceRootURI and ResourcePath ( ServiceRootURI / ResourcePath ). It will update the OData entry with the elements specified by EntryProperties .

Upon a successful update, all previous entries contained by the component, prior to the UpdateEntry call, will be cleared and replaced with the response entry data. EntryIndex will then be set to 0 (the first entry within the response), populating the EntryAuthor , EntryETag , EntryTitle , EntrySummary , EntryUpdated , EntryLinks , EntryProperties and ResourcePath properties. OtherHeaders will also be cleared and thus will need to be reset accordingly with each call made.

Throws:: IPWorksSSLException

updateProperty

public void updateProperty(java.lang.String XPath,
                           java.lang.String value)
                    throws IPWorksSSLException

Update an OData entry property.

The bean will update the OData entry specified by ServiceRootURI and ResourcePath ( ServiceRootURI / ResourcePath ). It will update only the single entry property specified by XPath with the specified Value .

Upon a successful update, all previous entries contained by the component, prior to the UpdateProperty call, will be cleared and replaced with the response entry data. EntryIndex will then be set to 0 (the first entry within the response), populating the EntryAuthor , EntryETag , EntryTitle , EntrySummary , EntryUpdated , EntryLinks , EntryProperties and ResourcePath . OtherHeaders will also be cleared and thus will need to be reset accordingly with each call made.

Throws:: IPWorksSSLException

addOdatasEventListener

public void addOdatasEventListener(OdatasEventListener l)
                            throws java.util.TooManyListenersException

Throws:: java.util.TooManyListenersException

removeOdatasEventListener

public void removeOdatasEventListener(OdatasEventListener l)

Package

Class

Tree

Deprecated

Index

Help

IP*Works! SSL V9

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

ipworksssl Class Odatas

authBasic

authDigest

authProprietary

authNone

authNtlm

authNegotiate

authOAuth

Odatas

Odatas

getAuthorization

setAuthorization

getAuthScheme

setAuthScheme

getChannel

setChannel

getCookies

getEntryAuthor

setEntryAuthor

getEntryCount

getEntryETag

setEntryETag

getEntryId

setEntryId

getEntryIndex

setEntryIndex

getEntryLinks

getEntryProperties

getEntrySummary

setEntrySummary

getEntryTitle

setEntryTitle

getEntryUpdated

getEntryXML

setEntryXML

getFirewall

setFirewall

isIdle

getLocalHost

setLocalHost

getOtherHeaders

setOtherHeaders

getOtherQueryOptions

setOtherQueryOptions

getParsedHeaders

getPassword

setPassword

getProxy

setProxy

getQueryFilter

setQueryFilter

getQueryOrderBy

setQueryOrderBy

getQuerySelect

setQuerySelect

getQuerySkip

setQuerySkip

getQuerySkipToken

setQuerySkipToken

getQueryTop

setQueryTop

getResourcePath

setResourcePath

getSchemaAssociation

getSchemaAssociationCount

getSchemaAssociationIndex

setSchemaAssociationIndex

getSchemaEntity

getSchemaEntityCount

getSchemaEntityIndex

setSchemaEntityIndex

getSchemaKeys

getSchemaProperty

getSchemaPropertyCount

getSchemaPropertyIndex

setSchemaPropertyIndex

getSchemaTypeField

getSchemaTypeFieldCount

getSchemaTypeFieldIndex

setSchemaTypeFieldIndex

ipworksssl
Class Odatas