com.esri.arcgis.server

Interface IServerObjectConfiguration

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IServerObjectConfigurationProxy

public interface IServerObjectConfiguration
extends java.io.Serializable

COM Interface 'IServerObjectConfiguration'. Generated 9/21/2023 10:01:45 AM from 'X:\ArcGIS\com\server\esriServer.tlb'

Description: 'Provides access to administrators to members that control the behavior and properties of a server object configuration.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IID832dab4c_a03d_429e_8c14_401e3f807284
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Description of the server object configuration.
int	getIsolationLevel() The isolation level of the server objects defined by the server object configuration.
int	getMaxInstances() The maximum number of server object instances for a server object configuration.
int	getMinInstances() The minimum number of server object instances for a server object configuration.
java.lang.String	getName() Name of the server object configuration.
IPropertySet	getProperties() Initialization parameters and properties for the server objects created by the server object configuration.
IPropertySet	getRecycleProperties() The recycling properties for the server object configuration.
int	getStartupType() The startup type for this server object configuration.
java.lang.String	getTypeName() Type of the server object configuration (MapServer or GeocodeServer).
int	getUsageTimeout() Maximum time (in seconds) a client can hold onto an instance of a server object for this server object configuration before releasing it back to the server.
int	getWaitTimeout() Maximum time (in seconds) a client will wait for an instance of a server object for this server object configuration using the CreateServerContext method on IServerObjectManager before timing out.
boolean	isPooled() Indicates whether the server objects defined by this configuration are pooled.
void	setDescription(java.lang.String desc) Description of the server object configuration.
void	setIsolationLevel(int isoLevel) The isolation level of the server objects defined by the server object configuration.
void	setIsPooled(boolean isPooled) Indicates whether the server objects defined by this configuration are pooled.
void	setMaxInstances(int instances) The maximum number of server object instances for a server object configuration.
void	setMinInstances(int instances) The minimum number of server object instances for a server object configuration.
void	setName(java.lang.String name) Name of the server object configuration.
void	setPropertiesByRef(IPropertySet props) Initialization parameters and properties for the server objects created by the server object configuration.
void	setRecyclePropertiesByRef(IPropertySet props) The recycling properties for the server object configuration.
void	setStartupType(int type) The startup type for this server object configuration.
void	setTypeName(java.lang.String typeName) Type of the server object configuration (MapServer or GeocodeServer).
void	setUsageTimeout(int pVal) Maximum time (in seconds) a client can hold onto an instance of a server object for this server object configuration before releasing it back to the server.
void	setWaitTimeout(int pVal) Maximum time (in seconds) a client will wait for an instance of a server object for this server object configuration using the CreateServerContext method on IServerObjectManager before timing out.

Field Detail

IID832dab4c_a03d_429e_8c14_401e3f807284

static final int IID832dab4c_a03d_429e_8c14_401e3f807284

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()
                  throws java.io.IOException,
                         AutomationException

Name of the server object configuration.

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(java.lang.String name)
      throws java.io.IOException,
             AutomationException

Name of the server object configuration.

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTypeName

java.lang.String getTypeName()
                      throws java.io.IOException,
                             AutomationException

Type of the server object configuration (MapServer or GeocodeServer).

Returns:

The typeName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTypeName

void setTypeName(java.lang.String typeName)
          throws java.io.IOException,
                 AutomationException

Type of the server object configuration (MapServer or GeocodeServer).

Parameters:

typeName - The typeName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

java.lang.String getDescription()
                         throws java.io.IOException,
                                AutomationException

Description of the server object configuration.

Returns:

The desc

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

void setDescription(java.lang.String desc)
             throws java.io.IOException,
                    AutomationException

Description of the server object configuration.

Parameters:

desc - The desc (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProperties

IPropertySet getProperties()
                    throws java.io.IOException,
                           AutomationException

Initialization parameters and properties for the server objects created by the server object configuration.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPropertiesByRef

void setPropertiesByRef(IPropertySet props)
                 throws java.io.IOException,
                        AutomationException

Initialization parameters and properties for the server objects created by the server object configuration.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRecycleProperties

IPropertySet getRecycleProperties()
                           throws java.io.IOException,
                                  AutomationException

The recycling properties for the server object configuration.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRecyclePropertiesByRef

void setRecyclePropertiesByRef(IPropertySet props)
                        throws java.io.IOException,
                               AutomationException

The recycling properties for the server object configuration.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinInstances

int getMinInstances()
             throws java.io.IOException,
                    AutomationException

The minimum number of server object instances for a server object configuration.

Returns:

The instances

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinInstances

void setMinInstances(int instances)
              throws java.io.IOException,
                     AutomationException

The minimum number of server object instances for a server object configuration.

Parameters:

instances - The instances (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxInstances

int getMaxInstances()
             throws java.io.IOException,
                    AutomationException

The maximum number of server object instances for a server object configuration.

Returns:

The instances

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxInstances

void setMaxInstances(int instances)
              throws java.io.IOException,
                     AutomationException

The maximum number of server object instances for a server object configuration.

Parameters:

instances - The instances (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPooled

boolean isPooled()
          throws java.io.IOException,
                 AutomationException

Indicates whether the server objects defined by this configuration are pooled.

Returns:

The isPooled

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsPooled

void setIsPooled(boolean isPooled)
          throws java.io.IOException,
                 AutomationException

Indicates whether the server objects defined by this configuration are pooled.

Parameters:

isPooled - The isPooled (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIsolationLevel

int getIsolationLevel()
               throws java.io.IOException,
                      AutomationException

The isolation level of the server objects defined by the server object configuration.

Returns:

A com.esri.arcgis.server.esriServerIsolationLevel constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsolationLevel

void setIsolationLevel(int isoLevel)
                throws java.io.IOException,
                       AutomationException

The isolation level of the server objects defined by the server object configuration.

Parameters:

isoLevel - A com.esri.arcgis.server.esriServerIsolationLevel constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStartupType

int getStartupType()
            throws java.io.IOException,
                   AutomationException

The startup type for this server object configuration. Startup type describes whether the server object configuration is started when the server object manager service is started for the GIS server.

Returns:

A com.esri.arcgis.server.esriStartupType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartupType

void setStartupType(int type)
             throws java.io.IOException,
                    AutomationException

The startup type for this server object configuration. Startup type describes whether the server object configuration is started when the server object manager service is started for the GIS server.

Parameters:

type - A com.esri.arcgis.server.esriStartupType constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWaitTimeout

int getWaitTimeout()
            throws java.io.IOException,
                   AutomationException

Maximum time (in seconds) a client will wait for an instance of a server object for this server object configuration using the CreateServerContext method on IServerObjectManager before timing out.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWaitTimeout

void setWaitTimeout(int pVal)
             throws java.io.IOException,
                    AutomationException

Maximum time (in seconds) a client will wait for an instance of a server object for this server object configuration using the CreateServerContext method on IServerObjectManager before timing out.

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUsageTimeout

int getUsageTimeout()
             throws java.io.IOException,
                    AutomationException

Maximum time (in seconds) a client can hold onto an instance of a server object for this server object configuration before releasing it back to the server. It is the maximum time allowed between calling CreateServerContext and ReleaseServerContext.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUsageTimeout

void setUsageTimeout(int pVal)
              throws java.io.IOException,
                     AutomationException

Maximum time (in seconds) a client can hold onto an instance of a server object for this server object configuration before releasing it back to the server. It is the maximum time allowed between calling CreateServerContext and ReleaseServerContext.

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.