com.esri.aims.mtier.model.axl.admin
Class AdminElementFactory

java.lang.Object
  |
  +--com.esri.aims.mtier.model.axl.admin.AdminElementFactory

public class AdminElementFactory
extends Object

Implements a factory class for admin elements.


Method Summary
static com.esri.w3c.dom.Element createAddCategoryElement(String name, String type, String permissions)
          Creates an ADDCATEGORY element with "name" attribute.
static com.esri.w3c.dom.Element createAddCookieDataElement(String name, String category)
          Creates an ADDCOOKIEDATA element with attributes.
static com.esri.w3c.dom.Element createAddCookieElement(String name, String category)
          Creates an ADDCOOKIE element with given attributes.
static com.esri.w3c.dom.Element createAddCustomServiceElement(String name, String group)
          Creates an ADDCUSTOMSERVICE element with attributes.
static com.esri.w3c.dom.Element createAddSDEServiceElement(String name, String port, String instanceName, String sdeAdminDatabase, String description)
          Creates a new SDE Service that is defined by the specified attributes.
static com.esri.w3c.dom.Element createAddServerElement(String id, String threads)
          Creates an ADDSERVER element with attributes.
static com.esri.w3c.dom.Element createAddServiceElement(String name, String servicegroup, String group)
          Creates an ADDSERVICE element with attributes.
static com.esri.w3c.dom.Element createAddServiceGroupElement(String name, String type, String version, String access, String desc)
          Creates an ADDSERVICEGROUP element with attributes.
static com.esri.w3c.dom.Element createCatalogElement()
          Creates an CATALOG element.
static com.esri.w3c.dom.Element createChangeCustomServiceElement(String name, String group)
          Creates an CHANGECUSTOMSERVICE element with attributes.
static com.esri.w3c.dom.Element createChangeServerElement(String name, String threads)
          Creates an CHANGESERVER element with attributes.
static com.esri.w3c.dom.Element createChangeServiceElement(String name, String servicegroup)
          Creates an CHANGESERVICE element with attributes.
static com.esri.w3c.dom.Element createChangeServiceGroupElement(String name, String desc)
          Creates an CHANGESERVICEGROUP element with given attributes.
static com.esri.w3c.dom.Element createChangeThreadsElement(String id, String threads)
          Creates an CHANGETHREADS element with attributes.
static com.esri.w3c.dom.Element createCleanupElement(String interval)
          Creates an CLEANUP element with the given interval attribute.
static com.esri.w3c.dom.Element createComponentElement(String type, String version, String access)
          Creates an COMPONENT element with type and access attributes.
static com.esri.w3c.dom.Element createCompressSDEServiceElement(String name, String port, String password)
           
static com.esri.w3c.dom.Element createConfigElement()
          Creates an CONFIG element.
static com.esri.w3c.dom.Element createCookieElement(String name, String data)
          Creates an COOKIE element with name and data attributes.
static com.esri.w3c.dom.Element createCSDElement(String name, String content)
          Creates an CSD element with attributes.
static com.esri.w3c.dom.Element createCustomServiceElement(String version)
          Creates an CUSTOMSERVICE element with the version attribute.
static com.esri.w3c.dom.Element createDataElement(String index, String type)
          Creates an DATA element.
static com.esri.w3c.dom.Element createDbtuneQueryElement(String name, String port, String password)
           
static com.esri.w3c.dom.Element createEnvironmentElement()
          Creates an ENVIRONMENT element.
static com.esri.w3c.dom.Element createErrorElement(String code, String message)
          Creates an ERROR element with attributes.
static com.esri.w3c.dom.Element createErrorsElement()
          Creates an ERRORS element.
static com.esri.w3c.dom.Element createExtensionElement(String type)
          Creates an EXTENSION element with type attribute.
static com.esri.w3c.dom.Element createGetAdminInfoElement()
          Creates an GETADMININFO element.
static com.esri.w3c.dom.Element createGetCatalogElement()
          Creates an GETCATALOG element.
static com.esri.w3c.dom.Element createGetCategoryInfoElement(String name)
          Creates an GETCATEGORYINFO element.
static com.esri.w3c.dom.Element createGetCookieDataElement(String name, String category)
          Creates an GETCOOKIEDATA element.
static com.esri.w3c.dom.Element createGetCookieInfoElement(String name, String category)
          Creates an GETCOOKIEINFO element.
static com.esri.w3c.dom.Element createGetMonitorsElement()
          Creates an GETMONITORS element.
static com.esri.w3c.dom.Element createGetPrefElement(String name)
          Creates an GETPREF element.
static com.esri.w3c.dom.Element createGetServersElement(String machine, String id)
          Creates an GETSERVERS element.
static com.esri.w3c.dom.Element createGetServiceGroupsElement(String name)
          Creates an GETSERVICEGROUPS element.
static com.esri.w3c.dom.Element createGetServicesElement(String name)
          Creates an GETSERVICES element.
static com.esri.w3c.dom.Element createGetStartupParametersElement()
          Creates an GETSTARTUPPARAMETERS element.
static com.esri.w3c.dom.Element createGetStatsElement(String servergroup)
          Creates an GETSTATS element.
static com.esri.w3c.dom.Element createGroupElement(String name, String description)
          Creates an GROUP element with type attribute.
static com.esri.w3c.dom.Element createGroupsElement()
          Creates an GROUPS element.
static com.esri.w3c.dom.Element createImageElement(String url, String path, String type, String pixelcount)
          Creates an IMAGE element with type attribute.
static com.esri.w3c.dom.Element createKillAllSDEConnectionsElement(String name, String port, String password)
           
static com.esri.w3c.dom.Element createKillSDEConnectionElement(String name, String port, String password, String connectionId)
           
static com.esri.w3c.dom.Element createLayerElement()
          Creates an LAYER element.
static com.esri.w3c.dom.Element createListSDEConnectionsElement(String name, String port)
           
static com.esri.w3c.dom.Element createLocaleElement(String language, String country, String variant)
          Creates an LOCALE element with attributes.
static com.esri.w3c.dom.Element createMachineElement(String name)
          Creates an MACHINE element with name attribute.
static com.esri.w3c.dom.Element createMonitorElement(String name, String numcontainer)
          Creates an MONITOR element with attributes.
static com.esri.w3c.dom.Element createMonitorsElement()
          Creates an MONITORS element.
static com.esri.w3c.dom.Element createOKElement()
          Creates an OK element.
static com.esri.w3c.dom.Element createPauseSDEServiceElement(String name, String port, String password)
           
static com.esri.w3c.dom.Element createPrivateServiceElement(String type)
          Creates a PRIVATESERVICE element with type attribute.
static com.esri.w3c.dom.Element createQueryFirstLoginElement()
          Creates an QUERYFIRSTLOGIN element.
static com.esri.w3c.dom.Element createRecyclingElement(String hour, String minute, String frequency)
          Creates a RECYCLING element with attributes.
static com.esri.w3c.dom.Element createRemoveCategoryElement(String name)
          Creates an REMOVECATEGORY element with attributes.
static com.esri.w3c.dom.Element createRemoveCookieDataElement(String name, String category)
          Creates an REMOVECOOKIEDATA element with attributes.
static com.esri.w3c.dom.Element createRemoveCookieElement(String name, String category)
          Creates an REMOVECOOKIE element with attributes.
static com.esri.w3c.dom.Element createRemoveCustomServiceElement(String name)
          Creates an REMOVECUSTOMSERVICE element with attributes.
static com.esri.w3c.dom.Element createRemovePrefElement(String name)
          Creates an REMOVEPREF element with name attribute.
static com.esri.w3c.dom.Element createRemoveSDEServiceElement(String name, String port)
           
static com.esri.w3c.dom.Element createRemoveServerElement(String id)
          Creates an REMOVESERVER element with attributes.
static com.esri.w3c.dom.Element createRemoveServiceElement(String name)
          Creates an REMOVESERVICE element with attributes.
static com.esri.w3c.dom.Element createRemoveServiceGroupElement(String name)
          Creates an REMOVESERVICEGROUP element with attributes.
static com.esri.w3c.dom.Element createResumeSDEServiceElement(String name, String port, String password)
           
static com.esri.w3c.dom.Element createSaveElement()
          Creates an SAVE element.
static com.esri.w3c.dom.Element createScreenElement(String dpi)
          Creates an SCREEN element with dpi attribute.
static com.esri.w3c.dom.Element createSdeStatusElement(String name, String port)
          Constructs a status request.
static com.esri.w3c.dom.Element createSecurityElement()
          Creates an SECURITY element.
static com.esri.w3c.dom.Element createServerElement(String id, String name, String threads, String monitor, String group, String alias, String status, String exitcode)
          Creates a SERVER element with attributes.
static com.esri.w3c.dom.Element createServersElement()
          Creates an SERVERS element.
static com.esri.w3c.dom.Element createServiceElement(String name, String type, String servicegroup, String status, String access)
          Creates an SERVICE element with attributes.
static com.esri.w3c.dom.Element createServiceGroupElement(String name, String type, String access, String description, String status)
          Creates an SERVICEGROUP element with attributes.
static com.esri.w3c.dom.Element createServiceGroupsElement()
          Creates a SERVICEGROUPS element.
static com.esri.w3c.dom.Element createServiceGroupServerElement(String id, String threads)
          Creates an SERVER element with attributes.
static com.esri.w3c.dom.Element createServicesElement()
          Creates an SERVICES element.
static com.esri.w3c.dom.Element createSetAdminPropertyElement(String username, String password)
          Creates a SETADMINPROPERTY element.
static com.esri.w3c.dom.Element createSetPrefElement(String name, String value)
          Creates a SETPREF element.
static com.esri.w3c.dom.Element createShutdownSDEServiceElement(String name, String port, String password)
           
static com.esri.w3c.dom.Element createStartSDEServiceElement(String name, String instanceName, String password)
          To start an SDE service the Instance Name is needed.
static com.esri.w3c.dom.Element createStartServerElement(String machine, String alias)
          Creates an STARTSERVER element with attributes.
static com.esri.w3c.dom.Element createStartServiceElement(String name)
          Creates an STARTSERVICE element with attributes.
static com.esri.w3c.dom.Element createStopServerElement(String name)
          Creates an STOPSERVER element with attributes.
static com.esri.w3c.dom.Element createStopServiceElement(String name)
          Creates an STOPSERVICE element with attributes.
static com.esri.w3c.dom.Element createSummaryElement(String desc)
          Creates an SUMMARY element with attributes.
static com.esri.w3c.dom.Element createUIFontElement(String name, String color, String size, String style)
          Creates an UIFONT element with attributes.
static com.esri.w3c.dom.Element createUpdateCategoryElement(String name)
          Creates an UPDATECATEGORY element with name attribute.
static com.esri.w3c.dom.Element createUpdateCookieElement(String name, String category)
          Creates an UPDATECOOKIE element with name attribute.
static com.esri.w3c.dom.Element createValidateElement()
          Creates a VALIDATE element.
static com.esri.w3c.dom.Element createXAPElement(String name, String content, String ext)
          Creates an XAP element with attributes.
static com.esri.w3c.dom.Element createZipElement(String url, String path)
          Creates an ZIP element with attributes.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

createAddCategoryElement

public static com.esri.w3c.dom.Element createAddCategoryElement(String name,
                                                                String type,
                                                                String permissions)
                                                         throws AXLAttributeException
Creates an ADDCATEGORY element with "name" attribute.

Parameters:
name - The name of the new category. (REQUIRED)
type - The type of the new category. If null, then type "Other" is default in Application Server.
permissions - The permissions on the folder. R or RW.
Returns:
Element An ADDCATEGORY Element.
Throws:
AXLAttributeException - if required attributes are not properly set.

createAddCookieElement

public static com.esri.w3c.dom.Element createAddCookieElement(String name,
                                                              String category)
                                                       throws AXLAttributeException
Creates an ADDCOOKIE element with given attributes.

Parameters:
name - The name of the new cookie. (REQUIRED)
category - The name of the category to which the cookie will belong. (REQUIRED)
Returns:
Element An ADDCOOKIE Element.
Throws:
AXLAttributeException - if required attributes are not properly set.

createAddCookieDataElement

public static com.esri.w3c.dom.Element createAddCookieDataElement(String name,
                                                                  String category)
                                                           throws AXLAttributeException
Creates an ADDCOOKIEDATA element with attributes.

Parameters:
name - The name of the cookie to which the data will be added. (REQUIRED)
category - The name of the category to which the cookie belongs. (REQUIRED)
Returns:
Element An ADDCOOKIE Element.
Throws:
AXLAttributeException - if required attributes are not properly set.

createAddCustomServiceElement

public static com.esri.w3c.dom.Element createAddCustomServiceElement(String name,
                                                                     String group)
                                                              throws AXLAttributeException
Creates an ADDCUSTOMSERVICE element with attributes.

Parameters:
name - The name of the new service group. (REQUIRED)
group - The access level of the service group.
Returns:
Element An ADDCUSTOMSERVICE Element.
Throws:
AXLAttributeException - if required attributes are not properly set.

createAddServerElement

public static com.esri.w3c.dom.Element createAddServerElement(String id,
                                                              String threads)
                                                       throws AXLAttributeException
Creates an ADDSERVER element with attributes.

Parameters:
id - The id server. (REQUIRED)
threads - The number of threads to run on it. (REQUIRED)
Returns:
Element An ADDSERVER Element.
Throws:
AXLAttributeException - if required attributes are not properly set.

createAddServiceElement

public static com.esri.w3c.dom.Element createAddServiceElement(String name,
                                                               String servicegroup,
                                                               String group)
                                                        throws AXLAttributeException
Creates an ADDSERVICE element with attributes.

Parameters:
name - The name of the new service group. (REQUIRED)
servicegroup - The type of service group to create. (REQUIRED)
group - The access level of the service group.
Returns:
Element An ADDSERVICE Element.
Throws:
AXLAttributeException - if required attributes are not properly set.

createAddServiceGroupElement

public static com.esri.w3c.dom.Element createAddServiceGroupElement(String name,
                                                                    String type,
                                                                    String version,
                                                                    String access,
                                                                    String desc)
                                                             throws AXLAttributeException
Creates an ADDSERVICEGROUP element with attributes.

Parameters:
name - The name of the new service group. (REQUIRED)
type - The type of service group to create. (REQUIRED)
access - The access level of the service group. (REQUIRED)
desc - The description of the service group.
version - The version of the service group.
Returns:
Element An ADDSERVICEGROUP Element.
Throws:
AXLAttributeException - if required attributes are not properly set.

createCatalogElement

public static com.esri.w3c.dom.Element createCatalogElement()
Creates an CATALOG element.

Returns:
Element An CATALOG Element.

createChangeCustomServiceElement

public static com.esri.w3c.dom.Element createChangeCustomServiceElement(String name,
                                                                        String group)
                                                                 throws AXLAttributeException
Creates an CHANGECUSTOMSERVICE element with attributes.

Parameters:
name - The name of the service group. (REQUIRED)
group - The group the service is associated with. (REQUIRED)
Returns:
Element A CHANGECUSTOMSERVICE Element.
Throws:
AXLAttributeException - if required attributes are not properly set.

createChangeServerElement

public static com.esri.w3c.dom.Element createChangeServerElement(String name,
                                                                 String threads)
                                                          throws AXLAttributeException
Creates an CHANGESERVER element with attributes.

Parameters:
name - The id of the server. (REQUIRED)
threads - The new number of threads to be associate with this server. (REQUIRED)
Returns:
Element A CHANGESERVER Element.
Throws:
AXLAttributeException - if required attributes are not properly set.

createChangeServiceElement

public static com.esri.w3c.dom.Element createChangeServiceElement(String name,
                                                                  String servicegroup)
                                                           throws AXLAttributeException
Creates an CHANGESERVICE element with attributes.

Parameters:
name - The name of the service group. (REQUIRED)
servicegroup - The service group the service is associated with. (REQUIRED)
Returns:
Element A CHANGESERVICE Element.
Throws:
AXLAttributeException - if required attributes are not properly set.

createChangeServiceGroupElement

public static com.esri.w3c.dom.Element createChangeServiceGroupElement(String name,
                                                                       String desc)
                                                                throws AXLAttributeException
Creates an CHANGESERVICEGROUP element with given attributes.

Parameters:
name - The name of the service group. (REQUIRED)
desc - The description of the service group.
Returns:
Element A CHANGESERVICEGROUP Element.
Throws:
AXLAttributeException - if required attributes are not properly set.

createChangeThreadsElement

public static com.esri.w3c.dom.Element createChangeThreadsElement(String id,
                                                                  String threads)
                                                           throws AXLAttributeException
Creates an CHANGETHREADS element with attributes.

Parameters:
id - The id of the server group . (REQUIRED)
threads - The new thread count. (REQUIRED)
Returns:
Element A CHANGETHREADS Element.
Throws:
AXLAttributeException - if required attributes are not properly set.

createCleanupElement

public static com.esri.w3c.dom.Element createCleanupElement(String interval)
                                                     throws AXLAttributeException
Creates an CLEANUP element with the given interval attribute.

Parameters:
interval - The cleanup interval for the service being created. (REQUIRED)
Returns:
Element A CLEANUP Element.
Throws:
AXLAttributeException - if required attributes are not properly set.

createComponentElement

public static com.esri.w3c.dom.Element createComponentElement(String type,
                                                              String version,
                                                              String access)
                                                       throws AXLAttributeException
Creates an COMPONENT element with type and access attributes.

Parameters:
type - The type of component to use. (REQUIRED)
version - The version of the component being used. (REQUIRED)
access - The access for the component defined. (REQUIRED)
Returns:
Element A COMPONENT Element.
Throws:
AXLAttributeException - if required attributes are not properly set.

createConfigElement

public static com.esri.w3c.dom.Element createConfigElement()
Creates an CONFIG element.

Returns:
Element A CONFIG Element.

createCookieElement

public static com.esri.w3c.dom.Element createCookieElement(String name,
                                                           String data)
                                                    throws AXLAttributeException
Creates an COOKIE element with name and data attributes.

Parameters:
name - The name of cookie. (REQUIRED)
data - The data for the cookie. (REQUIRED)
Returns:
Element A COOKIE Element.
Throws:
AXLAttributeException - if required attributes are not properly set.

createCSDElement

public static com.esri.w3c.dom.Element createCSDElement(String name,
                                                        String content)
                                                 throws AXLAttributeException
Creates an CSD element with attributes.

Parameters:
name - The name of the CSD. (REQUIRED)
Throws:
AXLAttributeException - if required attributes are not properly set.

createCustomServiceElement

public static com.esri.w3c.dom.Element createCustomServiceElement(String version)
                                                           throws AXLAttributeException
Creates an CUSTOMSERVICE element with the version attribute.

Parameters:
version - The CUSTOMSERVICE version. (REQUIRED)
Returns:
Element An CUSTOMSERVICE Element.
Throws:
AXLAttributeException - if required attributes are not properly set.

createDataElement

public static com.esri.w3c.dom.Element createDataElement(String index,
                                                         String type)
Creates an DATA element.

Returns:
Element A DATA Element.

createEnvironmentElement

public static com.esri.w3c.dom.Element createEnvironmentElement()
Creates an ENVIRONMENT element.

Returns:
Element A ENVIRONMENT Element.

createErrorElement

public static com.esri.w3c.dom.Element createErrorElement(String code,
                                                          String message)
                                                   throws AXLAttributeException
Creates an ERROR element with attributes.

Parameters:
message - The message giving detail on the error.
Throws:
AXLAttributeException - if required attributes are not properly set.

createErrorsElement

public static com.esri.w3c.dom.Element createErrorsElement()
Creates an ERRORS element.

Returns:
Element A ERRORS Element.

createExtensionElement

public static com.esri.w3c.dom.Element createExtensionElement(String type)
                                                       throws AXLAttributeException
Creates an EXTENSION element with type attribute.

Parameters:
type - The type of the extension being referred to. (REQUIRED)
Throws:
AXLAttributeException - if required attributes are not properly set.

createGetAdminInfoElement

public static com.esri.w3c.dom.Element createGetAdminInfoElement()
Creates an GETADMININFO element.

Returns:
Element A GETADMININFO Element.

createGetCatalogElement

public static com.esri.w3c.dom.Element createGetCatalogElement()
Creates an GETCATALOG element.

Returns:
Element A GETCATALOG Element.

createGetCategoryInfoElement

public static com.esri.w3c.dom.Element createGetCategoryInfoElement(String name)
Creates an GETCATEGORYINFO element.

Parameters:
name - The name of a category (folder) to get the information for. If no name is specified, then information on all the categories (folders) is returned.
Returns:
Element A GETCATEGORYINFO Element.

createGetCookieInfoElement

public static com.esri.w3c.dom.Element createGetCookieInfoElement(String name,
                                                                  String category)
Creates an GETCOOKIEINFO element.

Parameters:
name - The name of a cookie to get information on.
category - The name of the category to which the cookie belongs.
Returns:
Element A GETCOOKIEINFO Element.

createGetCookieDataElement

public static com.esri.w3c.dom.Element createGetCookieDataElement(String name,
                                                                  String category)
                                                           throws AXLAttributeException
Creates an GETCOOKIEDATA element.

Parameters:
name - The name of a cookie to get data from.
category - The name of the category to which the cookie belongs.
Returns:
Element A GETCOOKIEDATA Element.
AXLAttributeException

createGetMonitorsElement

public static com.esri.w3c.dom.Element createGetMonitorsElement()
Creates an GETMONITORS element.

Returns:
Element A GETMONITORS Element.

createGetPrefElement

public static com.esri.w3c.dom.Element createGetPrefElement(String name)
Creates an GETPREF element.

Parameters:
name -
Returns:
Element A GETPREF Element.

createGetServersElement

public static com.esri.w3c.dom.Element createGetServersElement(String machine,
                                                               String id)
Creates an GETSERVERS element.

Parameters:
machine - Defines the name of the machine about which to return all of the container information for.
id - Defines the name of the container about which to return all of the information for.
Returns:
Element A GETSERVERS Element.

createGetServiceGroupsElement

public static com.esri.w3c.dom.Element createGetServiceGroupsElement(String name)
Creates an GETSERVICEGROUPS element.

Parameters:
name - The name of a virtual server to get the information for. If no name is specified, then information on all the virtual servers is returned.
Returns:
Element A GETSERVICEGROUPS Element.

createGetServicesElement

public static com.esri.w3c.dom.Element createGetServicesElement(String name)
Creates an GETSERVICES element.

Parameters:
name - The name of the service to get information about. If this value is null, then information is returned about all services.
Returns:
Element A GETSERVICES Element.

createGetStartupParametersElement

public static com.esri.w3c.dom.Element createGetStartupParametersElement()
Creates an GETSTARTUPPARAMETERS element.

Returns:
Element A GETSETARTUPPARAMETERS Element.

createGetStatsElement

public static com.esri.w3c.dom.Element createGetStatsElement(String servergroup)
Creates an GETSTATS element.

Parameters:
servergroup - The name of the server group to get statistics on. If this value is not set, then statistics are sent on all server groups.
Returns:
Element A GETSTATS Element.

createGroupElement

public static com.esri.w3c.dom.Element createGroupElement(String name,
                                                          String description)
                                                   throws AXLAttributeException
Creates an GROUP element with type attribute.

Parameters:
name - The name of the group. (REQUIRED)
description - A description of the group.
Throws:
AXLAttributeException - if required attributes are not properly set.

createGroupsElement

public static com.esri.w3c.dom.Element createGroupsElement()
Creates an GROUPS element.

Returns:
Element A GROUPS Element.

createImageElement

public static com.esri.w3c.dom.Element createImageElement(String url,
                                                          String path,
                                                          String type,
                                                          String pixelcount)
                                                   throws AXLAttributeException
Creates an IMAGE element with type attribute.

Parameters:
url - The url of the image output directory. (REQUIRED)
path - The path of the image output directory. (REQUIRED)
type - The format of the image to be output. (REQUIRED)
pixelcount - The maximum number of pixels to be used in creating the image. (REQUIRED)
Throws:
AXLAttributeException - if required attributes are not properly set.

createLayerElement

public static com.esri.w3c.dom.Element createLayerElement()
Creates an LAYER element.

Returns:
Element A LAYER Element.

createLocaleElement

public static com.esri.w3c.dom.Element createLocaleElement(String language,
                                                           String country,
                                                           String variant)
                                                    throws AXLAttributeException
Creates an LOCALE element with attributes.

Parameters:
language - The language code for the locale. (REQUIRED)
country - The country code for the locale. (REQUIRED)
variant - The variant code for the locale.
Throws:
AXLAttributeException - if required attributes are not properly set.

createMachineElement

public static com.esri.w3c.dom.Element createMachineElement(String name)
                                                     throws AXLAttributeException
Creates an MACHINE element with name attribute.

Parameters:
name - The name of a given machine. (REQUIRED)
Throws:
AXLAttributeException - if required attributes are not properly set.

createMonitorElement

public static com.esri.w3c.dom.Element createMonitorElement(String name,
                                                            String numcontainer)
                                                     throws AXLAttributeException
Creates an MONITOR element with attributes.

Parameters:
name - The name of a given monitor. (REQUIRED)
numcontainer - The number of containers on a given monitor.
Throws:
AXLAttributeException - if required attributes are not properly set.

createMonitorsElement

public static com.esri.w3c.dom.Element createMonitorsElement()
Creates an MONITORS element.

Returns:
Element A MONITORS Element.

createOKElement

public static com.esri.w3c.dom.Element createOKElement()
Creates an OK element.

Returns:
Element An OK Element.

createPrivateServiceElement

public static com.esri.w3c.dom.Element createPrivateServiceElement(String type)
                                                            throws AXLAttributeException
Creates a PRIVATESERVICE element with type attribute.

Parameters:
type - The type of the private service. (REQUIRED)
Returns:
Element A PRIVATESERVICE Element.
Throws:
AXLAttributeException - if required attributes are not properly set.

createQueryFirstLoginElement

public static com.esri.w3c.dom.Element createQueryFirstLoginElement()
Creates an QUERYFIRSTLOGIN element.

Returns:
Element A QUERYFIRSTLOGIN Element.

createRecyclingElement

public static com.esri.w3c.dom.Element createRecyclingElement(String hour,
                                                              String minute,
                                                              String frequency)
Creates a RECYCLING element with attributes.

Parameters:
hour - The reference hour to begin recycling.
minute - The reference minute to begin recycling.
frequency - The frequency of recycling (i.e. value of 2 is twice a day).
Returns:
A RECYCLING Element.
Throws:
AXLAttributeException - if required attributes are not properly set.

createRemoveCategoryElement

public static com.esri.w3c.dom.Element createRemoveCategoryElement(String name)
                                                            throws AXLAttributeException
Creates an REMOVECATEGORY element with attributes.

Parameters:
name - The name of the category (folder) to be removed. (REQUIRED)
Returns:
A REMOVECATEGORY Element.
Throws:
AXLAttributeException - if required attributes are not properly set.

createRemoveCookieElement

public static com.esri.w3c.dom.Element createRemoveCookieElement(String name,
                                                                 String category)
                                                          throws AXLAttributeException
Creates an REMOVECOOKIE element with attributes.

Parameters:
name - The name of the cookie (folder item) to be removed. (REQUIRED)
Returns:
A REMOVECOOKIE Element.
Throws:
AXLAttributeException - if required attributes are not properly set.

createRemoveCookieDataElement

public static com.esri.w3c.dom.Element createRemoveCookieDataElement(String name,
                                                                     String category)
                                                              throws AXLAttributeException
Creates an REMOVECOOKIEDATA element with attributes.

Parameters:
name - The name of the cookie (folder item) to removed remove data from. (REQUIRED)
Returns:
A REMOVECOOKIEDATA Element.
Throws:
AXLAttributeException - if required attributes are not properly set.

createRemoveCustomServiceElement

public static com.esri.w3c.dom.Element createRemoveCustomServiceElement(String name)
                                                                 throws AXLAttributeException
Creates an REMOVECUSTOMSERVICE element with attributes.

Parameters:
name - The name of the custom service to be removed. (REQUIRED)
Returns:
A REMOVECUSTOMSERVICE Element.
Throws:
AXLAttributeException - if required attributes are not properly set.

createRemovePrefElement

public static com.esri.w3c.dom.Element createRemovePrefElement(String name)
                                                        throws AXLAttributeException
Creates an REMOVEPREF element with name attribute.

Parameters:
name - The name of the preference to be removed. (REQUIRED)
Returns:
A REMOVEPREF Element.
Throws:
AXLAttributeException - if required attributes are not properly set.

createRemoveServerElement

public static com.esri.w3c.dom.Element createRemoveServerElement(String id)
                                                          throws AXLAttributeException
Creates an REMOVESERVER element with attributes.

Parameters:
id - The id of the server to be removed. (REQUIRED)
Returns:
A REMOVESERVER Element.
Throws:
AXLAttributeException - if required attributes are not properly set.

createRemoveServiceElement

public static com.esri.w3c.dom.Element createRemoveServiceElement(String name)
                                                           throws AXLAttributeException
Creates an REMOVESERVICE element with attributes.

Parameters:
name - The name of the service to be removed. (REQUIRED)
Returns:
A REMOVESERVICE Element.
Throws:
AXLAttributeException - if required attributes are not properly set.

createRemoveServiceGroupElement

public static com.esri.w3c.dom.Element createRemoveServiceGroupElement(String name)
                                                                throws AXLAttributeException
Creates an REMOVESERVICEGROUP element with attributes.

Parameters:
name - The name of the service group to be removed. (REQUIRED)
Returns:
A REMOVESERVICEGROUP Element.
Throws:
AXLAttributeException - if required attributes are not properly set.

createSaveElement

public static com.esri.w3c.dom.Element createSaveElement()
Creates an SAVE element.

Returns:
Element A SAVE Element.

createScreenElement

public static com.esri.w3c.dom.Element createScreenElement(String dpi)
                                                    throws AXLAttributeException
Creates an SCREEN element with dpi attribute.

Parameters:
dpi - The screen dpi. (REQUIRED)
Throws:
AXLAttributeException - if required attributes are not properly set.

createSecurityElement

public static com.esri.w3c.dom.Element createSecurityElement()
Creates an SECURITY element.

Returns:
Element A SECURITY Element.

createServerElement

public static com.esri.w3c.dom.Element createServerElement(String id,
                                                           String name,
                                                           String threads,
                                                           String monitor,
                                                           String group,
                                                           String alias,
                                                           String status,
                                                           String exitcode)
                                                    throws AXLAttributeException
Creates a SERVER element with attributes.

Parameters:
id - The id of the server. (REQUIRED)
name - The name of the server. (REQUIRED)
threads - The number of threads running on the server. (REQUIRED)
monitor - The monitor associated with this server. (REQUIRED)
group - The server group for the server. (REQUIRED)
alias - The alias of the server. (REQUIRED)
status - The current status of the server.
exitcode - The exitcode used by the server to shut down.
Throws:
AXLAttributeException - if required attributes are not properly set.

createServersElement

public static com.esri.w3c.dom.Element createServersElement()
Creates an SERVERS element.

Returns:
Element A SERVERS Element.

createServiceElement

public static com.esri.w3c.dom.Element createServiceElement(String name,
                                                            String type,
                                                            String servicegroup,
                                                            String status,
                                                            String access)
                                                     throws AXLAttributeException
Creates an SERVICE element with attributes.

Parameters:
name - The name of the service. (REQUIRED)
type - The service type. (REQUIRED)
servicegroup - The name of the service group the service is associated with. (REQUIRED)
status - The current status of the service; Running or Stopped.
access - The access of the service.
Throws:
AXLAttributeException - if required attributes are not properly set.

createServicesElement

public static com.esri.w3c.dom.Element createServicesElement()
Creates an SERVICES element.

Returns:
Element A SERVICES Element.

createServiceGroupElement

public static com.esri.w3c.dom.Element createServiceGroupElement(String name,
                                                                 String type,
                                                                 String access,
                                                                 String description,
                                                                 String status)
                                                          throws AXLAttributeException
Creates an SERVICEGROUP element with attributes.

Parameters:
name - The name of the service group. (REQUIRED)
type - The service group type. (REQUIRED)
access - The access of the service. (REQUIRED)
description - A description of the service group.
status - The current status of the service; Running or Stopped.
Throws:
AXLAttributeException - if required attributes are not properly set.

createServiceGroupsElement

public static com.esri.w3c.dom.Element createServiceGroupsElement()
Creates a SERVICEGROUPS element.

Returns:
Element A SERVICEGROUPS Element.

createServiceGroupServerElement

public static com.esri.w3c.dom.Element createServiceGroupServerElement(String id,
                                                                       String threads)
                                                                throws AXLAttributeException
Creates an SERVER element with attributes. This SERVER object is used within SERVERGROUP request tags.

Parameters:
threads - The number of threads used in this server. (REQUIRED)
Throws:
AXLAttributeException - if required attributes are not properly set.

createSetAdminPropertyElement

public static com.esri.w3c.dom.Element createSetAdminPropertyElement(String username,
                                                                     String password)
                                                              throws AXLAttributeException
Creates a SETADMINPROPERTY element.

Parameters:
username - The new username for the site.
password - The new password for the site.
Returns:
Element A SETADMINPROPERTY Element.
AXLAttributeException

createSetPrefElement

public static com.esri.w3c.dom.Element createSetPrefElement(String name,
                                                            String value)
                                                     throws AXLAttributeException
Creates a SETPREF element.

Parameters:
name - The name of the preference to set.
value - The value of the preference to set.
Returns:
Element A SETPREF Element.
AXLAttributeException

createStartServerElement

public static com.esri.w3c.dom.Element createStartServerElement(String machine,
                                                                String alias)
                                                         throws AXLAttributeException
Creates an STARTSERVER element with attributes.

Parameters:
machine - The machine to start the server on. (REQUIRED)
alias - The alias for the server. (REQUIRED)
Throws:
AXLAttributeException - if required attributes are not properly set.

createStopServerElement

public static com.esri.w3c.dom.Element createStopServerElement(String name)
                                                        throws AXLAttributeException
Creates an STOPSERVER element with attributes.

Parameters:
name - The alias of the server to stop. (REQUIRED)
Throws:
AXLAttributeException - if required attributes are not properly set.

createStartServiceElement

public static com.esri.w3c.dom.Element createStartServiceElement(String name)
                                                          throws AXLAttributeException
Creates an STARTSERVICE element with attributes.

Parameters:
name - The name of the service to start. (REQUIRED)
Throws:
AXLAttributeException - if required attributes are not properly set.

createStopServiceElement

public static com.esri.w3c.dom.Element createStopServiceElement(String name)
                                                         throws AXLAttributeException
Creates an STOPSERVICE element with attributes.

Parameters:
name - The name of the service to stop. (REQUIRED)
Throws:
AXLAttributeException - if required attributes are not properly set.

createSummaryElement

public static com.esri.w3c.dom.Element createSummaryElement(String desc)
                                                     throws AXLAttributeException
Creates an SUMMARY element with attributes.

Parameters:
desc - The description value of the summary. (REQUIRED)
Throws:
AXLAttributeException - if required attributes are not properly set.

createUIFontElement

public static com.esri.w3c.dom.Element createUIFontElement(String name,
                                                           String color,
                                                           String size,
                                                           String style)
                                                    throws AXLAttributeException
Creates an UIFONT element with attributes.

Parameters:
name - The name of the font. (REQUIRED)
color - The color of the font (0,0,0 - 255,255,255).
size - The size of the font.
style - The font style.
Throws:
AXLAttributeException - if required attributes are not properly set.

createUpdateCategoryElement

public static com.esri.w3c.dom.Element createUpdateCategoryElement(String name)
                                                            throws AXLAttributeException
Creates an UPDATECATEGORY element with name attribute.

Parameters:
name - The name of the category. (REQUIRED)
Throws:
AXLAttributeException - if required attributes are not properly set.

createUpdateCookieElement

public static com.esri.w3c.dom.Element createUpdateCookieElement(String name,
                                                                 String category)
                                                          throws AXLAttributeException
Creates an UPDATECOOKIE element with name attribute.

Parameters:
name - The name of the cookie. (REQUIRED)
Throws:
AXLAttributeException - if required attributes are not properly set.

createValidateElement

public static com.esri.w3c.dom.Element createValidateElement()
Creates a VALIDATE element.

Returns:
Element A VALIDATE Element.

createXAPElement

public static com.esri.w3c.dom.Element createXAPElement(String name,
                                                        String content,
                                                        String ext)
                                                 throws AXLAttributeException
Creates an XAP element with attributes.

Parameters:
name - The name of the XAP. (REQUIRED)
Throws:
AXLAttributeException - if required attributes are not properly set.

createZipElement

public static com.esri.w3c.dom.Element createZipElement(String url,
                                                        String path)
                                                 throws AXLAttributeException
Creates an ZIP element with attributes.

Parameters:
url - The zip output url. (REQUIRED)
path - The path of the zip output directory. (REQUIRED)
Throws:
AXLAttributeException - if required attributes are not properly set.

createAddSDEServiceElement

public static com.esri.w3c.dom.Element createAddSDEServiceElement(String name,
                                                                  String port,
                                                                  String instanceName,
                                                                  String sdeAdminDatabase,
                                                                  String description)
                                                           throws AXLAttributeException
Creates a new SDE Service that is defined by the specified attributes.

Parameters:
name - the Server running ArcSDE
instanceName - an alias for port in services file (both $SDEHOME/etc/services.sde and os etc/services (*nix). %SDEHOME%\etc\services.sde and %windir%\system32\drivers\etc\services (wintel)
description - an user defined description of an SDE service, For example: "engineering database"
AXLAttributeException

createRemoveSDEServiceElement

public static com.esri.w3c.dom.Element createRemoveSDEServiceElement(String name,
                                                                     String port)
                                                              throws AXLAttributeException
AXLAttributeException

createSdeStatusElement

public static com.esri.w3c.dom.Element createSdeStatusElement(String name,
                                                              String port)
                                                       throws AXLAttributeException
Constructs a status request.

AXLAttributeException

createStartSDEServiceElement

public static com.esri.w3c.dom.Element createStartSDEServiceElement(String name,
                                                                    String instanceName,
                                                                    String password)
                                                             throws AXLAttributeException
To start an SDE service the Instance Name is needed. The Instance name is added via the ADDSERVICE tag, but here it is not necessary as a service can be identified by its name and port. The sdejavautil lib is needed in %sdehome%\bin or $SDEHOME/bin.

AXLAttributeException

createShutdownSDEServiceElement

public static com.esri.w3c.dom.Element createShutdownSDEServiceElement(String name,
                                                                       String port,
                                                                       String password)
                                                                throws AXLAttributeException
AXLAttributeException

createPauseSDEServiceElement

public static com.esri.w3c.dom.Element createPauseSDEServiceElement(String name,
                                                                    String port,
                                                                    String password)
                                                             throws AXLAttributeException
AXLAttributeException

createResumeSDEServiceElement

public static com.esri.w3c.dom.Element createResumeSDEServiceElement(String name,
                                                                     String port,
                                                                     String password)
                                                              throws AXLAttributeException
AXLAttributeException

createCompressSDEServiceElement

public static com.esri.w3c.dom.Element createCompressSDEServiceElement(String name,
                                                                       String port,
                                                                       String password)
                                                                throws AXLAttributeException
AXLAttributeException

createDbtuneQueryElement

public static com.esri.w3c.dom.Element createDbtuneQueryElement(String name,
                                                                String port,
                                                                String password)
                                                         throws AXLAttributeException
AXLAttributeException

createListSDEConnectionsElement

public static com.esri.w3c.dom.Element createListSDEConnectionsElement(String name,
                                                                       String port)
                                                                throws AXLAttributeException
AXLAttributeException

createKillSDEConnectionElement

public static com.esri.w3c.dom.Element createKillSDEConnectionElement(String name,
                                                                      String port,
                                                                      String password,
                                                                      String connectionId)
                                                               throws AXLAttributeException
AXLAttributeException

createKillAllSDEConnectionsElement

public static com.esri.w3c.dom.Element createKillAllSDEConnectionsElement(String name,
                                                                          String port,
                                                                          String password)
                                                                   throws AXLAttributeException
AXLAttributeException