com.esri.sde.sdk.client
Class SeInstance

java.lang.Object
  com.esri.sde.sdk.client.SeInstance

public class SeInstance
extends java.lang.Object

Used to manage and query an ArcSDE Instance.

Since:

ArcSDE 8.1

Nested Class Summary

static class	SeInstance.SeInstanceConfiguration SeInstance inner class that retrieves the configuration of ArcSde instance.
static class	SeInstance.SeInstanceId SeInstance inner class that retrieves the id of this instance.
static class	SeInstance.SeInstanceLocks SeInstance inner class that retrieves locks information for the ArcSde instance.
static class	SeInstance.SeInstanceStateLocks SeInstance inner class that retrieves state locks information for the ArcSde instance.
static class	SeInstance.SeInstanceStats SeInstance inner class that retrieves a list of user information for the ArcSde instance.
static class	SeInstance.SeInstanceStatus SeInstance inner class that retrieves the status of an ArcSde instance.
static class	SeInstance.SeInstanceTableLocks SeInstance inner class that retrieves table locks information for the ArcSde instance.
static class	SeInstance.SeInstanceUsers SeInstance inner class that retrieves a list of user information for the ArcSde instance.
static class	SeInstance.SeInstanceVersionLocks SeInstance inner class that retrieves version locks information for the ArcSde instance.

Constructor Summary

SeInstance(java.lang.String server, int instance)
Establishes a connection to an ArcSDE Instance.

SeInstance(java.lang.String server, int instance, java.util.Locale insLocale)
Establishes a connection to an ArcSDE Instance.

SeInstance(java.lang.String server, java.lang.String instance)
Establishes a connection to an ArcSDE Instance.

SeInstance(java.lang.String server, java.lang.String instance, java.util.Locale insLocale)
Establishes a connection to an ArcSDE Instance.

Method Summary

SeInstance.SeInstanceConfiguration	getConfiguration() Returns the ArcSde instance configuration.
int	getInstance() Returns the ArcSDE instance's port number.
SeInstance.SeInstanceId[]	getInstanceList() Returns a list of all the instances for this schema.
SeInstance.SeInstanceLocks[]	getLocks() Returns a list of all the layer locks allocated by the instance.
SeObjectLock[]	getObjectLocks() Returns a list of all object locks allocated by the instance.
java.lang.String	getServerName() Returns the ArSde instance server name.
SeInstance.SeInstanceStateLocks[]	getStateLocks() Returns a list of state locks in use.
SeInstance.SeInstanceStats[]	getStats() Returns statistics of server processes connected to the ArcSde instance.
SeInstance.SeInstanceStatus	getStatus() Retrieves the ArcSde instance status.
SeInstance.SeInstanceTableLocks[]	getTableLocks() Returnss a list of table locks in use.
SeInstance.SeInstanceUsers[]	getUsers() Returns a list of user information connected to ArcSde instance.
java.lang.String[]	getVariables() Returns the ArcSde instance environment variables list.
SeInstance.SeInstanceVersionLocks[]	getVersionLocks() Returns a list of version locks in use.
void	killAllProcesses(java.lang.String password) Kills all ArcSde server processes.
void	killProcess(int pid, java.lang.String password) Kills the specified ArcSde server process.
void	pause(java.lang.String password) Pauses, or disallows further connections to, the ArcSde instance.
void	resume(java.lang.String password) Resumes, or allows connections to, the ArcSde instance.
void	shutdown(java.lang.String password) Shuts down the ArcSde instance.
void	start(java.lang.String instance, java.lang.String password) Starts the ArcSde Instance.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SeInstance

public SeInstance(java.lang.String server,
                  int instance)
           throws SeException

Establishes a connection to an ArcSDE Instance. The instance is received as a port number.

Parameters:

server - name of the server machine.

instance - port number that the server instance is listening on.

Throws:

SeException

SeInstance

public SeInstance(java.lang.String server,
                  int instance,
                  java.util.Locale insLocale)
           throws SeException

Establishes a connection to an ArcSDE Instance. The instance is received as a port number.

Parameters:

server - name of the server machine.

instance - port number that the server instance is listening on.

insLocale - SeLocale object that identifies Locale properties.

Throws:

SeException

SeInstance

public SeInstance(java.lang.String server,
                  java.lang.String instance)
           throws SeException

Establishes a connection to an ArcSDE Instance. The instance is received as a port number and schema, e.g. port:schema.

Parameters:

server - name of the server machine.

instance - port number that the server instance is listening on, and the schema, e.g. port:schema.

Throws:

SeException

SeInstance

public SeInstance(java.lang.String server,
                  java.lang.String instance,
                  java.util.Locale insLocale)
           throws SeException

Establishes a connection to an ArcSDE Instance. The instance is received as a port number and schema, e.g. port:schema.

Parameters:

server - name of the server machine.

instance - port number that the server instance is listening on, and the schema, e.g. port:schema.

insLocale - SeLocale object that identifies Locale properties.

Throws:

SeException

Method Detail

getConfiguration

public SeInstance.SeInstanceConfiguration getConfiguration()
                                                    throws SeException

Returns the ArcSde instance configuration.

Returns:

SeInstanceConfiguration

Throws:

SeException

See Also:

SeInstance.SeInstanceConfiguration

shutdown

public void shutdown(java.lang.String password)
              throws SeException

Shuts down the ArcSde instance.

Parameters:

password - ArcSde DBA password.

Throws:

SeException

pause

public void pause(java.lang.String password)
           throws SeException

Pauses, or disallows further connections to, the ArcSde instance.

Parameters:

password - ArcSde DBA password.

Throws:

SeException

resume

public void resume(java.lang.String password)
            throws SeException

Resumes, or allows connections to, the ArcSde instance.

Parameters:

password - ArcSde DBA password.

Throws:

SeException

killProcess

public void killProcess(int pid,
                        java.lang.String password)
                 throws SeException

Kills the specified ArcSde server process.

Parameters:

pid - process id of the server process to be terminated.

password - ArcSde DBA password.

Throws:

SeException

killAllProcesses

public void killAllProcesses(java.lang.String password)
                      throws SeException

Kills all ArcSde server processes.

Parameters:

password - ArcSde DBA password.

Throws:

SeException

getStatus

public SeInstance.SeInstanceStatus getStatus()
                                      throws SeException

Retrieves the ArcSde instance status.

Returns:

SeInstanceStatus[]

Throws:

SeException

See Also:

SeInstance.SeInstanceStatus

getInstance

public int getInstance()

Returns the ArcSDE instance's port number.

Returns:

instance port number as an int value

getServerName

public java.lang.String getServerName()
                               throws SeException

Returns the ArSde instance server name.

Throws:

SeException

getUsers

public SeInstance.SeInstanceUsers[] getUsers()
                                      throws SeException

Returns a list of user information connected to ArcSde instance.

Returns:

SeInstanceUsers

Throws:

SeException

See Also:

SeInstance.SeInstanceUsers

getInstanceList

public SeInstance.SeInstanceId[] getInstanceList()
                                          throws SeException

Returns a list of all the instances for this schema.

Returns:

SeInstanceId[]

Throws:

SeException

See Also:

SeInstance.SeInstanceId

getStats

public SeInstance.SeInstanceStats[] getStats()
                                      throws SeException

Returns statistics of server processes connected to the ArcSde instance.

Returns:

SeInstanceStats[]

Throws:

SeException

See Also:

SeInstance.SeInstanceStats

getObjectLocks

public SeObjectLock[] getObjectLocks()
                              throws SeException

Returns a list of all object locks allocated by the instance.

Returns:

SeObjectLock[]

Throws:

SeException

See Also:

SeObjectLock

getLocks

public SeInstance.SeInstanceLocks[] getLocks()
                                      throws SeException

Returns a list of all the layer locks allocated by the instance.

Returns:

SeInstanceLocks[]

Throws:

SeException

See Also:

SeInstance.SeInstanceLocks

getStateLocks

public SeInstance.SeInstanceStateLocks[] getStateLocks()
                                                throws SeException

Returns a list of state locks in use.

Returns:

SeInstanceStateLocks[]

Throws:

SeException

See Also:

SeInstance.SeInstanceStateLocks

getTableLocks

public SeInstance.SeInstanceTableLocks[] getTableLocks()
                                                throws SeException

Returnss a list of table locks in use.

Returns:

SeInstanceTableLocks[]

Throws:

SeException

See Also:

SeInstance.SeInstanceTableLocks

getVersionLocks

public SeInstance.SeInstanceVersionLocks[] getVersionLocks()
                                                    throws SeException

Returns a list of version locks in use.

Returns:

SeInstanceVersionLocks[]

Throws:

SeException

See Also:

SeInstance.SeInstanceVersionLocks

getVariables

public java.lang.String[] getVariables()
                                throws SeException

Returns the ArcSde instance environment variables list.

Returns:

String[]

Throws:

SeException

start

public void start(java.lang.String instance,
                  java.lang.String password)
           throws SeException

Starts the ArcSde Instance. This function requires the native library file sdejavautil. On Windows platforms this file should be located in the %SDEHOME%/bin directory. On Unix platforms this file should be located in the $SDEHOME\lib directory.

Parameters:

instance - name of the service as it is defined in the services file on server machine.

password - ArcSde DBA password.

Throws:

SeException