com.esri.arcgis.search
Class SearchServer

java.lang.Object
  com.esri.arcgis.search.SearchServer

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISearchServer, ISearchServerAdmin, IServerObject, ILogSupport, IObjectActivate, IObjectConstruct, IRequestHandler, IRequestHandler2, ISupportErrorInfo, Serializable

public class SearchServer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISearchServer, ISearchServerAdmin, IObjectConstruct, IRequestHandler, IRequestHandler2, IObjectActivate, ILogSupport, ISupportErrorInfo, IServerObject

.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.system.IRequestHandler

IID, IID46a0e2ea_3b64_4a46_bd78_88a1660f35bb, xxDummy

Fields inherited from interface com.esri.arcgis.system.IObjectActivate

IID, IIDe3b78022_143e_4e61_9099_ed319ec061e7, xxDummy

Constructor Summary

SearchServer()
Constructs a SearchServer using ArcGIS Engine.

SearchServer(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SearchServer theSearchServer = (SearchServer) obj;

Method Summary

void	activate() Activates the object.
void	construct(IPropertySet props) Two phase object construction.
void	deactivate() Deactivates the object.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
String	getConfigurationName() Name of the server object configuration that defines the server object.
IStringArray	getDataSourceList() The list of dataSource path.
IIndexingOptions	getIndexingOptions() The indexing options.
IIndexingStatus	getIndexingStatus() The indexing status.
String	getSearchIndexLocation() Search index location.
String	getTypeName() Type of the server object (MapServer or GeocodeServer).
byte[]	handleBinaryRequest(byte[] request) Handles a binary request.
byte[]	handleBinaryRequest2(String capabilities, byte[] request) Handles a binary request with explicit capabilities.
String	handleStringRequest(String capabilities, String request) Handles a SOAP string request.
int	hashCode() the hashcode for this object
void	initLogging(ILog log) Initializes an object with a log.
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	registerDataSource(IDataSourceConfiguration dataSourceConfiguration) Register data source to index.
void	setIndexingOptions(IIndexingOptions pIndexingOptions) The indexing options.
void	unregisterDataSource(String path) Unregister Data Source.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

SearchServer

public SearchServer()
             throws IOException,
                    UnknownHostException

Constructs a SearchServer using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

SearchServer

public SearchServer(Object obj)
             throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SearchServer theSearchServer = (SearchServer) obj;

Construct a SearchServer using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to SearchServer.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

registerDataSource

public void registerDataSource(IDataSourceConfiguration dataSourceConfiguration)
                        throws IOException,
                               AutomationException

Register data source to index.

Specified by:

registerDataSource in interface ISearchServer

Parameters:

dataSourceConfiguration - A reference to a com.esri.arcgis.search.IDataSourceConfiguration (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

unregisterDataSource

public void unregisterDataSource(String path)
                          throws IOException,
                                 AutomationException

Unregister Data Source.

Specified by:

unregisterDataSource in interface ISearchServer

Parameters:

path - The path (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataSourceList

public IStringArray getDataSourceList()
                               throws IOException,
                                      AutomationException

The list of dataSource path.

Specified by:

getDataSourceList in interface ISearchServer

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIndexingOptions

public IIndexingOptions getIndexingOptions()
                                    throws IOException,
                                           AutomationException

The indexing options.

Specified by:

getIndexingOptions in interface ISearchServer

Returns:

A reference to a com.esri.arcgis.search.IIndexingOptions

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIndexingOptions

public void setIndexingOptions(IIndexingOptions pIndexingOptions)
                        throws IOException,
                               AutomationException

The indexing options.

Specified by:

setIndexingOptions in interface ISearchServer

Parameters:

pIndexingOptions - A reference to a com.esri.arcgis.search.IIndexingOptions (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIndexingStatus

public IIndexingStatus getIndexingStatus()
                                  throws IOException,
                                         AutomationException

The indexing status.

Specified by:

getIndexingStatus in interface ISearchServer

Returns:

A reference to a com.esri.arcgis.search.IIndexingStatus

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchIndexLocation

public String getSearchIndexLocation()
                              throws IOException,
                                     AutomationException

Search index location.

Specified by:

getSearchIndexLocation in interface ISearchServerAdmin

Returns:

The searchIndexLocation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

construct

public void construct(IPropertySet props)
               throws IOException,
                      AutomationException

Two phase object construction.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

construct in interface IObjectConstruct

Parameters:

props - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

handleBinaryRequest

public byte[] handleBinaryRequest(byte[] request)
                           throws IOException,
                                  AutomationException

Handles a binary request.

Specified by:

handleBinaryRequest in interface IRequestHandler

Parameters:

request - An unsigned byte (in)

Returns:

An unsigned byte

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

handleStringRequest

public String handleStringRequest(String capabilities,
                                  String request)
                           throws IOException,
                                  AutomationException

Handles a SOAP string request.

Specified by:

handleStringRequest in interface IRequestHandler

Parameters:

capabilities - The capabilities (in)

request - The request (in)

Returns:

The response

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

handleBinaryRequest2

public byte[] handleBinaryRequest2(String capabilities,
                                   byte[] request)
                            throws IOException,
                                   AutomationException

Handles a binary request with explicit capabilities.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

handleBinaryRequest2 in interface IRequestHandler2

Parameters:

capabilities - The capabilities (in)

request - An unsigned byte (in)

Returns:

An unsigned byte

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

activate

public void activate()
              throws IOException,
                     AutomationException

Activates the object.

Specified by:

activate in interface IObjectActivate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deactivate

public void deactivate()
                throws IOException,
                       AutomationException

Deactivates the object.

Specified by:

deactivate in interface IObjectActivate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initLogging

public void initLogging(ILog log)
                 throws IOException,
                        AutomationException

Initializes an object with a log.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

initLogging in interface ILogSupport

Parameters:

log - A reference to a com.esri.arcgis.system.ILog (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConfigurationName

public String getConfigurationName()
                            throws IOException,
                                   AutomationException

Name of the server object configuration that defines the server object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getConfigurationName in interface IServerObject

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTypeName

public String getTypeName()
                   throws IOException,
                          AutomationException

Type of the server object (MapServer or GeocodeServer).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTypeName in interface IServerObject

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.