com.esri.arcgis.server
Class ServerMachine

java.lang.Object
  com.esri.arcgis.server.ServerMachine

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IServerMachine, IServerMachine2, IServerMachine3, Serializable

public class ServerMachine
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IServerMachine, IServerMachine2, IServerMachine3

The ServerMachine object which provides information about the ServerMachine.

Remarks

A ServerMachine is a machine that can host server objects managed by the GIS server.

ArcGIS for Server is a distributed system. Server objects managed by the GIS server can run on one or more host machines. A machine that can host server objects must have the Server Object Container installed on it, and the machine must be added to the list of host machines managed by the ServerObjectManager.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

ServerObjectManager, ServerObjectType, IAGSServerConnectionAdmin, AGSServerConnectionName, IEnumServerObjectType, IEnumServerDirectory, AGSServerConnection, IServerConnection, ServerObjectTypeInfo, IEnumServerObjectTypeInfo, IAGSServerObject, ServerDirectoryInfo, ServerObjectConfiguration, ServerContext, ServerObjectConfigurationStatus, IAGSServerObjectName, ServerConnection, IAGSServerConnectionName, IAGSEnumServerObjectName, ServerObject, IServerObjectConfigurationInfo, IServerObjectAdmin, AGSServerConnectionFactory, IAGSServerConnectionFactory, IEnumServerObjectConfigurationInfo, IGISServerConnection, IAGSServerConnection, IServerContext, ServerDirectory, ServerObjectConfigurationInfo, IEnumServerMachine, ServerMachine, IServerObjectConfiguration, IServerObjectManager, IServerObjectTypeInfo, IServerMachine, IServerObject, IServerObjectType, GISServerConnection, AGSServerObjectName, ServerObjectAdmin, IEnumServerObjectConfiguration, Serialized Form

Constructor Summary

ServerMachine(Object obj)
Construct a ServerMachine using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(Object o) Compare this object with another
String	getAdminURL() The admin URL of the server machine.
int	getCapacity() The number of desired concurrently available configurations (the capacity) of the ArcGIS Server.
String	getDescription() The description of the host machine.
String	getName() The name of the machine that can host server objects for the GIS server.
String	getPlatform() The platform of the server machine.
int	getPortCount() The total count of ports.
IEnumBSTR	getPortNames() The port names.
int	getPortNumber(String name) The port number of a port.
int	hashCode() the hashcode for this object
void	setAdminURL(String pUrl) The admin URL of the server machine.
void	setCapacity(int val) The number of desired concurrently available configurations (the capacity) of the ArcGIS Server.
void	setDescription(String desc) The description of the host machine.
void	setName(String name) The name of the machine that can host server objects for the GIS server.
void	setPlatform(String pPlatform) The platform of the server machine.

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

ServerMachine

public ServerMachine(Object obj)
              throws IOException

Construct a ServerMachine using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ServerMachine.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
ServerMachine o = (ServerMachine)obj; // will not work

ServerMachine o = new ServerMachine(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems ServerMachine theServerMachine = (ServerMachine) obj;

Method Detail

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

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the machine that can host server objects for the GIS server.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IServerMachine

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException

The name of the machine that can host server objects for the GIS server.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface IServerMachine

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

The description of the host machine.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDescription in interface IServerMachine

Returns:

The desc

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(String desc)
                    throws IOException,
                           AutomationException

The description of the host machine.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDescription in interface IServerMachine

Parameters:

desc - The desc (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCapacity

public int getCapacity()
                throws IOException,
                       AutomationException

The number of desired concurrently available configurations (the capacity) of the ArcGIS Server.

Remarks

The Capacity property defines the number configuration instances on an SOC machine that are allowed to run concurrently before the pool-shrinking algorithm engages. The pool-shrinking algorithm removes least recently used configuration instances and replaces them with new instances. Capacity is dependent on system memory and CPU resources and should be tuned for each machine in the ArcGIS Server.

Product Availability

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

Specified by:

getCapacity in interface IServerMachine2

Returns:

The val

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCapacity

public void setCapacity(int val)
                 throws IOException,
                        AutomationException

The number of desired concurrently available configurations (the capacity) of the ArcGIS Server.

Product Availability

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

Specified by:

setCapacity in interface IServerMachine2

Parameters:

val - The val (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAdminURL

public String getAdminURL()
                   throws IOException,
                          AutomationException

The admin URL of the server machine.

Product Availability

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

Specified by:

getAdminURL in interface IServerMachine3

Returns:

The pUrl

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAdminURL

public void setAdminURL(String pUrl)
                 throws IOException,
                        AutomationException

The admin URL of the server machine.

Product Availability

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

Specified by:

setAdminURL in interface IServerMachine3

Parameters:

pUrl - The pUrl (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPlatform

public String getPlatform()
                   throws IOException,
                          AutomationException

The platform of the server machine.

Product Availability

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

Specified by:

getPlatform in interface IServerMachine3

Returns:

The pPlatform

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPlatform

public void setPlatform(String pPlatform)
                 throws IOException,
                        AutomationException

The platform of the server machine.

Product Availability

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

Specified by:

setPlatform in interface IServerMachine3

Parameters:

pPlatform - The pPlatform (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPortCount

public int getPortCount()
                 throws IOException,
                        AutomationException

The total count of ports.

Product Availability

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

Specified by:

getPortCount in interface IServerMachine3

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPortNames

public IEnumBSTR getPortNames()
                       throws IOException,
                              AutomationException

The port names.

Product Availability

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

Specified by:

getPortNames in interface IServerMachine3

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPortNumber

public int getPortNumber(String name)
                  throws IOException,
                         AutomationException

The port number of a port.

Product Availability

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

Specified by:

getPortNumber in interface IServerMachine3

Parameters:

name - The name (in)

Returns:

The pNumber

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.