org.ws4d.java.types

Class SearchParameter

java.lang.Object

org.ws4d.java.types.SearchParameter

public class SearchParameter
extends java.lang.Object

A collection of search criteria used when searching for devices or services.

See Also:

Search

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchParameter.SearchSetEntry

Field Summary

Fields

Modifier and Type	Field and Description
static org.ws4d.java.types.SearchParameter.EmptySearchParameter	EMPTY_SEARCH_PARAMETER

Constructor Summary

Constructors

Constructor and Description
SearchParameter()
SearchParameter(DiscoveryBinding binding)

Method Summary

Modifier and Type	Method and Description
void	addComManIdForLocalSearch(java.lang.String comManId)
void	allowAllForLocalSearch()
void	denyAllForLocalSearch()
boolean	equals(java.lang.Object obj)
HashMap	getComMan2DeviceTypes()
HashMap	getComMan2ServiceTypes()
CredentialInfo	getCredentialInfoForLocalSearch() Returns the credentialInfo to use for local search.
QNameSet	getDeviceTypes(java.lang.String comManId) Gets device port types of device to discover.
java.lang.Object	getReferenceObject() Gets reference object.
ProbeScopeSet	getScopes() Gets list of scopes of device to discover.
HashMap	getSearchMap() Returns the search map to use when discovering devices and services.
QNameSet	getServiceTypes(java.lang.String comManId) Gets service port types of service to discover.
boolean	hasDeviceCriteria()
int	hashCode()
boolean	hasServiceCriteria()
boolean	isExceptRemoteSearch()
boolean	isLocalSearch()
boolean	matchesDeviceTypes(HashMap otherComMan2deviceType)
static boolean	matchesDeviceTypes(HashMap comMan2searchTypes, HashMap types)
static boolean	matchesDeviceTypes(QNameSet searchTypes, QNameSet types, java.lang.String comManId)
boolean	matchesDeviceTypes(QNameSet deviceTypes, java.lang.String comManId)
static boolean	matchesScopes(ScopeSet searchScopes, ScopeSet deviceScopes, java.lang.String comManId)
boolean	matchesScopes(ScopeSet deviceScopes, java.lang.String comManId)
boolean	matchesSearch(MessageWithDiscoveryData message, java.lang.String comManId) Checks if the device sending the discovery message matches the searched device port types and scopes, which are part of the searchParameter.
boolean	matchesSearchMap(HashMap inDiscoveryDomains)
static boolean	matchesSearchMap(HashMap comMan2searchSet, HashSet localComManIdsToAccept, HashMap inDiscoveryDomains)
static boolean	matchesSearchMap(HashMap comMan2searchSet, HashSet localComManIdsToAccept, ProtocolInfo protocolInfo, DataStructure outgoingDiscoveryInfos)
boolean	matchesSearchMap(ProtocolInfo protocolInfo, DataStructure outgoingDiscoveryInfos)
boolean	matchesServiceTypes(HashMap comMan2inTypes)
static boolean	matchesServiceTypes(HashMap searchTypes, HashMap serviceTypes)
static boolean	matchesServiceTypes(QNameSet searchTypes, QNameSet serviceTypes, java.lang.String comManId)
boolean	matchesServiceTypes(QNameSet inTypes, java.lang.String comManId)
void	removeComManIdForLocalSearch(java.lang.String comManId)
void	setCredentialInfoForLocalSearch(CredentialInfo credentialInfoForLocalSearch) Sets the credentialInfo to use for local search.
void	setDeviceTypes(QNameSet deviceTypes, java.lang.String comManId) Sets device port types of device to discover.
void	setExceptRemoteSearch(boolean exceptRemoteSearch)
void	setReferenceObject(java.lang.Object referenceObject) Sets reference object.
void	setScopes(ProbeScopeSet scopes) Sets list of scopes of device to discover.
void	setSearchSet(DataStructure searchSet)
void	setSearchSet(DataStructure searchSet, java.lang.String comManId) Sets the search map for the discovery process.
void	setServiceTypes(QNameSet serviceTypes, java.lang.String comManId) Sets service port types of service to discover.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY_SEARCH_PARAMETER

public static final org.ws4d.java.types.SearchParameter.EmptySearchParameter EMPTY_SEARCH_PARAMETER

Constructor Detail

SearchParameter

public SearchParameter()

SearchParameter

public SearchParameter(DiscoveryBinding binding)

Method Detail

matchesDeviceTypes

public static boolean matchesDeviceTypes(QNameSet searchTypes,
                                         QNameSet types,
                                         java.lang.String comManId)

matchesDeviceTypes

public static boolean matchesDeviceTypes(HashMap comMan2searchTypes,
                                         HashMap types)

matchesScopes

public static boolean matchesScopes(ScopeSet searchScopes,
                                    ScopeSet deviceScopes,
                                    java.lang.String comManId)

matchesSearchMap

public static boolean matchesSearchMap(HashMap comMan2searchSet,
                                       HashSet localComManIdsToAccept,
                                       HashMap inDiscoveryDomains)

matchesSearchMap

public static boolean matchesSearchMap(HashMap comMan2searchSet,
                                       HashSet localComManIdsToAccept,
                                       ProtocolInfo protocolInfo,
                                       DataStructure outgoingDiscoveryInfos)

matchesServiceTypes

public static boolean matchesServiceTypes(QNameSet searchTypes,
                                          QNameSet serviceTypes,
                                          java.lang.String comManId)

matchesServiceTypes

public static boolean matchesServiceTypes(HashMap searchTypes,
                                          HashMap serviceTypes)

hasDeviceCriteria

public boolean hasDeviceCriteria()

hasServiceCriteria

public boolean hasServiceCriteria()

matchesDeviceTypes

public boolean matchesDeviceTypes(HashMap otherComMan2deviceType)

matchesDeviceTypes

public boolean matchesDeviceTypes(QNameSet deviceTypes,
                                  java.lang.String comManId)

matchesScopes

public boolean matchesScopes(ScopeSet deviceScopes,
                             java.lang.String comManId)

matchesSearchMap

public boolean matchesSearchMap(HashMap inDiscoveryDomains)

matchesSearchMap

public boolean matchesSearchMap(ProtocolInfo protocolInfo,
                                DataStructure outgoingDiscoveryInfos)

matchesServiceTypes

public boolean matchesServiceTypes(HashMap comMan2inTypes)

matchesServiceTypes

public boolean matchesServiceTypes(QNameSet inTypes,
                                   java.lang.String comManId)

matchesSearch

public boolean matchesSearch(MessageWithDiscoveryData message,
                             java.lang.String comManId)

Checks if the device sending the discovery message matches the searched device port types and scopes, which are part of the searchParameter. To match the device both the port types and the scopes must be part of the device.

Parameters:

message - Discovery message of device.

Returns:

true - if both the given device port types and scopes are part of the device.

getCredentialInfoForLocalSearch

public CredentialInfo getCredentialInfoForLocalSearch()

Returns the credentialInfo to use for local search.

Returns:

credentialInfo for local search

setCredentialInfoForLocalSearch

public void setCredentialInfoForLocalSearch(CredentialInfo credentialInfoForLocalSearch)

Sets the credentialInfo to use for local search.

Parameters:

credentialInfoForLocalSearch - the credentialInfo to set

getSearchMap

public HashMap getSearchMap()

Returns the search map to use when discovering devices and services. A search map is a data structure of SearchParameter.SearchSetEntry elements. Each element determines one or more technologies and physical or virtual interfaces of the local machine within those technologies, which should be carried out over a search/discovery process.

Returns:

the search map for the search process

isExceptRemoteSearch

public boolean isExceptRemoteSearch()

setExceptRemoteSearch

public void setExceptRemoteSearch(boolean exceptRemoteSearch)

addComManIdForLocalSearch

public void addComManIdForLocalSearch(java.lang.String comManId)

removeComManIdForLocalSearch

public void removeComManIdForLocalSearch(java.lang.String comManId)

allowAllForLocalSearch

public void allowAllForLocalSearch()

denyAllForLocalSearch

public void denyAllForLocalSearch()

isLocalSearch

public boolean isLocalSearch()

setSearchSet

public void setSearchSet(DataStructure searchSet,
                         java.lang.String comManId)

Sets the search map for the discovery process.

Parameters:

searchMap - the search map to use, if null, a default search map will be used

setSearchSet

public void setSearchSet(DataStructure searchSet)

getComMan2DeviceTypes

public HashMap getComMan2DeviceTypes()

getDeviceTypes

public QNameSet getDeviceTypes(java.lang.String comManId)

Gets device port types of device to discover.

Returns:

device port type.

setDeviceTypes

public void setDeviceTypes(QNameSet deviceTypes,
                           java.lang.String comManId)

Sets device port types of device to discover.

Parameters:

deviceTypes - device port types.

getScopes

public ProbeScopeSet getScopes()

Gets list of scopes of device to discover.

Returns:

list of scopes.

setScopes

public void setScopes(ProbeScopeSet scopes)

Sets list of scopes of device to discover.

Parameters:

scopes - list of scopes.

getServiceTypes

public QNameSet getServiceTypes(java.lang.String comManId)

Gets service port types of service to discover.

Returns:

service port types.

getComMan2ServiceTypes

public HashMap getComMan2ServiceTypes()

setServiceTypes

public void setServiceTypes(QNameSet serviceTypes,
                            java.lang.String comManId)

Sets service port types of service to discover. If no device filters are set, all devices are discovered. Later on the discovered services all filtered.

Parameters:

serviceTypes - service port types.

getReferenceObject

public java.lang.Object getReferenceObject()

Gets reference object.

Returns:

reference object.

setReferenceObject

public void setReferenceObject(java.lang.Object referenceObject)

Sets reference object. The reference object can include data, which is important for the further handling of the discovered devices or services.

Parameters:

referenceObject -

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object