Package jcifs

Interface NameServiceClient

All Known Implementing Classes:

NameServiceClientImpl

public interface NameServiceClient

This is an internal API for resolving names

Author:

mbechler

Method Summary

Modifier and Type	Method	Description
Address[]	getAllByName(String hostname, boolean possibleNTDomainOrWorkgroup)	Lookup addresses for the given hostname.
Address	getByName(String hostname)	Determines the address of a host given it's host name.
Address	getByName(String hostname, boolean possibleNTDomainOrWorkgroup)	Lookup hostname and return it's UniAddress.
NetbiosAddress	getLocalHost()
NetbiosName	getLocalName()
NetbiosAddress[]	getNbtAllByAddress(String host)	Retrieve all addresses of a host by it's address.
NetbiosAddress[]	getNbtAllByAddress(String host, int type, String scope)	Retrieve all addresses of a host by it's address.
NetbiosAddress[]	getNbtAllByAddress(NetbiosAddress addr)	Retrieve all addresses of a host by it's address.
NetbiosAddress[]	getNbtAllByName(String host, int type, String scope, InetAddress svr)	Retrieve all addresses of a host by it's name.
NetbiosAddress	getNbtByName(String host)	Determines the address of a host given it's host name.
NetbiosAddress	getNbtByName(String host, int type, String scope)	Determines the address of a host given it's host name.
NetbiosAddress	getNbtByName(String host, int type, String scope, InetAddress svr)	Determines the address of a host given it's host name.
NetbiosAddress[]	getNodeStatus(NetbiosAddress nbtAddress)
NetbiosName	getUnknownName()

Method Detail

getLocalHost

NetbiosAddress getLocalHost()

Returns:

local host address

getLocalName

NetbiosName getLocalName()

Returns:

the local host name

getUnknownName

NetbiosName getUnknownName()

Returns:

the unknown name

getNbtAllByAddress

NetbiosAddress[] getNbtAllByAddress(NetbiosAddress addr)
                             throws UnknownHostException

Retrieve all addresses of a host by it's address. NetBIOS hosts can have many names for a given IP address. The name and IP address make the NetBIOS address. This provides a way to retrieve the other names for a host with the same IP address.

Parameters:

addr - the address to query

Returns:

resolved addresses

Throws:

UnknownHostException - if address cannot be resolved

getNbtAllByAddress

NetbiosAddress[] getNbtAllByAddress(String host,
                                    int type,
                                    String scope)
                             throws UnknownHostException

Retrieve all addresses of a host by it's address. NetBIOS hosts can have many names for a given IP address. The name and IP address make the NetBIOS address. This provides a way to retrieve the other names for a host with the same IP address. See getByName(java.lang.String, boolean) for a description of type and scope.

Parameters:

host - hostname to lookup all addresses for

type - the hexcode of the name

scope - the scope of the name

Returns:

resolved addresses

Throws:

UnknownHostException - if there is an error resolving the name

getNbtAllByAddress

NetbiosAddress[] getNbtAllByAddress(String host)
                             throws UnknownHostException

Retrieve all addresses of a host by it's address. NetBIOS hosts can have many names for a given IP address. The name and IP address make the NetBIOS address. This provides a way to retrieve the other names for a host with the same IP address.

Parameters:

host - hostname to lookup all addresses for

Returns:

resolved addresses

Throws:

UnknownHostException - if there is an error resolving the name

getNbtAllByName

NetbiosAddress[] getNbtAllByName(String host,
                                 int type,
                                 String scope,
                                 InetAddress svr)
                          throws UnknownHostException

Retrieve all addresses of a host by it's name.

Parameters:

host - hostname to lookup all addresses for

type - the hexcode of the name

scope - the scope of the name

svr - server to query

Returns:

the resolved addresses

Throws:

UnknownHostException

getNbtByName

NetbiosAddress getNbtByName(String host,
                            int type,
                            String scope,
                            InetAddress svr)
                     throws UnknownHostException

Determines the address of a host given it's host name. NetBIOS names also have a type. Types(aka Hex Codes) are used to distinguish the various services on a host. Here is a fairly complete list of NetBIOS hex codes. Scope is not used but is still functional in other NetBIOS products and so for completeness it has been implemented. A scope of null or "" signifies no scope. The additional svr parameter specifies the address to query. This might be the address of a specific host, a name server, or a broadcast address.

Parameters:

host - the name to resolve

type - the hex code of the name

scope - the scope of the name

svr - server to query

Returns:

the resolved address

Throws:

UnknownHostException - if there is an error resolving the name

getNbtByName

NetbiosAddress getNbtByName(String host,
                            int type,
                            String scope)
                     throws UnknownHostException

Determines the address of a host given it's host name. NetBIOS names also have a type. Types(aka Hex Codes) are used to distinguish the various services on a host. Here is a fairly complete list of NetBIOS hex codes. Scope is not used but is still functional in other NetBIOS products and so for completeness it has been implemented. A scope of null or "" signifies no scope.

Parameters:

host - the name to resolve

type - the hex code of the name

scope - the scope of the name

Returns:

the resolved address

Throws:

UnknownHostException - if there is an error resolving the name

getNbtByName

NetbiosAddress getNbtByName(String host)
                     throws UnknownHostException

Determines the address of a host given it's host name. The name can be a NetBIOS name like "freto" or an IP address like "192.168.1.15". It cannot be a DNS name; the analygous UniAddress or InetAddress getByName methods can be used for that.

Parameters:

host - hostname to resolve

Returns:

the resolved address

Throws:

UnknownHostException - if there is an error resolving the name

getNodeStatus

NetbiosAddress[] getNodeStatus(NetbiosAddress nbtAddress)
                        throws UnknownHostException

Parameters:

nbtAddress -

Returns:

the node status responses

Throws:

UnknownHostException

getAllByName

Address[] getAllByName(String hostname,
                       boolean possibleNTDomainOrWorkgroup)
                throws UnknownHostException

Lookup addresses for the given hostname.

Parameters:

hostname -

possibleNTDomainOrWorkgroup -

Returns:

found addresses

Throws:

UnknownHostException

getByName

Address getByName(String hostname,
                  boolean possibleNTDomainOrWorkgroup)
           throws UnknownHostException

Lookup hostname and return it's UniAddress. If the possibleNTDomainOrWorkgroup parameter is true an additional name query will be performed to locate a master browser.

Parameters:

hostname -

possibleNTDomainOrWorkgroup -

Returns:

the first resolved address

Throws:

UnknownHostException

getByName

Address getByName(String hostname)
           throws UnknownHostException

Determines the address of a host given it's host name. The name can be a machine name like "jcifs.samba.org", or an IP address like "192.168.1.15".

Parameters:

hostname - NetBIOS or DNS hostname to resolve

Returns:

the found address

Throws:

UnknownHostException - if there is an error resolving the name