|
IP*Works! V9 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectipworks.Dns
public class Dns
The DNS bean is used to query DNS for record information.
The DNS bean queries a DNS server for records as specified in RFC
1035 and other relevant RFCs. The bean property QueryType
indicates the record to be queried. Calling Query
will
initiate the query.
Once the query is complete, a single Response
event
will fire and the record properties will be filled. StatusCode
is the server's success or fail code, and Status
is a standard
string interpretation of the code.
The records are contained in the Records
collection
. The programming
interface is designed to
allow a full walk of the records in the DNS response, including provisions for
handling new record types.
The bean operates synchronously by default (waits for a response before
returning control to the caller), however, the bean may also operate
asynchronously (return control immediately), by setting Timeout
to 0.
Please refer to the Timeout
property for more information.
Field Summary | |
---|---|
static int |
qtAAAA
|
static int |
qtAddress
|
static int |
qtAFSDB
|
static int |
qtCERT
|
static int |
qtCName
|
static int |
qtHostInfo
|
static int |
qtISDN
|
static int |
qtMailBox
|
static int |
qtMailGroup
|
static int |
qtMailInfo
|
static int |
qtMD
|
static int |
qtMF
|
static int |
qtMR
|
static int |
qtMX
|
static int |
qtNAPTR
|
static int |
qtNS
|
static int |
qtNULL
|
static int |
qtPointer
|
static int |
qtRevLookup
|
static int |
qtRP
|
static int |
qtRT
|
static int |
qtSOA
|
static int |
qtSRV
|
static int |
qtText
|
static int |
qtWKS
|
static int |
qtX25
|
static int |
rsAdditionalRecordsSection
|
static int |
rsAnswerSection
|
static int |
rsNameServerSection
|
Constructor Summary | |
---|---|
Dns()
Creates an instance of Dns Bean. |
|
Dns(java.lang.String runtimeLicense)
Creates an instance of Dns Bean with specified run-time license. |
Method Summary | |
---|---|
void |
addDnsEventListener(DnsEventListener l)
|
java.lang.String |
config(java.lang.String configurationString)
Sets or retrieves a configuration setting. |
void |
doEvents()
Processes events from the internal message queue. |
int |
getDNSPort()
The port to connect to on the DNS Server. |
java.lang.String |
getDNSServer()
The address of the DNS server. |
java.lang.String |
getFieldValue(int recordIndex,
java.lang.String fieldName)
Get the value of the field indicated from a record. |
java.lang.String |
getLocalHost()
The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
int |
getQueryType()
The record type to query. |
DNSRecordList |
getRecords()
Collection of records in the last response. |
int |
getRecordSource()
The source of records provided in the Records collection
. |
int |
getRequestId()
The ID of the current DNS request. |
java.lang.String |
getStatus()
A standard string interpretation of StatusCode . |
int |
getStatusCode()
The success or error code for the DNS query. |
int |
getTimeout()
A timeout for the bean. |
void |
interrupt()
Interrupt the current method. |
boolean |
isIdle()
The current status of the component. |
boolean |
isRecursive()
Determines whether to ask the DNSServer to recursively query other servers. |
void |
query(java.lang.String domain)
Query a Domain. |
void |
removeDnsEventListener(DnsEventListener l)
|
void |
setDNSPort(int DNSPort)
The port to connect to on the DNS Server. |
void |
setDNSServer(java.lang.String DNSServer)
The address of the DNS server. |
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 |
setQueryType(int queryType)
The record type to query. |
void |
setRecordSource(int recordSource)
The source of records provided in the Records collection
. |
void |
setRecursive(boolean recursive)
Determines whether to ask the DNSServer to recursively query other servers. |
void |
setRequestId(int requestId)
The ID of the current DNS request. |
void |
setTimeout(int timeout)
A timeout for the bean. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int qtAddress
public static final int qtNS
public static final int qtMD
public static final int qtMF
public static final int qtCName
public static final int qtSOA
public static final int qtMailBox
public static final int qtMailGroup
public static final int qtMR
public static final int qtNULL
public static final int qtWKS
public static final int qtPointer
public static final int qtHostInfo
public static final int qtMailInfo
public static final int qtMX
public static final int qtText
public static final int qtRP
public static final int qtAFSDB
public static final int qtX25
public static final int qtISDN
public static final int qtRT
public static final int qtAAAA
public static final int qtSRV
public static final int qtNAPTR
public static final int qtCERT
public static final int qtRevLookup
public static final int rsAnswerSection
public static final int rsNameServerSection
public static final int rsAdditionalRecordsSection
Constructor Detail |
---|
public Dns()
public Dns(java.lang.String runtimeLicense)
Method Detail |
---|
public int getDNSPort()
This property contains the port to connect to on the DNS Server. A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.
public void setDNSPort(int DNSPort) throws IPWorksException
This property contains the port to connect to on the DNS Server. A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.
IPWorksException
public java.lang.String getDNSServer()
This property contains the address of the DNS server. The bean attempts to find the default DNS server for the machine where it is installed, and provide it in the DNSServer
property. You may later change it to any particular DNS server you want to query.
While any internet host running a DNS service will suffice, it is preferable to use either the DNS server for your network or the DNS server for the domain which you are querying.
If the bean cannot determine the default DNS server address, the property value will be an empty string.
NOTE: Automatic discovery of the default DNS server is not supported in the Java edition.
public void setDNSServer(java.lang.String DNSServer) throws IPWorksException
This property contains the address of the DNS server. The bean attempts to find the default DNS server for the machine where it is installed, and provide it in the DNSServer
property. You may later change it to any particular DNS server you want to query.
While any internet host running a DNS service will suffice, it is preferable to use either the DNS server for your network or the DNS server for the domain which you are querying.
If the bean cannot determine the default DNS server address, the property value will be an empty string.
NOTE: Automatic discovery of the default DNS server is not supported in the Java edition.
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 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 int getQueryType()
Before a query is attempted, this property must be set to the desired record type. The records are defined as follows:
public void setQueryType(int queryType) throws IPWorksException
Before a query is attempted, this property must be set to the desired record type. The records are defined as follows:
IPWorksException
public DNSRecordList getRecords()
Once the query is complete, a single Response
event will fire, and
the following properties will contain the results:
StatusCode
Status
StatusCode
.
Records
Records
in the last DNS response.
RecordSource
This collection is indexed from 0 to size - 1.
Example (Loop through all fields of all records)
For i = 0 to DNSControl.Records.Count - 1
\011For j = 0 to DNSControl.Records.FieldCount(i) - 1
\011\011DNSControl.Records(i).FieldIndex = j
\011\011DoSomethingWith(DNSControl.Records(i).FieldName, DNSControl.Records(i).FieldValue)
\011Next j
Next i
public int getRecordSource()
Records
collection
.
This property contains the source of records provided in the Records
collection
and can have one of the following values:
public void setRecordSource(int recordSource) throws IPWorksException
Records
collection
.
This property contains the source of records provided in the Records
collection
and can have one of the following values:
IPWorksException
public boolean isRecursive()
DNSServer
to recursively query other servers.
If this property is true, the component will tell the DNS server to perform the query recursively. This means that if the DNS server does not have information about the Domain being queried, it will send the request to another DNS server.
public void setRecursive(boolean recursive) throws IPWorksException
DNSServer
to recursively query other servers.
If this property is true, the component will tell the DNS server to perform the query recursively. This means that if the DNS server does not have information about the Domain being queried, it will send the request to another DNS server.
IPWorksException
public int getRequestId()
This property is the identifier of the request that generated the current response values. Each time the bean makes a DNS query, it generates a unique request identifier to track the response.
If a custom value is needed for RequestId
, the property must be set before sending a request. The bean increments RequestId
automatically after sending each request.
NOTE: The bean throws an exception when a value that is not between 1 and 32,767 is specified.
public void setRequestId(int requestId) throws IPWorksException
This property is the identifier of the request that generated the current response values. Each time the bean makes a DNS query, it generates a unique request identifier to track the response.
If a custom value is needed for RequestId
, the property must be set before sending a request. The bean increments RequestId
automatically after sending each request.
NOTE: The bean throws an exception when a value that is not between 1 and 32,767 is specified.
IPWorksException
public java.lang.String getStatus()
StatusCode
.
This property contains a standard string interpretation of StatusCode
. For a list of valid error codes and their descriptions, please refer to the Error Messages section.
public int getStatusCode()
This property contains the success or error code for the DNS query. For a list of valid error codes and their descriptions, please refer to the Error Messages section.
public int getTimeout()
If the Timeout
property is set to 0, all operations return
immediately, potentially failing with an error if they can't be
completed immediately.
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 return
immediately, potentially failing with an error if they can't be
completed immediately.
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 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.
Query
and then queried after the operation completes. For instance: DNS.Config("DNSProtocolLog=true");
DNS.Query("www.nsoftware.com");
string myLog = DNS.Config("DNSProtocolLog");
The default value is False and no log will be constructed.
Note: This setting is only available in Windows.
CaptureIPPacketInfo
is set to true, then this will be populated with the packet's destination address when a packet is received.
This information will be accessible in the DataIn event.Note: This setting is only available in Windows.
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.
Active
property or it will have no effect.The default value for this setting is False.
UseConnection
specifies whether the bean
should use a connected socket or not. The connection is
defined as an association in between the local address/port
and the remote address/port. As such, this
is not a connection in the traditional TCP sense. What it
means is only that the bean will send and receive data
only to and from the specified destination.The default value for this setting is False.
UseConnection
must be True to use this setting. This option allows you to specify an arbitrary DSCP value
between 0 and 63. The default is 0. When set to the default value the component will not set a DSCP value.Note: This setting uses the qWAVE API is only available on Windows 7, Windows Server 2008 R2, and later.
UseConnection
must be True to use this setting.
You may specify either the text or integer values: BestEffort (0), Background (1), ExcellentEffort (2), AudioVideo (3), Voice (4), and Control (5).Note: This setting uses the qWAVE API which is only available on Windows Vista and Windows Server 2008 or above.
Note: QOSTrafficType must be set before setting Active
to true.
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 java.lang.String getFieldValue(int recordIndex, java.lang.String fieldName) throws IPWorksException
This method will get the value of the DNS record field specified by FieldName from the DNS record at RecordIndex . If no such field exists for that record type, the component throws an exception.
IPWorksException
public void interrupt() throws IPWorksException
If there is no method in progress, Interrupt
simply returns, doing nothing.
IPWorksException
public void query(java.lang.String domain) throws IPWorksException
This method will query the host Domain for any records of the type in QueryType
. After the query, RequestId
is the identifier corresponding to the request.
Once the query is complete, a single Response
event will fire, and
the following properties will contain the results:
StatusCode
Status
StatusCode
.
Records
Records
in the last DNS response.
RecordSource
IPWorksException
public void addDnsEventListener(DnsEventListener l) throws java.util.TooManyListenersException
java.util.TooManyListenersException
public void removeDnsEventListener(DnsEventListener l)
|
IP*Works! V9 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |